Annotation of parser3/src/include/pa_common.h, revision 1.176
1.15 paf 1: /** @file
1.16 paf 2: Parser: commonly used functions.
3:
1.174 moko 4: Copyright (c) 2001-2017 Art. Lebedev Studio (http://www.artlebedev.com)
1.74 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1 paf 6: */
7:
8: #ifndef PA_COMMON_H
9: #define PA_COMMON_H
1.78 paf 10:
1.176 ! moko 11: #define IDENT_PA_COMMON_H "$Id: pa_common.h,v 1.175 2019/09/06 10:17:07 moko Exp $"
1.1 paf 12:
1.33 paf 13: #include "pa_string.h"
1.93 paf 14: #include "pa_hash.h"
1.176 ! moko 15: #include "pa_base64.h"
1.1 paf 16:
1.128 misha 17: class Request;
18:
1.120 misha 19: // defines
1.164 moko 20: #define HTTP_STATUS "status"
1.140 misha 21: #define HTTP_STATUS_CAPITALIZED "Status"
22:
1.164 moko 23: #define HTTP_CONTENT_LENGTH "content-length"
1.140 misha 24: #define HTTP_CONTENT_LENGTH_CAPITALIZED "Content-Length"
1.136 misha 25:
1.159 moko 26: #define HTTP_CONTENT_TYPE "content-type"
27: #define HTTP_CONTENT_TYPE_UPPER "CONTENT-TYPE"
1.138 misha 28: #define HTTP_CONTENT_TYPE_CAPITALIZED "Content-Type"
1.120 misha 29:
1.159 moko 30: #define CONTENT_DISPOSITION "content-disposition"
31: #define CONTENT_DISPOSITION_UPPER "CONTENT-DISPOSITION"
1.138 misha 32: #define CONTENT_DISPOSITION_CAPITALIZED "Content-Disposition"
1.164 moko 33:
34: #define CONTENT_DISPOSITION_ATTACHMENT "attachment"
35: #define CONTENT_DISPOSITION_INLINE "inline"
1.134 misha 36: #define CONTENT_DISPOSITION_FILENAME_NAME "filename"
37:
1.164 moko 38: #define HTTP_CONTENT_TYPE_FORM_URLENCODED "application/x-www-form-urlencoded"
39: #define HTTP_CONTENT_TYPE_MULTIPART_FORMDATA "multipart/form-data"
40: #define HTTP_CONTENT_TYPE_MULTIPART_RELATED "multipart/related"
41: #define HTTP_CONTENT_TYPE_MULTIPART_MIXED "multipart/mixed"
42:
1.145 misha 43: #define BASE64_STRICT_OPTION_NAME "strict"
44:
1.134 misha 45: const String content_disposition_filename_name(CONTENT_DISPOSITION_FILENAME_NAME);
46:
1.132 misha 47: #define HASH_ORDER
48:
49: #ifdef HASH_ORDER
50: #undef PA_HASH_CLASS
51: #include "pa_hash.h"
52: #endif
53:
1.87 paf 54: class Value;
1.132 misha 55: typedef HASH_STRING<Value*> HashStringValue;
1.64 paf 56:
57: // replace system s*nprintf with our versions
1.69 paf 58: #undef vsnprintf
1.167 moko 59: int pa_vsnprintf(char *, size_t, const char* , va_list);
60: #define vsnprintf pa_vsnprintf
1.64 paf 61: #undef snprintf
1.167 moko 62: int pa_snprintf(char *, size_t, const char* , ...);
63: #define snprintf pa_snprintf
1.63 paf 64:
1.153 moko 65: #ifdef _MSC_VER
1.17 paf 66:
67: //access
68: #define F_OK 0
69: #define X_OK 1
70: #define W_OK 2
71: #define R_OK 4
72:
1.20 paf 73: #ifndef strcasecmp
74: # define strcasecmp _stricmp
75: #endif
1.2 paf 76:
1.157 moko 77: #ifndef strncasecmp
78: # define strncasecmp _strnicmp
79: #endif
80:
1.171 moko 81: #define stat __stat64
82: #define pa_fstat _fstat64
83:
1.173 moko 84: int pa_stat(const char *pathname, struct stat *buffer);
85: int pa_open(const char *pathname, int flags, int mode=0);
86: FILE *pa_fopen(const char *pathname, const char *mode);
87:
1.171 moko 88: #else
89:
90: #define pa_stat stat
91: #define pa_fstat fstat
92:
1.173 moko 93: #define pa_open open
94: #define pa_fopen fopen
95:
1.17 paf 96: #endif
1.59 paf 97:
1.154 moko 98: /**
99: file related functions
100: */
1.136 misha 101:
1.154 moko 102: #define FILE_BUFFER_SIZE 4096
1.95 paf 103:
104: int pa_lock_shared_blocking(int fd);
105: int pa_lock_exclusive_blocking(int fd);
106: int pa_lock_exclusive_nonblocking(int fd);
107: int pa_unlock(int fd);
1.101 paf 108:
109: void create_dir_for_file(const String& file_spec);
1.93 paf 110:
1.154 moko 111: int pa_get_valid_file_options_count(HashStringValue& options);
112:
1.163 moko 113: typedef void (*File_read_action)(struct stat& finfo, int f, const String& file_spec, void *context);
1.83 paf 114:
115: /**
116: shared-lock specified file,
117: do actions under lock.
118: if fail_on_read_problem is true[default] throws an exception
119:
120: @returns true if read OK
121: */
1.93 paf 122: bool file_read_action_under_lock(const String& file_spec,
123: const char* action_name, File_read_action action, void *context,
1.83 paf 124: bool as_text=false,
125: bool fail_on_read_problem=true);
1.128 misha 126:
1.15 paf 127: /**
1.93 paf 128: read specified text file using
1.15 paf 129: if fail_on_read_problem is true[default] throws an exception
1.83 paf 130:
1.93 paf 131: WARNING: charset is used for http header case conversion, it's not a charset of input file!
1.15 paf 132: */
1.93 paf 133: char *file_read_text(Request_charsets& charsets,
1.126 misha 134: const String& file_spec,
135: bool fail_on_read_problem=true,
136: HashStringValue* options=0,
137: bool transcode_result=true);
1.93 paf 138:
1.128 misha 139: char *file_load_text(Request& r,
140: const String& file_spec,
141: bool fail_on_read_problem=true,
142: HashStringValue* options=0,
143: bool transcode_result=true);
144:
1.93 paf 145: struct File_read_result {
146: bool success;
147: char* str; size_t length;
148: HashStringValue* headers;
149: };
1.17 paf 150:
151: /**
1.93 paf 152: read specified file using
1.29 paf 153: if fail_on_read_problem is true[default] throws an exception
1.83 paf 154:
1.93 paf 155: WARNING: charset is used for http header case conversion, it's not a charset of input file!
1.128 misha 156: */
157: File_read_result file_read(Request_charsets& charsets,
158: const String& file_spec,
159: bool as_text,
160: HashStringValue* options=0,
161: bool fail_on_read_problem=true,
162: char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true);
1.93 paf 163:
1.128 misha 164: File_read_result file_load(Request& r,
165: const String& file_spec,
1.126 misha 166: bool as_text,
167: HashStringValue* options=0,
168: bool fail_on_read_problem=true,
169: char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true);
1.83 paf 170:
171: typedef void (*File_write_action)(int f, void *context);
1.29 paf 172:
173: /**
1.71 paf 174: lock specified file exclusively,
175: do actions under lock.
176: throws an exception in case of problems
1.72 paf 177:
178: if block=false does non-blocking lock
179: @returns true if locked OK, or false if non-blocking locking failed
1.71 paf 180: */
1.72 paf 181: bool file_write_action_under_lock(
1.71 paf 182: const String& file_spec,
1.114 misha 183: const char* action_name,
184: File_write_action action,
185: void *context,
1.71 paf 186: bool as_text=false,
1.72 paf 187: bool do_append=false,
1.77 paf 188: bool do_block=true,
189: bool fail_on_lock_problem=true);
1.71 paf 190:
191: /**
192: write data to specified file,
1.17 paf 193: throws an exception in case of problems
194: */
1.70 paf 195: void file_write(
1.137 misha 196: Request_charsets& charsets,
1.25 paf 197: const String& file_spec,
1.137 misha 198: const char* data,
199: size_t size,
1.58 paf 200: bool as_text,
1.137 misha 201: bool do_append=false,
202: Charset* asked_charset=0);
1.26 paf 203:
204: /**
205: delete specified file
206: throws an exception in case of problems
207: */
1.149 misha 208: bool file_delete(const String& file_spec, bool fail_on_problem=true, bool keep_empty_dirs=false);
1.47 parser 209: /**
210: move specified file
211: throws an exception in case of problems
212: */
1.149 misha 213: void file_move(const String& old_spec, const String& new_spec, bool keep_empty_dirs=false);
1.27 paf 214:
1.93 paf 215: bool entry_exists(const char* fname, struct stat *afinfo=0);
1.82 paf 216: bool entry_exists(const String& file_spec);
1.107 paf 217: bool file_exist(const String& file_spec);
218: bool dir_exists(const String& file_spec);
219: const String* file_exist(const String& path, const String& name);
1.36 paf 220: bool file_executable(const String& file_spec);
1.37 paf 221:
1.168 moko 222: bool file_stat(const String& file_spec, uint64_t& rsize, time_t& ratime, time_t& rmtime, time_t& rctime, bool fail_on_read_problem=true);
1.172 moko 223: size_t check_file_size(uint64_t size, const String& file_spec);
1.15 paf 224:
1.154 moko 225: size_t stdout_write(const void *buf, size_t size);
226:
227: void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname);
228:
229: int file_block_read(const int f, unsigned char* buffer, const size_t size);
230:
231: /**
232: String related functions
233: */
234:
235: /** under WIN32 "t" mode fixes DOS chars OK,
236: can't say that about other systems/ line break styles
1.15 paf 237: */
1.154 moko 238: void fix_line_breaks(char *str, size_t& length /* < may change! used to speedup next actions */);
239:
1.7 paf 240: char *getrow(char **row_ref,char delim='\n');
1.76 paf 241: char *lsplit(char *string, char delim);
1.7 paf 242: char *lsplit(char **string_ref,char delim);
1.8 paf 243: char *rsplit(char *string, char delim);
1.165 moko 244:
1.151 moko 245: const char* format(double value, const char *fmt);
1.10 paf 246:
1.142 misha 247: char* unescape_chars(const char* cp, int len, Charset* client_charset=0, bool js=false/*true==decode \uXXXX and don't convert '+' to space*/);
1.23 paf 248:
1.148 misha 249: char *search_stop(char*& current, char cstop_at);
250:
1.157 moko 251: inline int pa_strncasecmp(const char* str, const char* substr, size_t count=0) {
252: return strncasecmp(str, substr, count ? count : strlen(substr));
253: }
254:
1.23 paf 255: #ifdef WIN32
256: void back_slashes_to_slashes(char *s);
257: #endif
258:
1.121 misha 259: size_t strpos(const char *str, const char *substr);
260:
1.116 misha 261: int remove_crlf(char *start, char *end);
1.90 paf 262:
1.165 moko 263: inline bool pa_isalpha(unsigned char c) { return (((c>='A') && (c<='Z')) || ((c>='a') && (c<='z'))); }
264: inline bool pa_isalnum(unsigned char c) { return (((c>='0') && (c<='9')) || pa_isalpha(c)); }
1.144 misha 265:
1.165 moko 266: const char* capitalize(const char* s);
267: char *str_lower(const char *s, size_t helper_length=0);
268: char *str_upper(const char *s, size_t helper_length=0);
1.144 misha 269:
1.154 moko 270: const char* hex_string(unsigned char* bytes, size_t size, bool upcase);
1.155 moko 271: extern const char* hex_digits;
1.99 paf 272:
1.158 moko 273: const char *pa_idna_encode(const char *in, Charset &source);
274: const char *pa_idna_decode(const char *in, Charset &source);
275:
1.169 moko 276: unsigned long pa_crc32(const char *in, size_t in_size);
277: unsigned long pa_crc32(const String& file_spec);
1.93 paf 278:
1.154 moko 279: /**
280: Mix functions
281: */
1.106 paf 282:
1.164 moko 283: #define PA_DEFAULT(A,B) ((A) ? (A):(B) )
284:
1.154 moko 285: Charset* detect_charset(const char* content_type);
286:
1.93 paf 287: // globals
288:
289: extern const String file_status_name;
1.1 paf 290:
1.103 paf 291: // global defines for file options which are handled but not checked elsewhere, we check them
292:
293: #define PA_COLUMN_SEPARATOR_NAME "separator"
294: #define PA_COLUMN_ENCLOSER_NAME "encloser"
1.113 misha 295: #define PA_CHARSET_NAME "charset"
1.150 moko 296: #define PA_RESPONSE_CHARSET_NAME "response-charset"
1.103 paf 297:
1.115 misha 298: // globals defines for sql options
299:
300: #define SQL_BIND_NAME "bind"
1.175 moko 301: #define PA_SQL_LIMIT_NAME "limit"
302: #define PA_SQL_OFFSET_NAME "offset"
1.115 misha 303: #define SQL_DEFAULT_NAME "default"
304: #define SQL_DISTINCT_NAME "distinct"
305: #define SQL_VALUE_TYPE_NAME "type"
306:
1.175 moko 307: extern String sql_bind_name;
308: extern String sql_limit_name;
309: extern String sql_offset_name;
310: extern String sql_default_name;
311: extern String sql_distinct_name;
312: extern String sql_value_type_name;
313:
1.115 misha 314: #ifndef DOXYGEN
315: enum Table2hash_distint { D_ILLEGAL, D_FIRST };
1.166 moko 316: enum Table2hash_value_type { C_HASH, C_STRING, C_TABLE, C_CODE };
1.115 misha 317: #endif
318:
1.1 paf 319: #endif
1.115 misha 320:
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_common.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include