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