Annotation of parser3/src/include/pa_common.h, revision 1.155
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.155 ! moko 11: #define IDENT_PA_COMMON_H "$Id: pa_common.h,v 1.154 2013/10/14 19:45:13 moko 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.17 paf 86: #endif
1.59 paf 87:
1.154 moko 88: /**
89: file related functions
90: */
1.136 misha 91:
1.154 moko 92: #define FILE_BUFFER_SIZE 4096
1.95 paf 93:
94: int pa_lock_shared_blocking(int fd);
95: int pa_lock_exclusive_blocking(int fd);
96: int pa_lock_exclusive_nonblocking(int fd);
97: int pa_unlock(int fd);
1.101 paf 98:
99: void create_dir_for_file(const String& file_spec);
1.93 paf 100:
1.154 moko 101: int pa_get_valid_file_options_count(HashStringValue& options);
102:
1.93 paf 103: typedef void (*File_read_action)(
1.126 misha 104: struct stat& finfo,
105: int f,
106: const String& file_spec, const char* fname, bool as_text,
107: void *context);
1.83 paf 108:
109: /**
110: shared-lock specified file,
111: do actions under lock.
112: if fail_on_read_problem is true[default] throws an exception
113:
114: @returns true if read OK
115: */
1.93 paf 116: bool file_read_action_under_lock(const String& file_spec,
117: const char* action_name, File_read_action action, void *context,
1.83 paf 118: bool as_text=false,
119: bool fail_on_read_problem=true);
1.128 misha 120:
1.15 paf 121: /**
1.93 paf 122: read specified text file using
1.15 paf 123: if fail_on_read_problem is true[default] throws an exception
1.83 paf 124:
1.93 paf 125: WARNING: charset is used for http header case conversion, it's not a charset of input file!
1.15 paf 126: */
1.93 paf 127: char *file_read_text(Request_charsets& charsets,
1.126 misha 128: const String& file_spec,
129: bool fail_on_read_problem=true,
130: HashStringValue* options=0,
131: bool transcode_result=true);
1.93 paf 132:
1.128 misha 133: char *file_load_text(Request& r,
134: const String& file_spec,
135: bool fail_on_read_problem=true,
136: HashStringValue* options=0,
137: bool transcode_result=true);
138:
1.93 paf 139: struct File_read_result {
140: bool success;
141: char* str; size_t length;
142: HashStringValue* headers;
143: };
1.17 paf 144:
145: /**
1.93 paf 146: read specified file using
1.29 paf 147: if fail_on_read_problem is true[default] throws an exception
1.83 paf 148:
1.93 paf 149: WARNING: charset is used for http header case conversion, it's not a charset of input file!
1.128 misha 150: */
151: File_read_result file_read(Request_charsets& charsets,
152: const String& file_spec,
153: bool as_text,
154: HashStringValue* options=0,
155: bool fail_on_read_problem=true,
156: char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true);
1.93 paf 157:
1.128 misha 158: File_read_result file_load(Request& r,
159: const String& file_spec,
1.126 misha 160: bool as_text,
161: HashStringValue* options=0,
162: bool fail_on_read_problem=true,
163: char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true);
1.83 paf 164:
165: typedef void (*File_write_action)(int f, void *context);
1.29 paf 166:
167: /**
1.71 paf 168: lock specified file exclusively,
169: do actions under lock.
170: throws an exception in case of problems
1.72 paf 171:
172: if block=false does non-blocking lock
173: @returns true if locked OK, or false if non-blocking locking failed
1.71 paf 174: */
1.72 paf 175: bool file_write_action_under_lock(
1.71 paf 176: const String& file_spec,
1.114 misha 177: const char* action_name,
178: File_write_action action,
179: void *context,
1.71 paf 180: bool as_text=false,
1.72 paf 181: bool do_append=false,
1.77 paf 182: bool do_block=true,
183: bool fail_on_lock_problem=true);
1.71 paf 184:
185: /**
186: write data to specified file,
1.17 paf 187: throws an exception in case of problems
188: */
1.70 paf 189: void file_write(
1.137 misha 190: Request_charsets& charsets,
1.25 paf 191: const String& file_spec,
1.137 misha 192: const char* data,
193: size_t size,
1.58 paf 194: bool as_text,
1.137 misha 195: bool do_append=false,
196: Charset* asked_charset=0);
1.26 paf 197:
198: /**
199: delete specified file
200: throws an exception in case of problems
201: */
1.149 misha 202: bool file_delete(const String& file_spec, bool fail_on_problem=true, bool keep_empty_dirs=false);
1.47 parser 203: /**
204: move specified file
205: throws an exception in case of problems
206: */
1.149 misha 207: void file_move(const String& old_spec, const String& new_spec, bool keep_empty_dirs=false);
1.27 paf 208:
1.93 paf 209: bool entry_exists(const char* fname, struct stat *afinfo=0);
1.82 paf 210: bool entry_exists(const String& file_spec);
1.107 paf 211: bool file_exist(const String& file_spec);
212: bool dir_exists(const String& file_spec);
213: const String* file_exist(const String& path, const String& name);
1.36 paf 214: bool file_executable(const String& file_spec);
1.37 paf 215:
1.48 parser 216: bool file_stat(const String& file_spec,
1.126 misha 217: size_t& rsize,
218: time_t& ratime,
219: time_t& rmtime,
220: time_t& rctime,
221: bool fail_on_read_problem=true);
1.15 paf 222:
1.154 moko 223: size_t stdout_write(const void *buf, size_t size);
224:
225: void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname);
226:
227: int file_block_read(const int f, unsigned char* buffer, const size_t size);
228:
229: /**
230: String related functions
231: */
232:
233: const char* capitalize(const char* s);
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.151 moko 244: const char* format(double value, const char *fmt);
1.10 paf 245:
1.142 misha 246: 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 247:
1.148 misha 248: char *search_stop(char*& current, char cstop_at);
249:
1.23 paf 250: #ifdef WIN32
251: void back_slashes_to_slashes(char *s);
252: #endif
253:
1.119 misha 254: bool StrStartFromNC(const char* str, const char* substr, bool equal=false);
1.121 misha 255: size_t strpos(const char *str, const char *substr);
256:
1.116 misha 257: int remove_crlf(char *start, char *end);
1.90 paf 258:
1.144 misha 259: inline bool pa_isalpha(unsigned char c) {
260: return (((c>='A') && (c<='Z')) || ((c>='a') && (c<='z')));
261: }
262:
263: inline bool pa_isalnum(unsigned char c) {
264: return (((c>='0') && (c<='9')) || pa_isalpha(c));
265: }
266:
1.154 moko 267: const char* hex_string(unsigned char* bytes, size_t size, bool upcase);
1.155 ! moko 268: extern const char* hex_digits;
1.99 paf 269:
1.145 misha 270: void pa_base64_decode(const char *in, size_t in_size, char*& result, size_t& result_size, bool strict=false);
1.104 paf 271: char* pa_base64_encode(const char *in, size_t in_size);
1.112 misha 272: char* pa_base64_encode(const String& file_spec);
1.108 misha 273:
274: const unsigned long pa_crc32(const char *in, size_t in_size);
275: const unsigned long pa_crc32(const String& file_spec);
1.93 paf 276:
1.154 moko 277: /**
278: Mix functions
279: */
1.106 paf 280:
1.115 misha 281: // some stuff for use with .for_each
282: static void copy_all_overwrite_to(
1.126 misha 283: HashStringValue::key_type key,
284: HashStringValue::value_type value,
285: HashStringValue* dest) {
1.115 misha 286: dest->put(key, value);
287: }
288:
289: static void remove_key_from(
290: HashStringValue::key_type key,
291: HashStringValue::value_type /*value*/,
292: HashStringValue* dest) {
293: dest->remove(key);
294: }
295:
1.154 moko 296: Charset* detect_charset(const char* content_type);
297:
298: #define SECS_PER_DAY (60*60*24)
299:
300: int getMonthDays(int year, int month);
301:
302: String::C date_gmt_string(tm* tms);
1.117 misha 303:
1.93 paf 304: // globals
305:
306: extern const String file_status_name;
1.1 paf 307:
1.103 paf 308: // global defines for file options which are handled but not checked elsewhere, we check them
309:
310: #define PA_SQL_LIMIT_NAME "limit"
311: #define PA_SQL_OFFSET_NAME "offset"
312: #define PA_COLUMN_SEPARATOR_NAME "separator"
313: #define PA_COLUMN_ENCLOSER_NAME "encloser"
1.113 misha 314: #define PA_CHARSET_NAME "charset"
1.150 moko 315: #define PA_RESPONSE_CHARSET_NAME "response-charset"
1.103 paf 316:
1.115 misha 317: // globals defines for sql options
318:
319: #define SQL_BIND_NAME "bind"
320: #define SQL_DEFAULT_NAME "default"
321: #define SQL_DISTINCT_NAME "distinct"
322: #define SQL_VALUE_TYPE_NAME "type"
323:
324: #ifndef DOXYGEN
325: enum Table2hash_distint { D_ILLEGAL, D_FIRST };
326: enum Table2hash_value_type { C_HASH, C_STRING, C_TABLE };
327: #endif
328:
1.1 paf 329: #endif
1.115 misha 330:
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