2 This file is part of GNUnet
3 (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file transport/plugin_transport_http_server.c
23 * @brief HTTP/S server transport plugin
24 * @author Matthias Wachs
28 #include "gnunet_protocols.h"
29 #include "gnunet_connection_lib.h"
30 #include "gnunet_server_lib.h"
31 #include "gnunet_service_lib.h"
32 #include "gnunet_statistics_service.h"
33 #include "gnunet_transport_service.h"
34 #include "gnunet_transport_plugin.h"
37 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_https_server_init
38 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_https_server_done
40 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_http_server_init
41 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_server_done
45 #define DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
48 * After how long do we expire an address that we
49 * learned from another peer if it is not reconfirmed
52 #define LEARNED_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
56 * Encapsulation of all of the state of the plugin.
62 * Session handle for connections.
67 * To whom are we talking to (set to our identity
68 * if we are still waiting for the welcome message)
70 struct GNUNET_PeerIdentity sender;
73 * Stored in a linked list.
78 * Pointer to the global plugin struct.
80 struct Plugin *plugin;
83 * The client (used to identify this connection)
88 * Continuation function to call once the transmission buffer
89 * has again space available. NULL if there is no
90 * continuation to call.
92 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
95 * Closure for transmit_cont.
97 void *transmit_cont_cls;
100 * At what time did we reset last_received last?
102 struct GNUNET_TIME_Absolute last_quota_update;
105 * How many bytes have we received since the "last_quota_update"
108 uint64_t last_received;
111 * Number of bytes per ms that this peer is allowed
119 * Encapsulation of all of the state of the plugin.
126 struct GNUNET_TRANSPORT_PluginEnvironment *env;
129 * List of open sessions.
131 struct Session *sessions;
137 * Function that can be used by the transport service to transmit
138 * a message using the plugin. Note that in the case of a
139 * peer disconnecting, the continuation MUST be called
140 * prior to the disconnect notification itself. This function
141 * will be called with this peer's HELLO message to initiate
142 * a fresh connection to another peer.
145 * @param session which session must be used
146 * @param msgbuf the message to transmit
147 * @param msgbuf_size number of bytes in 'msgbuf'
148 * @param priority how important is the message (most plugins will
149 * ignore message priority and just FIFO)
150 * @param to how long to wait at most for the transmission (does not
151 * require plugins to discard the message after the timeout,
152 * just advisory for the desired delay; most plugins will ignore
154 * @param cont continuation to call once the message has
155 * been transmitted (or if the transport is ready
156 * for the next transmission call; or if the
157 * peer disconnected...); can be NULL
158 * @param cont_cls closure for cont
159 * @return number of bytes used (on the physical network, with overheads);
160 * -1 on hard errors (i.e. address invalid); 0 is a legal value
161 * and does NOT mean that the message was not transmitted (DV)
164 http_server_plugin_send (void *cls,
165 struct Session *session,
166 const char *msgbuf, size_t msgbuf_size,
167 unsigned int priority,
168 struct GNUNET_TIME_Relative to,
169 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
171 struct Plugin *plugin = cls;
174 GNUNET_assert (plugin != NULL);
175 GNUNET_assert (session != NULL);
177 /* struct Plugin *plugin = cls; */
184 * Function that can be used to force the plugin to disconnect
185 * from the given peer and cancel all previous transmissions
186 * (and their continuationc).
189 * @param target peer from which to disconnect
192 http_server_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
194 // struct Plugin *plugin = cls;
200 * Convert the transports address to a nice, human-readable
204 * @param type name of the transport that generated the address
205 * @param addr one of the addresses of the host, NULL for the last address
206 * the specific address format depends on the transport
207 * @param addrlen length of the address
208 * @param numeric should (IP) addresses be displayed in numeric form?
209 * @param timeout after how long should we give up?
210 * @param asc function to call on each string
211 * @param asc_cls closure for asc
214 http_server_plugin_address_pretty_printer (void *cls, const char *type,
215 const void *addr, size_t addrlen,
217 struct GNUNET_TIME_Relative timeout,
218 GNUNET_TRANSPORT_AddressStringCallback
227 * Another peer has suggested an address for this
228 * peer and transport plugin. Check that this could be a valid
229 * address. If so, consider adding it to the list
233 * @param addr pointer to the address
234 * @param addrlen length of addr
235 * @return GNUNET_OK if this is a plausible address for this peer
239 http_server_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
241 /* struct Plugin *plugin = cls; */
243 /* check if the address is plausible; if so,
244 * add it to our list! */
250 * Function called for a quick conversion of the binary address to
251 * a numeric address. Note that the caller must not free the
252 * address and that the next call to this function is allowed
253 * to override the address again.
256 * @param addr binary address
257 * @param addrlen length of the address
258 * @return string representing the same address
261 http_server_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
271 * Entry point for the plugin.
274 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
276 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
277 struct GNUNET_TRANSPORT_PluginFunctions *api;
278 struct Plugin *plugin;
280 plugin = GNUNET_malloc (sizeof (struct Plugin));
282 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
284 api->send = &http_server_plugin_send;
285 api->disconnect = &http_server_plugin_disconnect;
286 api->address_pretty_printer = &http_server_plugin_address_pretty_printer;
287 api->check_address = &http_server_plugin_address_suggested;
288 api->address_to_string = &http_server_plugin_address_to_string;
294 * Exit point from the plugin.
297 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
299 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
300 struct Plugin *plugin = api->cls;
302 GNUNET_free (plugin);
307 /* end of plugin_transport_http_server.c */