Annotation of parser3/src/include/pa_request.h, revision 1.212
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.212 ! moko 11: #define IDENT_PA_REQUEST_H "$Id: pa_request.h,v 1.211 2013/07/23 14:29:02 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.183 misha 21: #include "pa_vconsole.h"
1.44 paf 22:
1.128 paf 23: // consts
24:
1.161 paf 25: const uint ANTI_ENDLESS_EXECUTE_RECOURSION=1000;
1.162 paf 26: const size_t pseudo_file_no__process=1;
1.128 paf 27:
1.162 paf 28: // forwards
1.4 paf 29:
1.39 paf 30: class Temp_lang;
1.84 paf 31: class Methoded;
1.116 paf 32: class VMethodFrame;
1.162 paf 33: class VMail;
34: class VForm;
35: class VResponse;
36: class VCookie;
37: class VStateless_class;
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.148 paf 43: friend class Request_context_saver;
1.155 paf 44: friend class Temp_request_self;
1.162 paf 45: friend class Exception_trace;
46:
1.1 paf 47: public:
1.162 paf 48: class Trace {
49: const String* fname;
50: Operation::Origin forigin;
51: public:
52: Trace(): fname(0) {}
53: void clear() { fname=0; }
54: operator bool() const { return 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: const element_type extract_origin(const String*& problem_source);
112: };
113:
114: ///@{ core data
115:
116: /// classes
1.195 misha 117: HashString<Value*> 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:
125: /** endless execute(execute(... preventing counter
126: @see ANTI_ENDLESS_EXECUTE_RECOURSION
127: */
128: uint anti_endless_execute_recoursion;
129:
130: ///@}
131:
132: /// execution stack
133: Stack<StackItem> stack;
134:
135: /// exception stack trace
136: Exception_trace exception_trace;
137: public:
138:
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 {
158: const Trace trace;
159: const String* problem_source;
160: VHash& vhash;
161:
162: Exception_details(
163: const Trace atrace,
164: const String* aproblem_source,
1.166 paf 165: VHash& avhash): trace(atrace), problem_source(aproblem_source), vhash(avhash) {}
1.162 paf 166: };
167: Exception_details get_details(const Exception& e);
1.176 paf 168: const char* get_exception_cstr(const Exception& e, Exception_details& details);
1.162 paf 169:
170: /// @see Stack::wipe_unused
171: void wipe_unused_execution_stack() {
172: stack.wipe_unused();
173: }
1.112 paf 174:
175: #ifdef RESOURCES_DEBUG
176: /// measures
177: double sql_connect_time;
178: double sql_request_time;
179: #endif
1.61 paf 180:
1.162 paf 181: Request(SAPI_Info& asapi_info, Request_info& arequest_info,
1.208 moko 182: String::Language adefault_lang ///< all tainted data default untainting lang
1.50 paf 183: );
1.118 paf 184: ~Request();
1.1 paf 185:
1.61 paf 186: /// global classes
1.195 misha 187: HashString<Value*>& classes() { return fclasses; }
1.197 misha 188: Value* get_class(const String& name);
1.6 paf 189:
1.65 paf 190: /**
191: core request processing
192:
193: BEWARE: may throw exception to you: catch it!
194: */
195: void core(
1.162 paf 196: const char* config_filespec, ///< system config filespec
1.138 paf 197: bool config_fail_on_read_problem, ///< fail if system config file not found
1.65 paf 198: bool header_only);
1.17 paf 199:
1.61 paf 200: /// executes ops
1.162 paf 201: void execute(ArrayOperation& ops); // execute.C
1.192 misha 202: void op_call(VMethodFrame &frame);
203: void op_call_write(VMethodFrame &frame);
1.202 moko 204: Value& construct(Value &class_value, const Method &method);
205:
1.127 paf 206: /// execute ops with anti-recoursion check
1.162 paf 207: void recoursion_checked_execute(/*const String& name, */ArrayOperation& ops) {
1.128 paf 208: // anti_endless_execute_recoursion
209: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
210: anti_endless_execute_recoursion=0; // give @exception a chance
1.184 misha 211: throw Exception(PARSER_RUNTIME,
1.162 paf 212: 0, //&name,
1.128 paf 213: "call canceled - endless recursion detected");
214: }
1.147 paf 215: execute(ops); // execute it
1.128 paf 216: anti_endless_execute_recoursion--;
217: }
1.40 paf 218:
1.199 misha 219: ///
220: void use_file_directly(VStateless_class& aclass,
221: const String& file_spec,
222: bool fail_on_read_problem=true,
1.201 misha 223: bool fail_on_file_absence=true);
1.199 misha 224:
1.64 paf 225: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.162 paf 226: void use_file(VStateless_class& aclass,
1.199 misha 227: const String& file_name,
1.201 misha 228: const String* use_filespec);
1.199 misha 229:
1.64 paf 230: /// compiles a @a source buffer
1.162 paf 231: void use_buf(VStateless_class& aclass,
232: const char* source,
233: const String* main_alias,
1.175 paf 234: uint file_no,
1.201 misha 235: int line_no_offset=0);
1.28 paf 236:
1.129 paf 237: /// processes any code-junction there may be inside of @a value
1.203 moko 238: StringOrValue process_getter(Junction& junction); // execute.C
1.131 paf 239: StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
1.192 misha 240: void process_write(Value& input_value); // execute.C
1.129 paf 241: //@{ convinient helpers
242: const String& process_to_string(Value& input_value) {
243: return process(input_value, true/*intercept_string*/).as_string();
244: }
245: Value& process_to_value(Value& input_value, bool intercept_string=true) {
246: return process(input_value, intercept_string).as_value();
1.126 paf 247: }
248: //@}
1.201 misha 249: const String* get_method_filename(const Method* method); // execute.C
1.199 misha 250: const String* get_used_filename(uint file_no);
1.126 paf 251:
1.131 paf 252: #define DEFINE_DUAL(modification) \
253: void write_##modification##_lang(StringOrValue dual) { \
1.162 paf 254: if(const String* string=dual.get_string()) \
1.131 paf 255: write_##modification##_lang(*string); \
256: else \
257: write_##modification##_lang(*dual.get_value()); \
258: }
259:
1.61 paf 260: /// appending, sure of clean string inside
1.65 paf 261: void write_no_lang(const String& astring) {
1.111 paf 262: wcontext->write(astring,
1.162 paf 263: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.49 paf 264: }
1.131 paf 265: /// appending sure value, that would be converted to clean string
266: void write_no_lang(Value& avalue) {
267: if(wcontext->get_in_expression())
268: wcontext->write(avalue);
269: else
270: wcontext->write(avalue,
1.162 paf 271: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.131 paf 272: }
273:
1.61 paf 274: /// appending string, passing language built into string being written
1.65 paf 275: void write_pass_lang(const String& astring) {
1.162 paf 276: wcontext->write(astring, String::L_PASS_APPENDED);
1.59 paf 277: }
1.131 paf 278: /// appending possible string, passing language built into string being written
279: void write_pass_lang(Value& avalue) {
1.162 paf 280: wcontext->write(avalue, String::L_PASS_APPENDED);
1.131 paf 281: }
282: DEFINE_DUAL(pass)
283:
1.61 paf 284: /// appending possible string, assigning untaint language
1.40 paf 285: void write_assign_lang(Value& avalue) {
1.39 paf 286: wcontext->write(avalue, flang);
1.106 parser 287: }
288: /// appending string, assigning untaint language
289: void write_assign_lang(const String& astring) {
290: wcontext->write(astring, flang);
1.22 paf 291: }
1.131 paf 292: DEFINE_DUAL(assign)
1.22 paf 293:
1.64 paf 294: /// returns relative to @a path path to @a file
1.162 paf 295: const String& relative(const char* apath, const String& relative_name);
1.61 paf 296:
1.64 paf 297: /// returns an absolute @a path to relative @a name
1.69 paf 298: const String& absolute(const String& relative_name);
1.42 paf 299:
1.209 misha 300: /// returns the mime type of 'user_file_name'
301: const String& mime_type_of(const String* file_name);
302:
1.80 paf 303: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 304: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 305:
1.117 paf 306: /// returns current SQL connection if any
1.162 paf 307: SQL_Connection* connection(bool fail_on_error=true) {
308: if(fail_on_error && !fconnection)
1.184 misha 309: throw Exception(PARSER_RUNTIME,
1.162 paf 310: 0,
1.117 paf 311: "outside of 'connect' operator");
312:
313: return fconnection;
1.133 paf 314: }
315:
1.162 paf 316: void set_interrupted(bool ainterrupted) { finterrupted=ainterrupted; }
317: bool get_interrupted() { return finterrupted; }
1.158 paf 318:
1.181 paf 319: void set_skip(Skip askip) { fskip=askip; }
320: Skip get_skip() { return fskip; }
321:
1.196 misha 322: void set_in_cycle(int adelta) { fin_cycle+=adelta; }
323: bool get_in_cycle() { return fin_cycle>0; }
324:
1.17 paf 325: public:
1.22 paf 326:
1.61 paf 327: /// info from web server
1.162 paf 328: Request_info& request_info;
329:
330: /// info about ServerAPI
331: SAPI_Info& sapi_info;
332:
333: /// source, client, mail charsets
334: Request_charsets charsets;
1.53 paf 335:
1.154 paf 336: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 337: VStateless_class& main_class;
1.86 paf 338: /// $form:elements
1.162 paf 339: VForm& form;
1.140 paf 340: /// $mail
1.162 paf 341: VMail& mail;
1.86 paf 342: /// $response:elements
1.162 paf 343: VResponse& response;
1.86 paf 344: /// $cookie:elements
1.162 paf 345: VCookie& cookie;
1.183 misha 346: /// $console
347: VConsole& console;
1.70 paf 348:
1.148 paf 349: /// classes configured data
1.193 misha 350: HashString<void*> classes_conf;
1.85 paf 351:
1.148 paf 352: public: // status read methods
1.76 paf 353:
1.148 paf 354: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 355: Value& get_self();
356: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
357: /* for strange reason call to this:
358: r.get_self<VHash>()
359: refuses to compile
1.87 paf 360:
1.162 paf 361: template<typename T> T& get_self() {
362: return *static_cast<T*>(get_self().get());
363: }
364: */
1.6 paf 365:
1.205 moko 366: /// public for ^reflection:copy[]
367: void put_element(Value& ncontext, const String& name, Value* value);
368:
1.173 paf 369: /// for @main[]
370: const String* execute_virtual_method(Value& aself, const String& method_name);
371:
1.204 moko 372: /// executes parser method, use op_call(frame) to execute native method
373: void execute_method(VMethodFrame& aframe);
374:
1.173 paf 375: //{ for @conf[filespec] and @auto[filespec] and parser://method/call
376: const String* execute_method(Value& aself,
1.190 misha 377: const Method& method, Value* optional_param,
1.173 paf 378: bool do_return_string);
379: struct Execute_nonvirtual_method_result {
380: const String* string;
381: Method* method;
382: Execute_nonvirtual_method_result(): string(0), method(0) {}
383: };
384: Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass,
1.185 misha 385: const String& method_name,
386: VString* optional_param,
1.173 paf 387: bool do_return_string);
388: //}
389:
1.162 paf 390: #ifdef XML
391: public: // charset helpers
1.67 paf 392:
1.162 paf 393: /// @see Charset::transcode
1.180 paf 394: xmlChar* transcode(const String& s);
1.162 paf 395: /// @see Charset::transcode
1.180 paf 396: xmlChar* transcode(const String::Body s);
1.162 paf 397: /// @see Charset::transcode
1.180 paf 398: const String& transcode(const xmlChar* s);
1.89 parser 399:
1.162 paf 400: #endif
1.136 paf 401:
402: private:
403:
404: /// already executed some @conf method
405: bool configure_admin_done;
406:
1.162 paf 407: void configure_admin(VStateless_class& conf_class);
1.177 paf 408:
409: void configure();
1.99 parser 410:
1.7 paf 411: private: // compile.C
412:
1.189 misha 413: ArrayClass& compile(VStateless_class* aclass,
1.162 paf 414: const char* source, const String* main_alias,
1.175 paf 415: uint file_no,
416: int line_no_offset);
1.7 paf 417:
418: private: // execute.C
1.9 paf 419:
1.191 misha 420: Value& get_element(Value& ncontext, const String& name);
1.22 paf 421:
1.58 paf 422: private: // defaults
423:
1.162 paf 424: const String::Language fdefault_lang;
1.80 paf 425:
426: private: // mime types
427:
428: /// $MAIN:MIME-TYPES
429: Table *mime_types;
1.22 paf 430:
1.39 paf 431: private: // lang manipulation
1.22 paf 432:
1.162 paf 433: String::Language set_lang(String::Language alang) {
434: String::Language result=flang;
1.39 paf 435: flang=alang;
436: return result;
437: }
1.162 paf 438: void restore_lang(String::Language alang) {
1.39 paf 439: flang=alang;
440: }
441:
1.117 paf 442: private: // connection manipulation
443:
1.162 paf 444: SQL_Connection* set_connection(SQL_Connection* aconnection) {
445: SQL_Connection* result=fconnection;
1.117 paf 446: fconnection=aconnection;
447: return result;
448: }
1.162 paf 449: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 450: fconnection=aconnection;
451: }
452:
453: private:
454:
1.162 paf 455: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 456: };
457:
458: /// Auto-object used to save request context across ^try body
459: class Request_context_saver {
460: Request& fr;
461:
462: /// exception stack trace
1.165 paf 463: size_t exception_trace_top;
464: size_t exception_trace_bottom;
1.148 paf 465: /// execution stack
1.162 paf 466: size_t stack;
1.166 paf 467: uint anti_endless_execute_recoursion;
1.148 paf 468: /// contexts
1.162 paf 469: VMethodFrame* method_frame;
470: Value* rcontext;
471: WContext* wcontext;
1.148 paf 472: /// current language
1.162 paf 473: String::Language flang;
1.148 paf 474: /// current connection
1.162 paf 475: SQL_Connection* fconnection;
1.126 paf 476:
1.148 paf 477: public:
478: Request_context_saver(Request& ar) :
1.171 paf 479: fr(ar),
1.165 paf 480: exception_trace_top(ar.exception_trace.top_index()),
481: exception_trace_bottom(ar.exception_trace.bottom_index()),
482: stack(ar.stack.top_index()),
1.166 paf 483: anti_endless_execute_recoursion(ar.anti_endless_execute_recoursion),
1.148 paf 484: method_frame(ar.method_frame),
485: rcontext(ar.rcontext),
486: wcontext(ar.wcontext),
487: flang(ar.flang),
1.171 paf 488: fconnection(ar.fconnection) {}
1.153 paf 489: void restore() {
1.165 paf 490: fr.exception_trace.set_top_index(exception_trace_top);
491: fr.exception_trace.set_bottom_index(exception_trace_bottom);
492: fr.stack.set_top_index(stack);
1.166 paf 493: fr.anti_endless_execute_recoursion=anti_endless_execute_recoursion;
1.157 paf 494: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 495: fr.flang=flang;
496: fr.fconnection=fconnection;
497: }
1.39 paf 498: };
499:
1.61 paf 500: /// Auto-object used for temporary changing Request::flang.
1.39 paf 501: class Temp_lang {
502: Request& frequest;
1.162 paf 503: String::Language saved_lang;
1.39 paf 504: public:
1.162 paf 505: Temp_lang(Request& arequest, String::Language alang) :
1.39 paf 506: frequest(arequest),
507: saved_lang(arequest.set_lang(alang)) {
508: }
509: ~Temp_lang() {
510: frequest.restore_lang(saved_lang);
1.117 paf 511: }
512: };
513:
514: /// Auto-object used for temporary changing Request::fconnection.
515: class Temp_connection {
516: Request& frequest;
1.162 paf 517: SQL_Connection* saved_connection;
1.117 paf 518: public:
1.162 paf 519: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 520: frequest(arequest),
521: saved_connection(arequest.set_connection(aconnection)) {
522: }
523: ~Temp_connection() {
524: frequest.restore_connection(saved_connection);
1.39 paf 525: }
1.91 parser 526: };
527:
1.196 misha 528: /// Auto-object used for break out of cycle check
529: class InCycle {
530: Request& frequest;
531: public:
532: InCycle(Request& arequest) : frequest(arequest) {
533: frequest.set_in_cycle(1);
534: }
535: ~InCycle() {
536: frequest.set_in_cycle(-1);
537: }
538: };
1.91 parser 539:
1.162 paf 540: // defines for externs
1.91 parser 541:
1.170 paf 542: #define EXCEPTION_HANDLED_PART_NAME "handled"
543:
1.162 paf 544:
545: // externs
546:
547: extern const String main_method_name;
548: extern const String auto_method_name;
549: extern const String body_name;
1.186 misha 550:
1.162 paf 551: extern const String exception_type_part_name;
552: extern const String exception_source_part_name;
553: extern const String exception_comment_part_name;
554: extern const String exception_handled_part_name;
1.91 parser 555:
1.162 paf 556: // defines for statics
1.91 parser 557:
1.162 paf 558: #define MAIN_CLASS_NAME "MAIN"
559: #define AUTO_FILE_NAME "auto.p"
1.1 paf 560:
561: #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