xref: /lighttpd1.4/src/plugin.h (revision 07517ff3)
1 #ifndef _PLUGIN_H_
2 #define _PLUGIN_H_
3 #include "first.h"
4 
5 #include "base_decls.h"
6 #include "buffer.h"
7 #include "array.h"
8 #include "configfile.h"
9 
10 #define SERVER_FUNC(x) \
11 		static handler_t x(server *srv, void *p_d)
12 
13 #define CONNECTION_FUNC(x) \
14 		static handler_t x(server *srv, connection *con, void *p_d)
15 
16 #define INIT_FUNC(x) \
17 		static void *x(void)
18 
19 #define FREE_FUNC          SERVER_FUNC
20 #define TRIGGER_FUNC       SERVER_FUNC
21 #define SETDEFAULTS_FUNC   SERVER_FUNC
22 #define SIGHUP_FUNC        SERVER_FUNC
23 
24 #define SUBREQUEST_FUNC    CONNECTION_FUNC
25 #define PHYSICALPATH_FUNC  CONNECTION_FUNC
26 #define REQUESTDONE_FUNC   CONNECTION_FUNC
27 #define URIHANDLER_FUNC    CONNECTION_FUNC
28 
29 #define PLUGIN_DATA        size_t id
30 
31 typedef struct {
32 	size_t version;
33 
34 	buffer *name; /* name of the plugin */
35 
36 	void *(* init)                       ();
37 	handler_t (* priv_defaults)          (server *srv, void *p_d);
38 	handler_t (* set_defaults)           (server *srv, void *p_d);
39 	handler_t (* cleanup)                (server *srv, void *p_d);
40 	                                                                                   /* is called ... */
41 	handler_t (* handle_trigger)         (server *srv, void *p_d);                     /* once a second */
42 	handler_t (* handle_sighup)          (server *srv, void *p_d);                     /* at a sighup */
43 	handler_t (* handle_waitpid)         (server *srv, void *p_d, pid_t pid, int status); /* upon a child process exit */
44 
45 	handler_t (* handle_uri_raw)         (server *srv, connection *con, void *p_d);    /* after uri_raw is set */
46 	handler_t (* handle_uri_clean)       (server *srv, connection *con, void *p_d);    /* after uri is set */
47 	handler_t (* handle_docroot)         (server *srv, connection *con, void *p_d);    /* getting the document-root */
48 	handler_t (* handle_physical)        (server *srv, connection *con, void *p_d);    /* mapping url to physical path */
49 	handler_t (* handle_request_env)     (server *srv, connection *con, void *p_d);    /* (deferred env populate) */
50 	handler_t (* handle_request_done)    (server *srv, connection *con, void *p_d);    /* at the end of a request */
51 	handler_t (* handle_connection_accept) (server *srv, connection *con, void *p_d);  /* after accept() socket */
52 	handler_t (* handle_connection_shut_wr)(server *srv, connection *con, void *p_d);  /* done writing to socket */
53 	handler_t (* handle_connection_close)  (server *srv, connection *con, void *p_d);  /* before close() of socket */
54 
55 
56 
57 	handler_t (* handle_subrequest_start)(server *srv, connection *con, void *p_d);
58 
59 	                                                                                   /* when a handler for the request
60 											    * has to be found
61 											    */
62 	handler_t (* handle_subrequest)      (server *srv, connection *con, void *p_d);    /* */
63 	handler_t (* handle_response_start)  (server *srv, connection *con, void *p_d);    /* before response headers are written */
64 	handler_t (* connection_reset)       (server *srv, connection *con, void *p_d);    /* after request done or request abort */
65 	void *data;
66 
67 	/* dlopen handle */
68 	void *lib;
69 } plugin;
70 
71 int plugins_load(server *srv);
72 void plugins_free(server *srv);
73 
74 handler_t plugins_call_handle_uri_raw(server *srv, connection *con);
75 handler_t plugins_call_handle_uri_clean(server *srv, connection *con);
76 handler_t plugins_call_handle_subrequest_start(server *srv, connection *con);
77 handler_t plugins_call_handle_subrequest(server *srv, connection *con);
78 handler_t plugins_call_handle_response_start(server *srv, connection *con);
79 handler_t plugins_call_handle_request_env(server *srv, connection *con);
80 handler_t plugins_call_handle_request_done(server *srv, connection *con);
81 handler_t plugins_call_handle_docroot(server *srv, connection *con);
82 handler_t plugins_call_handle_physical(server *srv, connection *con);
83 handler_t plugins_call_handle_connection_accept(server *srv, connection *con);
84 handler_t plugins_call_handle_connection_shut_wr(server *srv, connection *con);
85 handler_t plugins_call_handle_connection_close(server *srv, connection *con);
86 handler_t plugins_call_connection_reset(server *srv, connection *con);
87 
88 handler_t plugins_call_handle_trigger(server *srv);
89 handler_t plugins_call_handle_sighup(server *srv);
90 handler_t plugins_call_handle_waitpid(server *srv, pid_t pid, int status);
91 
92 handler_t plugins_call_init(server *srv);
93 handler_t plugins_call_set_defaults(server *srv);
94 handler_t plugins_call_cleanup(server *srv);
95 
96 #endif
97