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