Annotation of parser3/src/main/pa_request.C, revision 1.103
1.54 paf 1: /** @file
1.55 paf 2: Parser: request class main part. @see compile.C and execute.C.
3:
1.9 paf 4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.55 paf 5:
1.14 paf 6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.9 paf 7:
1.103 ! paf 8: $Id: pa_request.C,v 1.102 2001/04/07 13:48:42 paf Exp $
1.1 paf 9: */
10:
1.70 paf 11: #include "pa_config_includes.h"
1.19 paf 12:
1.96 paf 13: #include <locale.h>
14:
1.69 paf 15: #include "pa_sapi.h"
1.53 paf 16: #include "pa_common.h"
1.1 paf 17: #include "pa_request.h"
1.3 paf 18: #include "pa_wwrapper.h"
19: #include "pa_vclass.h"
1.100 paf 20: #include "_op.h"
1.17 paf 21: #include "_table.h"
1.82 paf 22: #include "_file.h"
1.31 paf 23: #include "pa_globals.h"
1.30 paf 24: #include "pa_vint.h"
25: #include "pa_vmframe.h"
1.32 paf 26: #include "pa_types.h"
1.78 paf 27: #include "pa_vtable.h"
1.89 paf 28: #include "_random.h"
1.90 paf 29: #include "pa_vfile.h"
1.101 paf 30: #include "_mail.h"
1.3 paf 31:
1.72 paf 32: /// $limits.post_max_size default 10M
33: const size_t MAX_POST_SIZE_DEFAULT=10*0x400*400;
34:
1.82 paf 35: /// content type of exception response, when no @MAIN:exception handler defined
36: const char *UNHANDLED_EXCEPTION_CONTENT_TYPE="text/plain";
37:
38: /// content type of response when no $MAIN:defaults.content-type defined
39: const char *DEFAULT_CONTENT_TYPE="text/html";
40:
1.72 paf 41: //
1.28 paf 42: Request::Request(Pool& apool,
1.33 paf 43: Info& ainfo,
1.43 paf 44: String::Untaint_lang adefault_lang) : Pooled(apool),
1.3 paf 45: stack(apool),
1.100 paf 46: OP(apool),
1.41 paf 47: env(apool),
48: form(apool),
49: request(apool, *this),
50: response(apool),
1.51 paf 51: cookie(apool),
1.3 paf 52: fclasses(apool),
1.43 paf 53: fdefault_lang(adefault_lang), flang(adefault_lang),
54: info(ainfo),
1.85 paf 55: used_files(apool),
1.74 paf 56: default_content_type(0),
1.94 paf 57: mime_types(0),
1.103 ! paf 58: connection(0), protocol2library(0),
! 59: mail(0)
1.3 paf 60: {
1.27 paf 61: // root superclass,
1.3 paf 62: // parent of all classes,
63: // operators holder
1.100 paf 64: initialize_op_class(pool(), OP);
65: classes().put(*op_class_name, &OP);
1.27 paf 66: // table class
67: classes().put(*table_class_name, table_class);
1.82 paf 68: // file class
69: classes().put(*file_class_name, file_class);
1.89 paf 70: // random class
71: classes().put(*random_class_name, random_class);
1.3 paf 72: // env class
1.41 paf 73: classes().put(*env_class_name, &env);
1.27 paf 74: // form class
1.41 paf 75: classes().put(*form_class_name, &form);
1.40 paf 76: // request class
1.41 paf 77: classes().put(*request_class_name, &request);
78: // response class
79: classes().put(*response_class_name, &response);
1.51 paf 80: // cookie class
81: classes().put(*cookie_class_name, &cookie);
1.101 paf 82: // mail class
83: classes().put(*mail_class_name, mail_class);
1.45 paf 84: }
85:
1.64 paf 86: /**
87: load MAIN class, execute @main.
88: MAIN class consists of all the auto.p files we'd manage to find
89: plus
90: the file user requested us to process
91: all located classes become children of one another,
92: composing class we name 'MAIN'
1.96 paf 93:
1.102 paf 94: @test get read of setlocale
1.64 paf 95: */
1.63 paf 96: void Request::core(const char *root_auto_path, bool root_auto_fail,
97: const char *site_auto_path, bool site_auto_fail,
1.62 paf 98: bool header_only) {
1.29 paf 99: VStateless_class *main_class=0;
1.41 paf 100: bool need_rethrow=false; Exception rethrow_me;
1.3 paf 101: TRY {
1.29 paf 102: char *auto_filespec=(char *)malloc(MAX_STRING);
103:
1.63 paf 104: // loading root auto.p
105: if(root_auto_path) {
1.77 paf 106: String& filespec=*NEW String(pool());
1.88 paf 107: filespec.APPEND_CLEAN(root_auto_path, 0, "root_auto", 0);
1.77 paf 108: filespec.APPEND_CONST("/" AUTO_FILE_NAME);
1.29 paf 109: main_class=use_file(
1.77 paf 110: filespec, root_auto_fail,
1.37 paf 111: main_class_name, main_class);
1.29 paf 112: }
113:
1.85 paf 114: // $MAIN:LIMITS hash used here,
1.72 paf 115: // until someone with less privileges have overriden them
1.78 paf 116: {
117: Value *limits=main_class?main_class->get_element(*limits_name):0;
118: // $limits.post_max_size default 10M
119: Value *element=limits?limits->get_element(*post_max_size_name):0;
1.84 paf 120: size_t value=element?(size_t)element->as_double():0;
1.78 paf 121: size_t post_max_size=value?value:MAX_POST_SIZE_DEFAULT;
122:
123: form.fill_fields(*this, post_max_size);
124: }
1.72 paf 125:
1.78 paf 126: // filling cookies
1.72 paf 127: cookie.fill_fields(*this);
128:
1.64 paf 129: // loading site auto.p
1.63 paf 130: if(site_auto_path) {
1.77 paf 131: String& filespec=*NEW String(pool());
1.88 paf 132: filespec.APPEND_CLEAN(site_auto_path, 0, "site_auto", 0);
1.77 paf 133: filespec.APPEND_CONST("/" AUTO_FILE_NAME);
1.37 paf 134: main_class=use_file(
1.77 paf 135: filespec, site_auto_fail,
1.37 paf 136: main_class_name, main_class);
1.29 paf 137: }
1.8 paf 138:
1.72 paf 139: // loading auto.p files from document_root/..
140: // to the one beside requested file.
141: // all assigned bases from upper dir
142: {
143: /* /document/root */
1.77 paf 144: char *file_spec=
1.72 paf 145: (char *)malloc(strlen(info.path_translated)+strlen(AUTO_FILE_NAME)+1);
1.83 paf 146: size_t document_root_size=strlen(info.document_root);
147: if(info.document_root[document_root_size-1]=='/')
148: document_root_size--;
149: memcpy(file_spec, info.document_root, document_root_size);
1.72 paf 150:
151: /* /requested/file.html */
152: char *branches=(char *)malloc(strlen(info.path_translated)+1);
1.83 paf 153: strcpy(branches, info.path_translated+document_root_size);
1.72 paf 154: char *next=branches;
1.83 paf 155: char *append_here=file_spec+document_root_size;
1.72 paf 156:
157: size_t slash_auto_p_size=strlen("/" AUTO_FILE_NAME);
158: while(true) {
159: char *step=lsplit(&next, '/');
160: if(next) { // not 'file.html' part
161: size_t step_size=strlen(step);
162: memcpy(append_here, step, step_size);
163: append_here+=step_size;
164: memcpy(append_here, "/" AUTO_FILE_NAME, slash_auto_p_size+1);
165: append_here++/* / */;
166:
1.77 paf 167: String& sfile_spec=*NEW String(pool());
1.88 paf 168: sfile_spec.APPEND_CLEAN(file_spec, 0, "scanned", 0);
1.77 paf 169: main_class=use_file(sfile_spec, false/*ignore read problem*/,
1.72 paf 170: main_class_name, main_class);
171: } else
172: break;
173: }
174: }
1.34 paf 175:
1.72 paf 176: // compiling requested file
1.77 paf 177: String& spath_translated=*NEW String(pool());
1.88 paf 178: spath_translated.APPEND_CLEAN(info.path_translated, 0, "user-request", 0);
1.77 paf 179: main_class=use_file(spath_translated, true/*don't ignore read problem*/,
1.72 paf 180: main_class_name, main_class);
1.7 paf 181:
1.85 paf 182: // $MAIN:DEFAULTS
1.78 paf 183: Value *defaults=main_class->get_element(*defaults_name);
1.75 paf 184: // value must be allocated on request's pool for that pool used on
185: // meaning constructing @see attributed_meaning_to_string
1.80 paf 186: default_content_type=defaults?defaults->get_element(*content_type_name):0;
1.78 paf 187: if(Value *element=main_class->get_element(*html_typo_name))
1.87 paf 188: if(Table *table=element->get_table())
189: pool().set_tag(table);
1.95 paf 190:
191: // $MAIN:SQL.drivers
192: if(Value *sql=main_class->get_element(*main_sql_name))
193: if(Value *element=sql->get_element(*main_sql_drivers_name))
194: protocol2library=element->get_table();
1.85 paf 195:
196: // $MAIN:MIME-TYPES
197: if(Value *element=main_class->get_element(*mime_types_name))
198: if(Table *table=element->get_table())
199: mime_types=table;
1.96 paf 200:
201: // $MAIN:LOCALE.ctype[Russian_Russia.1251]
202: /*
203: #define LC_ALL 0
204: #define LC_COLLATE 1
205: #define LC_CTYPE 2
206: #define LC_MONETARY 3
207: #define LC_NUMERIC 4
208: #define LC_TIME 5
209: */
210: if(Value *locale=main_class->get_element(*locale_name))
211: if(Value *element=locale->get_element(*locale_ctype_name)) {
212: const String& name=element->as_string();
213: if(!setlocale(LC_CTYPE, name.cstr()))
214: THROW(0, 0,
215: &name,
1.97 paf 216: "locale is invalid");
1.96 paf 217: }
1.102 paf 218:
219: // $MAIN:MAIL[$SMTP[mail.design.ru]]
220: if(Value *mail_element=main_class->get_element(*mail_name))
221: if(!(mail=mail_element->get_hash()))
222: THROW(0, 0,
223: 0,
224: "$MAIN:MAIL is not hash");
225:
1.25 paf 226:
227: // execute @main[]
1.41 paf 228: const String *body_string=execute_method(*main_class, *main_method_name);
229: if(!body_string)
1.25 paf 230: THROW(0,0,
231: 0,
232: "'"MAIN_METHOD_NAME"' method not found");
1.79 paf 233:
1.91 paf 234: VString body_vstring_before_post_process(*body_string);
235: VString *body_vstring_after_post_process=&body_vstring_before_post_process;
236:
237: // post-process
238: if(Value *value=main_class->get_element(*post_process_method_name))
239: if(Junction *junction=value->get_junction())
240: if(const Method *method=junction->method) {
241: // preparing to pass parameters to
242: // @post-process[data]
1.98 paf 243: VMethodFrame frame(pool(), *junction, false);
1.91 paf 244: frame.set_self(*main_class);
245:
246: frame.store_param(method->name,
247: &body_vstring_before_post_process);
248: body_vstring_after_post_process=
249: NEW VString(*execute_method(frame, *method));
250: }
1.90 paf 251:
1.91 paf 252: const VFile *body_file=body_vstring_after_post_process->as_vfile();
1.41 paf 253:
1.45 paf 254: // extract response body
255: Value *body_value=static_cast<Value *>(
256: response.fields().get(*body_name));
257: if(body_value) // there is some $request.body
1.90 paf 258: body_file=body_value->as_vfile();
1.45 paf 259:
260: // OK. write out the result
1.90 paf 261: output_result(*body_file, header_only);
1.3 paf 262: }
1.76 paf 263: CATCH(e) { // request handling problem
264: // we're returning not result, but error explanation
1.30 paf 265: TRY {
1.76 paf 266: // log the beast
267: const String *problem_source=e.problem_source();
268: if(problem_source)
269: SAPI::log(pool(),
270: #ifndef NO_STRING_ORIGIN
271: "%s(%d): "
272: #endif
273: "'%s' %s [%s %s]",
274: #ifndef NO_STRING_ORIGIN
275: problem_source->origin().file?problem_source->origin().file:"global",
276: problem_source->origin().line,
277: #endif
1.99 paf 278: problem_source->cstr(String::UL_AS_IS),
1.76 paf 279: e.comment(),
1.99 paf 280: e.type()?e.type()->cstr(String::UL_AS_IS):"-",
281: e.code()?e.code()->cstr(String::UL_AS_IS):"-"
1.76 paf 282: );
283: else
284: SAPI::log(pool(),
285: "%s [%s %s]",
286: e.comment(),
1.99 paf 287: e.type()?e.type()->cstr(String::UL_AS_IS):"-",
288: e.code()?e.code()->cstr(String::UL_AS_IS):"-"
1.76 paf 289: );
1.43 paf 290:
291: // reset language to default
292: flang=fdefault_lang;
293:
294: // reset response
295: response.fields().clear();
296:
297: // this is what we'd return in $response:body
1.41 paf 298: const String *body_string=0;
1.43 paf 299:
1.30 paf 300: if(main_class) { // we've managed to end up with some main_class
301: // maybe we'd be lucky enough as to report an error
302: // in a gracefull way...
303: if(Value *value=main_class->get_element(*exception_method_name))
304: if(Junction *junction=value->get_junction())
305: if(const Method *method=junction->method) {
306: // preparing to pass parameters to
307: // @exception[origin;source;comment;type;code]
1.98 paf 308: VMethodFrame frame(pool(), *junction, false);
1.38 paf 309: frame.set_self(*main_class);
1.30 paf 310:
311: const String *problem_source=e.problem_source();
312: // origin
1.38 paf 313: Value *origin_value=0;
1.30 paf 314: #ifndef NO_STRING_ORIGIN
1.38 paf 315: if(problem_source) {
316: const Origin& origin=problem_source->origin();
317: if(origin.file) {
318: char *buf=(char *)malloc(MAX_STRING);
1.42 paf 319: snprintf(buf, MAX_STRING, "%s(%d):",
1.38 paf 320: origin.file, 1+origin.line);
1.44 paf 321: String *origin_file_line=NEW String(pool(),
322: buf, true);
1.38 paf 323: origin_value=NEW VString(*origin_file_line);
324: }
1.30 paf 325: }
326: #endif
1.91 paf 327: frame.store_param(method->name,
1.38 paf 328: origin_value?origin_value:NEW VUnknown(pool()));
1.28 paf 329:
1.30 paf 330: // source
1.38 paf 331: Value *source_value=0;
1.43 paf 332: if(problem_source) {
1.47 paf 333: String& problem_source_copy=*NEW String(pool());
334: problem_source_copy.append(*problem_source,
335: flang, true);
1.43 paf 336: source_value=NEW VString(problem_source_copy);
337: }
1.91 paf 338: frame.store_param(method->name,
1.38 paf 339: source_value?source_value:NEW VUnknown(pool()));
1.30 paf 340:
341: // comment
1.44 paf 342: String *comment_value=NEW String(pool(),
343: e.comment(), true);
1.91 paf 344: frame.store_param(method->name,
1.30 paf 345: NEW VString(*comment_value));
346:
347: // type
348: Value *type_value;
1.43 paf 349: if(e.type()) {
1.47 paf 350: String& type_copy=*NEW String(pool());
351: type_value=NEW VString(type_copy.append(*e.type(),
352: flang, true));
1.43 paf 353: } else
1.30 paf 354: type_value=NEW VUnknown(pool());
1.91 paf 355: frame.store_param(method->name, type_value);
1.30 paf 356:
357: // code
358: Value *code_value;
1.43 paf 359: if(e.code()) {
1.47 paf 360: String& code_copy=*NEW String(pool());
361: code_value=NEW VString(code_copy.append(*e.code(),
362: flang, true));
1.43 paf 363: } else
1.30 paf 364: code_value=NEW VUnknown(pool());
1.91 paf 365: frame.store_param(method->name, code_value);
1.30 paf 366:
1.43 paf 367: // future $response:body=
368: // execute ^exception[origin;source;comment;type;code]
369: body_string=execute_method(frame, *method);
1.30 paf 370: }
371: }
372:
1.41 paf 373: if(!body_string) { // couldn't report an error beautifully?
374: // doing that ugly
375:
376: // make up result: $origin $source $comment $type $code
377: char *buf=(char *)malloc(MAX_STRING);
1.30 paf 378: size_t printed=0;
379: const String *problem_source=e.problem_source();
380: if(problem_source) {
1.16 paf 381: #ifndef NO_STRING_ORIGIN
1.30 paf 382: const Origin& origin=problem_source->origin();
383: if(origin.file)
1.41 paf 384: printed+=snprintf(buf+printed, MAX_STRING-printed, "%s(%d): ",
1.30 paf 385: origin.file, 1+origin.line);
1.28 paf 386: #endif
1.41 paf 387: printed+=snprintf(buf+printed, MAX_STRING-printed, "'%s' ",
1.99 paf 388: problem_source->cstr(String::UL_AS_IS));
1.30 paf 389: }
1.41 paf 390: printed+=snprintf(buf+printed, MAX_STRING-printed, "%s",
1.30 paf 391: e.comment());
392: const String *type=e.type();
393: if(type) {
1.41 paf 394: printed+=snprintf(buf+printed, MAX_STRING-printed, " type: %s",
1.99 paf 395: type->cstr(String::UL_AS_IS));
1.30 paf 396: const String *code=e.code();
397: if(code)
1.41 paf 398: printed+=snprintf(buf+printed, MAX_STRING-printed, ", code: %s",
1.99 paf 399: code->cstr(String::UL_AS_IS));
1.30 paf 400: }
1.43 paf 401:
402: // future $response:content-type
1.49 paf 403: response.fields().put(*content_type_name,
1.82 paf 404: NEW VString(*NEW String(pool(), UNHANDLED_EXCEPTION_CONTENT_TYPE)));
1.43 paf 405: // future $response:body
1.44 paf 406: body_string=NEW String(pool(), buf);
1.30 paf 407: }
1.41 paf 408:
1.90 paf 409: const VString body_vstring(*body_string);
410: const VFile *body_file=body_vstring.as_vfile();
411:
1.45 paf 412: // ERROR. write it out
1.90 paf 413: output_result(*body_file, header_only);
1.3 paf 414: }
1.30 paf 415: CATCH(e) {
1.41 paf 416: // exception in request exception handler
417: // remember to rethrow it
418: rethrow_me=e; need_rethrow=true;
1.1 paf 419: }
1.30 paf 420: END_CATCH
1.1 paf 421: }
1.41 paf 422: END_CATCH // do not use pool() after this point - no exception handler set
423: // any throw() would try to use zero exception() pointer
424:
1.91 paf 425: if(need_rethrow) // were there an exception for us to rethrow?
1.62 paf 426: THROW(rethrow_me.type(), rethrow_me.code(),
1.41 paf 427: rethrow_me.problem_source(),
428: rethrow_me.comment());
1.1 paf 429: }
430:
1.77 paf 431: VStateless_class *Request::use_file(const String& file_spec, bool fail_on_read_problem,
1.26 paf 432: const String *name,
433: VStateless_class *base_class) {
1.73 paf 434: // cyclic dependence check
1.77 paf 435: if(used_files.get(file_spec))
1.73 paf 436: return base_class;
1.77 paf 437: used_files.put(file_spec, (Hash::Val *)true);
1.73 paf 438:
439:
1.77 paf 440: char *source=file_read_text(pool(), file_spec, fail_on_read_problem);
1.3 paf 441: if(!source)
1.12 paf 442: return base_class;
1.3 paf 443:
1.77 paf 444: return use_buf(source, file_spec.cstr(), 0/*new class*/, name, base_class);
1.16 paf 445: }
446:
1.67 paf 447: VStateless_class *Request::use_buf(const char *source, const char *file,
1.26 paf 448: VStateless_class *aclass, const String *name,
449: VStateless_class *base_class) {
1.5 paf 450: // compile loaded class
1.26 paf 451: VStateless_class& cclass=COMPILE(source, aclass, name, base_class, file);
1.1 paf 452:
1.4 paf 453: // locate and execute possible @auto[] static method
1.25 paf 454: execute_method(cclass, *auto_method_name, false /*no result needed*/);
1.16 paf 455: return &cclass;
1.20 paf 456: }
457:
1.52 paf 458: /**
459: - fail_if_junction(true, junction = fail
460: - fail_if_junction(false, not junction = fail
461: */
1.62 paf 462: void Request::fail_if_junction_(bool is, Value& value,
463: const String& method_name, const char *msg) {
1.20 paf 464:
465: if((value.get_junction()!=0) ^ !is)
466: THROW(0, 0,
467: &method_name,
468: msg);
1.19 paf 469: }
470:
1.77 paf 471: const String& Request::relative(const char *apath, const String& relative_name) {
472: int lpath_buf_size=strlen(apath)+1;
473: char *lpath=(char *)malloc(lpath_buf_size);
474: memcpy(lpath, apath, lpath_buf_size);
475: rsplit(lpath, '/');
476: String& result=*NEW String(pool(), lpath);
477: result.APPEND_CONST("/");
478: result.append(relative_name, String::UL_PASS_APPENDED);
1.19 paf 479: return result;
480: }
481:
1.77 paf 482: const String& Request::absolute(const String& relative_name) {
483: char *relative_name_cstr=relative_name.cstr();
484: if(relative_name_cstr[0]=='/') {
485: String& result=*NEW String(pool(), info.document_root);
486: result.append(relative_name, String::UL_PASS_APPENDED);
1.19 paf 487: return result;
488: } else
1.77 paf 489: return relative(info.path_translated, relative_name);
1.1 paf 490: }
1.45 paf 491:
1.101 paf 492: static void add_header_attribute(const Hash::Key& aattribute, Hash::Val *ameaning,
493: void *info) {
494: String *attribute_to_exclude=static_cast<String *>(info);
495: if(aattribute==*attribute_to_exclude)
496: return;
497:
498: Value& lmeaning=*static_cast<Value *>(ameaning);
499: Pool& pool=lmeaning.pool();
500:
501: String attribute(pool);
502: SAPI::add_header_attribute(pool,
503: attribute.append(aattribute, String::UL_HTTP_HEADER, true).cstr(),
504: attributed_meaning_to_string(lmeaning, String::UL_HTTP_HEADER).cstr());
505: }
1.90 paf 506: void Request::output_result(const VFile& body_file, bool header_only) {
1.51 paf 507: // header: cookies
508: cookie.output_result();
509:
1.90 paf 510: // set content-type
511: if(String *body_file_content_type=static_cast<String *>(
512: body_file.fields().get(*vfile_mime_type_name))) {
513: // body file content type
514: response.fields().put(*content_type_name, body_file_content_type);
515: } else {
516: // default content type
517: response.fields().put_dont_replace(*content_type_name,
518: default_content_type?default_content_type
519: :NEW VString(*NEW String(pool(), DEFAULT_CONTENT_TYPE)));
1.92 paf 520: }
521:
522: // content-disposition
523: if(VString *vfile_name=static_cast<VString *>(body_file.fields().get(*name_name))) {
524: VHash& vhash=*NEW VHash(pool());
525: vhash.hash().put(*content_disposition_filename_name, vfile_name);
526: response.fields().put(*content_disposition_name, &vhash);
1.90 paf 527: }
1.49 paf 528:
1.62 paf 529: // prepare header: $response:fields without :body
1.73 paf 530: response.fields().for_each(add_header_attribute, /*excluding*/ body_name);
1.50 paf 531:
1.62 paf 532: // prepare...
1.90 paf 533: const void *body=body_file.value_ptr();
534: size_t content_length=body_file.value_size();
1.50 paf 535:
1.62 paf 536: // prepare header: content-length
1.65 paf 537: if(content_length) { // useful for redirecting [header "location: http://..."]
538: char content_length_cstr[MAX_NUMBER];
1.66 paf 539: snprintf(content_length_cstr, MAX_NUMBER, "%lu", content_length);
1.69 paf 540: SAPI::add_header_attribute(pool(), "content-length", content_length_cstr);
1.65 paf 541: }
1.62 paf 542:
543: // send header
1.69 paf 544: SAPI::send_header(pool());
1.71 paf 545:
1.62 paf 546: // send body
547: if(!header_only)
1.69 paf 548: SAPI::send_body(pool(), body, content_length);
1.50 paf 549: }
E-mail: