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