Annotation of parser3/src/include/pa_request.h, revision 1.168
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.162 paf 4: Copyright (c) 2001-2003 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.168 ! paf 11: static const char* IDENT_REQUEST_H="$Date: 2003/10/22 07:15:47 $";
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.112 paf 22: #ifdef RESOURCES_DEBUG
23: #include <sys/resource.h>
24: #endif
25:
1.128 paf 26: // consts
27:
1.161 paf 28: const uint ANTI_ENDLESS_EXECUTE_RECOURSION=1000;
1.162 paf 29: const size_t pseudo_file_no__process=1;
1.128 paf 30:
1.162 paf 31: // forwards
1.4 paf 32:
1.39 paf 33: class Temp_lang;
1.84 paf 34: class Methoded;
1.116 paf 35: class VMethodFrame;
1.162 paf 36: class GdomeDOMString_auto_ptr;
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.168 ! paf 67: private:
! 68: Pool fpool;
! 69: public:
! 70: Pool& pool() { return fpool; }
1.162 paf 71:
72: private:
73: union StackItem {
74: Value* fvalue;
75: ArrayOperation* fops;
76: VMethodFrame* fmethod_frame;
77: public:
78: Value& value() const { return *fvalue; }
79: const String& string() const {
1.167 paf 80: return fvalue->as_string();
1.162 paf 81: }
82: ArrayOperation& ops() const { return *fops; }
83: VMethodFrame& method_frame() const { return *fmethod_frame; }
84:
85: /// needed to fill unused Array entries
86: StackItem() {}
87: StackItem(Value& avalue): fvalue(&avalue) {}
88: StackItem(ArrayOperation& aops): fops(&aops) {}
89: StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {}
90: };
91:
92: class Exception_trace: public Stack<Trace> {
93: size_t fbottom;
94: public:
95: Exception_trace(): fbottom(0) {}
96:
97: size_t bottom_index() { return fbottom; }
1.165 paf 98: void set_bottom_index(size_t abottom) { fbottom=abottom; }
1.162 paf 99: element_type bottom_value() { return get(bottom_index()); }
100:
101: void clear() {
102: ftop=fbottom=0;
103: }
104:
105: bool is_empty() {
106: return ftop==fbottom;
107: }
108:
109: const element_type extract_origin(const String*& problem_source);
110: };
111:
112: ///@{ core data
113:
114: /// classes
115: HashStringValue fclasses;
116:
117: /// already used files to avoid cyclic uses
1.163 paf 118: Hash<const String::Body, bool> used_files;
1.162 paf 119: /// list of all used files, Operation::file_no = index to it
1.163 paf 120: Array<String::Body> file_list;
1.162 paf 121:
122: /** endless execute(execute(... preventing counter
123: @see ANTI_ENDLESS_EXECUTE_RECOURSION
124: */
125: uint anti_endless_execute_recoursion;
126:
127: ///@}
128:
129: /// execution stack
130: Stack<StackItem> stack;
131:
132: /// exception stack trace
133: Exception_trace exception_trace;
134: public:
135:
136: //@{ request processing status
137: /// contexts
138: VMethodFrame* method_frame;
139: Value* rcontext;
140: WContext* wcontext;
141: /// current language
142: String::Language flang;
143: /// current connection
144: SQL_Connection* fconnection;
145: //@}
146: /// interrupted flag, raised on signals [SIGPIPE]
147: bool finterrupted;
148:
149: public:
1.163 paf 150: size_t register_file(String::Body file_spec);
1.162 paf 151:
152: struct Exception_details {
153: const Trace trace;
154: const String* problem_source;
155: VHash& vhash;
156:
157: Exception_details(
158: const Trace atrace,
159: const String* aproblem_source,
1.166 paf 160: VHash& avhash): trace(atrace), problem_source(aproblem_source), vhash(avhash) {}
1.162 paf 161: };
162: Exception_details get_details(const Exception& e);
163:
164: /// @see Stack::wipe_unused
165: void wipe_unused_execution_stack() {
166: stack.wipe_unused();
167: }
1.112 paf 168:
169: #ifdef RESOURCES_DEBUG
170: /// measures
171: double sql_connect_time;
172: double sql_request_time;
173: #endif
1.61 paf 174:
1.162 paf 175: Request(SAPI_Info& asapi_info, Request_info& arequest_info,
176: String::Language adefault_lang, ///< all tainted data default untainting lang
1.110 paf 177: bool status_allowed ///< status class allowed
1.50 paf 178: );
1.118 paf 179: ~Request();
1.1 paf 180:
1.61 paf 181: /// global classes
1.162 paf 182: HashStringValue& classes() { return fclasses; }
1.6 paf 183:
1.65 paf 184: /**
185: core request processing
186:
187: BEWARE: may throw exception to you: catch it!
188: */
189: void core(
1.162 paf 190: const char* config_filespec, ///< system config filespec
1.138 paf 191: bool config_fail_on_read_problem, ///< fail if system config file not found
1.65 paf 192: bool header_only);
1.17 paf 193:
1.61 paf 194: /// executes ops
1.162 paf 195: void execute(ArrayOperation& ops); // execute.C
1.127 paf 196: /// execute ops with anti-recoursion check
1.162 paf 197: void recoursion_checked_execute(/*const String& name, */ArrayOperation& ops) {
1.128 paf 198: // anti_endless_execute_recoursion
199: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
200: anti_endless_execute_recoursion=0; // give @exception a chance
201: throw Exception("parser.runtime",
1.162 paf 202: 0, //&name,
1.128 paf 203: "call canceled - endless recursion detected");
204: }
1.147 paf 205: execute(ops); // execute it
1.128 paf 206: anti_endless_execute_recoursion--;
207: }
1.40 paf 208:
1.64 paf 209: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.162 paf 210: void use_file(VStateless_class& aclass,
1.94 parser 211: const String& file_name,
1.162 paf 212: const String* main_alias=0,
1.149 paf 213: bool ignore_class_path=false,
1.162 paf 214: bool fail_on_read_problem=true,
215: bool fail_on_file_absence=true); // pa_request.C
1.64 paf 216: /// compiles a @a source buffer
1.162 paf 217: void use_buf(VStateless_class& aclass,
218: const char* source,
219: const String* main_alias,
220: uint file_no); // pa_request.C
1.28 paf 221:
1.129 paf 222: /// processes any code-junction there may be inside of @a value
1.131 paf 223: StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
1.129 paf 224: //@{ convinient helpers
225: const String& process_to_string(Value& input_value) {
226: return process(input_value, true/*intercept_string*/).as_string();
227: }
228: Value& process_to_value(Value& input_value, bool intercept_string=true) {
229: return process(input_value, intercept_string).as_value();
1.126 paf 230: }
231: //@}
1.131 paf 232:
1.126 paf 233:
1.131 paf 234: #define DEFINE_DUAL(modification) \
235: void write_##modification##_lang(StringOrValue dual) { \
1.162 paf 236: if(const String* string=dual.get_string()) \
1.131 paf 237: write_##modification##_lang(*string); \
238: else \
239: write_##modification##_lang(*dual.get_value()); \
240: }
241:
1.61 paf 242: /// appending, sure of clean string inside
1.65 paf 243: void write_no_lang(const String& astring) {
1.111 paf 244: wcontext->write(astring,
1.162 paf 245: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.49 paf 246: }
1.131 paf 247: /// appending sure value, that would be converted to clean string
248: void write_no_lang(Value& avalue) {
249: if(wcontext->get_in_expression())
250: wcontext->write(avalue);
251: else
252: wcontext->write(avalue,
1.162 paf 253: (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
1.131 paf 254: }
255:
1.61 paf 256: /// appending string, passing language built into string being written
1.65 paf 257: void write_pass_lang(const String& astring) {
1.162 paf 258: wcontext->write(astring, String::L_PASS_APPENDED);
1.59 paf 259: }
1.131 paf 260: /// appending possible string, passing language built into string being written
261: void write_pass_lang(Value& avalue) {
1.162 paf 262: wcontext->write(avalue, String::L_PASS_APPENDED);
1.131 paf 263: }
264: DEFINE_DUAL(pass)
265:
1.61 paf 266: /// appending possible string, assigning untaint language
1.40 paf 267: void write_assign_lang(Value& avalue) {
1.39 paf 268: wcontext->write(avalue, flang);
1.106 parser 269: }
270: /// appending string, assigning untaint language
271: void write_assign_lang(const String& astring) {
272: wcontext->write(astring, flang);
1.22 paf 273: }
1.131 paf 274: DEFINE_DUAL(assign)
1.22 paf 275:
1.64 paf 276: /// returns relative to @a path path to @a file
1.162 paf 277: const String& relative(const char* apath, const String& relative_name);
1.61 paf 278:
1.64 paf 279: /// returns an absolute @a path to relative @a name
1.69 paf 280: const String& absolute(const String& relative_name);
1.42 paf 281:
1.80 paf 282: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 283: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 284:
1.117 paf 285: /// returns current SQL connection if any
1.162 paf 286: SQL_Connection* connection(bool fail_on_error=true) {
287: if(fail_on_error && !fconnection)
1.125 paf 288: throw Exception("parser.runtime",
1.162 paf 289: 0,
1.117 paf 290: "outside of 'connect' operator");
291:
292: return fconnection;
1.133 paf 293: }
294:
1.162 paf 295: void set_interrupted(bool ainterrupted) { finterrupted=ainterrupted; }
296: bool get_interrupted() { return finterrupted; }
1.158 paf 297:
1.17 paf 298: public:
1.22 paf 299:
1.61 paf 300: /// info from web server
1.162 paf 301: Request_info& request_info;
302:
303: /// info about ServerAPI
304: SAPI_Info& sapi_info;
305:
306: /// source, client, mail charsets
307: Request_charsets charsets;
1.53 paf 308:
1.154 paf 309: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 310: VStateless_class& main_class;
1.86 paf 311: /// $form:elements
1.162 paf 312: VForm& form;
1.140 paf 313: /// $mail
1.162 paf 314: VMail& mail;
1.86 paf 315: /// $response:elements
1.162 paf 316: VResponse& response;
1.86 paf 317: /// $cookie:elements
1.162 paf 318: VCookie& cookie;
1.70 paf 319:
1.148 paf 320: /// classes configured data
1.162 paf 321: HashStringObject classes_conf;
1.85 paf 322:
1.148 paf 323: public: // status read methods
1.76 paf 324:
1.148 paf 325: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 326: Value& get_self();
327: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
328: /* for strange reason call to this:
329: r.get_self<VHash>()
330: refuses to compile
1.87 paf 331:
1.162 paf 332: template<typename T> T& get_self() {
333: return *static_cast<T*>(get_self().get());
334: }
335: */
1.6 paf 336:
1.162 paf 337: #ifdef XML
338: public: // charset helpers
1.67 paf 339:
1.162 paf 340: /// @see Charset::transcode
341: GdomeDOMString_auto_ptr transcode(const String& s);
342: /// @see Charset::transcode
1.163 paf 343: GdomeDOMString_auto_ptr transcode(const String::Body s);
1.162 paf 344: /// @see Charset::transcode
345: const String& transcode(GdomeDOMString* s);
346: /// @see Charset::transcode
347: const String& transcode(xmlChar* s);
1.89 parser 348:
1.162 paf 349: #endif
1.136 paf 350:
351: private:
352:
353: /// already executed some @conf method
354: bool configure_admin_done;
355:
1.162 paf 356: void configure_admin(VStateless_class& conf_class);
1.99 parser 357:
1.7 paf 358: private: // compile.C
359:
1.162 paf 360: VStateless_class& compile(VStateless_class* aclass,
361: const char* source, const String* main_alias,
362: uint file_no);
1.7 paf 363:
364: private: // execute.C
365:
1.139 paf 366: /// for @postprocess[body]
1.164 paf 367: StringOrValue execute_method(VMethodFrame& amethodFrame, const Method& method);
1.139 paf 368: //{ for @conf[filespec] and @auto[filespec]
1.162 paf 369: const String* execute_method(Value& aself,
370: const Method& method, VString* optional_param,
371: bool do_return_string);
372: struct Execute_nonvirtual_method_result {
373: const String* string;
374: Method* method;
375: Execute_nonvirtual_method_result(): string(0), method(0) {}
376: };
377: Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass,
378: const String& method_name, VString* optional_param,
379: bool do_return_string);
1.139 paf 380: //}
381: /// for @main[]
1.162 paf 382: const String* execute_virtual_method(Value& aself, const String& method_name);
1.9 paf 383:
1.162 paf 384: Value& get_element(Value& ncontext, const String& name, bool can_call_operator);
1.22 paf 385:
1.58 paf 386: private: // defaults
387:
1.162 paf 388: const String::Language fdefault_lang;
1.80 paf 389:
390: private: // mime types
391:
392: /// $MAIN:MIME-TYPES
393: Table *mime_types;
1.22 paf 394:
1.39 paf 395: private: // lang manipulation
1.22 paf 396:
1.162 paf 397: String::Language set_lang(String::Language alang) {
398: String::Language result=flang;
1.39 paf 399: flang=alang;
400: return result;
401: }
1.162 paf 402: void restore_lang(String::Language alang) {
1.39 paf 403: flang=alang;
404: }
405:
1.117 paf 406: private: // connection manipulation
407:
1.162 paf 408: SQL_Connection* set_connection(SQL_Connection* aconnection) {
409: SQL_Connection* result=fconnection;
1.117 paf 410: fconnection=aconnection;
411: return result;
412: }
1.162 paf 413: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 414: fconnection=aconnection;
415: }
416:
417: private:
418:
1.162 paf 419: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 420: };
421:
422: /// Auto-object used to save request context across ^try body
423: class Request_context_saver {
424: Request& fr;
425:
426: /// exception stack trace
1.165 paf 427: size_t exception_trace_top;
428: size_t exception_trace_bottom;
1.148 paf 429: /// execution stack
1.162 paf 430: size_t stack;
1.166 paf 431: uint anti_endless_execute_recoursion;
1.148 paf 432: /// contexts
1.162 paf 433: VMethodFrame* method_frame;
434: Value* rcontext;
435: WContext* wcontext;
1.148 paf 436: /// current language
1.162 paf 437: String::Language flang;
1.148 paf 438: /// current connection
1.162 paf 439: SQL_Connection* fconnection;
1.126 paf 440:
1.148 paf 441: public:
442: Request_context_saver(Request& ar) :
1.165 paf 443: exception_trace_top(ar.exception_trace.top_index()),
444: exception_trace_bottom(ar.exception_trace.bottom_index()),
445: stack(ar.stack.top_index()),
1.166 paf 446: anti_endless_execute_recoursion(ar.anti_endless_execute_recoursion),
1.148 paf 447: method_frame(ar.method_frame),
448: rcontext(ar.rcontext),
449: wcontext(ar.wcontext),
450: flang(ar.flang),
451: fconnection(ar.fconnection),
452: fr(ar) {}
1.153 paf 453: void restore() {
1.165 paf 454: fr.exception_trace.set_top_index(exception_trace_top);
455: fr.exception_trace.set_bottom_index(exception_trace_bottom);
456: fr.stack.set_top_index(stack);
1.166 paf 457: fr.anti_endless_execute_recoursion=anti_endless_execute_recoursion;
1.157 paf 458: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 459: fr.flang=flang;
460: fr.fconnection=fconnection;
461: }
1.39 paf 462: };
463:
1.61 paf 464: /// Auto-object used for temporary changing Request::flang.
1.39 paf 465: class Temp_lang {
466: Request& frequest;
1.162 paf 467: String::Language saved_lang;
1.39 paf 468: public:
1.162 paf 469: Temp_lang(Request& arequest, String::Language alang) :
1.39 paf 470: frequest(arequest),
471: saved_lang(arequest.set_lang(alang)) {
472: }
473: ~Temp_lang() {
474: frequest.restore_lang(saved_lang);
1.117 paf 475: }
476: };
477:
478: /// Auto-object used for temporary changing Request::fconnection.
479: class Temp_connection {
480: Request& frequest;
1.162 paf 481: SQL_Connection* saved_connection;
1.117 paf 482: public:
1.162 paf 483: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 484: frequest(arequest),
485: saved_connection(arequest.set_connection(aconnection)) {
486: }
487: ~Temp_connection() {
488: frequest.restore_connection(saved_connection);
1.39 paf 489: }
1.91 parser 490: };
491:
492:
1.162 paf 493: // defines for externs
1.91 parser 494:
1.162 paf 495: #define CONTENT_DISPOSITION_NAME "content-disposition"
496: #define CONTENT_DISPOSITION_VALUE "attachment"
497: #define CONTENT_DISPOSITION_FILENAME_NAME "filename"
498:
499: // externs
500:
501: extern const String main_method_name;
502: extern const String auto_method_name;
503: extern const String body_name;
504: extern const String content_disposition_name;
505: extern const String content_disposition_value;
506: extern const String content_disposition_filename_name;
507:
508: extern const String exception_type_part_name;
509: extern const String exception_source_part_name;
510: extern const String exception_comment_part_name;
511: extern const String exception_handled_part_name;
1.91 parser 512:
1.162 paf 513: // defines for statics
1.91 parser 514:
1.162 paf 515: #define MAIN_CLASS_NAME "MAIN"
516: #define AUTO_FILE_NAME "auto.p"
1.1 paf 517:
518: #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