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