Annotation of parser3/src/targets/apache13/modules/extra/mod_parser3.C, revision 1.36
1.2 paf 1: /** @file
1.7 paf 2: Parser: apache 1.3 module.
1.2 paf 3:
4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
5:
6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
7: */
1.36 ! parser 8: static const char *RCSId="$Id: mod_parser3.C,v 1.35 2001/06/28 07:44:17 parser Exp $";
1.2 paf 9:
10: #include "httpd.h"
11: #include "http_config.h"
12: #include "http_core.h"
13: #include "http_log.h"
14: #include "http_main.h"
15: #include "http_protocol.h"
16: #include "util_script.h"
17:
1.15 paf 18: #include "pa_sapi.h"
1.32 paf 19: #include "classes.h"
1.2 paf 20: #include "pa_common.h"
21: #include "pa_globals.h"
22: #include "pa_request.h"
1.8 paf 23: #include "pa_version.h"
1.22 paf 24: #include "pa_socks.h"
1.2 paf 25:
1.36 ! parser 26: #ifdef _DEBUG
! 27: # define DEBUG_PREFIX "debug_"
! 28: # define PARSER3_MODULE debug_parser3_module
! 29: #else
! 30: # define DEBUG_PREFIX
! 31: # define PARSER3_MODULE parser3_module
! 32: #endif
! 33:
! 34:
1.33 paf 35: /// apache parser module configuration [httpd.conf + .htaccess-es]
1.8 paf 36: struct Parser_module_config {
1.33 paf 37: const char* parser_root_auto_path; ///< filespec of admin's auto.p file
38: const char* parser_site_auto_path; ///< filespec of site's auto.p file
1.8 paf 39: };
1.2 paf 40:
41: /*
42: * Declare ourselves so the configuration routines can find and know us.
43: * We'll fill it in at the end of the module.
44: */
1.36 ! parser 45: extern "C" module MODULE_VAR_EXPORT PARSER3_MODULE;
1.2 paf 46:
47: /*
48: * Locate our directory configuration record for the current request.
49: */
1.14 paf 50: static Parser_module_config *our_dconfig(request_rec *r) {
51: return (Parser_module_config *)
1.36 ! parser 52: ap_get_module_config(r->per_dir_config, &PARSER3_MODULE);
1.2 paf 53: }
54:
1.14 paf 55: static const char *cmd_parser_auto_path(cmd_parms *cmd, void *mconfig, char *file_spec) {
1.8 paf 56: Parser_module_config *cfg = (Parser_module_config *) mconfig;
1.2 paf 57:
1.8 paf 58: // remember assigned filespec into cfg
59: (cmd->info?cfg->parser_root_auto_path:cfg->parser_site_auto_path)=file_spec;
1.2 paf 60:
61: return NULL;
62: }
63:
1.8 paf 64:
1.2 paf 65: /*--------------------------------------------------------------------------*/
66: /* */
67: /* Now we declare our content handlers, which are invoked when the server */
68: /* encounters a document which our module is supposed to have a chance to */
69: /* see. (See mod_mime's SetHandler and AddHandler directives, and the */
70: /* mod_info and mod_status examples, for more details.) */
71: /* */
72: /* Since content handlers are dumping data directly into the connexion */
73: /* (using the r*() routines, such as rputs() and rprintf()) without */
74: /* intervention by other parts of the server, they need to make */
75: /* sure any accumulated HTTP headers are sent first. This is done by */
76: /* calling send_http_header(). Otherwise, no header will be sent at all, */
77: /* and the output sent to the client will actually be HTTP-uncompliant. */
78: /*--------------------------------------------------------------------------*/
79: /*
80: * Sample content handler. All this does is display the call list that has
81: * been built up so far.
82: *
83: * The return value instructs the caller concerning what happened and what to
84: * do next:
85: * OK ("we did our thing")
86: * DECLINED ("this isn't something with which we want to get involved")
87: * HTTP_mumble ("an error status should be reported")
88: */
89:
90:
1.8 paf 91: //@{
1.15 paf 92: /// SAPI func decl
1.26 paf 93: void SAPI::log(Pool& pool, const char *fmt, ...) {
94: request_rec *r=static_cast<request_rec *>(pool.context());
95:
96: va_list args;
97: va_start(args,fmt);
98: char buf[MAX_STRING];
99: vsnprintf(buf, MAX_STRING, fmt, args);
100: ap_log_rerror(0, 0, APLOG_ERR | APLOG_NOERRNO, r, "%s", buf);
101: va_end(args);
102: }
103:
1.15 paf 104: const char *SAPI::get_env(Pool& pool, const char *name) {
1.10 paf 105: request_rec *r=static_cast<request_rec *>(pool.context());
1.4 paf 106: return (const char *)ap_table_get(r->subprocess_env, name);
107: }
108:
1.24 paf 109: size_t SAPI::read_post(Pool& pool, char *buf, size_t max_bytes) {
1.10 paf 110: request_rec *r=static_cast<request_rec *>(pool.context());
1.5 paf 111:
112: /* ap_log_error(APLOG_MARK, APLOG_DEBUG, r->server,
1.15 paf 113: "mod_parser3: SAPI::read_post(max=%u)", max_bytes);
1.5 paf 114: */
115: int retval;
116: if((retval = ap_setup_client_block(r, REQUEST_CHUNKED_ERROR)))
117: return 0;
118: if(!ap_should_client_block(r))
119: return 0;
120:
121: uint total_read_bytes=0;
122: void (*handler)(int)=signal(SIGPIPE, SIG_IGN);
123: while (total_read_bytes<max_bytes) {
124: ap_hard_timeout("Read POST information", r); /* start timeout timer */
125: uint read_bytes=
126: ap_get_client_block(r, buf+total_read_bytes, max_bytes-total_read_bytes);
127: ap_reset_timeout(r);
128: if (read_bytes<=0)
1.2 paf 129: break;
1.5 paf 130: total_read_bytes+=read_bytes;
131: }
132: signal(SIGPIPE, handler);
133: return total_read_bytes;
1.2 paf 134: }
135:
1.15 paf 136: void SAPI::add_header_attribute(Pool& pool, const char *key, const char *value) {
1.10 paf 137: request_rec *r=static_cast<request_rec *>(pool.context());
1.2 paf 138:
1.3 paf 139: if(strcasecmp(key, "content-type")==0) {
1.2 paf 140: /* r->content_type, *not* r->headers_out("Content-type"). If you don't
141: * set it, it will be filled in with the server's default type (typically
142: * "text/plain"). You *must* also ensure that r->content_type is lower
143: * case.
144: */
145: r->content_type = value;
146: } else
147: ap_table_merge(r->headers_out, key, value);
148: }
149:
1.15 paf 150: void SAPI::send_header(Pool& pool) {
1.10 paf 151: request_rec *r=static_cast<request_rec *>(pool.context());
1.5 paf 152:
1.8 paf 153: ap_hard_timeout("Send header", r);
1.2 paf 154: ap_send_http_header(r);
1.5 paf 155: ap_kill_timeout(r);
1.2 paf 156: }
157:
1.21 paf 158: void SAPI::send_body(Pool& pool, const void *buf, size_t size) {
1.10 paf 159: request_rec *r=static_cast<request_rec *>(pool.context());
1.5 paf 160:
1.8 paf 161: ap_hard_timeout("Send body", r);
1.2 paf 162: ap_rwrite(buf, size, r);
1.5 paf 163: ap_kill_timeout(r);
1.2 paf 164: }
1.18 paf 165:
1.8 paf 166: //@}
167:
1.11 paf 168: /**
169: main workhorse
170:
1.21 paf 171: @todo intelligent cache-control
1.11 paf 172: */
1.8 paf 173: static int parser_handler(request_rec *r)
1.2 paf 174: {
1.16 paf 175: Pool pool(r->pool);
1.10 paf 176: pool.set_context(r);
1.2 paf 177:
1.8 paf 178: Parser_module_config *dcfg=our_dconfig(r);
1.2 paf 179:
180:
181: /* A flag which modules can set, to indicate that the data being
182: * returned is volatile, and clients should be told not to cache it.
183: */
184: r->no_cache=1;
185:
186: PTRY { // global try
1.4 paf 187: ap_add_common_vars(r);
188: ap_add_cgi_vars(r);
189:
1.2 paf 190: // Request info
191: Request::Info request_info;
1.20 paf 192: request_info.document_root=SAPI::get_env(pool, "DOCUMENT_ROOT");
1.14 paf 193: request_info.path_translated=r->filename;
1.2 paf 194: request_info.method=r->method;
195: request_info.query_string=r->args;
1.20 paf 196: request_info.uri=SAPI::get_env(pool, "REQUEST_URI");
197: request_info.content_type=SAPI::get_env(pool, "CONTENT_TYPE");
198: const char *content_length=SAPI::get_env(pool, "CONTENT_LENGTH");
1.2 paf 199: request_info.content_length=(content_length?atoi(content_length):0);
1.20 paf 200: request_info.cookie=SAPI::get_env(pool, "HTTP_COOKIE");
201: request_info.user_agent=SAPI::get_env(pool, "HTTP_USER_AGENT");
1.2 paf 202:
203: // prepare to process request
204: Request request(pool,
205: request_info,
1.30 paf 206: String::UL_USER_HTML
1.2 paf 207: );
208:
209: // process the request
210: request.core(
1.8 paf 211: dcfg->parser_root_auto_path, true, // /path/to/admin/auto.p
212: dcfg->parser_site_auto_path, true, // /path/to/site/auto.p
1.2 paf 213: r->header_only!=0);
214: // no actions with request' data past this point
215: // request.exception not not handled here, but all
216: // request' data are associated with it's pool=exception
217:
218: // successful finish
219: } PCATCH(e) { // global problem
1.18 paf 220: // don't allocate anything on pool here:
221: // possible pool' exception not catch-ed now
222: // and there could be out-of-memory exception
1.2 paf 223: const char *body=e.comment();
1.18 paf 224: // log it
225: SAPI::log(pool, "exception in request exception handler: %s", body);
226:
227: //
1.2 paf 228: int content_length=strlen(body);
229:
230: // prepare header
1.15 paf 231: SAPI::add_header_attribute(pool, "content-type", "text/plain");
1.2 paf 232: char content_length_cstr[MAX_NUMBER];
1.25 paf 233: snprintf(content_length_cstr, MAX_NUMBER, "%u", content_length);
1.15 paf 234: SAPI::add_header_attribute(pool, "content-length", content_length_cstr);
1.2 paf 235:
236: // send header
1.15 paf 237: SAPI::send_header(pool);
1.2 paf 238:
239: // send body
240: if(!r->header_only)
1.15 paf 241: SAPI::send_body(pool, body, content_length);
1.2 paf 242:
243: // unsuccessful finish
244: }
245: PEND_CATCH
246:
247: /*
248: * We did what we wanted to do, so tell the rest of the server we
249: * succeeded.
250: */
251: return OK;
252: }
253:
254: /*--------------------------------------------------------------------------*/
255: /* */
256: /* Now let's declare routines for each of the callback phase in order. */
257: /* (That's the order in which they're listed in the callback list, *not */
258: /* the order in which the server calls them! See the command_rec */
259: /* declaration near the bottom of this file.) Note that these may be */
260: /* called for situations that don't relate primarily to our function - in */
261: /* other words, the fixup handler shouldn't assume that the request has */
262: /* to do with "example" stuff. */
263: /* */
264: /* With the exception of the content handler, all of our routines will be */
265: /* called for each request, unless an earlier handler from another module */
266: /* aborted the sequence. */
267: /* */
268: /* Handlers that are declared as "int" can return the following: */
269: /* */
270: /* OK Handler accepted the request and did its thing with it. */
271: /* DECLINED Handler took no action. */
272: /* HTTP_mumble Handler looked at request and found it wanting. */
273: /* */
274: /* What the server does after calling a module handler depends upon the */
275: /* handler's return value. In all cases, if the handler returns */
276: /* DECLINED, the server will continue to the next module with an handler */
277: /* for the current phase. However, if the handler return a non-OK, */
278: /* non-DECLINED status, the server aborts the request right there. If */
279: /* the handler returns OK, the server's next action is phase-specific; */
280: /* see the individual handler comments below for details. */
281: /* */
282: /*--------------------------------------------------------------------------*/
283: /*
284: * This function is called during server initialisation. Any information
285: * that needs to be recorded must be in static cells, since there's no
286: * configuration record.
287: *
288: * There is no return value.
289: */
1.14 paf 290:
291: static void setup_module_cells() {
1.2 paf 292: static bool globals_inited=false;
293: if(globals_inited)
294: return;
295: globals_inited=true;
296:
1.14 paf 297: /*
298: * allocate our module-private pool.
299: */
1.16 paf 300: static Pool pool(ap_make_sub_pool(NULL)); // global pool
1.2 paf 301: PTRY {
1.27 paf 302: // init socks
303: init_socks(pool);
304:
1.29 paf 305: // init global classes
306: init_methoded_array(pool);
1.2 paf 307: // init global variables
1.15 paf 308: pa_globals_init(pool);
1.2 paf 309: } PCATCH(e) { // global problem
1.18 paf 310: ap_log_error(APLOG_MARK, APLOG_EMERG, 0,
311: "setup_module_cells failed: ", e.comment());
312: exit(1);
1.2 paf 313: }
314: PEND_CATCH
315: }
316:
1.14 paf 317: static void parser_server_init(server_rec *s, pool *p) {
318: #if MODULE_MAGIC_NUMBER >= 19980527
1.17 paf 319: ap_add_version_component("Parser/"PARSER_VERSION);
1.14 paf 320: #endif
1.2 paf 321:
322: /*
1.14 paf 323: * Set up any module cells that ought to be initialised.
1.2 paf 324: */
1.14 paf 325: setup_module_cells();
1.2 paf 326: }
327:
328: /*
329: * This function gets called to create a per-directory configuration
330: * record. This will be called for the "default" server environment, and for
331: * each directory for which the parser finds any of our directives applicable.
332: * If a directory doesn't have any of our directives involved (i.e., they
333: * aren't in the .htaccess file, or a <Location>, <Directory>, or related
334: * block), this routine will *not* be called - the configuration for the
335: * closest ancestor is used.
336: *
337: * The return value is a pointer to the created module-specific
338: * structure.
339: */
1.14 paf 340: static void *parser_create_dir_config(pool *p, char *dirspec) {
341: /*
1.2 paf 342: * Allocate the space for our record from the pool supplied.
343: */
1.14 paf 344: Parser_module_config *cfg=
345: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.2 paf 346: /*
347: * Now fill in the defaults. If there are any `parent' configuration
348: * records, they'll get merged as part of a separate callback.
349: */
1.8 paf 350: cfg->parser_root_auto_path = 0;
351: cfg->parser_site_auto_path = 0;
1.2 paf 352: return (void *) cfg;
353: }
354:
355: /*
356: * This function gets called to merge two per-directory configuration
357: * records. This is typically done to cope with things like .htaccess files
358: * or <Location> directives for directories that are beneath one for which a
359: * configuration record was already created. The routine has the
360: * responsibility of creating a new record and merging the contents of the
361: * other two into it appropriately. If the module doesn't declare a merge
362: * routine, the record for the closest ancestor location (that has one) is
363: * used exclusively.
364: *
365: * The routine MUST NOT modify any of its arguments!
366: *
367: * The return value is a pointer to the created module-specific structure
368: * containing the merged values.
369: */
1.8 paf 370: static void *parser_merge_dir_config(pool *p, void *parent_conf,
1.14 paf 371: void *newloc_conf) {
372: Parser_module_config *merged_config =
373: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.8 paf 374: Parser_module_config *pconf = (Parser_module_config *) parent_conf;
375: Parser_module_config *nconf = (Parser_module_config *) newloc_conf;
376:
377: // always from parent
378: merged_config->parser_root_auto_path = ap_pstrdup(p, pconf->parser_root_auto_path);
1.2 paf 379: /*
380: * Some things get copied directly from the more-specific record, rather
381: * than getting merged.
382: */
1.8 paf 383: merged_config->parser_site_auto_path = ap_pstrdup(p, nconf->parser_site_auto_path?
384: nconf->parser_site_auto_path:pconf->parser_site_auto_path);
385:
1.2 paf 386: return (void *) merged_config;
387: }
388:
389: /*
390: * This function gets called to create a per-server configuration
391: * record. It will always be called for the "default" server.
392: *
393: * The return value is a pointer to the created module-specific
394: * structure.
395: */
1.14 paf 396: static void *parser_create_server_config(pool *p, server_rec *s) {
1.2 paf 397: /*
1.8 paf 398: * As with the parser_create_dir_config() reoutine, we allocate and fill
1.2 paf 399: * in an empty record.
400: */
1.14 paf 401: Parser_module_config *cfg=
402: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
403:
1.8 paf 404: cfg->parser_root_auto_path = 0;
405: cfg->parser_site_auto_path = 0;
1.14 paf 406:
1.2 paf 407: return (void *) cfg;
408: }
409:
410: /*
411: * This function gets called to merge two per-server configuration
412: * records. This is typically done to cope with things like virtual hosts and
413: * the default server configuration The routine has the responsibility of
414: * creating a new record and merging the contents of the other two into it
415: * appropriately. If the module doesn't declare a merge routine, the more
416: * specific existing record is used exclusively.
417: *
418: * The routine MUST NOT modify any of its arguments!
419: *
420: * The return value is a pointer to the created module-specific structure
421: * containing the merged values.
422: */
1.8 paf 423: static void *parser_merge_server_config(pool *p, void *server1_conf,
1.2 paf 424: void *server2_conf)
425: {
426:
1.14 paf 427: Parser_module_config *merged_config =
428: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.8 paf 429: Parser_module_config *s1conf = (Parser_module_config *) server1_conf;
430: Parser_module_config *s2conf = (Parser_module_config *) server2_conf;
1.2 paf 431:
432: /*
433: * Our inheritance rules are our own, and part of our module's semantics.
434: * Basically, just note whence we came.
435: */
1.8 paf 436: merged_config->parser_root_auto_path = ap_pstrdup(p, s2conf->parser_root_auto_path?
437: s2conf->parser_root_auto_path:s1conf->parser_root_auto_path);
438: merged_config->parser_site_auto_path = ap_pstrdup(p, s2conf->parser_site_auto_path?
439: s2conf->parser_site_auto_path:s1conf->parser_site_auto_path);
440:
441: return (void *) merged_config;
1.2 paf 442: }
443:
444: /*
445: * This routine gives our module an opportunity to translate the URI into an
446: * actual filename. If we don't do anything special, the server's default
447: * rules (Alias directives and the like) will continue to be followed.
448: *
449: * The return value is OK, DECLINED, or HTTP_mumble. If we return OK, no
450: * further modules are called for this phase.
451: */
1.14 paf 452: static int parser_translate_handler(request_rec *r) {
453: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 454: return DECLINED;
455: }
456:
457: /*
458: * This routine is called to check the authentication information sent with
459: * the request (such as looking up the user in a database and verifying that
460: * the [encrypted] password sent matches the one in the database).
461: *
462: * The return value is OK, DECLINED, or some HTTP_mumble error (typically
463: * HTTP_UNAUTHORIZED). If we return OK, no other modules are given a chance
464: * at the request during this phase.
465: */
1.14 paf 466: static int parser_check_user_id(request_rec *r) {
467: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 468: return DECLINED;
469: }
470:
471: /*
472: * This routine is called to check to see if the resource being requested
473: * requires authorisation.
474: *
475: * The return value is OK, DECLINED, or HTTP_mumble. If we return OK, no
476: * other modules are called during this phase.
477: *
478: * If *all* modules return DECLINED, the request is aborted with a server
479: * error.
480: */
1.14 paf 481: static int parser_auth_checker(request_rec *r) {
482: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 483: return DECLINED;
484: }
485:
486: /*
487: * This routine is called to check for any module-specific restrictions placed
488: * upon the requested resource. (See the mod_access module for an example.)
489: *
490: * The return value is OK, DECLINED, or HTTP_mumble. All modules with an
491: * handler for this phase are called regardless of whether their predecessors
492: * return OK or DECLINED. The first one to return any other status, however,
493: * will abort the sequence (and the request) as usual.
494: */
1.14 paf 495: static int parser_access_checker(request_rec *r) {
1.2 paf 496:
1.14 paf 497: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 498: return DECLINED;
499: }
500:
501: /*--------------------------------------------------------------------------*/
502: /* */
503: /* All of the routines have been declared now. Here's the list of */
504: /* directives specific to our module, and information about where they */
505: /* may appear and how the command parser should pass them to us for */
506: /* processing. Note that care must be taken to ensure that there are NO */
507: /* collisions of directive names between modules. */
508: /* */
509: /*--------------------------------------------------------------------------*/
510: /*
511: * List of directives specific to our module.
512: */
1.8 paf 513: static const command_rec parser_cmds[] =
1.2 paf 514: {
515: {
1.36 ! parser 516: DEBUG_PREFIX"parser_root_auto_path", /* directive name */
1.8 paf 517: (const char *(*)(void))((void *)cmd_parser_auto_path), // config action routine
518: (void*)true, /* argument to include in call */
519: (int)(ACCESS_CONF|RSRC_CONF), /* where available */
520: TAKE1, /* arguments */
521: "Parser root auto.p filespec (Admin)" // directive description
522: },
523: {
1.36 ! parser 524: DEBUG_PREFIX"parser_site_auto_path", /* directive name */
1.8 paf 525: (const char *(*)(void))((void *)cmd_parser_auto_path), // config action routine
526: (void*)false, /* argument to include in call */
527: (int)(OR_OPTIONS), /* where available */
528: TAKE1, /* arguments */
529: "Parser site auto.p filespec" // directive description
1.2 paf 530: },
531: {NULL}
532: };
533:
534: /*--------------------------------------------------------------------------*/
535: /* */
536: /* Now the list of content handlers available from this module. */
537: /* */
538: /*--------------------------------------------------------------------------*/
539: /*
540: * List of content handlers our module supplies. Each handler is defined by
541: * two parts: a name by which it can be referenced (such as by
542: * {Add,Set}Handler), and the actual routine name. The list is terminated by
543: * a NULL block, since it can be of variable length.
544: *
545: * Note that content-handlers are invoked on a most-specific to least-specific
546: * basis; that is, a handler that is declared for "text/plain" will be
547: * invoked before one that was declared for "text / *". Note also that
548: * if a content-handler returns anything except DECLINED, no other
549: * content-handlers will be called.
550: */
1.8 paf 551: static const handler_rec parser_handlers[] =
1.2 paf 552: {
1.36 ! parser 553: {DEBUG_PREFIX"parser3-handler", parser_handler},
1.2 paf 554: {NULL}
555: };
556:
557: /*--------------------------------------------------------------------------*/
558: /* */
559: /* Finally, the list of callback routines and data structures that */
560: /* provide the hooks into our module from the other parts of the server. */
561: /* */
562: /*--------------------------------------------------------------------------*/
563: /*
564: * Module definition for configuration. If a particular callback is not
565: * needed, replace its routine name below with the word NULL.
566: *
567: * The number in brackets indicates the order in which the routine is called
568: * during request processing. Note that not all routines are necessarily
569: * called (such as if a resource doesn't have access restrictions).
570: */
1.36 ! parser 571: module MODULE_VAR_EXPORT PARSER3_MODULE =
1.2 paf 572: {
573: STANDARD_MODULE_STUFF,
1.14 paf 574: parser_server_init, /* module initializer */
575: parser_create_dir_config, /* per-directory config creator */
576: parser_merge_dir_config, /* dir config merger */
577: parser_create_server_config, /* server config creator */
578: parser_merge_server_config, /* server config merger */
579: parser_cmds, /* command table */
580: parser_handlers, /* [9] list of handlers */
581: parser_translate_handler, /* [2] filename-to-URI translation */
582: parser_check_user_id, /* [5] check/validate user_id */
583: parser_auth_checker, /* [6] check user_id is valid *here* */
584: parser_access_checker, /* [4] check access by host address */
585: 0, /* [7] MIME type checker/setter */
586: 0, /* [8] fixups */
587: 0 /* [10] logger */
1.2 paf 588: };
E-mail: