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