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