docu
[oweals/gnunet.git] / src / transport / plugin_transport_http_common.c
1 /*
2      This file is part of GNUnet
3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file transport/plugin_transport_http_common.c
23  * @brief functionality shared by http client and server transport service plugin
24  * @author Matthias Wachs
25  */
26
27 #include "platform.h"
28 #include "gnunet_common.h"
29 #include "gnunet_transport_plugin.h"
30
31 /**
32  * Convert the transports address to a nice, human-readable
33  * format.
34  *
35  * @param cls closure
36  * @param type name of the transport that generated the address
37  * @param addr one of the addresses of the host, NULL for the last address
38  *        the specific address format depends on the transport
39  * @param addrlen length of the address
40  * @param numeric should (IP) addresses be displayed in numeric form?
41  * @param timeout after how long should we give up?
42  * @param asc function to call on each string
43  * @param asc_cls closure for asc
44  */
45 void
46 http_common_plugin_address_pretty_printer (void *cls, const char *type,
47                                         const void *addr, size_t addrlen,
48                                         int numeric,
49                                         struct GNUNET_TIME_Relative timeout,
50                                         GNUNET_TRANSPORT_AddressStringCallback
51                                         asc, void *asc_cls)
52 {
53   const char *saddr = (const char *) addr;
54
55   if ( (NULL == saddr) ||
56        (0 >= addrlen) ||
57        ('\0' != saddr[addrlen-1]) )
58   {
59       asc (asc_cls, NULL);
60       return;
61   }
62   asc (asc_cls, saddr);
63 }
64
65
66 /**
67  * Function called for a quick conversion of the binary address to
68  * a numeric address.  Note that the caller must not free the
69  * address and that the next call to this function is allowed
70  * to override the address again.
71  *
72  * @param cls closure
73  * @param addr binary address
74  * @param addrlen length of the address
75  * @return string representing the same address
76  */
77 const char *
78 http_common_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
79 {
80   const char *saddr = (const char *) addr;
81   if (NULL == saddr)
82       return NULL;
83   if (0 >= addrlen)
84     return NULL;
85   if (saddr[addrlen-1] != '\0')
86     return NULL;
87   return saddr;
88 }
89
90 /**
91  * Function called to convert a string address to
92  * a binary address.
93  *
94  * @param cls closure ('struct Plugin*')
95  * @param addr string address
96  * @param addrlen length of the address
97  * @param buf location to store the buffer
98  *        If the function returns GNUNET_SYSERR, its contents are undefined.
99  * @param added length of created address
100  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
101  */
102 int
103 http_common_plugin_string_to_address (void *cls,
104                         const char *addr,
105                         uint16_t addrlen,
106                         void **buf,
107                         size_t *added)
108 {
109   if (NULL == addr)
110       return GNUNET_SYSERR;
111   if (0 >= addrlen)
112     return GNUNET_SYSERR;
113   if (addr[addrlen-1] != '\0')
114     return GNUNET_SYSERR;
115
116   (*buf) = strdup (addr);
117   (*added) = strlen (addr) + 1;
118   return GNUNET_OK;
119 }
120
121 /**
122  * Create a HTTP address from a socketaddr
123  *
124  * @param protocol protocol
125  * @param addr sockaddr * address
126  * @param addrlen length of the address
127  * @return the string
128  */
129 char *
130 http_common_address_from_socket (const char *protocol, const struct sockaddr *addr, socklen_t addrlen)
131 {
132   char *res;
133   GNUNET_asprintf(&res, "%s://%s", protocol, GNUNET_a2s (addr, addrlen));
134   return res;
135 }
136
137 /**
138  * Create a socketaddr from a HTTP address
139  *
140  * @param addr sockaddr * address
141  * @param addrlen length of the address
142  * @param res the result:
143  * GNUNET_SYSERR, invalid input,
144  * GNUNET_YES: could convert to ip,
145  * GNUNET_NO: valid input but could not convert to ip (hostname?)
146  * @return the string
147  */
148 struct sockaddr *
149 http_common_socket_from_address (const void *addr, size_t addrlen, int *res)
150 {
151   struct sockaddr_storage *s;
152   char *addrs;
153   char *addrs_org;
154   char *addrs_end;
155   (*res) = GNUNET_SYSERR;
156
157   if (NULL == addr)
158     {
159       GNUNET_break (0);
160       return NULL;
161     }
162   if (0 >= addrlen)
163     {
164       GNUNET_break (0);
165       return NULL;
166     }
167   if (((char *) addr)[addrlen-1] != '\0')
168     {
169       GNUNET_break (0);
170       return NULL;
171     }
172
173   addrs_org = strdup ((char *) addr);
174   addrs = strstr (addrs_org , "://");
175   if (NULL == addrs)
176   {
177     GNUNET_break (0);
178     GNUNET_free (addrs_org);
179     return NULL;
180   }
181
182   if (strlen (addrs) < 3)
183   {
184     GNUNET_break (0);
185     GNUNET_free (addrs_org);
186     return NULL;
187   }
188
189   addrs += 3;
190
191   addrs_end = strchr (addrs, '/');
192   if (NULL != addrs_end)
193     addrs[strlen (addrs) - strlen(addrs_end)] = '\0';
194
195   s = GNUNET_malloc (sizeof (struct sockaddr_storage));
196   if (GNUNET_SYSERR == GNUNET_STRINGS_to_address_ip (addrs, strlen(addrs), s))
197   {
198     /* could be a hostname */
199     GNUNET_free (s);
200     GNUNET_free (addrs_org);
201     (*res) = GNUNET_NO;
202     return NULL;
203   }
204   else
205   {
206     if ((AF_INET != s->ss_family) && (AF_INET6 != s->ss_family))
207     {
208       GNUNET_break (0);
209       GNUNET_free (s);
210       GNUNET_free (addrs_org);
211       (*res) = GNUNET_SYSERR;
212       return NULL;
213     }
214   }
215   (*res) = GNUNET_YES;
216   GNUNET_free (addrs_org);
217   return (struct sockaddr *) s;
218 }
219
220 /**
221  * Get the length of an address
222  *
223  * @param addr address
224  * @return the size
225  */
226 size_t
227 http_common_address_get_size (const void *addr)
228 {
229  return strlen (addr) + 1;
230 }
231
232 /**
233  * Compare addr1 to addr2
234  *
235  * @param addr1 address1
236  * @param addrlen1 address 1 length
237  * @param addr2 address2
238  * @param addrlen2 address 2 length
239  * @return GNUNET_YES if equal, GNUNET_NO if not, GNUNET_SYSERR on error
240  */
241 int
242 http_common_cmp_addresses (const void *addr1, size_t addrlen1, const void *addr2, size_t addrlen2)
243 {
244   const char *a1 = (const char *) addr1;
245   const char *a2 = (const char *) addr2;
246
247   if (NULL == a1)
248       return GNUNET_SYSERR;
249   if (0 >= addrlen1)
250     return GNUNET_SYSERR;
251   if (a1[addrlen1-1] != '\0')
252     return GNUNET_SYSERR;
253
254   if (NULL == a2)
255       return GNUNET_SYSERR;
256   if (0 >= addrlen2)
257     return GNUNET_SYSERR;
258   if (a2[addrlen2-1] != '\0')
259     return GNUNET_SYSERR;
260
261   if (addrlen1 != addrlen2)
262     return GNUNET_NO;
263
264   if (0 == strcmp (addr1, addr2))
265     return GNUNET_YES;
266   return GNUNET_NO;
267 }
268
269
270
271 /* end of plugin_transport_http_common.c */