Annotation of parser3/src/targets/apache13/modules/extra/mod_parser3.C, revision 1.21
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.21 ! paf 8: $Id: mod_parser3.C,v 1.20 2001/03/28 14:41:29 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.21 ! paf 136: void SAPI::send_body(Pool& pool, const void *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.21 ! paf 159: @todo 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.20 paf 180: request_info.document_root=SAPI::get_env(pool, "DOCUMENT_ROOT");
1.14 paf 181: request_info.path_translated=r->filename;
1.2 paf 182: request_info.method=r->method;
183: request_info.query_string=r->args;
1.20 paf 184: request_info.uri=SAPI::get_env(pool, "REQUEST_URI");
185: request_info.content_type=SAPI::get_env(pool, "CONTENT_TYPE");
186: const char *content_length=SAPI::get_env(pool, "CONTENT_LENGTH");
1.2 paf 187: request_info.content_length=(content_length?atoi(content_length):0);
1.20 paf 188: request_info.cookie=SAPI::get_env(pool, "HTTP_COOKIE");
189: request_info.user_agent=SAPI::get_env(pool, "HTTP_USER_AGENT");
1.2 paf 190:
191: // prepare to process request
192: Request request(pool,
193: request_info,
194: String::UL_HTML_TYPO
195: );
196:
197: // process the request
198: request.core(
1.8 paf 199: dcfg->parser_root_auto_path, true, // /path/to/admin/auto.p
200: dcfg->parser_site_auto_path, true, // /path/to/site/auto.p
1.2 paf 201: r->header_only!=0);
202: // no actions with request' data past this point
203: // request.exception not not handled here, but all
204: // request' data are associated with it's pool=exception
205:
206: // successful finish
207: } PCATCH(e) { // global problem
1.18 paf 208: // don't allocate anything on pool here:
209: // possible pool' exception not catch-ed now
210: // and there could be out-of-memory exception
1.2 paf 211: const char *body=e.comment();
1.18 paf 212: // log it
213: SAPI::log(pool, "exception in request exception handler: %s", body);
214:
215: //
1.2 paf 216: int content_length=strlen(body);
217:
218: // prepare header
1.15 paf 219: SAPI::add_header_attribute(pool, "content-type", "text/plain");
1.2 paf 220: char content_length_cstr[MAX_NUMBER];
1.12 paf 221: snprintf(content_length_cstr, MAX_NUMBER, "%lu", content_length);
1.15 paf 222: SAPI::add_header_attribute(pool, "content-length", content_length_cstr);
1.2 paf 223:
224: // send header
1.15 paf 225: SAPI::send_header(pool);
1.2 paf 226:
227: // send body
228: if(!r->header_only)
1.15 paf 229: SAPI::send_body(pool, body, content_length);
1.2 paf 230:
231: // unsuccessful finish
232: }
233: PEND_CATCH
234:
235: /*
236: * We did what we wanted to do, so tell the rest of the server we
237: * succeeded.
238: */
239: return OK;
240: }
241:
242: /*--------------------------------------------------------------------------*/
243: /* */
244: /* Now let's declare routines for each of the callback phase in order. */
245: /* (That's the order in which they're listed in the callback list, *not */
246: /* the order in which the server calls them! See the command_rec */
247: /* declaration near the bottom of this file.) Note that these may be */
248: /* called for situations that don't relate primarily to our function - in */
249: /* other words, the fixup handler shouldn't assume that the request has */
250: /* to do with "example" stuff. */
251: /* */
252: /* With the exception of the content handler, all of our routines will be */
253: /* called for each request, unless an earlier handler from another module */
254: /* aborted the sequence. */
255: /* */
256: /* Handlers that are declared as "int" can return the following: */
257: /* */
258: /* OK Handler accepted the request and did its thing with it. */
259: /* DECLINED Handler took no action. */
260: /* HTTP_mumble Handler looked at request and found it wanting. */
261: /* */
262: /* What the server does after calling a module handler depends upon the */
263: /* handler's return value. In all cases, if the handler returns */
264: /* DECLINED, the server will continue to the next module with an handler */
265: /* for the current phase. However, if the handler return a non-OK, */
266: /* non-DECLINED status, the server aborts the request right there. If */
267: /* the handler returns OK, the server's next action is phase-specific; */
268: /* see the individual handler comments below for details. */
269: /* */
270: /*--------------------------------------------------------------------------*/
271: /*
272: * This function is called during server initialisation. Any information
273: * that needs to be recorded must be in static cells, since there's no
274: * configuration record.
275: *
276: * There is no return value.
277: */
1.14 paf 278:
279: static void setup_module_cells() {
1.2 paf 280: static bool globals_inited=false;
281: if(globals_inited)
282: return;
283: globals_inited=true;
284:
1.14 paf 285: /*
286: * allocate our module-private pool.
287: */
1.16 paf 288: static Pool pool(ap_make_sub_pool(NULL)); // global pool
1.2 paf 289: PTRY {
290: // init global variables
1.15 paf 291: pa_globals_init(pool);
1.2 paf 292: } PCATCH(e) { // global problem
1.18 paf 293: ap_log_error(APLOG_MARK, APLOG_EMERG, 0,
294: "setup_module_cells failed: ", e.comment());
295: exit(1);
1.2 paf 296: }
297: PEND_CATCH
298: }
299:
1.14 paf 300: static void parser_server_init(server_rec *s, pool *p) {
301: #if MODULE_MAGIC_NUMBER >= 19980527
1.17 paf 302: ap_add_version_component("Parser/"PARSER_VERSION);
1.14 paf 303: #endif
1.2 paf 304:
305: /*
1.14 paf 306: * Set up any module cells that ought to be initialised.
1.2 paf 307: */
1.14 paf 308: setup_module_cells();
1.2 paf 309: }
310:
311: /*
312: * This function gets called to create a per-directory configuration
313: * record. This will be called for the "default" server environment, and for
314: * each directory for which the parser finds any of our directives applicable.
315: * If a directory doesn't have any of our directives involved (i.e., they
316: * aren't in the .htaccess file, or a <Location>, <Directory>, or related
317: * block), this routine will *not* be called - the configuration for the
318: * closest ancestor is used.
319: *
320: * The return value is a pointer to the created module-specific
321: * structure.
322: */
1.14 paf 323: static void *parser_create_dir_config(pool *p, char *dirspec) {
324: /*
1.2 paf 325: * Allocate the space for our record from the pool supplied.
326: */
1.14 paf 327: Parser_module_config *cfg=
328: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.2 paf 329: /*
330: * Now fill in the defaults. If there are any `parent' configuration
331: * records, they'll get merged as part of a separate callback.
332: */
1.8 paf 333: cfg->parser_root_auto_path = 0;
334: cfg->parser_site_auto_path = 0;
1.2 paf 335: return (void *) cfg;
336: }
337:
338: /*
339: * This function gets called to merge two per-directory configuration
340: * records. This is typically done to cope with things like .htaccess files
341: * or <Location> directives for directories that are beneath one for which a
342: * configuration record was already created. The routine has the
343: * responsibility of creating a new record and merging the contents of the
344: * other two into it appropriately. If the module doesn't declare a merge
345: * routine, the record for the closest ancestor location (that has one) is
346: * used exclusively.
347: *
348: * The routine MUST NOT modify any of its arguments!
349: *
350: * The return value is a pointer to the created module-specific structure
351: * containing the merged values.
352: */
1.8 paf 353: static void *parser_merge_dir_config(pool *p, void *parent_conf,
1.14 paf 354: void *newloc_conf) {
355: Parser_module_config *merged_config =
356: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.8 paf 357: Parser_module_config *pconf = (Parser_module_config *) parent_conf;
358: Parser_module_config *nconf = (Parser_module_config *) newloc_conf;
359:
360: // always from parent
361: merged_config->parser_root_auto_path = ap_pstrdup(p, pconf->parser_root_auto_path);
1.2 paf 362: /*
363: * Some things get copied directly from the more-specific record, rather
364: * than getting merged.
365: */
1.8 paf 366: merged_config->parser_site_auto_path = ap_pstrdup(p, nconf->parser_site_auto_path?
367: nconf->parser_site_auto_path:pconf->parser_site_auto_path);
368:
1.2 paf 369: return (void *) merged_config;
370: }
371:
372: /*
373: * This function gets called to create a per-server configuration
374: * record. It will always be called for the "default" server.
375: *
376: * The return value is a pointer to the created module-specific
377: * structure.
378: */
1.14 paf 379: static void *parser_create_server_config(pool *p, server_rec *s) {
1.2 paf 380: /*
1.8 paf 381: * As with the parser_create_dir_config() reoutine, we allocate and fill
1.2 paf 382: * in an empty record.
383: */
1.14 paf 384: Parser_module_config *cfg=
385: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
386:
1.8 paf 387: cfg->parser_root_auto_path = 0;
388: cfg->parser_site_auto_path = 0;
1.14 paf 389:
1.2 paf 390: return (void *) cfg;
391: }
392:
393: /*
394: * This function gets called to merge two per-server configuration
395: * records. This is typically done to cope with things like virtual hosts and
396: * the default server configuration The routine has the responsibility of
397: * creating a new record and merging the contents of the other two into it
398: * appropriately. If the module doesn't declare a merge routine, the more
399: * specific existing record is used exclusively.
400: *
401: * The routine MUST NOT modify any of its arguments!
402: *
403: * The return value is a pointer to the created module-specific structure
404: * containing the merged values.
405: */
1.8 paf 406: static void *parser_merge_server_config(pool *p, void *server1_conf,
1.2 paf 407: void *server2_conf)
408: {
409:
1.14 paf 410: Parser_module_config *merged_config =
411: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.8 paf 412: Parser_module_config *s1conf = (Parser_module_config *) server1_conf;
413: Parser_module_config *s2conf = (Parser_module_config *) server2_conf;
1.2 paf 414:
415: /*
416: * Our inheritance rules are our own, and part of our module's semantics.
417: * Basically, just note whence we came.
418: */
1.8 paf 419: merged_config->parser_root_auto_path = ap_pstrdup(p, s2conf->parser_root_auto_path?
420: s2conf->parser_root_auto_path:s1conf->parser_root_auto_path);
421: merged_config->parser_site_auto_path = ap_pstrdup(p, s2conf->parser_site_auto_path?
422: s2conf->parser_site_auto_path:s1conf->parser_site_auto_path);
423:
424: return (void *) merged_config;
1.2 paf 425: }
426:
427: /*
428: * This routine gives our module an opportunity to translate the URI into an
429: * actual filename. If we don't do anything special, the server's default
430: * rules (Alias directives and the like) will continue to be followed.
431: *
432: * The return value is OK, DECLINED, or HTTP_mumble. If we return OK, no
433: * further modules are called for this phase.
434: */
1.14 paf 435: static int parser_translate_handler(request_rec *r) {
436: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 437: return DECLINED;
438: }
439:
440: /*
441: * This routine is called to check the authentication information sent with
442: * the request (such as looking up the user in a database and verifying that
443: * the [encrypted] password sent matches the one in the database).
444: *
445: * The return value is OK, DECLINED, or some HTTP_mumble error (typically
446: * HTTP_UNAUTHORIZED). If we return OK, no other modules are given a chance
447: * at the request during this phase.
448: */
1.14 paf 449: static int parser_check_user_id(request_rec *r) {
450: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 451: return DECLINED;
452: }
453:
454: /*
455: * This routine is called to check to see if the resource being requested
456: * requires authorisation.
457: *
458: * The return value is OK, DECLINED, or HTTP_mumble. If we return OK, no
459: * other modules are called during this phase.
460: *
461: * If *all* modules return DECLINED, the request is aborted with a server
462: * error.
463: */
1.14 paf 464: static int parser_auth_checker(request_rec *r) {
465: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 466: return DECLINED;
467: }
468:
469: /*
470: * This routine is called to check for any module-specific restrictions placed
471: * upon the requested resource. (See the mod_access module for an example.)
472: *
473: * The return value is OK, DECLINED, or HTTP_mumble. All modules with an
474: * handler for this phase are called regardless of whether their predecessors
475: * return OK or DECLINED. The first one to return any other status, however,
476: * will abort the sequence (and the request) as usual.
477: */
1.14 paf 478: static int parser_access_checker(request_rec *r) {
1.2 paf 479:
1.14 paf 480: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 481: return DECLINED;
482: }
483:
484: /*--------------------------------------------------------------------------*/
485: /* */
486: /* All of the routines have been declared now. Here's the list of */
487: /* directives specific to our module, and information about where they */
488: /* may appear and how the command parser should pass them to us for */
489: /* processing. Note that care must be taken to ensure that there are NO */
490: /* collisions of directive names between modules. */
491: /* */
492: /*--------------------------------------------------------------------------*/
493: /*
494: * List of directives specific to our module.
495: */
1.8 paf 496: static const command_rec parser_cmds[] =
1.2 paf 497: {
498: {
1.8 paf 499: "parser_root_auto_path", /* directive name */
500: (const char *(*)(void))((void *)cmd_parser_auto_path), // config action routine
501: (void*)true, /* argument to include in call */
502: (int)(ACCESS_CONF|RSRC_CONF), /* where available */
503: TAKE1, /* arguments */
504: "Parser root auto.p filespec (Admin)" // directive description
505: },
506: {
507: "parser_site_auto_path", /* directive name */
508: (const char *(*)(void))((void *)cmd_parser_auto_path), // config action routine
509: (void*)false, /* argument to include in call */
510: (int)(OR_OPTIONS), /* where available */
511: TAKE1, /* arguments */
512: "Parser site auto.p filespec" // directive description
1.2 paf 513: },
514: {NULL}
515: };
516:
517: /*--------------------------------------------------------------------------*/
518: /* */
519: /* Now the list of content handlers available from this module. */
520: /* */
521: /*--------------------------------------------------------------------------*/
522: /*
523: * List of content handlers our module supplies. Each handler is defined by
524: * two parts: a name by which it can be referenced (such as by
525: * {Add,Set}Handler), and the actual routine name. The list is terminated by
526: * a NULL block, since it can be of variable length.
527: *
528: * Note that content-handlers are invoked on a most-specific to least-specific
529: * basis; that is, a handler that is declared for "text/plain" will be
530: * invoked before one that was declared for "text / *". Note also that
531: * if a content-handler returns anything except DECLINED, no other
532: * content-handlers will be called.
533: */
1.8 paf 534: static const handler_rec parser_handlers[] =
1.2 paf 535: {
1.8 paf 536: {"parser3-handler", parser_handler},
1.2 paf 537: {NULL}
538: };
539:
540: /*--------------------------------------------------------------------------*/
541: /* */
542: /* Finally, the list of callback routines and data structures that */
543: /* provide the hooks into our module from the other parts of the server. */
544: /* */
545: /*--------------------------------------------------------------------------*/
546: /*
547: * Module definition for configuration. If a particular callback is not
548: * needed, replace its routine name below with the word NULL.
549: *
550: * The number in brackets indicates the order in which the routine is called
551: * during request processing. Note that not all routines are necessarily
552: * called (such as if a resource doesn't have access restrictions).
553: */
554: module MODULE_VAR_EXPORT parser3_module =
555: {
556: STANDARD_MODULE_STUFF,
1.14 paf 557: parser_server_init, /* module initializer */
558: parser_create_dir_config, /* per-directory config creator */
559: parser_merge_dir_config, /* dir config merger */
560: parser_create_server_config, /* server config creator */
561: parser_merge_server_config, /* server config merger */
562: parser_cmds, /* command table */
563: parser_handlers, /* [9] list of handlers */
564: parser_translate_handler, /* [2] filename-to-URI translation */
565: parser_check_user_id, /* [5] check/validate user_id */
566: parser_auth_checker, /* [6] check user_id is valid *here* */
567: parser_access_checker, /* [4] check access by host address */
568: 0, /* [7] MIME type checker/setter */
569: 0, /* [8] fixups */
570: 0 /* [10] logger */
1.2 paf 571: };
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