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