Annotation of parser3/src/include/pa_request.h, revision 1.201
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.190 misha 4: Copyright (c) 2001-2009 ArtLebedev Group (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.201 ! misha 11: static const char * const IDENT_REQUEST_H="$Date: 2010-05-20 04:40:49 $";
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.112 paf 23: #ifdef RESOURCES_DEBUG
24: #include <sys/resource.h>
25: #endif
26:
1.128 paf 27: // consts
28:
1.161 paf 29: const uint ANTI_ENDLESS_EXECUTE_RECOURSION=1000;
1.162 paf 30: const size_t pseudo_file_no__process=1;
1.128 paf 31:
1.162 paf 32: // forwards
1.4 paf 33:
1.39 paf 34: class Temp_lang;
1.84 paf 35: class Methoded;
1.116 paf 36: class VMethodFrame;
1.162 paf 37: class VMail;
38: class VForm;
39: class VResponse;
40: class VCookie;
41: class VStateless_class;
1.1 paf 42:
1.61 paf 43: /// Main workhorse.
1.162 paf 44: class Request: public PA_Object {
1.107 paf 45: friend class Temp_lang;
1.117 paf 46: friend class Temp_connection;
1.148 paf 47: friend class Request_context_saver;
1.155 paf 48: friend class Temp_request_self;
1.162 paf 49: friend class Exception_trace;
50:
1.1 paf 51: public:
1.162 paf 52: class Trace {
53: const String* fname;
54: Operation::Origin forigin;
55: public:
56: Trace(): fname(0) {}
57: void clear() { fname=0; }
58: operator bool() const { return fname!=0; }
59:
60: Trace(const String* aname, const Operation::Origin aorigin):
61: fname(aname), forigin(aorigin) {}
62:
63: const String* name() const { return fname; }
64: const Operation::Origin origin() const { return forigin; }
65: };
66:
1.181 paf 67: enum Skip {
68: SKIP_NOTHING,
69: SKIP_BREAK,
70: SKIP_CONTINUE
71: };
72:
1.168 paf 73: private:
74: Pool fpool;
75: public:
76: Pool& pool() { return fpool; }
1.162 paf 77:
78: private:
79: union StackItem {
80: Value* fvalue;
81: ArrayOperation* fops;
82: VMethodFrame* fmethod_frame;
83: public:
84: Value& value() const { return *fvalue; }
85: const String& string() const {
1.167 paf 86: return fvalue->as_string();
1.162 paf 87: }
88: ArrayOperation& ops() const { return *fops; }
89: VMethodFrame& method_frame() const { return *fmethod_frame; }
90:
91: /// needed to fill unused Array entries
92: StackItem() {}
93: StackItem(Value& avalue): fvalue(&avalue) {}
94: StackItem(ArrayOperation& aops): fops(&aops) {}
95: StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {}
96: };
97:
98: class Exception_trace: public Stack<Trace> {
99: size_t fbottom;
100: public:
101: Exception_trace(): fbottom(0) {}
102:
103: size_t bottom_index() { return fbottom; }
1.165 paf 104: void set_bottom_index(size_t abottom) { fbottom=abottom; }
1.162 paf 105: element_type bottom_value() { return get(bottom_index()); }
106:
107: void clear() {
1.191 misha 108: fused=fbottom=0;
1.162 paf 109: }
110:
111: bool is_empty() {
1.191 misha 112: return fused==fbottom;
1.162 paf 113: }
114:
115: const element_type extract_origin(const String*& problem_source);
116: };
117:
118: ///@{ core data
119:
120: /// classes
1.195 misha 121: HashString<Value*> fclasses;
1.162 paf 122:
123: /// already used files to avoid cyclic uses
1.193 misha 124: HashString<bool> used_files;
1.200 misha 125: HashString<bool> searched_along_class_path;
1.162 paf 126: /// list of all used files, Operation::file_no = index to it
1.163 paf 127: Array<String::Body> file_list;
1.162 paf 128:
129: /** endless execute(execute(... preventing counter
130: @see ANTI_ENDLESS_EXECUTE_RECOURSION
131: */
132: uint anti_endless_execute_recoursion;
133:
134: ///@}
135:
136: /// execution stack
137: Stack<StackItem> stack;
138:
139: /// exception stack trace
140: Exception_trace exception_trace;
141: public:
142:
143: //@{ request processing status
144: /// contexts
145: VMethodFrame* method_frame;
146: Value* rcontext;
147: WContext* wcontext;
148: /// current language
149: String::Language flang;
150: /// current connection
151: SQL_Connection* fconnection;
152: //@}
153: /// interrupted flag, raised on signals [SIGPIPE]
154: bool finterrupted;
1.181 paf 155: Skip fskip;
1.196 misha 156: int fin_cycle;
1.162 paf 157:
158: public:
1.175 paf 159: uint register_file(String::Body file_spec);
1.162 paf 160:
161: struct Exception_details {
162: const Trace trace;
163: const String* problem_source;
164: VHash& vhash;
165:
166: Exception_details(
167: const Trace atrace,
168: const String* aproblem_source,
1.166 paf 169: VHash& avhash): trace(atrace), problem_source(aproblem_source), vhash(avhash) {}
1.162 paf 170: };
171: Exception_details get_details(const Exception& e);
1.176 paf 172: const char* get_exception_cstr(const Exception& e, Exception_details& details);
1.162 paf 173:
174: /// @see Stack::wipe_unused
175: void wipe_unused_execution_stack() {
176: stack.wipe_unused();
177: }
1.112 paf 178:
179: #ifdef RESOURCES_DEBUG
180: /// measures
181: double sql_connect_time;
182: double sql_request_time;
183: #endif
1.61 paf 184:
1.162 paf 185: Request(SAPI_Info& asapi_info, Request_info& arequest_info,
186: String::Language adefault_lang, ///< all tainted data default untainting lang
1.110 paf 187: bool status_allowed ///< status class allowed
1.50 paf 188: );
1.118 paf 189: ~Request();
1.1 paf 190:
1.61 paf 191: /// global classes
1.195 misha 192: HashString<Value*>& classes() { return fclasses; }
1.197 misha 193: Value* get_class(const String& name);
1.6 paf 194:
1.65 paf 195: /**
196: core request processing
197:
198: BEWARE: may throw exception to you: catch it!
199: */
200: void core(
1.162 paf 201: const char* config_filespec, ///< system config filespec
1.138 paf 202: bool config_fail_on_read_problem, ///< fail if system config file not found
1.65 paf 203: bool header_only);
1.17 paf 204:
1.61 paf 205: /// executes ops
1.162 paf 206: void execute(ArrayOperation& ops); // execute.C
1.192 misha 207: void op_call(VMethodFrame &frame);
208: void op_call_write(VMethodFrame &frame);
1.194 misha 209: void op_call(VMethodFrame &frame, bool constructing);
1.127 paf 210: /// execute ops with anti-recoursion check
1.162 paf 211: void recoursion_checked_execute(/*const String& name, */ArrayOperation& ops) {
1.128 paf 212: // anti_endless_execute_recoursion
213: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
214: anti_endless_execute_recoursion=0; // give @exception a chance
1.184 misha 215: throw Exception(PARSER_RUNTIME,
1.162 paf 216: 0, //&name,
1.128 paf 217: "call canceled - endless recursion detected");
218: }
1.147 paf 219: execute(ops); // execute it
1.128 paf 220: anti_endless_execute_recoursion--;
221: }
1.40 paf 222:
1.199 misha 223: ///
224: void use_file_directly(VStateless_class& aclass,
225: const String& file_spec,
226: bool fail_on_read_problem=true,
1.201 ! misha 227: bool fail_on_file_absence=true);
1.199 misha 228:
1.64 paf 229: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.162 paf 230: void use_file(VStateless_class& aclass,
1.199 misha 231: const String& file_name,
1.201 ! misha 232: const String* use_filespec);
1.199 misha 233:
1.64 paf 234: /// compiles a @a source buffer
1.162 paf 235: void use_buf(VStateless_class& aclass,
236: const char* source,
237: const String* main_alias,
1.175 paf 238: uint file_no,
1.201 ! misha 239: int line_no_offset=0);
1.28 paf 240:
1.129 paf 241: /// processes any code-junction there may be inside of @a value
1.131 paf 242: StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
1.192 misha 243: void process_write(Value& input_value); // execute.C
1.129 paf 244: //@{ convinient helpers
245: const String& process_to_string(Value& input_value) {
246: return process(input_value, true/*intercept_string*/).as_string();
247: }
248: Value& process_to_value(Value& input_value, bool intercept_string=true) {
249: return process(input_value, intercept_string).as_value();
1.126 paf 250: }
251: //@}
1.201 ! misha 252: const String* get_method_filename(const Method* method); // execute.C
1.199 misha 253: const String* get_used_filename(uint file_no);
1.126 paf 254:
1.131 paf 255: #define DEFINE_DUAL(modification) \
256: void write_##modification##_lang(StringOrValue dual) { \
1.162 paf 257: if(const String* string=dual.get_string()) \
1.131 paf 258: write_##modification##_lang(*string); \
259: else \
260: write_##modification##_lang(*dual.get_value()); \
261: }
262:
1.61 paf 263: /// appending, sure of clean string inside
1.65 paf 264: void write_no_lang(const String& astring) {
1.111 paf 265: wcontext->write(astring,
1.162 paf 266: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.49 paf 267: }
1.131 paf 268: /// appending sure value, that would be converted to clean string
269: void write_no_lang(Value& avalue) {
270: if(wcontext->get_in_expression())
271: wcontext->write(avalue);
272: else
273: wcontext->write(avalue,
1.162 paf 274: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.131 paf 275: }
276:
1.61 paf 277: /// appending string, passing language built into string being written
1.65 paf 278: void write_pass_lang(const String& astring) {
1.162 paf 279: wcontext->write(astring, String::L_PASS_APPENDED);
1.59 paf 280: }
1.131 paf 281: /// appending possible string, passing language built into string being written
282: void write_pass_lang(Value& avalue) {
1.162 paf 283: wcontext->write(avalue, String::L_PASS_APPENDED);
1.131 paf 284: }
285: DEFINE_DUAL(pass)
286:
1.61 paf 287: /// appending possible string, assigning untaint language
1.40 paf 288: void write_assign_lang(Value& avalue) {
1.39 paf 289: wcontext->write(avalue, flang);
1.106 parser 290: }
291: /// appending string, assigning untaint language
292: void write_assign_lang(const String& astring) {
293: wcontext->write(astring, flang);
1.22 paf 294: }
1.131 paf 295: DEFINE_DUAL(assign)
1.22 paf 296:
1.64 paf 297: /// returns relative to @a path path to @a file
1.162 paf 298: const String& relative(const char* apath, const String& relative_name);
1.61 paf 299:
1.64 paf 300: /// returns an absolute @a path to relative @a name
1.69 paf 301: const String& absolute(const String& relative_name);
1.42 paf 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.173 paf 366: /// for @main[]
367: const String* execute_virtual_method(Value& aself, const String& method_name);
368:
369: /// for @postprocess[body]
370: StringOrValue execute_method(VMethodFrame& amethodFrame, const Method& method);
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.190 misha 416: void put_element(Value& ncontext, const String& name, Value* value);
1.191 misha 417: Value& get_element(Value& ncontext, const String& name);
1.22 paf 418:
1.58 paf 419: private: // defaults
420:
1.162 paf 421: const String::Language fdefault_lang;
1.80 paf 422:
423: private: // mime types
424:
425: /// $MAIN:MIME-TYPES
426: Table *mime_types;
1.22 paf 427:
1.39 paf 428: private: // lang manipulation
1.22 paf 429:
1.162 paf 430: String::Language set_lang(String::Language alang) {
431: String::Language result=flang;
1.39 paf 432: flang=alang;
433: return result;
434: }
1.162 paf 435: void restore_lang(String::Language alang) {
1.39 paf 436: flang=alang;
437: }
438:
1.117 paf 439: private: // connection manipulation
440:
1.162 paf 441: SQL_Connection* set_connection(SQL_Connection* aconnection) {
442: SQL_Connection* result=fconnection;
1.117 paf 443: fconnection=aconnection;
444: return result;
445: }
1.162 paf 446: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 447: fconnection=aconnection;
448: }
449:
450: private:
451:
1.162 paf 452: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 453: };
454:
455: /// Auto-object used to save request context across ^try body
456: class Request_context_saver {
457: Request& fr;
458:
459: /// exception stack trace
1.165 paf 460: size_t exception_trace_top;
461: size_t exception_trace_bottom;
1.148 paf 462: /// execution stack
1.162 paf 463: size_t stack;
1.166 paf 464: uint anti_endless_execute_recoursion;
1.148 paf 465: /// contexts
1.162 paf 466: VMethodFrame* method_frame;
467: Value* rcontext;
468: WContext* wcontext;
1.148 paf 469: /// current language
1.162 paf 470: String::Language flang;
1.148 paf 471: /// current connection
1.162 paf 472: SQL_Connection* fconnection;
1.126 paf 473:
1.148 paf 474: public:
475: Request_context_saver(Request& ar) :
1.171 paf 476: fr(ar),
1.165 paf 477: exception_trace_top(ar.exception_trace.top_index()),
478: exception_trace_bottom(ar.exception_trace.bottom_index()),
479: stack(ar.stack.top_index()),
1.166 paf 480: anti_endless_execute_recoursion(ar.anti_endless_execute_recoursion),
1.148 paf 481: method_frame(ar.method_frame),
482: rcontext(ar.rcontext),
483: wcontext(ar.wcontext),
484: flang(ar.flang),
1.171 paf 485: fconnection(ar.fconnection) {}
1.153 paf 486: void restore() {
1.165 paf 487: fr.exception_trace.set_top_index(exception_trace_top);
488: fr.exception_trace.set_bottom_index(exception_trace_bottom);
489: fr.stack.set_top_index(stack);
1.166 paf 490: fr.anti_endless_execute_recoursion=anti_endless_execute_recoursion;
1.157 paf 491: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 492: fr.flang=flang;
493: fr.fconnection=fconnection;
494: }
1.39 paf 495: };
496:
1.61 paf 497: /// Auto-object used for temporary changing Request::flang.
1.39 paf 498: class Temp_lang {
499: Request& frequest;
1.162 paf 500: String::Language saved_lang;
1.39 paf 501: public:
1.162 paf 502: Temp_lang(Request& arequest, String::Language alang) :
1.39 paf 503: frequest(arequest),
504: saved_lang(arequest.set_lang(alang)) {
505: }
506: ~Temp_lang() {
507: frequest.restore_lang(saved_lang);
1.117 paf 508: }
509: };
510:
511: /// Auto-object used for temporary changing Request::fconnection.
512: class Temp_connection {
513: Request& frequest;
1.162 paf 514: SQL_Connection* saved_connection;
1.117 paf 515: public:
1.162 paf 516: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 517: frequest(arequest),
518: saved_connection(arequest.set_connection(aconnection)) {
519: }
520: ~Temp_connection() {
521: frequest.restore_connection(saved_connection);
1.39 paf 522: }
1.91 parser 523: };
524:
1.196 misha 525: /// Auto-object used for break out of cycle check
526: class InCycle {
527: Request& frequest;
528: public:
529: InCycle(Request& arequest) : frequest(arequest) {
530: frequest.set_in_cycle(1);
531: }
532: ~InCycle() {
533: frequest.set_in_cycle(-1);
534: }
535: };
1.91 parser 536:
1.162 paf 537: // defines for externs
1.91 parser 538:
1.170 paf 539: #define EXCEPTION_HANDLED_PART_NAME "handled"
540:
1.162 paf 541:
542: // externs
543:
544: extern const String main_method_name;
545: extern const String auto_method_name;
546: extern const String body_name;
1.186 misha 547:
1.162 paf 548: extern const String exception_type_part_name;
549: extern const String exception_source_part_name;
550: extern const String exception_comment_part_name;
551: extern const String exception_handled_part_name;
1.91 parser 552:
1.162 paf 553: // defines for statics
1.91 parser 554:
1.162 paf 555: #define MAIN_CLASS_NAME "MAIN"
556: #define AUTO_FILE_NAME "auto.p"
1.1 paf 557:
558: #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