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