Annotation of parser3/src/include/pa_request.h, revision 1.130
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.120 paf 4: Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
1.121 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.32 paf 6:
1.130 ! paf 7: $Id: pa_request.h,v 1.129 2002/04/15 10:35:22 paf Exp $
1.1 paf 8: */
9:
10: #ifndef PA_REQUEST_H
11: #define PA_REQUEST_H
12:
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.12 paf 18: #include "pa_vclass.h"
1.45 paf 19: #include "pa_vobject.h"
1.47 paf 20: #include "pa_venv.h"
1.108 paf 21: #include "pa_vstatus.h"
1.48 paf 22: #include "pa_vform.h"
1.90 parser 23: #include "pa_vmath.h"
1.56 paf 24: #include "pa_vrequest.h"
1.57 paf 25: #include "pa_vresponse.h"
1.60 paf 26: #include "pa_vcookie.h"
1.77 paf 27: #include "pa_sql_driver_manager.h"
1.44 paf 28:
1.112 paf 29: #ifdef RESOURCES_DEBUG
30: #include <sys/resource.h>
31: #endif
32:
1.128 paf 33: // consts
34:
35: const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500;
36:
37: // defines
38:
1.7 paf 39: #ifndef NO_STRING_ORIGIN
1.40 paf 40: # define COMPILE_PARAMS \
41: const char *source, \
1.46 paf 42: VStateless_class *aclass, const String *name, \
43: VStateless_class *base_class, \
1.40 paf 44: const char *file
45: # define COMPILE(source, aclass, name, base_class, file) \
46: real_compile(source, aclass, name, base_class, file)
1.7 paf 47: #else
1.40 paf 48: # define COMPILE_PARAMS \
49: const char *source, \
1.46 paf 50: VStateless_class *aclass, const String *name, \
51: VStateless_class *base_class
1.40 paf 52: # define COMPILE(source, aclass, name, base_class, file) \
53: real_compile(source, aclass, name, base_class)
1.7 paf 54: #endif
1.4 paf 55:
1.39 paf 56: class Temp_lang;
1.84 paf 57: class Methoded;
1.116 paf 58: class VMethodFrame;
1.1 paf 59:
1.61 paf 60: /// Main workhorse.
1.7 paf 61: class Request : public Pooled {
1.107 paf 62: friend class Temp_lang;
1.117 paf 63: friend class Temp_connection;
1.1 paf 64: public:
1.112 paf 65:
66: #ifdef RESOURCES_DEBUG
67: /// measures
68: double sql_connect_time;
69: double sql_request_time;
70: #endif
1.61 paf 71:
72: /// some information from web server
1.65 paf 73: class Info {
74: public:
1.53 paf 75: const char *document_root;
76: const char *path_translated;
1.56 paf 77: const char *method;
1.53 paf 78: const char *query_string;
1.56 paf 79: const char *uri;
1.53 paf 80: const char *content_type;
81: size_t content_length;
1.60 paf 82: const char *cookie;
1.71 paf 83: const char *user_agent;
1.53 paf 84: };
85:
1.50 paf 86: Request(Pool& apool,
1.53 paf 87: Info& ainfo,
1.111 paf 88: uchar adefault_lang, ///< all tainted data default untainting lang
1.110 paf 89: bool status_allowed ///< status class allowed
1.50 paf 90: );
1.118 paf 91: ~Request();
1.1 paf 92:
1.61 paf 93: /// global classes
1.6 paf 94: Hash& classes() { return fclasses; }
95:
1.65 paf 96: /**
97: core request processing
98:
99: BEWARE: may throw exception to you: catch it!
100: */
101: void core(
1.95 parser 102: const char *root_config_filespec, ///< system config filespec
103: bool root_config_fail_on_read_problem, ///< fail if system config file not found
104: const char *site_config_filespec, ///< site config filespec
105: bool site_config_fail_on_read_problem, ///< fail if site config file not found
1.65 paf 106: bool header_only);
1.17 paf 107:
1.61 paf 108: /// executes ops
1.89 parser 109: void execute(const Array& ops); // execute.C
1.127 paf 110: /// execute ops with anti-recoursion check
1.128 paf 111: void recoursion_checked_execute(const String *name, const Array& ops) {
112: // anti_endless_execute_recoursion
113: if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
114: anti_endless_execute_recoursion=0; // give @exception a chance
115: throw Exception("parser.runtime",
116: name,
117: "call canceled - endless recursion detected");
118: }
119: execute(ops); // execute it
120: anti_endless_execute_recoursion--;
121: }
1.40 paf 122:
1.64 paf 123: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46 paf 124: VStateless_class *use_file(
1.94 parser 125: const String& file_name,
126: bool ignore_class_path=false, bool fail_on_read_problem=true,
1.45 paf 127: const String *name=0,
1.46 paf 128: VStateless_class *base_class=0); // core.C
1.64 paf 129: /// compiles a @a source buffer
1.46 paf 130: VStateless_class *use_buf(
1.40 paf 131: const char *source, const char *file,
1.46 paf 132: VStateless_class *aclass=0, const String *name=0,
133: VStateless_class *base_class=0); // core.C
1.28 paf 134:
1.129 paf 135: /// processes any code-junction there may be inside of @a value
1.130 ! paf 136: StringOrValue process(Value& input_value, bool intercept_string); // execute.C
1.129 paf 137: //@{ convinient helpers
138: const String& process_to_string(Value& input_value) {
139: return process(input_value, true/*intercept_string*/).as_string();
140: }
141: Value& process_to_value(Value& input_value, bool intercept_string=true) {
142: return process(input_value, intercept_string).as_value();
1.126 paf 143: }
144: //@}
145:
1.61 paf 146: /// appending, sure of clean string inside
1.65 paf 147: void write_no_lang(const String& astring) {
1.111 paf 148: wcontext->write(astring,
149: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.49 paf 150: }
1.61 paf 151: /// appending string, passing language built into string being written
1.65 paf 152: void write_pass_lang(const String& astring) {
153: wcontext->write(astring, String::UL_PASS_APPENDED);
1.59 paf 154: }
1.61 paf 155: /// appending possible string, assigning untaint language
1.40 paf 156: void write_assign_lang(Value& avalue) {
1.39 paf 157: wcontext->write(avalue, flang);
1.106 parser 158: }
159: /// appending string, assigning untaint language
160: void write_assign_lang(const String& astring) {
161: wcontext->write(astring, flang);
1.22 paf 162: }
1.61 paf 163: /// appending possible string, passing language built into string being written
1.40 paf 164: void write_pass_lang(Value& avalue) {
1.65 paf 165: wcontext->write(avalue, String::UL_PASS_APPENDED);
1.49 paf 166: }
1.61 paf 167: /// appending sure value, that would be converted to clean string
1.49 paf 168: void write_no_lang(Value& avalue) {
1.122 paf 169: if(wcontext->get_in_expression())
170: wcontext->write(avalue);
171: else
172: wcontext->write(avalue,
173: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.55 paf 174: }
1.61 paf 175: /// appending sure value, not VString
1.55 paf 176: void write_expr_result(Value& avalue) {
177: wcontext->write(avalue);
1.40 paf 178: }
1.22 paf 179:
1.64 paf 180: /// returns relative to @a path path to @a file
1.69 paf 181: const String& relative(const char *apath, const String& relative_name);
1.61 paf 182:
1.64 paf 183: /// returns an absolute @a path to relative @a name
1.69 paf 184: const String& absolute(const String& relative_name);
1.42 paf 185:
1.80 paf 186: /// returns the mime type of 'user_file_name_cstr'
187: const String& mime_type_of(const char *user_file_name_cstr);
188:
1.117 paf 189: /// returns current SQL connection if any
190: SQL_Connection *connection(const String *source) {
191: if(!fconnection && source)
1.125 paf 192: throw Exception("parser.runtime",
1.117 paf 193: source,
194: "outside of 'connect' operator");
195:
196: return fconnection;
197: }
198:
1.17 paf 199: public:
1.22 paf 200:
1.61 paf 201: /// info from web server
1.53 paf 202: Info& info;
1.81 paf 203: /// user's post data
204: char *post_data; size_t post_size;
1.53 paf 205:
1.78 paf 206: /// operators are methods of this class
1.84 paf 207: Methoded& OP;
1.86 paf 208: /// $env:fields
1.57 paf 209: VEnv env;
1.108 paf 210: /// $status:fields
211: VStatus status;
1.86 paf 212: /// $form:elements
1.57 paf 213: VForm form;
1.90 parser 214: /// $math:constants
215: VMath math;
1.86 paf 216: /// $request:elements
1.57 paf 217: VRequest request;
1.86 paf 218: /// $response:elements
1.57 paf 219: VResponse response;
1.86 paf 220: /// $cookie:elements
1.60 paf 221: VCookie cookie;
1.70 paf 222:
1.123 paf 223: //@{ request processing status
224: /// execution stack
225: Stack stack;
1.61 paf 226: /// contexts
1.22 paf 227: Value *self, *root, *rcontext;
1.61 paf 228: /// contexts
1.22 paf 229: WContext *wcontext;
1.124 paf 230: /// exception stack trace
231: Stack exception_trace;
1.123 paf 232: //@}
1.85 paf 233:
1.86 paf 234: /// 'MAIN' class conglomerat
1.85 paf 235: VStateless_class *main_class;
1.76 paf 236:
1.87 paf 237: /// classes configured data
238: Hash classes_conf;
239:
1.7 paf 240: private: // core data
1.6 paf 241:
1.89 parser 242: /// classes
1.6 paf 243: Hash fclasses;
1.67 paf 244:
1.89 parser 245: /// already used files to avoid cyclic uses
1.67 paf 246: Hash used_files;
1.89 parser 247:
248: /** endless execute(execute(... preventing counter
249: @see ANTI_ENDLESS_EXECUTE_RECOURSION
250: */
251: uint anti_endless_execute_recoursion;
1.99 parser 252:
1.7 paf 253: private: // compile.C
254:
1.46 paf 255: VStateless_class& real_compile(COMPILE_PARAMS);
1.7 paf 256:
257: private: // execute.C
258:
1.116 paf 259: const String *execute_method(Value& aself, const Method& method,
260: bool return_cstr);
261: const String& execute_method(VMethodFrame& amethodFrame, const Method& method);
262: const String *execute_virtual_method(Value& aself, const String& method_name);
1.93 parser 263: const String *execute_nonvirtual_method(VStateless_class& aclass,
1.116 paf 264: const String& method_name,
265: bool return_cstr);
1.9 paf 266:
1.119 paf 267: Value *get_element(bool can_call_operator);
1.22 paf 268:
1.58 paf 269: private: // defaults
270:
1.111 paf 271: const uchar fdefault_lang;
1.68 paf 272: Value *default_content_type;
1.80 paf 273:
274: private: // mime types
275:
276: /// $MAIN:MIME-TYPES
277: Table *mime_types;
1.22 paf 278:
1.39 paf 279: private: // lang manipulation
1.22 paf 280:
1.111 paf 281: uchar set_lang(uchar alang) {
282: uchar result=flang;
1.39 paf 283: flang=alang;
284: return result;
285: }
1.111 paf 286: void restore_lang(uchar alang) {
1.39 paf 287: flang=alang;
288: }
289:
1.117 paf 290: private: // lang&raw
291:
292: uchar flang;
293:
294:
295: private: // connection manipulation
296:
297: SQL_Connection *set_connection(SQL_Connection *aconnection) {
298: SQL_Connection *result=fconnection;
299: fconnection=aconnection;
300: return result;
301: }
302: void restore_connection(SQL_Connection *aconnection) {
303: fconnection=aconnection;
304: }
305:
306: private:
307:
308: /// connection
309: SQL_Connection *fconnection;
1.126 paf 310:
1.75 paf 311: void output_result(const VFile& body_file, bool header_only);
1.39 paf 312: };
313:
1.61 paf 314: /// Auto-object used for temporary changing Request::flang.
1.39 paf 315: class Temp_lang {
316: Request& frequest;
1.111 paf 317: uchar saved_lang;
1.39 paf 318: public:
1.111 paf 319: Temp_lang(Request& arequest, uchar alang) :
1.39 paf 320: frequest(arequest),
321: saved_lang(arequest.set_lang(alang)) {
322: }
323: ~Temp_lang() {
324: frequest.restore_lang(saved_lang);
1.117 paf 325: }
326: };
327:
328: /// Auto-object used for temporary changing Request::fconnection.
329: class Temp_connection {
330: Request& frequest;
331: SQL_Connection *saved_connection;
332: public:
333: Temp_connection(Request& arequest, SQL_Connection *aconnection) :
334: frequest(arequest),
335: saved_connection(arequest.set_connection(aconnection)) {
336: }
337: ~Temp_connection() {
338: frequest.restore_connection(saved_connection);
1.39 paf 339: }
1.91 parser 340: };
341:
342: /**
343: @b method parameters passed in this array.
344: contains handy typecast ad junction/not junction ensurers
345:
346: */
347: class MethodParams : public Array {
348: public:
349: MethodParams(Pool& pool, const String& amethod_name) : Array(pool),
350: fmethod_name(amethod_name) {
351: }
352:
353: /// handy typecast. I long for templates
354: Value& get(int index) {
355: return *static_cast<Value *>(Array::get(index));
356: }
357: /// handy is-value-a-junction ensurer
358: Value& as_junction(int index, const char *msg) {
359: return get_as(index, true, msg);
360: }
361: /// handy value-is-not-a-junction ensurer
362: Value& as_no_junction(int index, const char *msg) {
363: return get_as(index, false, msg);
364: }
365: /// handy expression auto-processing to double
1.102 parser 366: double as_double(int index, const char *msg, Request& r) {
367: return get_processed(index, msg, r).as_double();
1.91 parser 368: }
369: /// handy expression auto-processing to int
1.102 parser 370: int as_int(int index, const char *msg, Request& r) {
371: return get_processed(index, msg, r).as_int();
1.103 parser 372: }
373: /// handy expression auto-processing to bool
374: bool as_bool(int index, const char *msg, Request& r) {
375: return get_processed(index, msg, r).as_bool();
1.91 parser 376: }
377: /// handy string ensurer
378: const String& as_string(int index, const char *msg) {
379: return as_no_junction(index, msg).as_string();
380: }
381:
382: private:
383:
384: /// handy value-is/not-a-junction ensurer
385: Value& get_as(int index, bool as_junction, const char *msg) {
386: Value& result=get(index);
387: if((result.get_junction()!=0) ^ as_junction)
1.125 paf 388: throw Exception("parser.runtime",
1.91 parser 389: &fmethod_name,
390: "%s (parameter #%d)", msg, 1+index);
1.104 parser 391:
1.91 parser 392: return result;
393: }
394:
1.102 parser 395: Value& get_processed(int index, const char *msg, Request& r) {
1.126 paf 396: return r.process_to_value(as_junction(index, msg), 0/*no name*/);
1.91 parser 397: }
398:
399: private:
400:
401: const String& fmethod_name;
402:
1.4 paf 403: };
1.1 paf 404:
405: #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