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