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