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