a413a7093186bb2004e9f57b8d15fae621566562
[olsrd.git] / lib / nameservice / src / nameservice.h
1 /*
2  * Copyright (c) 2005, Bruno Randolf <bruno.randolf@4g-systems.biz>
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto-at-olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright notice, 
11  *   this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright notice, 
13  *   this list of conditions and the following disclaimer in the documentation 
14  *   and/or other materials provided with the distribution.
15  * * Neither the name of the UniK olsr daemon nor the names of its contributors 
16  *   may be used to endorse or promote products derived from this software 
17  *   without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
22  * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
23  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
27  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  */
31
32  
33 /*
34  * Dynamic linked library for UniK OLSRd
35  */
36
37 #ifndef _NAMESERVICE_PLUGIN
38 #define _NAMESERVICE_PLUGIN
39
40 #include <sys/time.h>
41 #include <regex.h>
42
43 #include "olsr_types.h"
44 #include "interfaces.h"
45 #include "olsr_protocol.h"
46
47 #include "olsrd_plugin.h"
48 #include "nameservice_msg.h"
49 #include "hashing.h"
50 #include "mapwrite.h"
51
52 #define PLUGIN_NAME     "OLSRD nameservice plugin"
53 #define PLUGIN_VERSION  "0.3"
54 #define PLUGIN_AUTHOR   "Bruno Randolf, Jens Nachtigall, Sven-Ola"
55
56 // useful to set for the freifunkfirmware to remove all
57 // calls to olsr_printf by the empty statement ";"
58 //#define olsr_printf(...) ;
59
60 #define MESSAGE_TYPE            130
61 #define PARSER_TYPE             MESSAGE_TYPE
62 #define EMISSION_INTERVAL       120 /* two minutes */
63 #define NAME_VALID_TIME         1800 /* half one hour */
64 #define NAMESERVER_COUNT        3
65
66 #define NAME_PROTOCOL_VERSION   1
67
68 #define MAX_NAME 127
69 #define MAX_FILE 255
70 #define MAX_SUFFIX 63
71
72 /**
73  * a linked list of name_entry
74  * if type is NAME_HOST, name is a hostname and ip its IP addr
75  * if type is NAME_FORWARDER, then ip is a dns-server (and name is irrelevant)
76  * if type is NAME_SERVICE, then name is a service-line (and the ip is irrelevant)
77  * if type is NAME_LATLON, then name has 2 floats with lat and lon (and the ip is irrelevant)
78  */
79 struct name_entry
80 {
81         union olsr_ip_addr      ip;
82         olsr_u16_t              type;
83         olsr_u16_t              len;
84         char                    *name;
85         struct name_entry       *next;          /* linked list */
86 };
87
88 /* *
89  * linked list of db_entries for each originator with
90  * originator being its main_addr
91  * 
92  * names points to the name_entry with its hostname, dns-server or
93  * service-line entry
94  *
95  * all the db_entries are hashed in nameservice.c to avoid a too long list
96  * for many nodes in a net
97  *
98  * */
99 struct db_entry
100 {
101         union olsr_ip_addr      originator;     /* IP address of the node this entry describes */
102         struct timeval          timer;          /* Validity time */
103         struct name_entry       *names;         /* list of names this originator declares */
104         struct db_entry         *next;          /* linked list */
105 };
106
107 extern struct name_entry *my_names;
108 extern struct db_entry* latlon_list[HASHSIZE];
109 extern float my_lat, my_lon;
110
111 /* Timeout function to register with the sceduler */
112 void
113 olsr_timeout(void);
114
115 /* Parser function to register with the sceduler */
116 void
117 olsr_parser(union olsr_message *, struct interface *, union olsr_ip_addr *);
118
119 /* Event function to register with the sceduler */
120 void
121 olsr_event(void *);
122
123 int
124 encap_namemsg(struct namemsg *);
125
126 struct name_entry*
127 add_name_to_list(struct name_entry *my_list, const char *value, int type, const union olsr_ip_addr *ip);
128
129 struct name_entry*
130 remove_nonvalid_names_from_list(struct name_entry *my_list, int type);
131
132 void 
133 free_all_list_entries(struct db_entry **this_db_list) ;
134
135 void
136 timeout_old_names(struct db_entry **this_list, olsr_bool *this_table_changed);
137
138 void
139 decap_namemsg(struct name *from_packet, struct name_entry **to, olsr_bool *this_table_changed );
140
141 void
142 insert_new_name_in_list(union olsr_ip_addr *originator, struct db_entry **this_list, struct name *from_packet, olsr_bool *this_table_changed, double vtime);
143
144 olsr_bool
145 allowed_hostname_or_ip_in_service(const char *service_line, const regmatch_t *hostname_or_ip);
146
147 void
148 update_name_entry(union olsr_ip_addr *, struct namemsg *, int, double);
149
150 void
151 write_hosts_file(void);
152
153 void
154 write_services_file(void);
155
156 void
157 write_resolv_file(void);
158
159 int
160 register_olsr_param(char *key, char *value);
161
162 void 
163 free_name_entry_list(struct name_entry **list);
164
165 olsr_bool
166 allowed_ip(const union olsr_ip_addr *addr);
167
168 olsr_bool
169 allowed_service(const char *service_line);
170
171 olsr_bool
172 is_name_wellformed(const char *service_line);
173
174 olsr_bool
175 is_service_wellformed(const char *service_line);
176
177 olsr_bool
178 is_service_wellformed(const char *service_line);
179
180 olsr_bool
181 is_latlon_wellformed(const char *latlon_line);
182
183 olsr_bool
184 get_isdefhna_latlon(void);
185
186 void
187 lookup_defhna_latlon(union olsr_ip_addr *ip);
188
189 const char*
190 lookup_name_latlon(union olsr_ip_addr *ip);
191
192 void
193 write_latlon_file(void);
194
195 char*  
196 create_packet(struct name *to, struct name_entry *from);
197
198 void
199 name_constructor(void);
200
201 void
202 name_destructor(void);
203
204 int
205 name_init(void);
206
207 #endif