xref: /lighttpd1.4/src/plugin.h (revision 11864d29)
1 #ifndef _PLUGIN_H_
2 #define _PLUGIN_H_
3 #include "first.h"
4 
5 #include "base_decls.h"
6 #include "plugin_config.h"
7 
8 
9 #define SERVER_FUNC(x) \
10 		static handler_t x(server *srv, void *p_d)
11 
12 #define CONNECTION_FUNC(x) \
13 		static handler_t x(connection *con, void *p_d)
14 
15 #define REQUEST_FUNC(x) \
16 		static handler_t x(request_st *r, void *p_d)
17 
18 #define INIT_FUNC(x) \
19 		__attribute_cold__ \
20 		static void *x(void)
21 
22 #define FREE_FUNC(x) \
23 		__attribute_cold__ \
24 		static void x(void *p_d)
25 
26 #define SETDEFAULTS_FUNC   __attribute_cold__ SERVER_FUNC
27 #define SIGHUP_FUNC        __attribute_cold__ SERVER_FUNC
28 #define TRIGGER_FUNC       SERVER_FUNC
29 
30 #define SUBREQUEST_FUNC    REQUEST_FUNC
31 #define PHYSICALPATH_FUNC  REQUEST_FUNC
32 #define REQUESTDONE_FUNC   REQUEST_FUNC
33 #define URIHANDLER_FUNC    REQUEST_FUNC
34 
35 #define PLUGIN_DATA        int id; \
36                            int nconfig; \
37                            config_plugin_value_t *cvlist; \
38                            struct plugin *self
39 
40 typedef struct {
41 	PLUGIN_DATA;
42 } plugin_data_base;
43 
44 struct plugin {
45 	void *data;
46 	                                                                      /* is called ... */
47 	handler_t (* handle_uri_raw)           (request_st *r, void *p_d);  /* after uri_raw is set */
48 	handler_t (* handle_uri_clean)         (request_st *r, void *p_d);  /* after uri is set */
49 	handler_t (* handle_docroot)           (request_st *r, void *p_d);  /* getting the document-root */
50 	handler_t (* handle_physical)          (request_st *r, void *p_d);  /* mapping url to physical path */
51 	handler_t (* handle_request_env)       (request_st *r, void *p_d);  /* (deferred env populate) */
52 	handler_t (* handle_request_done)      (request_st *r, void *p_d);  /* at the end of a request */
53 	handler_t (* handle_subrequest_start)  (request_st *r, void *p_d);  /* when handler for request not found yet */
54 	handler_t (* handle_subrequest)        (request_st *r, void *p_d);  /* handler for request (max one per request) */
55 	handler_t (* handle_response_start)    (request_st *r, void *p_d);  /* before response headers are written */
56 	handler_t (* handle_request_reset)     (request_st *r, void *p_d);  /* after request done or request abort */
57 
58 	handler_t (* handle_connection_accept) (connection *con, void *p_d);  /* after accept() socket */
59 	handler_t (* handle_connection_shut_wr)(connection *con, void *p_d);  /* done writing to socket */
60 	handler_t (* handle_connection_close)  (connection *con, void *p_d);  /* before close() of socket */
61 
62 	handler_t (* handle_trigger)         (server *srv, void *p_d);        /* once a second */
63 	handler_t (* handle_sighup)          (server *srv, void *p_d);        /* at a sighup */
64 	handler_t (* handle_waitpid)         (server *srv, void *p_d, pid_t pid, int status); /* upon a child process exit */
65 
66 	void *(* init)                       ();
67 	handler_t (* priv_defaults)          (server *srv, void *p_d);
68 	handler_t (* set_defaults)           (server *srv, void *p_d);
69 	handler_t (* worker_init)            (server *srv, void *p_d); /* at server startup (each worker after fork()) */
70 	void (* cleanup)                     (void *p_d);
71 
72 	const char *name;/* name of the plugin */
73 	size_t version;
74 	void *lib;       /* dlopen handle */
75 };
76 
77 #endif
78