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