Annotation of parser3/src/include/pa_request.h, revision 1.193
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.190 misha 4: Copyright (c) 2001-2009 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.193 ! misha 11: static const char * const IDENT_REQUEST_H="$Date: 2009-05-04 09:26:08 $";
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() {
1.191 misha 108: fused=fbottom=0;
1.162 paf 109: }
110:
111: bool is_empty() {
1.191 misha 112: return fused==fbottom;
1.162 paf 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.193 ! misha 124: HashString<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.192 misha 204: void op_call(VMethodFrame &frame);
205: void op_call_write(VMethodFrame &frame);
1.127 paf 206: /// execute ops with anti-recoursion check
1.162 paf 207: void recoursion_checked_execute(/*const String& name, */ArrayOperation& ops) {
1.128 paf 208: // anti_endless_execute_recoursion
209: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
210: anti_endless_execute_recoursion=0; // give @exception a chance
1.184 misha 211: throw Exception(PARSER_RUNTIME,
1.162 paf 212: 0, //&name,
1.128 paf 213: "call canceled - endless recursion detected");
214: }
1.147 paf 215: execute(ops); // execute it
1.128 paf 216: anti_endless_execute_recoursion--;
217: }
1.40 paf 218:
1.64 paf 219: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.162 paf 220: void use_file(VStateless_class& aclass,
1.94 parser 221: const String& file_name,
1.162 paf 222: const String* main_alias=0,
1.149 paf 223: bool ignore_class_path=false,
1.162 paf 224: bool fail_on_read_problem=true,
225: bool fail_on_file_absence=true); // pa_request.C
1.64 paf 226: /// compiles a @a source buffer
1.162 paf 227: void use_buf(VStateless_class& aclass,
228: const char* source,
229: const String* main_alias,
1.175 paf 230: uint file_no,
231: int line_no_offset=0); // pa_request.C
1.28 paf 232:
1.129 paf 233: /// processes any code-junction there may be inside of @a value
1.131 paf 234: StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
1.192 misha 235: void process_write(Value& input_value); // execute.C
1.129 paf 236: //@{ convinient helpers
237: const String& process_to_string(Value& input_value) {
238: return process(input_value, true/*intercept_string*/).as_string();
239: }
240: Value& process_to_value(Value& input_value, bool intercept_string=true) {
241: return process(input_value, intercept_string).as_value();
1.126 paf 242: }
243: //@}
1.131 paf 244:
1.126 paf 245:
1.131 paf 246: #define DEFINE_DUAL(modification) \
247: void write_##modification##_lang(StringOrValue dual) { \
1.162 paf 248: if(const String* string=dual.get_string()) \
1.131 paf 249: write_##modification##_lang(*string); \
250: else \
251: write_##modification##_lang(*dual.get_value()); \
252: }
253:
1.61 paf 254: /// appending, sure of clean string inside
1.65 paf 255: void write_no_lang(const String& astring) {
1.111 paf 256: wcontext->write(astring,
1.162 paf 257: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.49 paf 258: }
1.131 paf 259: /// appending sure value, that would be converted to clean string
260: void write_no_lang(Value& avalue) {
261: if(wcontext->get_in_expression())
262: wcontext->write(avalue);
263: else
264: wcontext->write(avalue,
1.162 paf 265: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.131 paf 266: }
267:
1.61 paf 268: /// appending string, passing language built into string being written
1.65 paf 269: void write_pass_lang(const String& astring) {
1.162 paf 270: wcontext->write(astring, String::L_PASS_APPENDED);
1.59 paf 271: }
1.131 paf 272: /// appending possible string, passing language built into string being written
273: void write_pass_lang(Value& avalue) {
1.162 paf 274: wcontext->write(avalue, String::L_PASS_APPENDED);
1.131 paf 275: }
276: DEFINE_DUAL(pass)
277:
1.61 paf 278: /// appending possible string, assigning untaint language
1.40 paf 279: void write_assign_lang(Value& avalue) {
1.39 paf 280: wcontext->write(avalue, flang);
1.106 parser 281: }
282: /// appending string, assigning untaint language
283: void write_assign_lang(const String& astring) {
284: wcontext->write(astring, flang);
1.22 paf 285: }
1.131 paf 286: DEFINE_DUAL(assign)
1.22 paf 287:
1.64 paf 288: /// returns relative to @a path path to @a file
1.162 paf 289: const String& relative(const char* apath, const String& relative_name);
1.61 paf 290:
1.64 paf 291: /// returns an absolute @a path to relative @a name
1.69 paf 292: const String& absolute(const String& relative_name);
1.42 paf 293:
1.80 paf 294: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 295: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 296:
1.117 paf 297: /// returns current SQL connection if any
1.162 paf 298: SQL_Connection* connection(bool fail_on_error=true) {
299: if(fail_on_error && !fconnection)
1.184 misha 300: throw Exception(PARSER_RUNTIME,
1.162 paf 301: 0,
1.117 paf 302: "outside of 'connect' operator");
303:
304: return fconnection;
1.133 paf 305: }
306:
1.162 paf 307: void set_interrupted(bool ainterrupted) { finterrupted=ainterrupted; }
308: bool get_interrupted() { return finterrupted; }
1.158 paf 309:
1.181 paf 310: void set_skip(Skip askip) { fskip=askip; }
311: Skip get_skip() { return fskip; }
312:
1.17 paf 313: public:
1.22 paf 314:
1.61 paf 315: /// info from web server
1.162 paf 316: Request_info& request_info;
317:
318: /// info about ServerAPI
319: SAPI_Info& sapi_info;
320:
321: /// source, client, mail charsets
322: Request_charsets charsets;
1.53 paf 323:
1.154 paf 324: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 325: VStateless_class& main_class;
1.86 paf 326: /// $form:elements
1.162 paf 327: VForm& form;
1.140 paf 328: /// $mail
1.162 paf 329: VMail& mail;
1.86 paf 330: /// $response:elements
1.162 paf 331: VResponse& response;
1.86 paf 332: /// $cookie:elements
1.162 paf 333: VCookie& cookie;
1.183 misha 334: /// $console
335: VConsole& console;
1.70 paf 336:
1.148 paf 337: /// classes configured data
1.193 ! misha 338: HashString<void*> classes_conf;
1.85 paf 339:
1.148 paf 340: public: // status read methods
1.76 paf 341:
1.148 paf 342: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 343: Value& get_self();
344: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
345: /* for strange reason call to this:
346: r.get_self<VHash>()
347: refuses to compile
1.87 paf 348:
1.162 paf 349: template<typename T> T& get_self() {
350: return *static_cast<T*>(get_self().get());
351: }
352: */
1.6 paf 353:
1.173 paf 354: /// for @main[]
355: const String* execute_virtual_method(Value& aself, const String& method_name);
356:
357: /// for @postprocess[body]
358: StringOrValue execute_method(VMethodFrame& amethodFrame, const Method& method);
359: //{ for @conf[filespec] and @auto[filespec] and parser://method/call
360: const String* execute_method(Value& aself,
1.190 misha 361: const Method& method, Value* optional_param,
1.173 paf 362: bool do_return_string);
363: struct Execute_nonvirtual_method_result {
364: const String* string;
365: Method* method;
366: Execute_nonvirtual_method_result(): string(0), method(0) {}
367: };
368: Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass,
1.185 misha 369: const String& method_name,
370: VString* optional_param,
1.173 paf 371: bool do_return_string);
372: //}
373:
1.162 paf 374: #ifdef XML
375: public: // charset helpers
1.67 paf 376:
1.162 paf 377: /// @see Charset::transcode
1.180 paf 378: xmlChar* transcode(const String& s);
1.162 paf 379: /// @see Charset::transcode
1.180 paf 380: xmlChar* transcode(const String::Body s);
1.162 paf 381: /// @see Charset::transcode
1.180 paf 382: const String& transcode(const xmlChar* s);
1.89 parser 383:
1.162 paf 384: #endif
1.136 paf 385:
386: private:
387:
388: /// already executed some @conf method
389: bool configure_admin_done;
390:
1.162 paf 391: void configure_admin(VStateless_class& conf_class);
1.177 paf 392:
393: void configure();
1.99 parser 394:
1.7 paf 395: private: // compile.C
396:
1.189 misha 397: ArrayClass& compile(VStateless_class* aclass,
1.162 paf 398: const char* source, const String* main_alias,
1.175 paf 399: uint file_no,
400: int line_no_offset);
1.7 paf 401:
402: private: // execute.C
1.9 paf 403:
1.190 misha 404: void put_element(Value& ncontext, const String& name, Value* value);
1.191 misha 405: Value& get_element(Value& ncontext, const String& name);
1.22 paf 406:
1.58 paf 407: private: // defaults
408:
1.162 paf 409: const String::Language fdefault_lang;
1.80 paf 410:
411: private: // mime types
412:
413: /// $MAIN:MIME-TYPES
414: Table *mime_types;
1.22 paf 415:
1.39 paf 416: private: // lang manipulation
1.22 paf 417:
1.162 paf 418: String::Language set_lang(String::Language alang) {
419: String::Language result=flang;
1.39 paf 420: flang=alang;
421: return result;
422: }
1.162 paf 423: void restore_lang(String::Language alang) {
1.39 paf 424: flang=alang;
425: }
426:
1.117 paf 427: private: // connection manipulation
428:
1.162 paf 429: SQL_Connection* set_connection(SQL_Connection* aconnection) {
430: SQL_Connection* result=fconnection;
1.117 paf 431: fconnection=aconnection;
432: return result;
433: }
1.162 paf 434: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 435: fconnection=aconnection;
436: }
437:
438: private:
439:
1.162 paf 440: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 441: };
442:
443: /// Auto-object used to save request context across ^try body
444: class Request_context_saver {
445: Request& fr;
446:
447: /// exception stack trace
1.165 paf 448: size_t exception_trace_top;
449: size_t exception_trace_bottom;
1.148 paf 450: /// execution stack
1.162 paf 451: size_t stack;
1.166 paf 452: uint anti_endless_execute_recoursion;
1.148 paf 453: /// contexts
1.162 paf 454: VMethodFrame* method_frame;
455: Value* rcontext;
456: WContext* wcontext;
1.148 paf 457: /// current language
1.162 paf 458: String::Language flang;
1.148 paf 459: /// current connection
1.162 paf 460: SQL_Connection* fconnection;
1.126 paf 461:
1.148 paf 462: public:
463: Request_context_saver(Request& ar) :
1.171 paf 464: fr(ar),
1.165 paf 465: exception_trace_top(ar.exception_trace.top_index()),
466: exception_trace_bottom(ar.exception_trace.bottom_index()),
467: stack(ar.stack.top_index()),
1.166 paf 468: anti_endless_execute_recoursion(ar.anti_endless_execute_recoursion),
1.148 paf 469: method_frame(ar.method_frame),
470: rcontext(ar.rcontext),
471: wcontext(ar.wcontext),
472: flang(ar.flang),
1.171 paf 473: fconnection(ar.fconnection) {}
1.153 paf 474: void restore() {
1.165 paf 475: fr.exception_trace.set_top_index(exception_trace_top);
476: fr.exception_trace.set_bottom_index(exception_trace_bottom);
477: fr.stack.set_top_index(stack);
1.166 paf 478: fr.anti_endless_execute_recoursion=anti_endless_execute_recoursion;
1.157 paf 479: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 480: fr.flang=flang;
481: fr.fconnection=fconnection;
482: }
1.39 paf 483: };
484:
1.61 paf 485: /// Auto-object used for temporary changing Request::flang.
1.39 paf 486: class Temp_lang {
487: Request& frequest;
1.162 paf 488: String::Language saved_lang;
1.39 paf 489: public:
1.162 paf 490: Temp_lang(Request& arequest, String::Language alang) :
1.39 paf 491: frequest(arequest),
492: saved_lang(arequest.set_lang(alang)) {
493: }
494: ~Temp_lang() {
495: frequest.restore_lang(saved_lang);
1.117 paf 496: }
497: };
498:
499: /// Auto-object used for temporary changing Request::fconnection.
500: class Temp_connection {
501: Request& frequest;
1.162 paf 502: SQL_Connection* saved_connection;
1.117 paf 503: public:
1.162 paf 504: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 505: frequest(arequest),
506: saved_connection(arequest.set_connection(aconnection)) {
507: }
508: ~Temp_connection() {
509: frequest.restore_connection(saved_connection);
1.39 paf 510: }
1.91 parser 511: };
512:
513:
1.162 paf 514: // defines for externs
1.91 parser 515:
1.187 misha 516: #define CONTENT_TRANSFER_ENCODING_NAME "content-transfer-encoding"
517: #define CONTENT_DISPOSITION_NAME "content-disposition"
1.185 misha 518: #define CONTENT_DISPOSITION_ATTACHMENT "attachment"
1.182 misha 519: #define CONTENT_DISPOSITION_INLINE "inline"
1.162 paf 520: #define CONTENT_DISPOSITION_FILENAME_NAME "filename"
1.186 misha 521:
1.170 paf 522: #define EXCEPTION_HANDLED_PART_NAME "handled"
523:
1.162 paf 524:
525: // externs
526:
527: extern const String main_method_name;
528: extern const String auto_method_name;
529: extern const String body_name;
1.186 misha 530:
1.187 misha 531: extern const String content_transfer_encoding_name;
1.162 paf 532: extern const String content_disposition_name;
1.185 misha 533: extern const String content_disposition_attachment;
1.182 misha 534: extern const String content_disposition_inline;
1.162 paf 535: extern const String content_disposition_filename_name;
536:
537: extern const String exception_type_part_name;
538: extern const String exception_source_part_name;
539: extern const String exception_comment_part_name;
540: extern const String exception_handled_part_name;
1.91 parser 541:
1.162 paf 542: // defines for statics
1.91 parser 543:
1.162 paf 544: #define MAIN_CLASS_NAME "MAIN"
545: #define AUTO_FILE_NAME "auto.p"
1.1 paf 546:
547: #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