Annotation of parser3/src/include/pa_request.h, revision 1.186
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.179 paf 4: Copyright (c) 2001-2005 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.186 ! misha 11: static const char * const IDENT_REQUEST_H="$Date: 2007/10/22 13:44:42 $";
1.1 paf 12:
1.168 paf 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.162 paf 18: #include "pa_request_info.h"
19: #include "pa_request_charsets.h"
20: #include "pa_sapi.h"
1.183 misha 21: #include "pa_vconsole.h"
1.44 paf 22:
1.112 paf 23: #ifdef RESOURCES_DEBUG
24: #include <sys/resource.h>
25: #endif
26:
1.128 paf 27: // consts
28:
1.161 paf 29: const uint ANTI_ENDLESS_EXECUTE_RECOURSION=1000;
1.162 paf 30: const size_t pseudo_file_no__process=1;
1.128 paf 31:
1.162 paf 32: // forwards
1.4 paf 33:
1.39 paf 34: class Temp_lang;
1.84 paf 35: class Methoded;
1.116 paf 36: class VMethodFrame;
1.162 paf 37: class VMail;
38: class VForm;
39: class VResponse;
40: class VCookie;
41: class VStateless_class;
1.1 paf 42:
1.61 paf 43: /// Main workhorse.
1.162 paf 44: class Request: public PA_Object {
1.107 paf 45: friend class Temp_lang;
1.117 paf 46: friend class Temp_connection;
1.148 paf 47: friend class Request_context_saver;
1.155 paf 48: friend class Temp_request_self;
1.162 paf 49: friend class Exception_trace;
50:
1.1 paf 51: public:
1.162 paf 52: class Trace {
53: const String* fname;
54: Operation::Origin forigin;
55: public:
56: Trace(): fname(0) {}
57: void clear() { fname=0; }
58: operator bool() const { return fname!=0; }
59:
60: Trace(const String* aname, const Operation::Origin aorigin):
61: fname(aname), forigin(aorigin) {}
62:
63: const String* name() const { return fname; }
64: const Operation::Origin origin() const { return forigin; }
65: };
66:
1.181 paf 67: enum Skip {
68: SKIP_NOTHING,
69: SKIP_BREAK,
70: SKIP_CONTINUE
71: };
72:
1.168 paf 73: private:
74: Pool fpool;
75: public:
76: Pool& pool() { return fpool; }
1.162 paf 77:
78: private:
79: union StackItem {
80: Value* fvalue;
81: ArrayOperation* fops;
82: VMethodFrame* fmethod_frame;
83: public:
84: Value& value() const { return *fvalue; }
85: const String& string() const {
1.167 paf 86: return fvalue->as_string();
1.162 paf 87: }
88: ArrayOperation& ops() const { return *fops; }
89: VMethodFrame& method_frame() const { return *fmethod_frame; }
90:
91: /// needed to fill unused Array entries
92: StackItem() {}
93: StackItem(Value& avalue): fvalue(&avalue) {}
94: StackItem(ArrayOperation& aops): fops(&aops) {}
95: StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {}
96: };
97:
98: class Exception_trace: public Stack<Trace> {
99: size_t fbottom;
100: public:
101: Exception_trace(): fbottom(0) {}
102:
103: size_t bottom_index() { return fbottom; }
1.165 paf 104: void set_bottom_index(size_t abottom) { fbottom=abottom; }
1.162 paf 105: element_type bottom_value() { return get(bottom_index()); }
106:
107: void clear() {
108: ftop=fbottom=0;
109: }
110:
111: bool is_empty() {
112: return ftop==fbottom;
113: }
114:
115: const element_type extract_origin(const String*& problem_source);
116: };
117:
118: ///@{ core data
119:
120: /// classes
121: HashStringValue fclasses;
122:
123: /// already used files to avoid cyclic uses
1.163 paf 124: Hash<const String::Body, bool> used_files;
1.162 paf 125: /// list of all used files, Operation::file_no = index to it
1.163 paf 126: Array<String::Body> file_list;
1.162 paf 127:
128: /** endless execute(execute(... preventing counter
129: @see ANTI_ENDLESS_EXECUTE_RECOURSION
130: */
131: uint anti_endless_execute_recoursion;
132:
133: ///@}
134:
135: /// execution stack
136: Stack<StackItem> stack;
137:
138: /// exception stack trace
139: Exception_trace exception_trace;
140: public:
141:
142: //@{ request processing status
143: /// contexts
144: VMethodFrame* method_frame;
145: Value* rcontext;
146: WContext* wcontext;
147: /// current language
148: String::Language flang;
149: /// current connection
150: SQL_Connection* fconnection;
151: //@}
152: /// interrupted flag, raised on signals [SIGPIPE]
153: bool finterrupted;
1.181 paf 154: Skip fskip;
1.162 paf 155:
156: public:
1.175 paf 157: uint register_file(String::Body file_spec);
1.162 paf 158:
159: struct Exception_details {
160: const Trace trace;
161: const String* problem_source;
162: VHash& vhash;
163:
164: Exception_details(
165: const Trace atrace,
166: const String* aproblem_source,
1.166 paf 167: VHash& avhash): trace(atrace), problem_source(aproblem_source), vhash(avhash) {}
1.162 paf 168: };
169: Exception_details get_details(const Exception& e);
1.176 paf 170: const char* get_exception_cstr(const Exception& e, Exception_details& details);
1.162 paf 171:
172: /// @see Stack::wipe_unused
173: void wipe_unused_execution_stack() {
174: stack.wipe_unused();
175: }
1.112 paf 176:
177: #ifdef RESOURCES_DEBUG
178: /// measures
179: double sql_connect_time;
180: double sql_request_time;
181: #endif
1.61 paf 182:
1.162 paf 183: Request(SAPI_Info& asapi_info, Request_info& arequest_info,
184: String::Language adefault_lang, ///< all tainted data default untainting lang
1.110 paf 185: bool status_allowed ///< status class allowed
1.50 paf 186: );
1.118 paf 187: ~Request();
1.1 paf 188:
1.61 paf 189: /// global classes
1.162 paf 190: HashStringValue& classes() { return fclasses; }
1.6 paf 191:
1.65 paf 192: /**
193: core request processing
194:
195: BEWARE: may throw exception to you: catch it!
196: */
197: void core(
1.162 paf 198: const char* config_filespec, ///< system config filespec
1.138 paf 199: bool config_fail_on_read_problem, ///< fail if system config file not found
1.65 paf 200: bool header_only);
1.17 paf 201:
1.61 paf 202: /// executes ops
1.162 paf 203: void execute(ArrayOperation& ops); // execute.C
1.127 paf 204: /// execute ops with anti-recoursion check
1.162 paf 205: void recoursion_checked_execute(/*const String& name, */ArrayOperation& ops) {
1.128 paf 206: // anti_endless_execute_recoursion
207: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
208: anti_endless_execute_recoursion=0; // give @exception a chance
1.184 misha 209: throw Exception(PARSER_RUNTIME,
1.162 paf 210: 0, //&name,
1.128 paf 211: "call canceled - endless recursion detected");
212: }
1.147 paf 213: execute(ops); // execute it
1.128 paf 214: anti_endless_execute_recoursion--;
215: }
1.40 paf 216:
1.64 paf 217: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.162 paf 218: void use_file(VStateless_class& aclass,
1.94 parser 219: const String& file_name,
1.162 paf 220: const String* main_alias=0,
1.149 paf 221: bool ignore_class_path=false,
1.162 paf 222: bool fail_on_read_problem=true,
223: bool fail_on_file_absence=true); // pa_request.C
1.64 paf 224: /// compiles a @a source buffer
1.162 paf 225: void use_buf(VStateless_class& aclass,
226: const char* source,
227: const String* main_alias,
1.175 paf 228: uint file_no,
229: int line_no_offset=0); // pa_request.C
1.28 paf 230:
1.129 paf 231: /// processes any code-junction there may be inside of @a value
1.131 paf 232: StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
1.129 paf 233: //@{ convinient helpers
234: const String& process_to_string(Value& input_value) {
235: return process(input_value, true/*intercept_string*/).as_string();
236: }
237: Value& process_to_value(Value& input_value, bool intercept_string=true) {
238: return process(input_value, intercept_string).as_value();
1.126 paf 239: }
240: //@}
1.131 paf 241:
1.126 paf 242:
1.131 paf 243: #define DEFINE_DUAL(modification) \
244: void write_##modification##_lang(StringOrValue dual) { \
1.162 paf 245: if(const String* string=dual.get_string()) \
1.131 paf 246: write_##modification##_lang(*string); \
247: else \
248: write_##modification##_lang(*dual.get_value()); \
249: }
250:
1.61 paf 251: /// appending, sure of clean string inside
1.65 paf 252: void write_no_lang(const String& astring) {
1.111 paf 253: wcontext->write(astring,
1.162 paf 254: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.49 paf 255: }
1.131 paf 256: /// appending sure value, that would be converted to clean string
257: void write_no_lang(Value& avalue) {
258: if(wcontext->get_in_expression())
259: wcontext->write(avalue);
260: else
261: wcontext->write(avalue,
1.162 paf 262: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.131 paf 263: }
264:
1.61 paf 265: /// appending string, passing language built into string being written
1.65 paf 266: void write_pass_lang(const String& astring) {
1.162 paf 267: wcontext->write(astring, String::L_PASS_APPENDED);
1.59 paf 268: }
1.131 paf 269: /// appending possible string, passing language built into string being written
270: void write_pass_lang(Value& avalue) {
1.162 paf 271: wcontext->write(avalue, String::L_PASS_APPENDED);
1.131 paf 272: }
273: DEFINE_DUAL(pass)
274:
1.61 paf 275: /// appending possible string, assigning untaint language
1.40 paf 276: void write_assign_lang(Value& avalue) {
1.39 paf 277: wcontext->write(avalue, flang);
1.106 parser 278: }
279: /// appending string, assigning untaint language
280: void write_assign_lang(const String& astring) {
281: wcontext->write(astring, flang);
1.22 paf 282: }
1.131 paf 283: DEFINE_DUAL(assign)
1.22 paf 284:
1.64 paf 285: /// returns relative to @a path path to @a file
1.162 paf 286: const String& relative(const char* apath, const String& relative_name);
1.61 paf 287:
1.64 paf 288: /// returns an absolute @a path to relative @a name
1.69 paf 289: const String& absolute(const String& relative_name);
1.42 paf 290:
1.80 paf 291: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 292: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 293:
1.117 paf 294: /// returns current SQL connection if any
1.162 paf 295: SQL_Connection* connection(bool fail_on_error=true) {
296: if(fail_on_error && !fconnection)
1.184 misha 297: throw Exception(PARSER_RUNTIME,
1.162 paf 298: 0,
1.117 paf 299: "outside of 'connect' operator");
300:
301: return fconnection;
1.133 paf 302: }
303:
1.162 paf 304: void set_interrupted(bool ainterrupted) { finterrupted=ainterrupted; }
305: bool get_interrupted() { return finterrupted; }
1.158 paf 306:
1.181 paf 307: void set_skip(Skip askip) { fskip=askip; }
308: Skip get_skip() { return fskip; }
309:
1.17 paf 310: public:
1.22 paf 311:
1.61 paf 312: /// info from web server
1.162 paf 313: Request_info& request_info;
314:
315: /// info about ServerAPI
316: SAPI_Info& sapi_info;
317:
318: /// source, client, mail charsets
319: Request_charsets charsets;
1.53 paf 320:
1.154 paf 321: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 322: VStateless_class& main_class;
1.86 paf 323: /// $form:elements
1.162 paf 324: VForm& form;
1.140 paf 325: /// $mail
1.162 paf 326: VMail& mail;
1.86 paf 327: /// $response:elements
1.162 paf 328: VResponse& response;
1.86 paf 329: /// $cookie:elements
1.162 paf 330: VCookie& cookie;
1.183 misha 331: /// $console
332: VConsole& console;
1.70 paf 333:
1.148 paf 334: /// classes configured data
1.169 paf 335: Hash<const String::Body, void*> classes_conf;
1.85 paf 336:
1.148 paf 337: public: // status read methods
1.76 paf 338:
1.148 paf 339: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 340: Value& get_self();
341: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
342: /* for strange reason call to this:
343: r.get_self<VHash>()
344: refuses to compile
1.87 paf 345:
1.162 paf 346: template<typename T> T& get_self() {
347: return *static_cast<T*>(get_self().get());
348: }
349: */
1.6 paf 350:
1.173 paf 351: /// for @main[]
352: const String* execute_virtual_method(Value& aself, const String& method_name);
353:
354: /// for @postprocess[body]
355: StringOrValue execute_method(VMethodFrame& amethodFrame, const Method& method);
356: //{ for @conf[filespec] and @auto[filespec] and parser://method/call
357: const String* execute_method(Value& aself,
358: const Method& method, VString* optional_param,
359: bool do_return_string);
360: struct Execute_nonvirtual_method_result {
361: const String* string;
362: Method* method;
363: Execute_nonvirtual_method_result(): string(0), method(0) {}
364: };
365: Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass,
1.185 misha 366: const String& method_name,
367: VString* optional_param,
1.173 paf 368: bool do_return_string);
369: //}
370:
1.162 paf 371: #ifdef XML
372: public: // charset helpers
1.67 paf 373:
1.162 paf 374: /// @see Charset::transcode
1.180 paf 375: xmlChar* transcode(const String& s);
1.162 paf 376: /// @see Charset::transcode
1.180 paf 377: xmlChar* transcode(const String::Body s);
1.162 paf 378: /// @see Charset::transcode
1.180 paf 379: const String& transcode(const xmlChar* s);
1.89 parser 380:
1.162 paf 381: #endif
1.136 paf 382:
383: private:
384:
385: /// already executed some @conf method
386: bool configure_admin_done;
387:
1.162 paf 388: void configure_admin(VStateless_class& conf_class);
1.177 paf 389:
390: void configure();
1.99 parser 391:
1.7 paf 392: private: // compile.C
393:
1.162 paf 394: VStateless_class& compile(VStateless_class* aclass,
395: const char* source, const String* main_alias,
1.175 paf 396: uint file_no,
397: int line_no_offset);
1.7 paf 398:
399: private: // execute.C
1.9 paf 400:
1.178 paf 401: void put_element(Value& ncontext, const String& name, Value& value);
1.162 paf 402: Value& get_element(Value& ncontext, const String& name, bool can_call_operator);
1.22 paf 403:
1.58 paf 404: private: // defaults
405:
1.162 paf 406: const String::Language fdefault_lang;
1.80 paf 407:
408: private: // mime types
409:
410: /// $MAIN:MIME-TYPES
411: Table *mime_types;
1.22 paf 412:
1.39 paf 413: private: // lang manipulation
1.22 paf 414:
1.162 paf 415: String::Language set_lang(String::Language alang) {
416: String::Language result=flang;
1.39 paf 417: flang=alang;
418: return result;
419: }
1.162 paf 420: void restore_lang(String::Language alang) {
1.39 paf 421: flang=alang;
422: }
423:
1.117 paf 424: private: // connection manipulation
425:
1.162 paf 426: SQL_Connection* set_connection(SQL_Connection* aconnection) {
427: SQL_Connection* result=fconnection;
1.117 paf 428: fconnection=aconnection;
429: return result;
430: }
1.162 paf 431: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 432: fconnection=aconnection;
433: }
434:
435: private:
436:
1.162 paf 437: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 438: };
439:
440: /// Auto-object used to save request context across ^try body
441: class Request_context_saver {
442: Request& fr;
443:
444: /// exception stack trace
1.165 paf 445: size_t exception_trace_top;
446: size_t exception_trace_bottom;
1.148 paf 447: /// execution stack
1.162 paf 448: size_t stack;
1.166 paf 449: uint anti_endless_execute_recoursion;
1.148 paf 450: /// contexts
1.162 paf 451: VMethodFrame* method_frame;
452: Value* rcontext;
453: WContext* wcontext;
1.148 paf 454: /// current language
1.162 paf 455: String::Language flang;
1.148 paf 456: /// current connection
1.162 paf 457: SQL_Connection* fconnection;
1.126 paf 458:
1.148 paf 459: public:
460: Request_context_saver(Request& ar) :
1.171 paf 461: fr(ar),
1.165 paf 462: exception_trace_top(ar.exception_trace.top_index()),
463: exception_trace_bottom(ar.exception_trace.bottom_index()),
464: stack(ar.stack.top_index()),
1.166 paf 465: anti_endless_execute_recoursion(ar.anti_endless_execute_recoursion),
1.148 paf 466: method_frame(ar.method_frame),
467: rcontext(ar.rcontext),
468: wcontext(ar.wcontext),
469: flang(ar.flang),
1.171 paf 470: fconnection(ar.fconnection) {}
1.153 paf 471: void restore() {
1.165 paf 472: fr.exception_trace.set_top_index(exception_trace_top);
473: fr.exception_trace.set_bottom_index(exception_trace_bottom);
474: fr.stack.set_top_index(stack);
1.166 paf 475: fr.anti_endless_execute_recoursion=anti_endless_execute_recoursion;
1.157 paf 476: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 477: fr.flang=flang;
478: fr.fconnection=fconnection;
479: }
1.39 paf 480: };
481:
1.61 paf 482: /// Auto-object used for temporary changing Request::flang.
1.39 paf 483: class Temp_lang {
484: Request& frequest;
1.162 paf 485: String::Language saved_lang;
1.39 paf 486: public:
1.162 paf 487: Temp_lang(Request& arequest, String::Language alang) :
1.39 paf 488: frequest(arequest),
489: saved_lang(arequest.set_lang(alang)) {
490: }
491: ~Temp_lang() {
492: frequest.restore_lang(saved_lang);
1.117 paf 493: }
494: };
495:
496: /// Auto-object used for temporary changing Request::fconnection.
497: class Temp_connection {
498: Request& frequest;
1.162 paf 499: SQL_Connection* saved_connection;
1.117 paf 500: public:
1.162 paf 501: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 502: frequest(arequest),
503: saved_connection(arequest.set_connection(aconnection)) {
504: }
505: ~Temp_connection() {
506: frequest.restore_connection(saved_connection);
1.39 paf 507: }
1.91 parser 508: };
509:
510:
1.162 paf 511: // defines for externs
1.91 parser 512:
1.186 ! misha 513: #define CONTENT_TRANSFER_ENCODING_NAME "Content-Transfer-Encoding"
! 514: #define CONTENT_DISPOSITION_NAME "Content-Disposition"
1.185 misha 515: #define CONTENT_DISPOSITION_ATTACHMENT "attachment"
1.182 misha 516: #define CONTENT_DISPOSITION_INLINE "inline"
1.162 paf 517: #define CONTENT_DISPOSITION_FILENAME_NAME "filename"
1.186 ! misha 518:
1.170 paf 519: #define EXCEPTION_HANDLED_PART_NAME "handled"
520:
1.162 paf 521:
522: // externs
523:
524: extern const String main_method_name;
525: extern const String auto_method_name;
526: extern const String body_name;
1.186 ! misha 527:
1.162 paf 528: extern const String content_disposition_name;
1.185 misha 529: extern const String content_disposition_attachment;
1.182 misha 530: extern const String content_disposition_inline;
1.162 paf 531: extern const String content_disposition_filename_name;
532:
533: extern const String exception_type_part_name;
534: extern const String exception_source_part_name;
535: extern const String exception_comment_part_name;
536: extern const String exception_handled_part_name;
1.91 parser 537:
1.162 paf 538: // defines for statics
1.91 parser 539:
1.162 paf 540: #define MAIN_CLASS_NAME "MAIN"
541: #define AUTO_FILE_NAME "auto.p"
1.1 paf 542:
543: #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