Annotation of parser3/src/include/pa_common.h, revision 1.175
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.175 ! moko 11: #define IDENT_PA_COMMON_H "$Id: pa_common.h,v 1.174 2017/02/07 22:00:32 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_fstat _fstat64
82:
1.173 moko 83: int pa_stat(const char *pathname, struct stat *buffer);
84: int pa_open(const char *pathname, int flags, int mode=0);
85: FILE *pa_fopen(const char *pathname, const char *mode);
86:
1.171 moko 87: #else
88:
89: #define pa_stat stat
90: #define pa_fstat fstat
91:
1.173 moko 92: #define pa_open open
93: #define pa_fopen fopen
94:
1.17 paf 95: #endif
1.59 paf 96:
1.154 moko 97: /**
98: file related functions
99: */
1.136 misha 100:
1.154 moko 101: #define FILE_BUFFER_SIZE 4096
1.95 paf 102:
103: int pa_lock_shared_blocking(int fd);
104: int pa_lock_exclusive_blocking(int fd);
105: int pa_lock_exclusive_nonblocking(int fd);
106: int pa_unlock(int fd);
1.101 paf 107:
108: void create_dir_for_file(const String& file_spec);
1.93 paf 109:
1.154 moko 110: int pa_get_valid_file_options_count(HashStringValue& options);
111:
1.163 moko 112: typedef void (*File_read_action)(struct stat& finfo, int f, const String& file_spec, void *context);
1.83 paf 113:
114: /**
115: shared-lock specified file,
116: do actions under lock.
117: if fail_on_read_problem is true[default] throws an exception
118:
119: @returns true if read OK
120: */
1.93 paf 121: bool file_read_action_under_lock(const String& file_spec,
122: const char* action_name, File_read_action action, void *context,
1.83 paf 123: bool as_text=false,
124: bool fail_on_read_problem=true);
1.128 misha 125:
1.15 paf 126: /**
1.93 paf 127: read specified text file using
1.15 paf 128: if fail_on_read_problem is true[default] throws an exception
1.83 paf 129:
1.93 paf 130: WARNING: charset is used for http header case conversion, it's not a charset of input file!
1.15 paf 131: */
1.93 paf 132: char *file_read_text(Request_charsets& charsets,
1.126 misha 133: const String& file_spec,
134: bool fail_on_read_problem=true,
135: HashStringValue* options=0,
136: bool transcode_result=true);
1.93 paf 137:
1.128 misha 138: char *file_load_text(Request& r,
139: const String& file_spec,
140: bool fail_on_read_problem=true,
141: HashStringValue* options=0,
142: bool transcode_result=true);
143:
1.93 paf 144: struct File_read_result {
145: bool success;
146: char* str; size_t length;
147: HashStringValue* headers;
148: };
1.17 paf 149:
150: /**
1.93 paf 151: read specified file using
1.29 paf 152: if fail_on_read_problem is true[default] throws an exception
1.83 paf 153:
1.93 paf 154: WARNING: charset is used for http header case conversion, it's not a charset of input file!
1.128 misha 155: */
156: File_read_result file_read(Request_charsets& charsets,
157: const String& file_spec,
158: bool as_text,
159: HashStringValue* options=0,
160: bool fail_on_read_problem=true,
161: char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true);
1.93 paf 162:
1.128 misha 163: File_read_result file_load(Request& r,
164: const String& file_spec,
1.126 misha 165: bool as_text,
166: HashStringValue* options=0,
167: bool fail_on_read_problem=true,
168: char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true);
1.83 paf 169:
170: typedef void (*File_write_action)(int f, void *context);
1.29 paf 171:
172: /**
1.71 paf 173: lock specified file exclusively,
174: do actions under lock.
175: throws an exception in case of problems
1.72 paf 176:
177: if block=false does non-blocking lock
178: @returns true if locked OK, or false if non-blocking locking failed
1.71 paf 179: */
1.72 paf 180: bool file_write_action_under_lock(
1.71 paf 181: const String& file_spec,
1.114 misha 182: const char* action_name,
183: File_write_action action,
184: void *context,
1.71 paf 185: bool as_text=false,
1.72 paf 186: bool do_append=false,
1.77 paf 187: bool do_block=true,
188: bool fail_on_lock_problem=true);
1.71 paf 189:
190: /**
191: write data to specified file,
1.17 paf 192: throws an exception in case of problems
193: */
1.70 paf 194: void file_write(
1.137 misha 195: Request_charsets& charsets,
1.25 paf 196: const String& file_spec,
1.137 misha 197: const char* data,
198: size_t size,
1.58 paf 199: bool as_text,
1.137 misha 200: bool do_append=false,
201: Charset* asked_charset=0);
1.26 paf 202:
203: /**
204: delete specified file
205: throws an exception in case of problems
206: */
1.149 misha 207: bool file_delete(const String& file_spec, bool fail_on_problem=true, bool keep_empty_dirs=false);
1.47 parser 208: /**
209: move specified file
210: throws an exception in case of problems
211: */
1.149 misha 212: void file_move(const String& old_spec, const String& new_spec, bool keep_empty_dirs=false);
1.27 paf 213:
1.93 paf 214: bool entry_exists(const char* fname, struct stat *afinfo=0);
1.82 paf 215: bool entry_exists(const String& file_spec);
1.107 paf 216: bool file_exist(const String& file_spec);
217: bool dir_exists(const String& file_spec);
218: const String* file_exist(const String& path, const String& name);
1.36 paf 219: bool file_executable(const String& file_spec);
1.37 paf 220:
1.168 moko 221: 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 222: size_t check_file_size(uint64_t size, const String& file_spec);
1.15 paf 223:
1.154 moko 224: size_t stdout_write(const void *buf, size_t size);
225:
226: void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname);
227:
228: int file_block_read(const int f, unsigned char* buffer, const size_t size);
229:
230: /**
231: String related functions
232: */
233:
234: /** under WIN32 "t" mode fixes DOS chars OK,
235: can't say that about other systems/ line break styles
1.15 paf 236: */
1.154 moko 237: void fix_line_breaks(char *str, size_t& length /* < may change! used to speedup next actions */);
238:
1.7 paf 239: char *getrow(char **row_ref,char delim='\n');
1.76 paf 240: char *lsplit(char *string, char delim);
1.7 paf 241: char *lsplit(char **string_ref,char delim);
1.8 paf 242: char *rsplit(char *string, char delim);
1.165 moko 243:
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.157 moko 250: inline int pa_strncasecmp(const char* str, const char* substr, size_t count=0) {
251: return strncasecmp(str, substr, count ? count : strlen(substr));
252: }
253:
1.23 paf 254: #ifdef WIN32
255: void back_slashes_to_slashes(char *s);
256: #endif
257:
1.121 misha 258: size_t strpos(const char *str, const char *substr);
259:
1.116 misha 260: int remove_crlf(char *start, char *end);
1.90 paf 261:
1.165 moko 262: inline bool pa_isalpha(unsigned char c) { return (((c>='A') && (c<='Z')) || ((c>='a') && (c<='z'))); }
263: inline bool pa_isalnum(unsigned char c) { return (((c>='0') && (c<='9')) || pa_isalpha(c)); }
1.144 misha 264:
1.165 moko 265: const char* capitalize(const char* s);
266: char *str_lower(const char *s, size_t helper_length=0);
267: char *str_upper(const char *s, size_t helper_length=0);
1.144 misha 268:
1.154 moko 269: const char* hex_string(unsigned char* bytes, size_t size, bool upcase);
1.155 moko 270: extern const char* hex_digits;
1.99 paf 271:
1.145 misha 272: void pa_base64_decode(const char *in, size_t in_size, char*& result, size_t& result_size, bool strict=false);
1.104 paf 273: char* pa_base64_encode(const char *in, size_t in_size);
1.112 misha 274: char* pa_base64_encode(const String& file_spec);
1.108 misha 275:
1.158 moko 276: const char *pa_idna_encode(const char *in, Charset &source);
277: const char *pa_idna_decode(const char *in, Charset &source);
278:
1.169 moko 279: unsigned long pa_crc32(const char *in, size_t in_size);
280: unsigned long pa_crc32(const String& file_spec);
1.93 paf 281:
1.154 moko 282: /**
283: Mix functions
284: */
1.106 paf 285:
1.164 moko 286: #define PA_DEFAULT(A,B) ((A) ? (A):(B) )
287:
1.154 moko 288: Charset* detect_charset(const char* content_type);
289:
1.93 paf 290: // globals
291:
292: extern const String file_status_name;
1.1 paf 293:
1.103 paf 294: // global defines for file options which are handled but not checked elsewhere, we check them
295:
296: #define PA_COLUMN_SEPARATOR_NAME "separator"
297: #define PA_COLUMN_ENCLOSER_NAME "encloser"
1.113 misha 298: #define PA_CHARSET_NAME "charset"
1.150 moko 299: #define PA_RESPONSE_CHARSET_NAME "response-charset"
1.103 paf 300:
1.115 misha 301: // globals defines for sql options
302:
303: #define SQL_BIND_NAME "bind"
1.175 ! moko 304: #define PA_SQL_LIMIT_NAME "limit"
! 305: #define PA_SQL_OFFSET_NAME "offset"
1.115 misha 306: #define SQL_DEFAULT_NAME "default"
307: #define SQL_DISTINCT_NAME "distinct"
308: #define SQL_VALUE_TYPE_NAME "type"
309:
1.175 ! moko 310: extern String sql_bind_name;
! 311: extern String sql_limit_name;
! 312: extern String sql_offset_name;
! 313: extern String sql_default_name;
! 314: extern String sql_distinct_name;
! 315: extern String sql_value_type_name;
! 316:
1.115 misha 317: #ifndef DOXYGEN
318: enum Table2hash_distint { D_ILLEGAL, D_FIRST };
1.166 moko 319: enum Table2hash_value_type { C_HASH, C_STRING, C_TABLE, C_CODE };
1.115 misha 320: #endif
321:
1.1 paf 322: #endif
1.115 misha 323:
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