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