Annotation of parser3/src/include/pa_request.h, revision 1.76
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.32 paf 4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.62 paf 5:
1.36 paf 6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.32 paf 7:
1.76 ! paf 8: $Id: pa_request.h,v 1.75 2001/04/03 06:23:04 paf Exp $
1.1 paf 9: */
10:
11: #ifndef PA_REQUEST_H
12: #define PA_REQUEST_H
13:
14: #include "pa_pool.h"
1.5 paf 15: #include "pa_hash.h"
1.7 paf 16: #include "pa_wcontext.h"
1.6 paf 17: #include "pa_value.h"
1.7 paf 18: #include "pa_stack.h"
1.12 paf 19: #include "pa_vclass.h"
1.45 paf 20: #include "pa_vobject.h"
1.47 paf 21: #include "pa_venv.h"
1.48 paf 22: #include "pa_vform.h"
1.56 paf 23: #include "pa_vrequest.h"
1.57 paf 24: #include "pa_vresponse.h"
1.60 paf 25: #include "pa_vcookie.h"
1.44 paf 26:
1.7 paf 27: #ifndef NO_STRING_ORIGIN
1.40 paf 28: # define COMPILE_PARAMS \
29: const char *source, \
1.46 paf 30: VStateless_class *aclass, const String *name, \
31: VStateless_class *base_class, \
1.40 paf 32: const char *file
33: # define COMPILE(source, aclass, name, base_class, file) \
34: real_compile(source, aclass, name, base_class, file)
1.7 paf 35: #else
1.40 paf 36: # define COMPILE_PARAMS \
37: const char *source, \
1.46 paf 38: VStateless_class *aclass, const String *name, \
39: VStateless_class *base_class
1.40 paf 40: # define COMPILE(source, aclass, name, base_class, file) \
41: real_compile(source, aclass, name, base_class)
1.7 paf 42: #endif
1.4 paf 43:
1.39 paf 44: class Temp_lang;
1.1 paf 45:
1.61 paf 46: /// Main workhorse.
1.7 paf 47: class Request : public Pooled {
1.39 paf 48: friend Temp_lang;
1.1 paf 49: public:
1.61 paf 50:
51: /// some information from web server
1.65 paf 52: class Info {
53: public:
1.53 paf 54: const char *document_root;
55: const char *path_translated;
1.56 paf 56: const char *method;
1.53 paf 57: const char *query_string;
1.56 paf 58: const char *uri;
1.53 paf 59: const char *content_type;
60: size_t content_length;
1.60 paf 61: const char *cookie;
1.71 paf 62: const char *user_agent;
1.53 paf 63: };
64:
1.50 paf 65: Request(Pool& apool,
1.53 paf 66: Info& ainfo,
1.63 paf 67: String::Untaint_lang adefault_lang ///< all tainted data default untainting lang
1.50 paf 68: );
1.3 paf 69: ~Request() {}
1.1 paf 70:
1.61 paf 71: /// global classes
1.6 paf 72: Hash& classes() { return fclasses; }
73:
1.65 paf 74: /**
75: core request processing
76:
77: BEWARE: may throw exception to you: catch it!
78: */
79: void core(
1.66 paf 80: const char *root_auto_path, ///< path to system auto.p file
81: bool root_auto_fail, ///< fail if system auto.p file not found
82: const char *site_auto_path, ///< path to site auto.p file
83: bool site_auto_fail, ///< fail if site auto.p file not found
1.65 paf 84: bool header_only);
1.17 paf 85:
1.61 paf 86: /// executes ops
1.40 paf 87: void execute(const Array& ops);
88:
1.64 paf 89: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46 paf 90: VStateless_class *use_file(
1.69 paf 91: const String& file_spec, bool fail_on_read_problem=true,
1.45 paf 92: const String *name=0,
1.46 paf 93: VStateless_class *base_class=0); // core.C
1.64 paf 94: /// compiles a @a source buffer
1.46 paf 95: VStateless_class *use_buf(
1.40 paf 96: const char *source, const char *file,
1.46 paf 97: VStateless_class *aclass=0, const String *name=0,
98: VStateless_class *base_class=0); // core.C
1.64 paf 99: /// processes any code-junction there may be inside of @a value
1.40 paf 100: Value& process(
1.33 paf 101: Value& value,
1.37 paf 102: const String *name=0,
1.38 paf 103: bool intercept_string=true); // execute.C
1.28 paf 104:
1.61 paf 105: /// appending, sure of clean string inside
1.65 paf 106: void write_no_lang(const String& astring) {
1.74 paf 107: wcontext->write(astring, String::UL_CLEAN);
1.49 paf 108: }
1.61 paf 109: /// appending string, passing language built into string being written
1.65 paf 110: void write_pass_lang(const String& astring) {
111: wcontext->write(astring, String::UL_PASS_APPENDED);
1.59 paf 112: }
1.61 paf 113: /// appending possible string, assigning untaint language
1.40 paf 114: void write_assign_lang(Value& avalue) {
1.39 paf 115: wcontext->write(avalue, flang);
1.22 paf 116: }
1.61 paf 117: /// appending possible string, passing language built into string being written
1.40 paf 118: void write_pass_lang(Value& avalue) {
1.65 paf 119: wcontext->write(avalue, String::UL_PASS_APPENDED);
1.49 paf 120: }
1.61 paf 121: /// appending sure value, that would be converted to clean string
1.49 paf 122: void write_no_lang(Value& avalue) {
1.74 paf 123: wcontext->write(avalue, String::UL_CLEAN);
1.55 paf 124: }
1.61 paf 125: /// appending sure value, not VString
1.55 paf 126: void write_expr_result(Value& avalue) {
127: wcontext->write(avalue);
1.40 paf 128: }
1.43 paf 129:
1.61 paf 130: /// handy is-value-a-junction ensurer
1.65 paf 131: void fail_if_junction_(bool is, Value& value,
132: const String& method_name, const char *msg);
1.22 paf 133:
1.64 paf 134: /// returns relative to @a path path to @a file
1.69 paf 135: const String& relative(const char *apath, const String& relative_name);
1.61 paf 136:
1.64 paf 137: /// returns an absolute @a path to relative @a name
1.69 paf 138: const String& absolute(const String& relative_name);
1.42 paf 139:
1.17 paf 140: public:
1.22 paf 141:
1.61 paf 142: /// info from web server
1.53 paf 143: Info& info;
144:
1.61 paf 145: /// default base
1.57 paf 146: VClass ROOT;
1.61 paf 147: /// $env:fields here
1.57 paf 148: VEnv env;
1.61 paf 149: /// $form:elements here
1.57 paf 150: VForm form;
1.61 paf 151: /// $request:elements here
1.57 paf 152: VRequest request;
1.61 paf 153: /// $response:
1.57 paf 154: VResponse response;
1.61 paf 155: /// $cookie:
1.60 paf 156: VCookie cookie;
1.70 paf 157:
158: /// $MAIN:MIME-TYPES
159: Table *mime_types;
1.17 paf 160:
1.61 paf 161: /// contexts
1.22 paf 162: Value *self, *root, *rcontext;
1.61 paf 163: /// contexts
1.22 paf 164: WContext *wcontext;
1.76 ! paf 165:
! 166: /// connection
! 167: const String *connection;
1.6 paf 168:
1.7 paf 169: private: // core data
1.6 paf 170:
171: // classes
172: Hash fclasses;
1.67 paf 173:
174: // already used files to avoid cyclic uses
175: Hash used_files;
1.6 paf 176:
1.7 paf 177: // execution stack
178: Stack stack;
179:
180: private: // compile.C
181:
1.46 paf 182: VStateless_class& real_compile(COMPILE_PARAMS);
1.7 paf 183:
184: private: // execute.C
185:
1.57 paf 186: const String *execute_method(Value& aself, const Method& method,
187: bool return_cstr=true);
188: const String *execute_method(Value& aself, const String& method_name,
189: bool return_cstr=true);
1.9 paf 190:
191: Value *get_element();
1.22 paf 192:
193: private: // lang&raw
194:
1.39 paf 195: String::Untaint_lang flang;
1.58 paf 196:
197: private: // defaults
198:
199: const String::Untaint_lang fdefault_lang;
1.68 paf 200: Value *default_content_type;
1.22 paf 201:
1.39 paf 202: private: // lang manipulation
1.22 paf 203:
1.39 paf 204: String::Untaint_lang set_lang(String::Untaint_lang alang) {
205: String::Untaint_lang result=flang;
206: flang=alang;
207: return result;
208: }
209: void restore_lang(String::Untaint_lang alang) {
210: flang=alang;
211: }
212:
1.59 paf 213: private:
214:
1.75 paf 215: void output_result(const VFile& body_file, bool header_only);
1.39 paf 216: };
217:
1.61 paf 218: /// Auto-object used for temporary changing Request::flang.
1.39 paf 219: class Temp_lang {
220: Request& frequest;
221: String::Untaint_lang saved_lang;
222: public:
223: Temp_lang(Request& arequest, String::Untaint_lang alang) :
224: frequest(arequest),
225: saved_lang(arequest.set_lang(alang)) {
226: }
227: ~Temp_lang() {
228: frequest.restore_lang(saved_lang);
229: }
1.4 paf 230: };
1.1 paf 231:
232: #endif
E-mail: