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