* merged it also and fixed lots of stuff by hand
[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 /* $Id: nameservice.h,v 1.10 2007/02/04 21:11:48 bernd67 Exp $ */
33  
34 /*
35  * Dynamic linked library for UniK OLSRd
36  */
37
38 #ifndef _NAMESERVICE_PLUGIN
39 #define _NAMESERVICE_PLUGIN
40
41 #include <sys/time.h>
42 #include <regex.h>
43
44 #include "olsr_types.h"
45 #include "interfaces.h"
46 #include "olsr_protocol.h"
47
48 #include "olsrd_plugin.h"
49 #include "nameservice_msg.h"
50
51 #define PLUGIN_NAME     "OLSRD nameservice plugin"
52 #define PLUGIN_VERSION  "0.2"
53 #define PLUGIN_AUTHOR   "Bruno Randolf"
54
55 // useful to set for the freifunkfirmware to remove all
56 // calls to olsr_printf by the empty statement ";"
57 //#define olsr_printf(...) ;
58
59 #define MESSAGE_TYPE            130
60 #define PARSER_TYPE             MESSAGE_TYPE
61 #define EMISSION_INTERVAL       120 /* two minutes */
62 #define NAME_VALID_TIME         1800 /* half one hour */
63
64 #define NAME_PROTOCOL_VERSION   1
65
66 #define MAX_NAME 127
67 #define MAX_FILE 255
68 #define MAX_SUFFIX 63
69
70 /**
71  * a linked list of name_entry
72  * if type is NAME_HOST, name is a hostname and ip its IP addr
73  * if type is NAME_FORWARDER, then ip is a dns-server (and name is irrelevant)
74  * if type is NAME_SERVICE, then name is a service-line (and the ip is irrelevant)
75  */
76 struct name_entry
77 {
78         union olsr_ip_addr      ip;
79         olsr_u16_t              type;
80         olsr_u16_t              len;
81         char                    *name;
82         struct name_entry       *next;          /* linked list */
83 };
84
85 /* *
86  * linked list of db_entries for each originator with
87  * originator being its main_addr
88  * 
89  * names points to the name_entry with its hostname, dns-server or
90  * service-line entry
91  *
92  * all the db_entries are hashed in nameservice.c to avoid a too long list
93  * for many nodes in a net
94  *
95  * */
96 struct db_entry
97 {
98         union olsr_ip_addr      originator;     /* IP address of the node this entry describes */
99         struct timeval          timer;          /* Validity time */
100         struct name_entry       *names;         /* list of names this originator declares */
101         struct db_entry         *next;          /* linked list */
102 };
103
104
105 /* Timeout function to register with the sceduler */
106 void
107 olsr_timeout(void);
108
109 /* Parser function to register with the sceduler */
110 void
111 olsr_parser(union olsr_message *, struct interface *, union olsr_ip_addr *);
112
113 /* Event function to register with the sceduler */
114 void
115 olsr_event(void *);
116
117 int
118 encap_namemsg(struct namemsg *);
119
120 struct name_entry*
121 add_name_to_list(struct name_entry *my_list, char *value, int type, struct in_addr *ip);
122
123 struct name_entry*
124 remove_nonvalid_names_from_list(struct name_entry *my_list, int type);
125
126 void 
127 free_all_list_entries(struct db_entry **this_db_list) ;
128
129 void
130 timeout_old_names(struct db_entry **this_list, olsr_bool *this_table_changed);
131
132 void
133 decap_namemsg(struct name *from_packet, struct name_entry **to, olsr_bool *this_table_changed );
134
135 void
136 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);
137
138 olsr_bool
139 allowed_hostname_or_ip_in_service(char *service_line, regmatch_t *hostname_or_ip);
140
141 void
142 update_name_entry(union olsr_ip_addr *, struct namemsg *, int, double);
143
144 void
145 write_hosts_file(void);
146
147 void
148 write_services_file(void);
149
150 void
151 write_resolv_file(void);
152
153 int
154 register_olsr_param(char *key, char *value);
155
156 void 
157 free_name_entry_list(struct name_entry **list);
158
159 olsr_bool
160 allowed_ip(union olsr_ip_addr *addr);
161
162 olsr_bool
163 allowed_service(char *service_line);
164
165 olsr_bool
166 is_name_wellformed(char *service_line);
167
168 olsr_bool
169 is_service_wellformed(char *service_line);
170
171 char*  
172 create_packet(struct name *to, struct name_entry *from);
173
174 void
175 name_constructor(void);
176
177 void
178 name_destructor(void);
179
180 int
181 name_init(void);
182
183 #endif