gateway: simplify stopping the cleanup timer
[olsrd.git] / lib / tas / src / plugin.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon (olsrd)
4  *
5  * Copyright (c) 2004, Thomas Lopatic (thomas@olsr.org)
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  *   notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in
16  *   the documentation and/or other materials provided with the
17  *   distribution.
18  * * Neither the name of olsr.org, olsrd nor the names of its
19  *   contributors may be used to endorse or promote products derived
20  *   from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  * Visit http://www.olsr.org for more information.
36  *
37  * If you find this software useful feel free to make a donation
38  * to the project. For more information see the website or contact
39  * the copyright holders.
40  *
41  */
42
43 #include <string.h>
44 #include <time.h>               // clock_t required by olsrd includes
45
46 #include "link.h"
47 #include "plugin.h"
48 #include "lib.h"
49 #include "os_unix.h"
50 #include "http.h"
51 #include "glua.h"
52 #include "glua_ext.h"
53 #include "olsrd_plugin.h"
54 #include "net_olsr.h"
55
56 #include <defs.h>
57 #include <olsr.h>
58 #include <scheduler.h>
59 #include <parser.h>
60 #include <link_set.h>
61 #include <neighbor_table.h>
62 #include <two_hop_neighbor_table.h>
63 #include <mid_set.h>
64 #include <tc_set.h>
65 #include <hna_set.h>
66 #include <routing_table.h>
67 #include <olsr_protocol.h>
68 #include <mpr_selector_set.h>
69 #include <duplicate_set.h>
70 #include <lq_plugin.h>
71
72 #define PLUGIN_INTERFACE_VERSION 5
73
74 #define MESSAGE_TYPE 129
75
76 int olsrd_plugin_interface_version(void);
77 int olsrd_plugin_init(void);
78
79 static int ipAddrLen;
80 static union olsr_ip_addr *mainAddr;
81
82 static struct interface *intTab = NULL;
83 static struct neighbor_entry *neighTab = NULL;
84 static struct mid_entry *midTab = NULL;
85 static struct hna_entry *hnaTab = NULL;
86 static struct olsrd_config *config = NULL;
87
88 static int iterIndex;
89
90 static struct link_entry *iterLinkTab = NULL;
91 static struct neighbor_entry *iterNeighTab = NULL;
92 static struct tc_entry *iterTcTab = NULL;
93 static struct rt_entry *iterRouteTab = NULL;
94
95 static void __attribute__ ((constructor)) banner(void)
96 {
97   printf("Tiny Application Server 0.1 by olsr.org\n");
98 }
99
100 int
101 iterLinkTabNext(char *buff, int len)
102 {
103   struct list_node *link_node;
104   struct lqtextbuffer lqbuffer;
105
106   if (iterLinkTab == NULL)
107     return -1;
108
109   snprintf(buff, len, "local~%s~remote~%s~main~%s~hysteresis~%f~cost~%s~",
110            rawIpAddrToString(&iterLinkTab->local_iface_addr, ipAddrLen), rawIpAddrToString(&iterLinkTab->neighbor_iface_addr,
111                                                                                            ipAddrLen),
112            rawIpAddrToString(&iterLinkTab->neighbor->neighbor_main_addr, ipAddrLen), (double)iterLinkTab->L_link_quality,
113            get_linkcost_text(iterLinkTab->linkcost, false, &lqbuffer));
114
115   link_node = iterLinkTab->link_list.next;
116   if (link_node != &link_entry_head) {
117     iterLinkTab = list2link(link_node);
118   } else {
119     iterLinkTab = NULL;
120   }
121
122   return 0;
123 }
124
125 void
126 iterLinkTabInit(void)
127 {
128   struct list_node *link_node;
129
130   link_node = link_entry_head.next;
131   if (link_node != &link_entry_head) {
132     iterLinkTab = list2link(link_node);
133   } else {
134     iterLinkTab = NULL;
135   }
136 }
137
138 int
139 iterNeighTabNext(char *buff, int len)
140 {
141   int res;
142   int i;
143   struct neighbor_2_list_entry *neigh2;
144
145   if (iterNeighTab == NULL)
146     return -1;
147
148   res =
149     snprintf(buff, len, "main~%s~symmetric~%s~mpr~%s~mprs~%s~willingness~%d~[~neighbors2~",
150              rawIpAddrToString(&iterNeighTab->neighbor_main_addr, ipAddrLen), iterNeighTab->status == SYM ? "true" : "false",
151              iterNeighTab->is_mpr != 0 ? "true" : "false",
152              olsr_lookup_mprs_set(&iterNeighTab->neighbor_main_addr) != NULL ? "true" : "false", iterNeighTab->willingness);
153
154   i = 0;
155
156   len -= res;
157   buff += res;
158
159   len -= 2;
160
161   for (neigh2 = iterNeighTab->neighbor_2_list.next; neigh2 != &iterNeighTab->neighbor_2_list; neigh2 = neigh2->next) {
162     res = snprintf(buff, len, "%d~%s~", i, rawIpAddrToString(&neigh2->neighbor_2->neighbor_2_addr, ipAddrLen));
163
164     if (res < len)
165       buff += res;
166
167     len -= res;
168
169     if (len <= 0)
170       break;
171
172     i++;
173   }
174
175   strcpy(buff, "]~");
176
177   iterNeighTab = iterNeighTab->next;
178
179   if (iterNeighTab == &neighTab[iterIndex]) {
180     iterNeighTab = NULL;
181
182     while (++iterIndex < HASHSIZE)
183       if (neighTab[iterIndex].next != &neighTab[iterIndex]) {
184         iterNeighTab = neighTab[iterIndex].next;
185         break;
186       }
187   }
188
189   return 0;
190 }
191
192 void
193 iterNeighTabInit(void)
194 {
195   iterNeighTab = NULL;
196
197   if (neighTab == NULL)
198     return;
199
200   for (iterIndex = 0; iterIndex < HASHSIZE; iterIndex++)
201     if (neighTab[iterIndex].next != &neighTab[iterIndex]) {
202       iterNeighTab = neighTab[iterIndex].next;
203       break;
204     }
205 }
206
207 int
208 iterRouteTabNext(char *buff, int len)
209 {
210   struct avl_node *rt_tree_node;
211
212   if (iterRouteTab == NULL)
213     return -1;
214
215   snprintf(buff, len, "destination~%s~gateway~%s~interface~%s~metric~%d~",
216            rawIpAddrToString(&iterRouteTab->rt_dst.prefix, ipAddrLen),
217            rawIpAddrToString(&iterRouteTab->rt_best->rtp_nexthop.gateway, ipAddrLen),
218            if_ifwithindex_name(iterRouteTab->rt_best->rtp_nexthop.iif_index), iterRouteTab->rt_best->rtp_metric.hops);
219
220   rt_tree_node = avl_walk_next(&iterRouteTab->rt_tree_node);
221   if (rt_tree_node) {
222     iterRouteTab = rt_tree2rt(rt_tree_node);
223   } else {
224     iterRouteTab = NULL;
225   }
226
227   return 0;
228 }
229
230 void
231 iterRouteTabInit(void)
232 {
233   struct avl_node *node;
234
235   avl_init(&routingtree, avl_comp_prefix_default);
236   routingtree_version = 0;
237
238   node = avl_walk_first(&routingtree);
239   iterRouteTab = node ? rt_tree2rt(node) : NULL;
240
241 }
242
243 /**
244  * Grab the next topology entry.
245  *
246  * @param adr the address to look for
247  * @return the entry found or NULL
248  */
249 static struct tc_entry *
250 tas_getnext_tc_entry(struct tc_entry *tc)
251 {
252   struct avl_node *node = avl_walk_next(&tc->vertex_node);
253
254   return (node ? vertex_tree2tc(node) : NULL);
255 }
256
257 int
258 iterTcTabNext(char *buff, int len)
259 {
260   int res;
261   int i;
262   struct tc_edge_entry *tc_edge;
263   struct lqtextbuffer lqbuffer;
264
265   if (iterTcTab == NULL)
266     return -1;
267
268   res = snprintf(buff, len, "main~%s~[~destinations~", rawIpAddrToString(&iterTcTab->addr, ipAddrLen));
269
270   len -= res;
271   buff += res;
272
273   len -= 2;
274   i = 0;
275
276   OLSR_FOR_ALL_TC_EDGE_ENTRIES(iterTcTab, tc_edge) {
277
278     res =
279       snprintf(buff, len, "[~%d~address~%s~cost~%s~]~", i, rawIpAddrToString(&tc_edge->T_dest_addr, ipAddrLen),
280                get_linkcost_text(tc_edge->cost, false, &lqbuffer));
281
282     if (res < len)
283       buff += res;
284
285     len -= res;
286
287     if (len <= 0)
288       break;
289
290     i++;
291   }
292   OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(iterTcTab, tc_edge);
293
294   strcpy(buff, "]~");
295
296   iterTcTab = tas_getnext_tc_entry(iterTcTab);
297
298   return 0;
299 }
300
301 void
302 iterTcTabInit(void)
303 {
304   struct avl_node *node;
305
306   avl_init(&tc_tree, avl_comp_default);
307
308   node = avl_walk_first(&tc_tree);
309   iterTcTab = (node ? vertex_tree2tc(node) : NULL);
310 }
311
312 static bool
313 parserFunc(union olsr_message *msg, struct interface *inInt __attribute__ ((unused)), union olsr_ip_addr *neighIntAddr)
314 {
315   char *mess = (char *)msg;
316   union olsr_ip_addr *orig = (union olsr_ip_addr *)ARM_NOWARN_ALIGN(mess + 4);
317   int len = (mess[2] << 8) | mess[3];
318   char *service, *string;
319   int i;
320
321   if (memcmp(orig, mainAddr, ipAddrLen) == 0)
322     return false;
323
324   if (check_neighbor_link(neighIntAddr) != SYM_LINK) {
325     error("TAS message not from symmetric neighbour\n");
326     return false;
327   }
328
329   if (len < ipAddrLen + 8 + 2) {
330     error("short TAS message received (%d bytes)\n", len);
331     return false;
332   }
333
334   len -= ipAddrLen + 8;
335   service = mess + ipAddrLen + 8;
336
337   for (i = 0; i < len && service[i] != 0; i++);
338
339   if (i++ == len) {
340     error("TAS message has unterminated service string\n");
341     return false;
342   }
343
344   if (i == len) {
345     error("TAS message lacks payload string\n");
346     return false;
347   }
348
349   string = service + i;
350   len -= i;
351
352   for (i = 0; i < len && string[i] != 0; i++);
353
354   if (i == len) {
355     error("TAS message has unterminated payload string\n");
356     return false;
357   }
358
359   httpAddTasMessage(service, string, rawIpAddrToString(orig, ipAddrLen));
360
361   /* Forward the message */
362   return true;
363 }
364
365 void
366 sendMessage(const char *service, const char *string)
367 {
368   unsigned char *mess, *walker;
369   int len, pad;
370   unsigned short seqNo;
371   struct interface *inter;
372
373   pad = len = ipAddrLen + 8 + strlen(service) + 1 + strlen(string) + 1;
374
375   len = 1 + ((len - 1) | 3);
376
377   pad = len - pad;
378
379   walker = mess = allocMem(len);
380
381   seqNo = get_msg_seqno();
382
383   *walker++ = MESSAGE_TYPE;
384   *walker++ = 0;
385   *walker++ = (unsigned char)(len >> 8);
386   *walker++ = (unsigned char)len;
387
388   memcpy(walker, mainAddr, ipAddrLen);
389   walker += ipAddrLen;
390
391   *walker++ = 255;
392   *walker++ = 0;
393   *walker++ = (unsigned char)(seqNo >> 8);
394   *walker++ = (unsigned char)seqNo;
395
396   while (*service != 0)
397     *walker++ = *service++;
398
399   *walker++ = 0;
400
401   while (*string != 0)
402     *walker++ = *string++;
403
404   *walker++ = 0;
405
406   while (pad-- > 0)
407     *walker++ = 0;
408
409   for (inter = intTab; inter != NULL; inter = inter->int_next) {
410     if (net_outbuffer_push(inter, mess, len) != len) {
411       net_output(inter);
412       net_outbuffer_push(inter, mess, len);
413     }
414   }
415
416   freeMem(mess);
417 }
418
419 static void
420 serviceFunc(void *context __attribute__ ((unused)))
421 {
422   static int up = 0;
423
424   if (up == 0) {
425     if (httpSetup() < 0)
426       return;
427
428     up = 1;
429   }
430
431   if (up != 0)
432     httpService((int)(1.0f / config->pollrate));
433 }
434
435 int
436 olsrd_plugin_interface_version(void)
437 {
438   return PLUGIN_INTERFACE_VERSION;
439 }
440
441 int
442 olsrd_plugin_init(void)
443 {
444   ipAddrLen = olsr_cnf->ipsize;
445   mainAddr = &olsr_cnf->main_addr;
446
447   intTab = ifnet;
448   neighTab = neighbortable;
449   midTab = mid_set;
450   hnaTab = hna_set;
451   config = olsr_cnf;
452
453   httpInit();
454
455   olsr_start_timer(OLSR_TAS_SERVICE_INT, 0, OLSR_TIMER_PERIODIC, &serviceFunc, NULL, 0);
456
457   olsr_parser_add_function(parserFunc, MESSAGE_TYPE);
458
459   return 0;
460 }
461
462 static const struct olsrd_plugin_parameters plugin_parameters[] = {
463   {.name = "address",.set_plugin_parameter = &httpSetAddress,.data = NULL},
464   {.name = "port",.set_plugin_parameter = &httpSetPort,.data = NULL},
465   {.name = "rootdir",.set_plugin_parameter = &httpSetRootDir,.data = NULL},
466   {.name = "workdir",.set_plugin_parameter = &httpSetWorkDir,.data = NULL},
467   {.name = "indexfile",.set_plugin_parameter = &httpSetIndexFile,.data = NULL},
468   {.name = "user",.set_plugin_parameter = &httpSetUser,.data = NULL},
469   {.name = "password",.set_plugin_parameter = &httpSetPassword,.data = NULL},
470   {.name = "sesstime",.set_plugin_parameter = &httpSetSessTime,.data = NULL},
471   {.name = "pubdir",.set_plugin_parameter = &httpSetPubDir,.data = NULL},
472   {.name = "quantum",.set_plugin_parameter = &httpSetQuantum,.data = NULL},
473   {.name = "messtime",.set_plugin_parameter = &httpSetMessTime,.data = NULL},
474   {.name = "messlimit",.set_plugin_parameter = &httpSetMessLimit,.data = NULL},
475 };
476
477 void
478 olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
479 {
480   *params = plugin_parameters;
481   *size = sizeof(plugin_parameters) / sizeof(*plugin_parameters);
482 }
483
484 /*
485  * Local Variables:
486  * c-basic-offset: 2
487  * indent-tabs-mode: nil
488  * End:
489  */