Annotation of parser3/src/include/pa_request.h, revision 1.148
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.120 paf 4: Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
1.121 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1 paf 6: */
7:
8: #ifndef PA_REQUEST_H
9: #define PA_REQUEST_H
1.141 paf 10:
1.148 ! paf 11: static const char* IDENT_REQUEST_H="$Date: 2002/09/10 12:05:37 $";
1.1 paf 12:
13: #include "pa_pool.h"
1.5 paf 14: #include "pa_hash.h"
1.7 paf 15: #include "pa_wcontext.h"
1.6 paf 16: #include "pa_value.h"
1.7 paf 17: #include "pa_stack.h"
1.12 paf 18: #include "pa_vclass.h"
1.45 paf 19: #include "pa_vobject.h"
1.47 paf 20: #include "pa_venv.h"
1.108 paf 21: #include "pa_vstatus.h"
1.48 paf 22: #include "pa_vform.h"
1.140 paf 23: #include "pa_vmail.h"
1.90 parser 24: #include "pa_vmath.h"
1.56 paf 25: #include "pa_vrequest.h"
1.57 paf 26: #include "pa_vresponse.h"
1.60 paf 27: #include "pa_vcookie.h"
1.77 paf 28: #include "pa_sql_driver_manager.h"
1.44 paf 29:
1.112 paf 30: #ifdef RESOURCES_DEBUG
31: #include <sys/resource.h>
32: #endif
33:
1.128 paf 34: // consts
35:
1.134 paf 36: #define MAIN_METHOD_NAME "main"
1.128 paf 37: const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500;
38:
39: // defines
40:
1.7 paf 41: #ifndef NO_STRING_ORIGIN
1.40 paf 42: # define COMPILE_PARAMS \
43: const char *source, \
1.46 paf 44: VStateless_class *aclass, const String *name, \
45: VStateless_class *base_class, \
1.40 paf 46: const char *file
47: # define COMPILE(source, aclass, name, base_class, file) \
48: real_compile(source, aclass, name, base_class, file)
1.7 paf 49: #else
1.40 paf 50: # define COMPILE_PARAMS \
51: const char *source, \
1.46 paf 52: VStateless_class *aclass, const String *name, \
53: VStateless_class *base_class
1.40 paf 54: # define COMPILE(source, aclass, name, base_class, file) \
55: real_compile(source, aclass, name, base_class)
1.7 paf 56: #endif
1.4 paf 57:
1.39 paf 58: class Temp_lang;
1.84 paf 59: class Methoded;
1.116 paf 60: class VMethodFrame;
1.1 paf 61:
1.61 paf 62: /// Main workhorse.
1.7 paf 63: class Request : public Pooled {
1.107 paf 64: friend class Temp_lang;
1.117 paf 65: friend class Temp_connection;
1.148 ! paf 66: friend class Request_context_saver;
1.1 paf 67: public:
1.112 paf 68:
69: #ifdef RESOURCES_DEBUG
70: /// measures
71: double sql_connect_time;
72: double sql_request_time;
73: #endif
1.61 paf 74:
75: /// some information from web server
1.65 paf 76: class Info {
77: public:
1.53 paf 78: const char *document_root;
79: const char *path_translated;
1.56 paf 80: const char *method;
1.53 paf 81: const char *query_string;
1.56 paf 82: const char *uri;
1.53 paf 83: const char *content_type;
84: size_t content_length;
1.60 paf 85: const char *cookie;
1.140 paf 86: bool mail_received;
1.53 paf 87: };
88:
1.50 paf 89: Request(Pool& apool,
1.53 paf 90: Info& ainfo,
1.111 paf 91: uchar adefault_lang, ///< all tainted data default untainting lang
1.110 paf 92: bool status_allowed ///< status class allowed
1.50 paf 93: );
1.118 paf 94: ~Request();
1.1 paf 95:
1.61 paf 96: /// global classes
1.6 paf 97: Hash& classes() { return fclasses; }
98:
1.65 paf 99: /**
100: core request processing
101:
102: BEWARE: may throw exception to you: catch it!
103: */
104: void core(
1.138 paf 105: const char *config_filespec, ///< system config filespec
106: bool config_fail_on_read_problem, ///< fail if system config file not found
1.65 paf 107: bool header_only);
1.17 paf 108:
1.61 paf 109: /// executes ops
1.147 paf 110: void execute(const Array& ops); // execute.C
1.127 paf 111: /// execute ops with anti-recoursion check
1.128 paf 112: void recoursion_checked_execute(const String *name, const Array& ops) {
113: // anti_endless_execute_recoursion
114: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
115: anti_endless_execute_recoursion=0; // give @exception a chance
116: throw Exception("parser.runtime",
117: name,
118: "call canceled - endless recursion detected");
119: }
1.147 paf 120: execute(ops); // execute it
1.128 paf 121: anti_endless_execute_recoursion--;
122: }
1.40 paf 123:
1.64 paf 124: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46 paf 125: VStateless_class *use_file(
1.94 parser 126: const String& file_name,
127: bool ignore_class_path=false, bool fail_on_read_problem=true,
1.45 paf 128: const String *name=0,
1.46 paf 129: VStateless_class *base_class=0); // core.C
1.64 paf 130: /// compiles a @a source buffer
1.46 paf 131: VStateless_class *use_buf(
1.139 paf 132: const char *source, const String& filespec, const char *filespec_cstr,
1.46 paf 133: VStateless_class *aclass=0, const String *name=0,
134: VStateless_class *base_class=0); // core.C
1.28 paf 135:
1.129 paf 136: /// processes any code-junction there may be inside of @a value
1.131 paf 137: StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
1.129 paf 138: //@{ convinient helpers
139: const String& process_to_string(Value& input_value) {
140: return process(input_value, true/*intercept_string*/).as_string();
141: }
142: Value& process_to_value(Value& input_value, bool intercept_string=true) {
143: return process(input_value, intercept_string).as_value();
1.126 paf 144: }
145: //@}
1.131 paf 146:
1.126 paf 147:
1.131 paf 148: #define DEFINE_DUAL(modification) \
149: void write_##modification##_lang(StringOrValue dual) { \
150: if(const String *string=dual.get_string()) \
151: write_##modification##_lang(*string); \
152: else \
153: write_##modification##_lang(*dual.get_value()); \
154: }
1.132 paf 155: #define DEFINE_DUAL_CHECKED(modification) \
156: void write_##modification##_lang(StringOrValue dual, const String *origin) { \
157: if(const String *string=dual.get_string()) \
158: write_##modification##_lang(*string); \
159: else \
160: write_##modification##_lang(*dual.get_value(), origin); \
161: }
1.131 paf 162:
1.61 paf 163: /// appending, sure of clean string inside
1.65 paf 164: void write_no_lang(const String& astring) {
1.111 paf 165: wcontext->write(astring,
166: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.49 paf 167: }
1.131 paf 168: /// appending sure value, that would be converted to clean string
169: void write_no_lang(Value& avalue) {
170: if(wcontext->get_in_expression())
171: wcontext->write(avalue);
172: else
173: wcontext->write(avalue,
174: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
175: }
176: //DEFINE_DUAL(no)
177:
1.61 paf 178: /// appending string, passing language built into string being written
1.65 paf 179: void write_pass_lang(const String& astring) {
180: wcontext->write(astring, String::UL_PASS_APPENDED);
1.59 paf 181: }
1.131 paf 182: /// appending possible string, passing language built into string being written
183: void write_pass_lang(Value& avalue) {
184: wcontext->write(avalue, String::UL_PASS_APPENDED);
185: }
186: DEFINE_DUAL(pass)
187:
1.61 paf 188: /// appending possible string, assigning untaint language
1.40 paf 189: void write_assign_lang(Value& avalue) {
1.39 paf 190: wcontext->write(avalue, flang);
1.106 parser 191: }
1.132 paf 192: /// appending possible string, assigning untaint language
193: void write_assign_lang(Value& avalue, const String *origin) {
194: wcontext->write(avalue, flang, origin);
195: }
1.106 parser 196: /// appending string, assigning untaint language
197: void write_assign_lang(const String& astring) {
198: wcontext->write(astring, flang);
1.22 paf 199: }
1.131 paf 200: DEFINE_DUAL(assign)
1.132 paf 201: DEFINE_DUAL_CHECKED(assign)
1.22 paf 202:
1.64 paf 203: /// returns relative to @a path path to @a file
1.69 paf 204: const String& relative(const char *apath, const String& relative_name);
1.61 paf 205:
1.64 paf 206: /// returns an absolute @a path to relative @a name
1.69 paf 207: const String& absolute(const String& relative_name);
1.42 paf 208:
1.80 paf 209: /// returns the mime type of 'user_file_name_cstr'
210: const String& mime_type_of(const char *user_file_name_cstr);
211:
1.117 paf 212: /// returns current SQL connection if any
213: SQL_Connection *connection(const String *source) {
214: if(!fconnection && source)
1.125 paf 215: throw Exception("parser.runtime",
1.117 paf 216: source,
217: "outside of 'connect' operator");
218:
219: return fconnection;
1.133 paf 220: }
221:
222: bool origins_mode() {
1.144 paf 223: return main_class->get_element(*origins_mode_name, main_class, false)!=0; // $ORIGINS mode
1.117 paf 224: }
225:
1.17 paf 226: public:
1.22 paf 227:
1.61 paf 228: /// info from web server
1.53 paf 229: Info& info;
1.81 paf 230: /// user's post data
1.145 paf 231: const char *post_data; size_t post_size;
1.53 paf 232:
1.134 paf 233: /// name of 'main' method
234: const String main_method_name;
235:
1.78 paf 236: /// operators are methods of this class
1.84 paf 237: Methoded& OP;
1.86 paf 238: /// $env:fields
1.57 paf 239: VEnv env;
1.108 paf 240: /// $status:fields
241: VStatus status;
1.86 paf 242: /// $form:elements
1.57 paf 243: VForm form;
1.140 paf 244: /// $mail
245: VMail mail;
1.90 parser 246: /// $math:constants
247: VMath math;
1.86 paf 248: /// $request:elements
1.57 paf 249: VRequest request;
1.86 paf 250: /// $response:elements
1.57 paf 251: VResponse response;
1.86 paf 252: /// $cookie:elements
1.60 paf 253: VCookie cookie;
1.70 paf 254:
1.148 ! paf 255: /// 'MAIN' class conglomerat
! 256: VStateless_class *main_class;
! 257:
! 258: /// classes configured data
! 259: Hash classes_conf;
! 260:
! 261: private:
! 262:
1.123 paf 263: //@{ request processing status
1.148 ! paf 264: /// exception stack trace
! 265: Stack exception_trace;
1.123 paf 266: /// execution stack
267: Stack stack;
1.61 paf 268: /// contexts
1.146 paf 269: Value *self;
270: VMethodFrame *method_frame;
271: Value *rcontext;
1.22 paf 272: WContext *wcontext;
1.148 ! paf 273: /// current language
! 274: uchar flang;
! 275: /// current connection
! 276: SQL_Connection *fconnection;
1.123 paf 277: //@}
1.85 paf 278:
1.148 ! paf 279: public: // status read methods
1.76 paf 280:
1.148 ! paf 281: Value *get_self() { return self; }
! 282: VMethodFrame *get_method_frame() { return method_frame; }
1.87 paf 283:
1.7 paf 284: private: // core data
1.6 paf 285:
1.89 parser 286: /// classes
1.6 paf 287: Hash fclasses;
1.67 paf 288:
1.89 parser 289: /// already used files to avoid cyclic uses
1.67 paf 290: Hash used_files;
1.89 parser 291:
292: /** endless execute(execute(... preventing counter
293: @see ANTI_ENDLESS_EXECUTE_RECOURSION
294: */
295: uint anti_endless_execute_recoursion;
1.136 paf 296:
297: private:
298:
299: /// already executed some @conf method
300: bool configure_admin_done;
301:
302: void configure_admin(VStateless_class& conf_class, const String *source);
1.99 parser 303:
1.7 paf 304: private: // compile.C
305:
1.46 paf 306: VStateless_class& real_compile(COMPILE_PARAMS);
1.7 paf 307:
308: private: // execute.C
309:
1.139 paf 310: /// for @postprocess[body]
311: const String& execute_method(VMethodFrame& amethodFrame, const Method& method);
312: //{ for @conf[filespec] and @auto[filespec]
313: void execute_method(Value& aself,
314: const Method& method, VString *optional_param,
1.137 paf 315: const String **return_string);
316: void execute_nonvirtual_method(VStateless_class& aclass,
1.139 paf 317: const String& method_name, VString *optional_param,
1.137 paf 318: const String **return_string,
319: const Method **return_method=0);
1.139 paf 320: //}
321: /// for @main[]
322: const String *execute_virtual_method(Value& aself, const String& method_name);
1.9 paf 323:
1.132 paf 324: Value *get_element(const String *& remember_name, bool can_call_operator);
1.22 paf 325:
1.58 paf 326: private: // defaults
327:
1.111 paf 328: const uchar fdefault_lang;
1.68 paf 329: Value *default_content_type;
1.80 paf 330:
331: private: // mime types
332:
333: /// $MAIN:MIME-TYPES
334: Table *mime_types;
1.22 paf 335:
1.39 paf 336: private: // lang manipulation
1.22 paf 337:
1.111 paf 338: uchar set_lang(uchar alang) {
339: uchar result=flang;
1.39 paf 340: flang=alang;
341: return result;
342: }
1.111 paf 343: void restore_lang(uchar alang) {
1.39 paf 344: flang=alang;
345: }
346:
1.117 paf 347: private: // connection manipulation
348:
349: SQL_Connection *set_connection(SQL_Connection *aconnection) {
350: SQL_Connection *result=fconnection;
351: fconnection=aconnection;
352: return result;
353: }
354: void restore_connection(SQL_Connection *aconnection) {
355: fconnection=aconnection;
356: }
357:
358: private:
359:
1.148 ! paf 360: void output_result(const VFile& body_file, bool header_only);
! 361: };
! 362:
! 363: /// Auto-object used to save request context across ^try body
! 364: class Request_context_saver {
! 365:
! 366: Request& fr;
! 367:
! 368: /// exception stack trace
! 369: int exception_trace;
! 370: /// execution stack
! 371: int stack;
! 372: /// contexts
! 373: Value *self;
! 374: VMethodFrame *method_frame;
! 375: Value *rcontext;
! 376: WContext *wcontext;
! 377: /// current language
! 378: uchar flang;
! 379: /// current connection
1.117 paf 380: SQL_Connection *fconnection;
1.126 paf 381:
1.148 ! paf 382: public:
! 383: Request_context_saver(Request& ar) :
! 384: exception_trace(ar.exception_trace.top_index()),
! 385: stack(ar.stack.top_index()),
! 386: self(ar.self),
! 387: method_frame(ar.method_frame),
! 388: rcontext(ar.rcontext),
! 389: wcontext(ar.wcontext),
! 390: flang(ar.flang),
! 391: fconnection(ar.fconnection),
! 392: fr(ar) {}
! 393: ~Request_context_saver() {
! 394: fr.exception_trace.top_index(exception_trace);
! 395: fr.stack.top_index(stack);
! 396: fr.self=self; fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
! 397: fr.flang=flang;
! 398: fr.fconnection=fconnection;
! 399: }
1.39 paf 400: };
401:
1.61 paf 402: /// Auto-object used for temporary changing Request::flang.
1.39 paf 403: class Temp_lang {
404: Request& frequest;
1.111 paf 405: uchar saved_lang;
1.39 paf 406: public:
1.111 paf 407: Temp_lang(Request& arequest, uchar alang) :
1.39 paf 408: frequest(arequest),
409: saved_lang(arequest.set_lang(alang)) {
410: }
411: ~Temp_lang() {
412: frequest.restore_lang(saved_lang);
1.117 paf 413: }
414: };
415:
416: /// Auto-object used for temporary changing Request::fconnection.
417: class Temp_connection {
418: Request& frequest;
419: SQL_Connection *saved_connection;
420: public:
421: Temp_connection(Request& arequest, SQL_Connection *aconnection) :
422: frequest(arequest),
423: saved_connection(arequest.set_connection(aconnection)) {
424: }
425: ~Temp_connection() {
426: frequest.restore_connection(saved_connection);
1.39 paf 427: }
1.91 parser 428: };
429:
430: /**
431: @b method parameters passed in this array.
432: contains handy typecast ad junction/not junction ensurers
433:
434: */
435: class MethodParams : public Array {
436: public:
437: MethodParams(Pool& pool, const String& amethod_name) : Array(pool),
438: fmethod_name(amethod_name) {
439: }
440:
441: /// handy typecast. I long for templates
442: Value& get(int index) {
443: return *static_cast<Value *>(Array::get(index));
444: }
445: /// handy is-value-a-junction ensurer
446: Value& as_junction(int index, const char *msg) {
447: return get_as(index, true, msg);
448: }
449: /// handy value-is-not-a-junction ensurer
450: Value& as_no_junction(int index, const char *msg) {
451: return get_as(index, false, msg);
452: }
453: /// handy expression auto-processing to double
1.102 parser 454: double as_double(int index, const char *msg, Request& r) {
455: return get_processed(index, msg, r).as_double();
1.91 parser 456: }
457: /// handy expression auto-processing to int
1.102 parser 458: int as_int(int index, const char *msg, Request& r) {
459: return get_processed(index, msg, r).as_int();
1.103 parser 460: }
461: /// handy expression auto-processing to bool
462: bool as_bool(int index, const char *msg, Request& r) {
463: return get_processed(index, msg, r).as_bool();
1.91 parser 464: }
465: /// handy string ensurer
466: const String& as_string(int index, const char *msg) {
467: return as_no_junction(index, msg).as_string();
468: }
469:
470: private:
471:
472: /// handy value-is/not-a-junction ensurer
473: Value& get_as(int index, bool as_junction, const char *msg) {
474: Value& result=get(index);
475: if((result.get_junction()!=0) ^ as_junction)
1.125 paf 476: throw Exception("parser.runtime",
1.91 parser 477: &fmethod_name,
478: "%s (parameter #%d)", msg, 1+index);
1.104 parser 479:
1.91 parser 480: return result;
481: }
482:
1.102 parser 483: Value& get_processed(int index, const char *msg, Request& r) {
1.126 paf 484: return r.process_to_value(as_junction(index, msg), 0/*no name*/);
1.91 parser 485: }
486:
487: private:
488:
489: const String& fmethod_name;
490:
1.4 paf 491: };
1.1 paf 492:
493: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_request.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include