Annotation of parser3/src/include/pa_request.h, revision 1.226
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.226 ! moko 11: #define IDENT_PA_REQUEST_H "$Id: pa_request.h,v 1.225 2016/07/20 17:01: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.226 ! moko 290: /// appending sure value
! 291: void write_value(Value& avalue) {
! 292: wcontext->write(avalue);
! 293: }
! 294:
1.64 paf 295: /// returns relative to @a path path to @a file
1.162 paf 296: const String& relative(const char* apath, const String& relative_name);
1.61 paf 297:
1.64 paf 298: /// returns an absolute @a path to relative @a name
1.69 paf 299: const String& absolute(const String& relative_name);
1.42 paf 300:
1.209 misha 301: /// returns the mime type of 'user_file_name'
302: const String& mime_type_of(const String* file_name);
303:
1.80 paf 304: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 305: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 306:
1.117 paf 307: /// returns current SQL connection if any
1.162 paf 308: SQL_Connection* connection(bool fail_on_error=true) {
309: if(fail_on_error && !fconnection)
1.184 misha 310: throw Exception(PARSER_RUNTIME,
1.162 paf 311: 0,
1.117 paf 312: "outside of 'connect' operator");
313:
314: return fconnection;
1.133 paf 315: }
316:
1.162 paf 317: void set_interrupted(bool ainterrupted) { finterrupted=ainterrupted; }
318: bool get_interrupted() { return finterrupted; }
1.158 paf 319:
1.181 paf 320: void set_skip(Skip askip) { fskip=askip; }
321: Skip get_skip() { return fskip; }
322:
1.196 misha 323: void set_in_cycle(int adelta) { fin_cycle+=adelta; }
324: bool get_in_cycle() { return fin_cycle>0; }
325:
1.17 paf 326: public:
1.22 paf 327:
1.61 paf 328: /// info from web server
1.162 paf 329: Request_info& request_info;
330:
331: /// info about ServerAPI
332: SAPI_Info& sapi_info;
333:
334: /// source, client, mail charsets
335: Request_charsets charsets;
1.53 paf 336:
1.154 paf 337: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 338: VStateless_class& main_class;
1.86 paf 339: /// $form:elements
1.162 paf 340: VForm& form;
1.140 paf 341: /// $mail
1.162 paf 342: VMail& mail;
1.86 paf 343: /// $response:elements
1.162 paf 344: VResponse& response;
1.86 paf 345: /// $cookie:elements
1.162 paf 346: VCookie& cookie;
1.183 misha 347: /// $console
348: VConsole& console;
1.70 paf 349:
1.148 paf 350: /// classes configured data
1.193 misha 351: HashString<void*> classes_conf;
1.85 paf 352:
1.148 paf 353: public: // status read methods
1.76 paf 354:
1.148 paf 355: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 356: Value& get_self();
357: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
358: /* for strange reason call to this:
359: r.get_self<VHash>()
360: refuses to compile
1.87 paf 361:
1.162 paf 362: template<typename T> T& get_self() {
363: return *static_cast<T*>(get_self().get());
364: }
365: */
1.6 paf 366:
1.205 moko 367: /// public for ^reflection:copy[]
368: void put_element(Value& ncontext, const String& name, Value* value);
369:
1.173 paf 370: /// for @main[]
371: const String* execute_virtual_method(Value& aself, const String& method_name);
372:
1.204 moko 373: /// executes parser method, use op_call(frame) to execute native method
374: void execute_method(VMethodFrame& aframe);
375:
1.173 paf 376: //{ for @conf[filespec] and @auto[filespec] and parser://method/call
377: const String* execute_method(Value& aself,
1.190 misha 378: const Method& method, Value* optional_param,
1.173 paf 379: bool do_return_string);
380: struct Execute_nonvirtual_method_result {
381: const String* string;
382: Method* method;
383: Execute_nonvirtual_method_result(): string(0), method(0) {}
384: };
385: Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass,
1.185 misha 386: const String& method_name,
387: VString* optional_param,
1.173 paf 388: bool do_return_string);
389: //}
390:
1.162 paf 391: #ifdef XML
392: public: // charset helpers
1.67 paf 393:
1.162 paf 394: /// @see Charset::transcode
1.180 paf 395: xmlChar* transcode(const String& s);
1.162 paf 396: /// @see Charset::transcode
1.180 paf 397: xmlChar* transcode(const String::Body s);
1.162 paf 398: /// @see Charset::transcode
1.180 paf 399: const String& transcode(const xmlChar* s);
1.89 parser 400:
1.162 paf 401: #endif
1.136 paf 402:
403: private:
404:
405: /// already executed some @conf method
406: bool configure_admin_done;
407:
1.162 paf 408: void configure_admin(VStateless_class& conf_class);
1.177 paf 409:
410: void configure();
1.99 parser 411:
1.7 paf 412: private: // compile.C
413:
1.189 misha 414: ArrayClass& compile(VStateless_class* aclass,
1.162 paf 415: const char* source, const String* main_alias,
1.175 paf 416: uint file_no,
417: int line_no_offset);
1.7 paf 418:
419: private: // execute.C
1.9 paf 420:
1.191 misha 421: Value& get_element(Value& ncontext, const String& name);
1.219 moko 422: #ifdef FEATURE_GET_ELEMENT4CALL
423: Value& get_element4call(Value& ncontext, const String& name);
424: #endif
1.22 paf 425:
1.58 paf 426: private: // defaults
427:
1.162 paf 428: const String::Language fdefault_lang;
1.80 paf 429:
430: private: // mime types
431:
432: /// $MAIN:MIME-TYPES
433: Table *mime_types;
1.22 paf 434:
1.39 paf 435: private: // lang manipulation
1.22 paf 436:
1.162 paf 437: String::Language set_lang(String::Language alang) {
438: String::Language result=flang;
1.39 paf 439: flang=alang;
440: return result;
441: }
1.162 paf 442: void restore_lang(String::Language alang) {
1.39 paf 443: flang=alang;
444: }
445:
1.117 paf 446: private: // connection manipulation
447:
1.162 paf 448: SQL_Connection* set_connection(SQL_Connection* aconnection) {
449: SQL_Connection* result=fconnection;
1.117 paf 450: fconnection=aconnection;
451: return result;
452: }
1.162 paf 453: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 454: fconnection=aconnection;
455: }
456:
457: private:
458:
1.162 paf 459: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 460: };
461:
462: /// Auto-object used to save request context across ^try body
463: class Request_context_saver {
464: Request& fr;
465:
466: /// exception stack trace
1.165 paf 467: size_t exception_trace_top;
468: size_t exception_trace_bottom;
1.148 paf 469: /// execution stack
1.162 paf 470: size_t stack;
1.166 paf 471: uint anti_endless_execute_recoursion;
1.148 paf 472: /// contexts
1.162 paf 473: VMethodFrame* method_frame;
474: Value* rcontext;
475: WContext* wcontext;
1.148 paf 476: /// current language
1.162 paf 477: String::Language flang;
1.148 paf 478: /// current connection
1.162 paf 479: SQL_Connection* fconnection;
1.126 paf 480:
1.148 paf 481: public:
482: Request_context_saver(Request& ar) :
1.171 paf 483: fr(ar),
1.165 paf 484: exception_trace_top(ar.exception_trace.top_index()),
485: exception_trace_bottom(ar.exception_trace.bottom_index()),
486: stack(ar.stack.top_index()),
1.166 paf 487: anti_endless_execute_recoursion(ar.anti_endless_execute_recoursion),
1.148 paf 488: method_frame(ar.method_frame),
489: rcontext(ar.rcontext),
490: wcontext(ar.wcontext),
491: flang(ar.flang),
1.171 paf 492: fconnection(ar.fconnection) {}
1.153 paf 493: void restore() {
1.165 paf 494: fr.exception_trace.set_top_index(exception_trace_top);
495: fr.exception_trace.set_bottom_index(exception_trace_bottom);
496: fr.stack.set_top_index(stack);
1.166 paf 497: fr.anti_endless_execute_recoursion=anti_endless_execute_recoursion;
1.157 paf 498: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 499: fr.flang=flang;
500: fr.fconnection=fconnection;
501: }
1.39 paf 502: };
503:
1.61 paf 504: /// Auto-object used for temporary changing Request::flang.
1.39 paf 505: class Temp_lang {
506: Request& frequest;
1.162 paf 507: String::Language saved_lang;
1.39 paf 508: public:
1.162 paf 509: Temp_lang(Request& arequest, String::Language alang) :
1.39 paf 510: frequest(arequest),
511: saved_lang(arequest.set_lang(alang)) {
512: }
513: ~Temp_lang() {
514: frequest.restore_lang(saved_lang);
1.117 paf 515: }
516: };
517:
518: /// Auto-object used for temporary changing Request::fconnection.
519: class Temp_connection {
520: Request& frequest;
1.162 paf 521: SQL_Connection* saved_connection;
1.117 paf 522: public:
1.162 paf 523: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 524: frequest(arequest),
525: saved_connection(arequest.set_connection(aconnection)) {
526: }
527: ~Temp_connection() {
528: frequest.restore_connection(saved_connection);
1.39 paf 529: }
1.91 parser 530: };
531:
1.196 misha 532: /// Auto-object used for break out of cycle check
533: class InCycle {
534: Request& frequest;
535: public:
536: InCycle(Request& arequest) : frequest(arequest) {
537: frequest.set_in_cycle(1);
538: }
539: ~InCycle() {
540: frequest.set_in_cycle(-1);
541: }
542: };
1.91 parser 543:
1.213 moko 544: /// Auto-object used for temporary changing Request::allow_class_replace.
545: class Temp_class_replace {
546: Request& frequest;
547: public:
548: Temp_class_replace(Request& arequest, bool avalue) : frequest(arequest){
549: frequest.allow_class_replace=avalue;
550: }
551: ~Temp_class_replace() {
552: frequest.allow_class_replace=false;
553: }
554: };
555:
1.214 moko 556: /// Auto-object used for temporarily substituting/removing elements
557: class Temp_value_element {
558: Request& frequest;
559: Value& fwhere;
560: const String& fname;
1.216 moko 561: Value* saved;
1.214 moko 562: public:
1.216 moko 563: Temp_value_element(Request& arequest, Value& awhere, const String& aname, Value* awhat);
564: ~Temp_value_element();
1.214 moko 565: };
566:
1.162 paf 567: // defines for externs
1.91 parser 568:
1.170 paf 569: #define EXCEPTION_HANDLED_PART_NAME "handled"
570:
1.162 paf 571:
572: // externs
573:
574: extern const String main_method_name;
575: extern const String auto_method_name;
1.186 misha 576:
1.162 paf 577: extern const String exception_type_part_name;
578: extern const String exception_source_part_name;
579: extern const String exception_comment_part_name;
580: extern const String exception_handled_part_name;
1.91 parser 581:
1.162 paf 582: // defines for statics
1.91 parser 583:
1.162 paf 584: #define MAIN_CLASS_NAME "MAIN"
585: #define AUTO_FILE_NAME "auto.p"
1.1 paf 586:
587: #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