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