Annotation of parser3/src/targets/apache13/modules/extra/mod_parser3.C, revision 1.25
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.25 ! paf 8: $Id: mod_parser3.C,v 1.24 2001/04/09 13:21:16 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.22 paf 24: #include "pa_socks.h"
25:
26: /// @todo init_socks
1.2 paf 27:
1.8 paf 28: struct Parser_module_config {
29: const char* parser_root_auto_path; /// filespec of admin's auto.p file
30: const char* parser_site_auto_path; /// filespec of site's auto.p file
31: };
1.2 paf 32:
33: /*
34: * Declare ourselves so the configuration routines can find and know us.
35: * We'll fill it in at the end of the module.
36: */
37: extern "C" module MODULE_VAR_EXPORT parser3_module;
38:
39: /*
40: * Locate our directory configuration record for the current request.
41: */
1.14 paf 42: static Parser_module_config *our_dconfig(request_rec *r) {
43: return (Parser_module_config *)
44: ap_get_module_config(r->per_dir_config, &parser3_module);
1.2 paf 45: }
46:
1.14 paf 47: static const char *cmd_parser_auto_path(cmd_parms *cmd, void *mconfig, char *file_spec) {
1.8 paf 48: Parser_module_config *cfg = (Parser_module_config *) mconfig;
1.2 paf 49:
1.8 paf 50: // remember assigned filespec into cfg
51: (cmd->info?cfg->parser_root_auto_path:cfg->parser_site_auto_path)=file_spec;
1.2 paf 52:
53: return NULL;
54: }
55:
1.8 paf 56:
1.2 paf 57: /*--------------------------------------------------------------------------*/
58: /* */
59: /* Now we declare our content handlers, which are invoked when the server */
60: /* encounters a document which our module is supposed to have a chance to */
61: /* see. (See mod_mime's SetHandler and AddHandler directives, and the */
62: /* mod_info and mod_status examples, for more details.) */
63: /* */
64: /* Since content handlers are dumping data directly into the connexion */
65: /* (using the r*() routines, such as rputs() and rprintf()) without */
66: /* intervention by other parts of the server, they need to make */
67: /* sure any accumulated HTTP headers are sent first. This is done by */
68: /* calling send_http_header(). Otherwise, no header will be sent at all, */
69: /* and the output sent to the client will actually be HTTP-uncompliant. */
70: /*--------------------------------------------------------------------------*/
71: /*
72: * Sample content handler. All this does is display the call list that has
73: * been built up so far.
74: *
75: * The return value instructs the caller concerning what happened and what to
76: * do next:
77: * OK ("we did our thing")
78: * DECLINED ("this isn't something with which we want to get involved")
79: * HTTP_mumble ("an error status should be reported")
80: */
81:
82:
1.8 paf 83: //@{
1.15 paf 84: /// SAPI func decl
85: const char *SAPI::get_env(Pool& pool, const char *name) {
1.10 paf 86: request_rec *r=static_cast<request_rec *>(pool.context());
1.4 paf 87: return (const char *)ap_table_get(r->subprocess_env, name);
88: }
89:
1.24 paf 90: size_t SAPI::read_post(Pool& pool, char *buf, size_t max_bytes) {
1.10 paf 91: request_rec *r=static_cast<request_rec *>(pool.context());
1.5 paf 92:
93: /* ap_log_error(APLOG_MARK, APLOG_DEBUG, r->server,
1.15 paf 94: "mod_parser3: SAPI::read_post(max=%u)", max_bytes);
1.5 paf 95: */
96: int retval;
97: if((retval = ap_setup_client_block(r, REQUEST_CHUNKED_ERROR)))
98: return 0;
99: if(!ap_should_client_block(r))
100: return 0;
101:
102: uint total_read_bytes=0;
103: void (*handler)(int)=signal(SIGPIPE, SIG_IGN);
104: while (total_read_bytes<max_bytes) {
105: ap_hard_timeout("Read POST information", r); /* start timeout timer */
106: uint read_bytes=
107: ap_get_client_block(r, buf+total_read_bytes, max_bytes-total_read_bytes);
108: ap_reset_timeout(r);
109: if (read_bytes<=0)
1.2 paf 110: break;
1.5 paf 111: total_read_bytes+=read_bytes;
112: }
113: signal(SIGPIPE, handler);
114: return total_read_bytes;
1.2 paf 115: }
116:
1.15 paf 117: void SAPI::add_header_attribute(Pool& pool, const char *key, const char *value) {
1.10 paf 118: request_rec *r=static_cast<request_rec *>(pool.context());
1.2 paf 119:
1.3 paf 120: if(strcasecmp(key, "content-type")==0) {
1.2 paf 121: /* r->content_type, *not* r->headers_out("Content-type"). If you don't
122: * set it, it will be filled in with the server's default type (typically
123: * "text/plain"). You *must* also ensure that r->content_type is lower
124: * case.
125: */
126: r->content_type = value;
127: } else
128: ap_table_merge(r->headers_out, key, value);
129: }
130:
1.15 paf 131: void SAPI::send_header(Pool& pool) {
1.10 paf 132: request_rec *r=static_cast<request_rec *>(pool.context());
1.5 paf 133:
1.8 paf 134: ap_hard_timeout("Send header", r);
1.2 paf 135: ap_send_http_header(r);
1.5 paf 136: ap_kill_timeout(r);
1.2 paf 137: }
138:
1.21 paf 139: void SAPI::send_body(Pool& pool, const void *buf, size_t size) {
1.10 paf 140: request_rec *r=static_cast<request_rec *>(pool.context());
1.5 paf 141:
1.8 paf 142: ap_hard_timeout("Send body", r);
1.2 paf 143: ap_rwrite(buf, size, r);
1.5 paf 144: ap_kill_timeout(r);
1.2 paf 145: }
1.18 paf 146:
147: void SAPI::log(Pool& pool, const char *fmt, ...) {
148: request_rec *r=static_cast<request_rec *>(pool.context());
149:
150: va_list args;
151: va_start(args,fmt);
152: char buf[MAX_STRING];
153: vsnprintf(buf, MAX_STRING, fmt, args);
154: ap_log_rerror(0, 0, APLOG_ERR | APLOG_NOERRNO, r, "%s", buf);
155: va_end(args);
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,
197: String::UL_HTML_TYPO
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 {
293: // init global variables
1.15 paf 294: pa_globals_init(pool);
1.2 paf 295: } PCATCH(e) { // global problem
1.18 paf 296: ap_log_error(APLOG_MARK, APLOG_EMERG, 0,
297: "setup_module_cells failed: ", e.comment());
298: exit(1);
1.2 paf 299: }
300: PEND_CATCH
301: }
302:
1.14 paf 303: static void parser_server_init(server_rec *s, pool *p) {
304: #if MODULE_MAGIC_NUMBER >= 19980527
1.17 paf 305: ap_add_version_component("Parser/"PARSER_VERSION);
1.14 paf 306: #endif
1.2 paf 307:
308: /*
1.14 paf 309: * Set up any module cells that ought to be initialised.
1.2 paf 310: */
1.14 paf 311: setup_module_cells();
1.2 paf 312: }
313:
314: /*
315: * This function gets called to create a per-directory configuration
316: * record. This will be called for the "default" server environment, and for
317: * each directory for which the parser finds any of our directives applicable.
318: * If a directory doesn't have any of our directives involved (i.e., they
319: * aren't in the .htaccess file, or a <Location>, <Directory>, or related
320: * block), this routine will *not* be called - the configuration for the
321: * closest ancestor is used.
322: *
323: * The return value is a pointer to the created module-specific
324: * structure.
325: */
1.14 paf 326: static void *parser_create_dir_config(pool *p, char *dirspec) {
327: /*
1.2 paf 328: * Allocate the space for our record from the pool supplied.
329: */
1.14 paf 330: Parser_module_config *cfg=
331: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.2 paf 332: /*
333: * Now fill in the defaults. If there are any `parent' configuration
334: * records, they'll get merged as part of a separate callback.
335: */
1.8 paf 336: cfg->parser_root_auto_path = 0;
337: cfg->parser_site_auto_path = 0;
1.2 paf 338: return (void *) cfg;
339: }
340:
341: /*
342: * This function gets called to merge two per-directory configuration
343: * records. This is typically done to cope with things like .htaccess files
344: * or <Location> directives for directories that are beneath one for which a
345: * configuration record was already created. The routine has the
346: * responsibility of creating a new record and merging the contents of the
347: * other two into it appropriately. If the module doesn't declare a merge
348: * routine, the record for the closest ancestor location (that has one) is
349: * used exclusively.
350: *
351: * The routine MUST NOT modify any of its arguments!
352: *
353: * The return value is a pointer to the created module-specific structure
354: * containing the merged values.
355: */
1.8 paf 356: static void *parser_merge_dir_config(pool *p, void *parent_conf,
1.14 paf 357: void *newloc_conf) {
358: Parser_module_config *merged_config =
359: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.8 paf 360: Parser_module_config *pconf = (Parser_module_config *) parent_conf;
361: Parser_module_config *nconf = (Parser_module_config *) newloc_conf;
362:
363: // always from parent
364: merged_config->parser_root_auto_path = ap_pstrdup(p, pconf->parser_root_auto_path);
1.2 paf 365: /*
366: * Some things get copied directly from the more-specific record, rather
367: * than getting merged.
368: */
1.8 paf 369: merged_config->parser_site_auto_path = ap_pstrdup(p, nconf->parser_site_auto_path?
370: nconf->parser_site_auto_path:pconf->parser_site_auto_path);
371:
1.2 paf 372: return (void *) merged_config;
373: }
374:
375: /*
376: * This function gets called to create a per-server configuration
377: * record. It will always be called for the "default" server.
378: *
379: * The return value is a pointer to the created module-specific
380: * structure.
381: */
1.14 paf 382: static void *parser_create_server_config(pool *p, server_rec *s) {
1.2 paf 383: /*
1.8 paf 384: * As with the parser_create_dir_config() reoutine, we allocate and fill
1.2 paf 385: * in an empty record.
386: */
1.14 paf 387: Parser_module_config *cfg=
388: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
389:
1.8 paf 390: cfg->parser_root_auto_path = 0;
391: cfg->parser_site_auto_path = 0;
1.14 paf 392:
1.2 paf 393: return (void *) cfg;
394: }
395:
396: /*
397: * This function gets called to merge two per-server configuration
398: * records. This is typically done to cope with things like virtual hosts and
399: * the default server configuration The routine has the responsibility of
400: * creating a new record and merging the contents of the other two into it
401: * appropriately. If the module doesn't declare a merge routine, the more
402: * specific existing record is used exclusively.
403: *
404: * The routine MUST NOT modify any of its arguments!
405: *
406: * The return value is a pointer to the created module-specific structure
407: * containing the merged values.
408: */
1.8 paf 409: static void *parser_merge_server_config(pool *p, void *server1_conf,
1.2 paf 410: void *server2_conf)
411: {
412:
1.14 paf 413: Parser_module_config *merged_config =
414: (Parser_module_config *) ap_pcalloc(p, sizeof(Parser_module_config));
1.8 paf 415: Parser_module_config *s1conf = (Parser_module_config *) server1_conf;
416: Parser_module_config *s2conf = (Parser_module_config *) server2_conf;
1.2 paf 417:
418: /*
419: * Our inheritance rules are our own, and part of our module's semantics.
420: * Basically, just note whence we came.
421: */
1.8 paf 422: merged_config->parser_root_auto_path = ap_pstrdup(p, s2conf->parser_root_auto_path?
423: s2conf->parser_root_auto_path:s1conf->parser_root_auto_path);
424: merged_config->parser_site_auto_path = ap_pstrdup(p, s2conf->parser_site_auto_path?
425: s2conf->parser_site_auto_path:s1conf->parser_site_auto_path);
426:
427: return (void *) merged_config;
1.2 paf 428: }
429:
430: /*
431: * This routine gives our module an opportunity to translate the URI into an
432: * actual filename. If we don't do anything special, the server's default
433: * rules (Alias directives and the like) will continue to be followed.
434: *
435: * The return value is OK, DECLINED, or HTTP_mumble. If we return OK, no
436: * further modules are called for this phase.
437: */
1.14 paf 438: static int parser_translate_handler(request_rec *r) {
439: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 440: return DECLINED;
441: }
442:
443: /*
444: * This routine is called to check the authentication information sent with
445: * the request (such as looking up the user in a database and verifying that
446: * the [encrypted] password sent matches the one in the database).
447: *
448: * The return value is OK, DECLINED, or some HTTP_mumble error (typically
449: * HTTP_UNAUTHORIZED). If we return OK, no other modules are given a chance
450: * at the request during this phase.
451: */
1.14 paf 452: static int parser_check_user_id(request_rec *r) {
453: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 454: return DECLINED;
455: }
456:
457: /*
458: * This routine is called to check to see if the resource being requested
459: * requires authorisation.
460: *
461: * The return value is OK, DECLINED, or HTTP_mumble. If we return OK, no
462: * other modules are called during this phase.
463: *
464: * If *all* modules return DECLINED, the request is aborted with a server
465: * error.
466: */
1.14 paf 467: static int parser_auth_checker(request_rec *r) {
468: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 469: return DECLINED;
470: }
471:
472: /*
473: * This routine is called to check for any module-specific restrictions placed
474: * upon the requested resource. (See the mod_access module for an example.)
475: *
476: * The return value is OK, DECLINED, or HTTP_mumble. All modules with an
477: * handler for this phase are called regardless of whether their predecessors
478: * return OK or DECLINED. The first one to return any other status, however,
479: * will abort the sequence (and the request) as usual.
480: */
1.14 paf 481: static int parser_access_checker(request_rec *r) {
1.2 paf 482:
1.14 paf 483: Parser_module_config *cfg=our_dconfig(r);
1.2 paf 484: return DECLINED;
485: }
486:
487: /*--------------------------------------------------------------------------*/
488: /* */
489: /* All of the routines have been declared now. Here's the list of */
490: /* directives specific to our module, and information about where they */
491: /* may appear and how the command parser should pass them to us for */
492: /* processing. Note that care must be taken to ensure that there are NO */
493: /* collisions of directive names between modules. */
494: /* */
495: /*--------------------------------------------------------------------------*/
496: /*
497: * List of directives specific to our module.
498: */
1.8 paf 499: static const command_rec parser_cmds[] =
1.2 paf 500: {
501: {
1.8 paf 502: "parser_root_auto_path", /* directive name */
503: (const char *(*)(void))((void *)cmd_parser_auto_path), // config action routine
504: (void*)true, /* argument to include in call */
505: (int)(ACCESS_CONF|RSRC_CONF), /* where available */
506: TAKE1, /* arguments */
507: "Parser root auto.p filespec (Admin)" // directive description
508: },
509: {
510: "parser_site_auto_path", /* directive name */
511: (const char *(*)(void))((void *)cmd_parser_auto_path), // config action routine
512: (void*)false, /* argument to include in call */
513: (int)(OR_OPTIONS), /* where available */
514: TAKE1, /* arguments */
515: "Parser site auto.p filespec" // directive description
1.2 paf 516: },
517: {NULL}
518: };
519:
520: /*--------------------------------------------------------------------------*/
521: /* */
522: /* Now the list of content handlers available from this module. */
523: /* */
524: /*--------------------------------------------------------------------------*/
525: /*
526: * List of content handlers our module supplies. Each handler is defined by
527: * two parts: a name by which it can be referenced (such as by
528: * {Add,Set}Handler), and the actual routine name. The list is terminated by
529: * a NULL block, since it can be of variable length.
530: *
531: * Note that content-handlers are invoked on a most-specific to least-specific
532: * basis; that is, a handler that is declared for "text/plain" will be
533: * invoked before one that was declared for "text / *". Note also that
534: * if a content-handler returns anything except DECLINED, no other
535: * content-handlers will be called.
536: */
1.8 paf 537: static const handler_rec parser_handlers[] =
1.2 paf 538: {
1.8 paf 539: {"parser3-handler", parser_handler},
1.2 paf 540: {NULL}
541: };
542:
543: /*--------------------------------------------------------------------------*/
544: /* */
545: /* Finally, the list of callback routines and data structures that */
546: /* provide the hooks into our module from the other parts of the server. */
547: /* */
548: /*--------------------------------------------------------------------------*/
549: /*
550: * Module definition for configuration. If a particular callback is not
551: * needed, replace its routine name below with the word NULL.
552: *
553: * The number in brackets indicates the order in which the routine is called
554: * during request processing. Note that not all routines are necessarily
555: * called (such as if a resource doesn't have access restrictions).
556: */
557: module MODULE_VAR_EXPORT parser3_module =
558: {
559: STANDARD_MODULE_STUFF,
1.14 paf 560: parser_server_init, /* module initializer */
561: parser_create_dir_config, /* per-directory config creator */
562: parser_merge_dir_config, /* dir config merger */
563: parser_create_server_config, /* server config creator */
564: parser_merge_server_config, /* server config merger */
565: parser_cmds, /* command table */
566: parser_handlers, /* [9] list of handlers */
567: parser_translate_handler, /* [2] filename-to-URI translation */
568: parser_check_user_id, /* [5] check/validate user_id */
569: parser_auth_checker, /* [6] check user_id is valid *here* */
570: parser_access_checker, /* [4] check access by host address */
571: 0, /* [7] MIME type checker/setter */
572: 0, /* [8] fixups */
573: 0 /* [10] logger */
1.2 paf 574: };
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