Annotation of parser3/src/include/pa_request.h, revision 1.204
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.204 ! moko 11: static const char * const IDENT_REQUEST_H="$Date: 2010-08-11 16:21:52 $";
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.202 moko 209: Value& construct(Value &class_value, const Method &method);
210:
1.127 paf 211: /// execute ops with anti-recoursion check
1.162 paf 212: void recoursion_checked_execute(/*const String& name, */ArrayOperation& ops) {
1.128 paf 213: // anti_endless_execute_recoursion
214: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
215: anti_endless_execute_recoursion=0; // give @exception a chance
1.184 misha 216: throw Exception(PARSER_RUNTIME,
1.162 paf 217: 0, //&name,
1.128 paf 218: "call canceled - endless recursion detected");
219: }
1.147 paf 220: execute(ops); // execute it
1.128 paf 221: anti_endless_execute_recoursion--;
222: }
1.40 paf 223:
1.199 misha 224: ///
225: void use_file_directly(VStateless_class& aclass,
226: const String& file_spec,
227: bool fail_on_read_problem=true,
1.201 misha 228: bool fail_on_file_absence=true);
1.199 misha 229:
1.64 paf 230: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.162 paf 231: void use_file(VStateless_class& aclass,
1.199 misha 232: const String& file_name,
1.201 misha 233: const String* use_filespec);
1.199 misha 234:
1.64 paf 235: /// compiles a @a source buffer
1.162 paf 236: void use_buf(VStateless_class& aclass,
237: const char* source,
238: const String* main_alias,
1.175 paf 239: uint file_no,
1.201 misha 240: int line_no_offset=0);
1.28 paf 241:
1.129 paf 242: /// processes any code-junction there may be inside of @a value
1.203 moko 243: StringOrValue process_getter(Junction& junction); // execute.C
1.131 paf 244: StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
1.192 misha 245: void process_write(Value& input_value); // execute.C
1.129 paf 246: //@{ convinient helpers
247: const String& process_to_string(Value& input_value) {
248: return process(input_value, true/*intercept_string*/).as_string();
249: }
250: Value& process_to_value(Value& input_value, bool intercept_string=true) {
251: return process(input_value, intercept_string).as_value();
1.126 paf 252: }
253: //@}
1.201 misha 254: const String* get_method_filename(const Method* method); // execute.C
1.199 misha 255: const String* get_used_filename(uint file_no);
1.126 paf 256:
1.131 paf 257: #define DEFINE_DUAL(modification) \
258: void write_##modification##_lang(StringOrValue dual) { \
1.162 paf 259: if(const String* string=dual.get_string()) \
1.131 paf 260: write_##modification##_lang(*string); \
261: else \
262: write_##modification##_lang(*dual.get_value()); \
263: }
264:
1.61 paf 265: /// appending, sure of clean string inside
1.65 paf 266: void write_no_lang(const String& astring) {
1.111 paf 267: wcontext->write(astring,
1.162 paf 268: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.49 paf 269: }
1.131 paf 270: /// appending sure value, that would be converted to clean string
271: void write_no_lang(Value& avalue) {
272: if(wcontext->get_in_expression())
273: wcontext->write(avalue);
274: else
275: wcontext->write(avalue,
1.162 paf 276: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.131 paf 277: }
278:
1.61 paf 279: /// appending string, passing language built into string being written
1.65 paf 280: void write_pass_lang(const String& astring) {
1.162 paf 281: wcontext->write(astring, String::L_PASS_APPENDED);
1.59 paf 282: }
1.131 paf 283: /// appending possible string, passing language built into string being written
284: void write_pass_lang(Value& avalue) {
1.162 paf 285: wcontext->write(avalue, String::L_PASS_APPENDED);
1.131 paf 286: }
287: DEFINE_DUAL(pass)
288:
1.61 paf 289: /// appending possible string, assigning untaint language
1.40 paf 290: void write_assign_lang(Value& avalue) {
1.39 paf 291: wcontext->write(avalue, flang);
1.106 parser 292: }
293: /// appending string, assigning untaint language
294: void write_assign_lang(const String& astring) {
295: wcontext->write(astring, flang);
1.22 paf 296: }
1.131 paf 297: DEFINE_DUAL(assign)
1.22 paf 298:
1.64 paf 299: /// returns relative to @a path path to @a file
1.162 paf 300: const String& relative(const char* apath, const String& relative_name);
1.61 paf 301:
1.64 paf 302: /// returns an absolute @a path to relative @a name
1.69 paf 303: const String& absolute(const String& relative_name);
1.42 paf 304:
1.80 paf 305: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 306: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 307:
1.117 paf 308: /// returns current SQL connection if any
1.162 paf 309: SQL_Connection* connection(bool fail_on_error=true) {
310: if(fail_on_error && !fconnection)
1.184 misha 311: throw Exception(PARSER_RUNTIME,
1.162 paf 312: 0,
1.117 paf 313: "outside of 'connect' operator");
314:
315: return fconnection;
1.133 paf 316: }
317:
1.162 paf 318: void set_interrupted(bool ainterrupted) { finterrupted=ainterrupted; }
319: bool get_interrupted() { return finterrupted; }
1.158 paf 320:
1.181 paf 321: void set_skip(Skip askip) { fskip=askip; }
322: Skip get_skip() { return fskip; }
323:
1.196 misha 324: void set_in_cycle(int adelta) { fin_cycle+=adelta; }
325: bool get_in_cycle() { return fin_cycle>0; }
326:
1.17 paf 327: public:
1.22 paf 328:
1.61 paf 329: /// info from web server
1.162 paf 330: Request_info& request_info;
331:
332: /// info about ServerAPI
333: SAPI_Info& sapi_info;
334:
335: /// source, client, mail charsets
336: Request_charsets charsets;
1.53 paf 337:
1.154 paf 338: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 339: VStateless_class& main_class;
1.86 paf 340: /// $form:elements
1.162 paf 341: VForm& form;
1.140 paf 342: /// $mail
1.162 paf 343: VMail& mail;
1.86 paf 344: /// $response:elements
1.162 paf 345: VResponse& response;
1.86 paf 346: /// $cookie:elements
1.162 paf 347: VCookie& cookie;
1.183 misha 348: /// $console
349: VConsole& console;
1.70 paf 350:
1.148 paf 351: /// classes configured data
1.193 misha 352: HashString<void*> classes_conf;
1.85 paf 353:
1.148 paf 354: public: // status read methods
1.76 paf 355:
1.148 paf 356: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 357: Value& get_self();
358: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
359: /* for strange reason call to this:
360: r.get_self<VHash>()
361: refuses to compile
1.87 paf 362:
1.162 paf 363: template<typename T> T& get_self() {
364: return *static_cast<T*>(get_self().get());
365: }
366: */
1.6 paf 367:
1.173 paf 368: /// for @main[]
369: const String* execute_virtual_method(Value& aself, const String& method_name);
370:
1.204 ! moko 371: /// executes parser method, use op_call(frame) to execute native method
! 372: void execute_method(VMethodFrame& aframe);
! 373:
1.173 paf 374: //{ for @conf[filespec] and @auto[filespec] and parser://method/call
375: const String* execute_method(Value& aself,
1.190 misha 376: const Method& method, Value* optional_param,
1.173 paf 377: bool do_return_string);
378: struct Execute_nonvirtual_method_result {
379: const String* string;
380: Method* method;
381: Execute_nonvirtual_method_result(): string(0), method(0) {}
382: };
383: Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass,
1.185 misha 384: const String& method_name,
385: VString* optional_param,
1.173 paf 386: bool do_return_string);
387: //}
388:
1.162 paf 389: #ifdef XML
390: public: // charset helpers
1.67 paf 391:
1.162 paf 392: /// @see Charset::transcode
1.180 paf 393: xmlChar* transcode(const String& s);
1.162 paf 394: /// @see Charset::transcode
1.180 paf 395: xmlChar* transcode(const String::Body s);
1.162 paf 396: /// @see Charset::transcode
1.180 paf 397: const String& transcode(const xmlChar* s);
1.89 parser 398:
1.162 paf 399: #endif
1.136 paf 400:
401: private:
402:
403: /// already executed some @conf method
404: bool configure_admin_done;
405:
1.162 paf 406: void configure_admin(VStateless_class& conf_class);
1.177 paf 407:
408: void configure();
1.99 parser 409:
1.7 paf 410: private: // compile.C
411:
1.189 misha 412: ArrayClass& compile(VStateless_class* aclass,
1.162 paf 413: const char* source, const String* main_alias,
1.175 paf 414: uint file_no,
415: int line_no_offset);
1.7 paf 416:
417: private: // execute.C
1.9 paf 418:
1.190 misha 419: void put_element(Value& ncontext, const String& name, Value* value);
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