Annotation of parser3/src/include/pa_request.h, revision 1.274
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.272 moko 4: Copyright (c) 2001-2026 Art. Lebedev Studio (https://www.artlebedev.com)
1.262 moko 5: Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.1 paf 6: */
7:
8: #ifndef PA_REQUEST_H
9: #define PA_REQUEST_H
1.141 paf 10:
1.274 ! moko 11: #define IDENT_PA_REQUEST_H "$Id: pa_request.h,v 1.273 2026/09/24 02:40:10 moko Exp $"
1.1 paf 12:
1.168 paf 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.273 moko 17: #include "pa_vhash.h"
1.7 paf 18: #include "pa_stack.h"
1.162 paf 19: #include "pa_request_info.h"
20: #include "pa_request_charsets.h"
21: #include "pa_sapi.h"
1.44 paf 22:
1.257 moko 23: // externs
24:
25: extern const String main_method_name;
26: extern const String auto_method_name;
27:
28: // defines for statics
29:
30: #define MAIN_CLASS_NAME "MAIN"
31: #define AUTO_FILE_NAME "auto.p"
32:
1.128 paf 33: // consts
34:
1.162 paf 35: const size_t pseudo_file_no__process=1;
1.128 paf 36:
1.162 paf 37: // forwards
1.4 paf 38:
1.39 paf 39: class Temp_lang;
1.84 paf 40: class Methoded;
1.116 paf 41: class VMethodFrame;
1.162 paf 42: class VMail;
43: class VForm;
44: class VResponse;
45: class VCookie;
46: class VStateless_class;
1.215 moko 47: class VConsole;
1.273 moko 48: class VException;
1.1 paf 49:
1.244 moko 50: extern int pa_loop_limit;
1.266 moko 51: extern int pa_array_limit;
1.267 moko 52: extern int pa_execute_recursion_limit;
1.257 moko 53: extern int pa_httpd_timeout;
1.244 moko 54: extern size_t pa_file_size_limit;
1.229 moko 55:
1.61 paf 56: /// Main workhorse.
1.162 paf 57: class Request: public PA_Object {
1.107 paf 58: friend class Temp_lang;
1.117 paf 59: friend class Temp_connection;
1.214 moko 60: friend class Temp_request_self;
61: friend class Temp_value_element;
1.267 moko 62: friend class Temp_recursion;
1.148 paf 63: friend class Request_context_saver;
1.162 paf 64: friend class Exception_trace;
1.273 moko 65: friend class VException;
1.162 paf 66:
1.1 paf 67: public:
1.162 paf 68: class Trace {
69: const String* fname;
70: Operation::Origin forigin;
71: public:
72: Trace(): fname(0) {}
73: void clear() { fname=0; }
74:
75: Trace(const String* aname, const Operation::Origin aorigin):
76: fname(aname), forigin(aorigin) {}
77:
78: const String* name() const { return fname; }
79: const Operation::Origin origin() const { return forigin; }
80: };
81:
1.181 paf 82: enum Skip {
83: SKIP_NOTHING,
1.245 moko 84: SKIP_CONTINUE,
1.181 paf 85: SKIP_BREAK,
1.245 moko 86: SKIP_RETURN,
87: SKIP_INTERRUPTED
1.181 paf 88: };
89:
1.168 paf 90: private:
91: Pool fpool;
92: public:
93: Pool& pool() { return fpool; }
1.162 paf 94:
95: private:
96: union StackItem {
97: Value* fvalue;
98: ArrayOperation* fops;
99: VMethodFrame* fmethod_frame;
100: public:
101: Value& value() const { return *fvalue; }
102: const String& string() const {
1.167 paf 103: return fvalue->as_string();
1.162 paf 104: }
105: ArrayOperation& ops() const { return *fops; }
106: VMethodFrame& method_frame() const { return *fmethod_frame; }
107:
1.228 moko 108: StackItem(Value& avalue): fvalue(&avalue) {}
1.162 paf 109: StackItem(ArrayOperation& aops): fops(&aops) {}
110: StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {}
111: };
112:
113: class Exception_trace: public Stack<Trace> {
114: size_t fbottom;
115: public:
116: Exception_trace(): fbottom(0) {}
117:
118: size_t bottom_index() { return fbottom; }
1.165 paf 119: void set_bottom_index(size_t abottom) { fbottom=abottom; }
1.162 paf 120: element_type bottom_value() { return get(bottom_index()); }
1.274 ! moko 121: void set_range(size_t bottom, size_t top) { fbottom=bottom; fsize=top; }
1.162 paf 122:
123: void clear() {
1.264 moko 124: fsize=fbottom=0;
1.162 paf 125: }
126:
127: bool is_empty() {
1.264 moko 128: return fsize==fbottom;
1.162 paf 129: }
1.259 moko 130:
1.274 ! moko 131: Table &table(Request &r, const String* problem_source);
1.162 paf 132: };
133:
134: ///@{ core data
135:
136: /// classes
1.270 moko 137: OrderedHashString<VStateless_class*> fclasses;
1.162 paf 138:
139: /// already used files to avoid cyclic uses
1.193 misha 140: HashString<bool> used_files;
1.200 misha 141: HashString<bool> searched_along_class_path;
1.162 paf 142: /// list of all used files, Operation::file_no = index to it
1.163 paf 143: Array<String::Body> file_list;
1.162 paf 144:
1.229 moko 145: /// endless execute(execute(... preventing counter
1.267 moko 146: int anti_endless_execute_recursion;
1.162 paf 147:
148: ///@}
149:
150: /// execution stack
151: Stack<StackItem> stack;
152:
1.274 ! moko 153: public:
1.162 paf 154: /// exception stack trace
155: Exception_trace exception_trace;
156:
1.213 moko 157: bool allow_class_replace;
158:
1.162 paf 159: //@{ request processing status
160: /// contexts
161: VMethodFrame* method_frame;
162: Value* rcontext;
163: WContext* wcontext;
164: /// current language
1.228 moko 165: String::Language flang;
1.162 paf 166: /// current connection
167: SQL_Connection* fconnection;
168: //@}
1.245 moko 169:
170: private:
171:
172: int fin_cycle;
1.181 paf 173: Skip fskip;
1.245 moko 174: VMethodFrame* freturn_method_frame;
1.162 paf 175:
176: public:
1.175 paf 177: uint register_file(String::Body file_spec);
1.162 paf 178:
1.273 moko 179: const char* get_exception_cstr(const Exception& e, VException& details);
1.162 paf 180:
181: /// @see Stack::wipe_unused
182: void wipe_unused_execution_stack() {
183: stack.wipe_unused();
184: }
1.112 paf 185:
186: #ifdef RESOURCES_DEBUG
187: /// measures
188: double sql_connect_time;
189: double sql_request_time;
190: #endif
1.61 paf 191:
1.162 paf 192: Request(SAPI_Info& asapi_info, Request_info& arequest_info,
1.208 moko 193: String::Language adefault_lang ///< all tainted data default untainting lang
1.50 paf 194: );
1.118 paf 195: ~Request();
1.1 paf 196:
1.61 paf 197: /// global classes
1.270 moko 198: OrderedHashString<VStateless_class*>& classes() { return fclasses; }
1.224 moko 199: VStateless_class* get_class(const String& name);
1.260 moko 200: VStateless_class& get_class_ref(const String& name);
1.224 moko 201: void put_class(VStateless_class *aclass){ classes().put(aclass->type(), aclass); }
1.265 moko 202: bool add_class(const char* atype, VStateless_class *aclass);
1.6 paf 203:
1.65 paf 204: /**
205: core request processing
206: BEWARE: may throw exception to you: catch it!
207: */
1.261 moko 208: void core(const char* config_filespec, bool header_only, const String& amain_method_name = main_method_name, const String* amain_class_name = NULL);
1.17 paf 209:
1.61 paf 210: /// executes ops
1.162 paf 211: void execute(ArrayOperation& ops); // execute.C
1.239 moko 212:
213: template<typename Frame> void call(Frame& frame){
214: VMethodFrame *saved_method_frame=method_frame;
215: Value* saved_rcontext=rcontext;
216: WContext *saved_wcontext=wcontext;
217:
218: rcontext=wcontext=method_frame=&frame;
219:
220: frame.call(*this);
221:
222: wcontext=saved_wcontext;
223: rcontext=saved_rcontext;
224: method_frame=saved_method_frame;
225: }
226:
227: template<typename Frame> void call_write(Frame& frame){
228: VMethodFrame *saved_method_frame=method_frame;
229: Value* saved_rcontext=rcontext;
230:
231: rcontext=method_frame=&frame;
232:
233: frame.call(*this);
234:
235: rcontext=saved_rcontext;
236: method_frame=saved_method_frame;
237: }
238:
1.225 moko 239: Value& construct(VStateless_class &class_value, const Method &method);
1.202 moko 240:
1.267 moko 241: /// execute ops with anti-recursion check
242: void recursion_checked_execute(ArrayOperation& ops) {
1.271 moko 243: if(++anti_endless_execute_recursion>=pa_execute_recursion_limit) {
1.267 moko 244: anti_endless_execute_recursion=0; // give @exception a chance
1.228 moko 245: throw Exception(PARSER_RUNTIME, 0, "call canceled - endless recursion detected");
1.128 paf 246: }
1.147 paf 247: execute(ops); // execute it
1.267 moko 248: anti_endless_execute_recursion--;
1.128 paf 249: }
1.40 paf 250:
1.199 misha 251: ///
1.255 moko 252: void use_file_directly(const String& file_spec, bool fail_on_file_absence=true, bool with_auto_p=false);
1.228 moko 253:
1.255 moko 254: /// compiles the file in main class context by default
255: void use_file(const String& file_name, const String* use_filespec, bool with_auto_p=false);
1.241 moko 256:
257: /// for @USE only, calls ^use (which may be user-defined)
258: void use_file(const String& file_name, const String* use_filespec, Operation::Origin origin);
1.199 misha 259:
1.64 paf 260: /// compiles a @a source buffer
1.228 moko 261: void use_buf(VStateless_class& aclass, const char* source, const String* main_alias, uint file_no, int line_no_offset=0);
1.28 paf 262:
1.129 paf 263: /// processes any code-junction there may be inside of @a value
1.227 moko 264: Value& process_getter(Junction& junction); // execute.C
1.231 moko 265: Value& process(Value& input_value); // execute.C
1.192 misha 266: void process_write(Value& input_value); // execute.C
1.228 moko 267:
1.129 paf 268: //@{ convinient helpers
269: const String& process_to_string(Value& input_value) {
1.231 moko 270: return process(input_value).as_string();
1.129 paf 271: }
1.126 paf 272: //@}
1.247 moko 273: const Operation::Origin get_method_origin(const Method* method); // execute.C
1.242 moko 274: const String* get_method_filespec(const Method* method); // execute.C
275: const String* get_used_filespec(uint file_no);
1.126 paf 276:
1.238 moko 277: /// appending string with it's languages
1.239 moko 278: inline void write(const String& astring) {
1.236 moko 279: wcontext->write(astring);
1.49 paf 280: }
1.238 moko 281:
282: /// in [] and {} appending string if get_string is not null, else appending value
1.240 moko 283: /// in () appending string if is_string, else appending value
1.239 moko 284: inline void write(Value& avalue) {
1.236 moko 285: wcontext->write_as_string(avalue);
1.131 paf 286: }
287:
1.238 moko 288: /// allways appending value
1.239 moko 289: inline void write_value(Value& avalue) {
1.226 moko 290: wcontext->write(avalue);
291: }
292:
1.64 paf 293: /// returns relative to @a path path to @a file
1.162 paf 294: const String& relative(const char* apath, const String& relative_name);
1.61 paf 295:
1.256 moko 296: const String& full_disk_path(const String& relative_name);
1.42 paf 297:
1.209 misha 298: /// returns the mime type of 'user_file_name'
299: const String& mime_type_of(const String* file_name);
300:
1.80 paf 301: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 302: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 303:
1.117 paf 304: /// returns current SQL connection if any
1.228 moko 305: SQL_Connection* connection(bool fail_on_error=true) {
1.162 paf 306: if(fail_on_error && !fconnection)
1.228 moko 307: throw Exception(PARSER_RUNTIME, 0, "outside of 'connect' operator");
308: return fconnection;
1.133 paf 309: }
310:
1.245 moko 311: Skip get_skip() { return fskip; }
1.181 paf 312: void set_skip(Skip askip) { fskip=askip; }
1.246 moko 313: void set_skip_return(VMethodFrame& amethod_frame) { fskip=SKIP_RETURN; freturn_method_frame=&amethod_frame; }
1.245 moko 314: inline bool check_skip_break() { bool result=fskip >= SKIP_BREAK; if(fskip <= SKIP_BREAK) fskip=SKIP_NOTHING; return result; }
315: inline void check_skip_return() { if(fskip==SKIP_RETURN && method_frame==freturn_method_frame) fskip=SKIP_NOTHING; }
1.181 paf 316:
1.196 misha 317: void set_in_cycle(int adelta) { fin_cycle+=adelta; }
318: bool get_in_cycle() { return fin_cycle>0; }
319:
1.17 paf 320: public:
1.22 paf 321:
1.61 paf 322: /// info from web server
1.162 paf 323: Request_info& request_info;
324:
325: /// info about ServerAPI
326: SAPI_Info& sapi_info;
327:
328: /// source, client, mail charsets
329: Request_charsets charsets;
1.53 paf 330:
1.154 paf 331: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 332: VStateless_class& main_class;
1.86 paf 333: /// $form:elements
1.162 paf 334: VForm& form;
1.140 paf 335: /// $mail
1.162 paf 336: VMail& mail;
1.86 paf 337: /// $response:elements
1.162 paf 338: VResponse& response;
1.86 paf 339: /// $cookie:elements
1.162 paf 340: VCookie& cookie;
1.183 misha 341: /// $console
342: VConsole& console;
1.70 paf 343:
1.148 paf 344: /// classes configured data
1.193 misha 345: HashString<void*> classes_conf;
1.85 paf 346:
1.148 paf 347: public: // status read methods
1.76 paf 348:
1.148 paf 349: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 350: Value& get_self();
1.227 moko 351:
1.162 paf 352: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
1.6 paf 353:
1.205 moko 354: /// public for ^reflection:copy[]
355: void put_element(Value& ncontext, const String& name, Value* value);
356:
1.251 moko 357: /// for @main[] and parser://method/call
358: const String* execute_method(VStateless_class& aclass, const String& method_name, Value* optional_param = 0);
1.173 paf 359:
1.251 moko 360: //{ for @conf[filespec] and @auto[filespec]
361: bool execute_method_if_exists(VStateless_class& aclass, const String& method_name, Value* optional_param);
1.263 moko 362: bool execute_auto_method_if_exists(VStateless_class& aclass, const String& method_name, Value* optional_param);
1.228 moko 363:
1.173 paf 364: //}
365:
1.162 paf 366: #ifdef XML
367: public: // charset helpers
1.67 paf 368:
1.162 paf 369: /// @see Charset::transcode
1.180 paf 370: xmlChar* transcode(const String& s);
1.162 paf 371: /// @see Charset::transcode
1.180 paf 372: xmlChar* transcode(const String::Body s);
1.162 paf 373: /// @see Charset::transcode
1.180 paf 374: const String& transcode(const xmlChar* s);
1.89 parser 375:
1.162 paf 376: #endif
1.136 paf 377:
378: private:
379:
380: /// already executed some @conf method
381: bool configure_admin_done;
382:
1.162 paf 383: void configure_admin(VStateless_class& conf_class);
1.177 paf 384:
385: void configure();
1.99 parser 386:
1.7 paf 387: private: // compile.C
388:
1.228 moko 389: ArrayClass& compile(VStateless_class* aclass, const char* source, const String* main_alias, uint file_no, int line_no_offset);
1.7 paf 390:
391: private: // execute.C
1.9 paf 392:
1.191 misha 393: Value& get_element(Value& ncontext, const String& name);
1.219 moko 394: #ifdef FEATURE_GET_ELEMENT4CALL
395: Value& get_element4call(Value& ncontext, const String& name);
396: #endif
1.22 paf 397:
1.58 paf 398: private: // defaults
399:
1.162 paf 400: const String::Language fdefault_lang;
1.80 paf 401:
402: private: // mime types
403:
404: /// $MAIN:MIME-TYPES
405: Table *mime_types;
1.22 paf 406:
1.117 paf 407: private: // connection manipulation
408:
1.162 paf 409: SQL_Connection* set_connection(SQL_Connection* aconnection) {
410: SQL_Connection* result=fconnection;
1.117 paf 411: fconnection=aconnection;
412: return result;
413: }
1.162 paf 414: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 415: fconnection=aconnection;
416: }
417:
418: private:
419:
1.162 paf 420: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 421: };
422:
1.273 moko 423: /// Hash-compatible exception; hash is built on demand.
424: class VException: public VHashReference {
425: Exception fexception;
426: String::Body ffile;
427: Value* fhandled;
428: public:
429: Operation::Origin origin;
430: const String* problem_source;
431:
432: VException(Request& r, const Exception& e);
433:
434: override HashStringValue& hash();
435: override Value* get_element(const String& name);
436: override const VJunction* put_element(const String& name, Value* value);
437:
438: Value* handled();
439: };
440:
1.148 paf 441: /// Auto-object used to save request context across ^try body
442: class Request_context_saver {
443: Request& fr;
444:
445: /// execution stack
1.162 paf 446: size_t stack;
1.267 moko 447: uint anti_endless_execute_recursion;
1.148 paf 448: /// contexts
1.162 paf 449: VMethodFrame* method_frame;
450: Value* rcontext;
451: WContext* wcontext;
1.148 paf 452: /// current language
1.162 paf 453: String::Language flang;
1.148 paf 454: /// current connection
1.162 paf 455: SQL_Connection* fconnection;
1.126 paf 456:
1.148 paf 457: public:
1.228 moko 458: Request_context_saver(Request& ar) :
1.171 paf 459: fr(ar),
1.165 paf 460: stack(ar.stack.top_index()),
1.267 moko 461: anti_endless_execute_recursion(ar.anti_endless_execute_recursion),
1.148 paf 462: method_frame(ar.method_frame),
463: rcontext(ar.rcontext),
464: wcontext(ar.wcontext),
465: flang(ar.flang),
1.171 paf 466: fconnection(ar.fconnection) {}
1.153 paf 467: void restore() {
1.165 paf 468: fr.stack.set_top_index(stack);
1.267 moko 469: fr.anti_endless_execute_recursion=anti_endless_execute_recursion;
1.157 paf 470: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 471: fr.flang=flang;
472: fr.fconnection=fconnection;
473: }
1.39 paf 474: };
475:
1.117 paf 476: /// Auto-object used for temporary changing Request::fconnection.
477: class Temp_connection {
478: Request& frequest;
1.162 paf 479: SQL_Connection* saved_connection;
1.117 paf 480: public:
1.228 moko 481: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 482: frequest(arequest),
483: saved_connection(arequest.set_connection(aconnection)) {
484: }
1.228 moko 485: ~Temp_connection() {
1.117 paf 486: frequest.restore_connection(saved_connection);
1.39 paf 487: }
1.91 parser 488: };
489:
1.196 misha 490: /// Auto-object used for break out of cycle check
491: class InCycle {
492: Request& frequest;
493: public:
494: InCycle(Request& arequest) : frequest(arequest) {
495: frequest.set_in_cycle(1);
496: }
1.228 moko 497: ~InCycle() {
1.196 misha 498: frequest.set_in_cycle(-1);
499: }
500: };
1.91 parser 501:
1.245 moko 502: /// Auto-object used for break out of cycle check
503: class TempSkip4Delimiter {
504: Request& frequest;
505: Request::Skip fskip;
506: public:
507: TempSkip4Delimiter(Request& arequest) : frequest(arequest), fskip(arequest.get_skip()) {
508: frequest.set_skip(Request::SKIP_NOTHING);
509: }
510: // returns true if break required, should be called
511: bool check_break() {
512: if(frequest.get_skip())
513: fskip=frequest.get_skip();
514: frequest.set_skip(fskip <= Request::SKIP_BREAK ? Request::SKIP_NOTHING : fskip);
515: return fskip >= Request::SKIP_BREAK;
516: }
517: };
518:
1.213 moko 519: /// Auto-object used for temporary changing Request::allow_class_replace.
520: class Temp_class_replace {
521: Request& frequest;
522: public:
523: Temp_class_replace(Request& arequest, bool avalue) : frequest(arequest){
524: frequest.allow_class_replace=avalue;
525: }
526: ~Temp_class_replace() {
527: frequest.allow_class_replace=false;
528: }
529: };
530:
1.214 moko 531: /// Auto-object used for temporarily substituting/removing elements
532: class Temp_value_element {
533: Request& frequest;
534: Value& fwhere;
535: const String& fname;
1.216 moko 536: Value* saved;
1.214 moko 537: public:
1.216 moko 538: Temp_value_element(Request& arequest, Value& awhere, const String& aname, Value* awhat);
539: ~Temp_value_element();
1.214 moko 540: };
541:
1.267 moko 542: /// Auto-object that temporarily increases recursion
543: class Temp_recursion {
544: Request& frequest;
545: public:
546: Temp_recursion(Request& arequest) : frequest(arequest){
547: frequest.anti_endless_execute_recursion++;
548: }
549: ~Temp_recursion(){
550: frequest.anti_endless_execute_recursion--;
551: }
552: };
553:
1.1 paf 554: #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