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