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