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