|
|
| version 1.78, 2002/08/01 11:26:46 | version 1.168, 2016/12/21 21:14:42 |
|---|---|
| Line 1 | Line 1 |
| /** @file | /** @file |
| Parser: commonly used functions. | Parser: commonly used functions. |
| Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com) | Copyright (c) 2001-2015 Art. Lebedev Studio (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) |
| */ | */ |
| #ifndef PA_COMMON_H | #ifndef PA_COMMON_H |
| #define PA_COMMON_H | #define PA_COMMON_H |
| static const char* IDENT_COMMON_H="$Id$"; | #define IDENT_PA_COMMON_H "$Id$" |
| #include "pa_pool.h" | |
| #include "pa_string.h" | #include "pa_string.h" |
| #include "pa_hash.h" | |
| class Request; | |
| // defines | |
| #define HTTP_STATUS "status" | |
| #define HTTP_STATUS_CAPITALIZED "Status" | |
| #define HTTP_CONTENT_LENGTH "content-length" | |
| #define HTTP_CONTENT_LENGTH_CAPITALIZED "Content-Length" | |
| #define HTTP_CONTENT_TYPE "content-type" | |
| #define HTTP_CONTENT_TYPE_UPPER "CONTENT-TYPE" | |
| #define HTTP_CONTENT_TYPE_CAPITALIZED "Content-Type" | |
| #define CONTENT_DISPOSITION "content-disposition" | |
| #define CONTENT_DISPOSITION_UPPER "CONTENT-DISPOSITION" | |
| #define CONTENT_DISPOSITION_CAPITALIZED "Content-Disposition" | |
| #define CONTENT_DISPOSITION_ATTACHMENT "attachment" | |
| #define CONTENT_DISPOSITION_INLINE "inline" | |
| #define CONTENT_DISPOSITION_FILENAME_NAME "filename" | |
| #define HTTP_CONTENT_TYPE_FORM_URLENCODED "application/x-www-form-urlencoded" | |
| #define HTTP_CONTENT_TYPE_MULTIPART_FORMDATA "multipart/form-data" | |
| #define HTTP_CONTENT_TYPE_MULTIPART_RELATED "multipart/related" | |
| #define HTTP_CONTENT_TYPE_MULTIPART_MIXED "multipart/mixed" | |
| #define BASE64_STRICT_OPTION_NAME "strict" | |
| const String content_disposition_filename_name(CONTENT_DISPOSITION_FILENAME_NAME); | |
| #define HASH_ORDER | |
| #ifdef HASH_ORDER | |
| #undef PA_HASH_CLASS | |
| #include "pa_hash.h" | |
| #endif | |
| class Value; | class Value; |
| typedef HASH_STRING<Value*> HashStringValue; | |
| // replace system s*nprintf with our versions | // replace system s*nprintf with our versions |
| #undef vsnprintf | #undef vsnprintf |
| int __vsnprintf(char *, size_t, const char *, va_list); | int pa_vsnprintf(char *, size_t, const char* , va_list); |
| #define vsnprintf __vsnprintf | #define vsnprintf pa_vsnprintf |
| #undef snprintf | #undef snprintf |
| int __snprintf(char *, size_t, const char *, ...); | int pa_snprintf(char *, size_t, const char* , ...); |
| #define snprintf __snprintf | #define snprintf pa_snprintf |
| #if _MSC_VER | #ifdef _MSC_VER |
| /* | |
| inline int open( const char *filename, int oflag ) { return _open(filename, oflag); } | |
| inline int close( int handle ) { return _close(handle); } | |
| inline int read( int handle, void *buffer, unsigned int count ) { return _read(handle,buffer,count); } | |
| inline int write( int handle, const void *buffer, unsigned int count ) { return _write(handle,buffer,count); } | |
| inline int stat( const char *path, struct _stat *buffer ) { return _stat(path, buffer); } | |
| inline long lseek( int handle, long offset, int origin ) { return _lseek(handle, offset, origin); } | |
| */ | |
| //access | //access |
| #define F_OK 0 | #define F_OK 0 |
| Line 42 inline long lseek( int handle, long offs | Line 72 inline long lseek( int handle, long offs |
| #ifndef strcasecmp | #ifndef strcasecmp |
| # define strcasecmp _stricmp | # define strcasecmp _stricmp |
| #endif | #endif |
| #ifndef strncasecmp | #ifndef strncasecmp |
| # define strncasecmp _strnicmp | # define strncasecmp _strnicmp |
| #endif | #endif |
| #ifndef mkdir | |
| # define mkdir(path, mode) _mkdir(path) | |
| #endif | |
| #ifndef putenv | |
| # define putenv _putenv | |
| #endif | #endif |
| #endif | /** |
| file related functions | |
| */ | |
| #ifdef HAVE_TRUNC | #define FILE_BUFFER_SIZE 4096 |
| # ifndef trunc | |
| extern "C" double trunc(double); | |
| # endif | |
| #else | |
| inline double trunc(double param) { return param > 0? floor(param) : ceil(param); } | |
| #endif | |
| #ifdef HAVE_ROUND | int pa_lock_shared_blocking(int fd); |
| # ifndef round | int pa_lock_exclusive_blocking(int fd); |
| extern "C" double round(double); | int pa_lock_exclusive_nonblocking(int fd); |
| # endif | int pa_unlock(int fd); |
| #else | |
| inline double round(double param) { return floor(param+0.5); } | |
| #endif | |
| #ifdef HAVE_SIGN | |
| # ifndef sign | |
| extern "C" double sign(double); | |
| # endif | |
| #else | |
| inline double sign(double param) { return param > 0 ? 1 : ( param < 0 ? -1 : 0 ); } | |
| #endif | |
| /// yields to OS for secs secs and usecs milliseconds | void create_dir_for_file(const String& file_spec); |
| int pa_sleep(unsigned long secs, unsigned long usecs); | |
| /** under WIN32 "t" mode fixes DOS chars OK, | int pa_get_valid_file_options_count(HashStringValue& options); |
| can't say that about other systems/ line break styles | |
| typedef void (*File_read_action)(struct stat& finfo, int f, const String& file_spec, void *context); | |
| /** | |
| shared-lock specified file, | |
| do actions under lock. | |
| if fail_on_read_problem is true[default] throws an exception | |
| @returns true if read OK | |
| */ | */ |
| void fix_line_breaks( | bool file_read_action_under_lock(const String& file_spec, |
| char *buf, | const char* action_name, File_read_action action, void *context, |
| size_t& size ///< may change! used to speedup next actions | bool as_text=false, |
| ); | bool fail_on_read_problem=true); |
| /** | /** |
| read specified text file using pool, | read specified text file using |
| if fail_on_read_problem is true[default] throws an exception | if fail_on_read_problem is true[default] throws an exception |
| WARNING: charset is used for http header case conversion, it's not a charset of input file! | |
| */ | */ |
| char *file_read_text(Pool& pool, | char *file_read_text(Request_charsets& charsets, |
| const String& file_spec, | const String& file_spec, |
| bool fail_on_read_problem=true); | bool fail_on_read_problem=true, |
| HashStringValue* options=0, | |
| bool transcode_result=true); | |
| char *file_load_text(Request& r, | |
| const String& file_spec, | |
| bool fail_on_read_problem=true, | |
| HashStringValue* options=0, | |
| bool transcode_result=true); | |
| struct File_read_result { | |
| bool success; | |
| char* str; size_t length; | |
| HashStringValue* headers; | |
| }; | |
| /** | /** |
| read specified file using pool, | read specified file using |
| if fail_on_read_problem is true[default] throws an exception | if fail_on_read_problem is true[default] throws an exception |
| WARNING: charset is used for http header case conversion, it's not a charset of input file! | |
| */ | */ |
| bool file_read(Pool& pool, const String& file_spec, | File_read_result file_read(Request_charsets& charsets, |
| void*& data, size_t& size, | const String& file_spec, |
| bool as_text, | bool as_text, |
| bool fail_on_read_problem=true, | HashStringValue* options=0, |
| size_t offset=0, size_t limit=0); | bool fail_on_read_problem=true, |
| char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true); | |
| File_read_result file_load(Request& r, | |
| const String& file_spec, | |
| bool as_text, | |
| HashStringValue* options=0, | |
| bool fail_on_read_problem=true, | |
| char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=true); | |
| typedef void (*File_write_action)(int f, void *context); | |
| /** | /** |
| lock specified file exclusively, | lock specified file exclusively, |
| Line 117 bool file_read(Pool& pool, const String& | Line 164 bool file_read(Pool& pool, const String& |
| */ | */ |
| bool file_write_action_under_lock( | bool file_write_action_under_lock( |
| const String& file_spec, | const String& file_spec, |
| const char *action_name, void (*action)(int, void *), void *context=0, | const char* action_name, |
| File_write_action action, | |
| void *context, | |
| bool as_text=false, | bool as_text=false, |
| bool do_append=false, | bool do_append=false, |
| bool do_block=true, | bool do_block=true, |
| Line 128 bool file_write_action_under_lock( | Line 177 bool file_write_action_under_lock( |
| throws an exception in case of problems | throws an exception in case of problems |
| */ | */ |
| void file_write( | void file_write( |
| Request_charsets& charsets, | |
| const String& file_spec, | const String& file_spec, |
| const void *data, size_t size, | const char* data, |
| size_t size, | |
| bool as_text, | bool as_text, |
| bool do_append=false); | bool do_append=false, |
| Charset* asked_charset=0); | |
| /** | /** |
| delete specified file | delete specified file |
| throws an exception in case of problems | throws an exception in case of problems |
| */ | */ |
| bool file_delete(const String& file_spec, bool fail_on_read_problem=true); | bool file_delete(const String& file_spec, bool fail_on_problem=true, bool keep_empty_dirs=false); |
| /** | /** |
| move specified file | move specified file |
| throws an exception in case of problems | throws an exception in case of problems |
| */ | */ |
| void file_move(const String& old_spec, const String& new_spec); | void file_move(const String& old_spec, const String& new_spec, bool keep_empty_dirs=false); |
| bool file_readable(const String& file_spec); | bool entry_exists(const char* fname, struct stat *afinfo=0); |
| bool dir_readable(const String& file_spec); | bool entry_exists(const String& file_spec); |
| String *file_readable(const String& path, const String& name); | bool file_exist(const String& file_spec); |
| bool dir_exists(const String& file_spec); | |
| const String* file_exist(const String& path, const String& name); | |
| bool file_executable(const String& file_spec); | bool file_executable(const String& file_spec); |
| bool file_stat(const String& file_spec, | 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); |
| size_t& rsize, | |
| time_t& ratime, | |
| time_t& rmtime, | |
| time_t& rctime, | |
| bool fail_on_read_problem=true); | |
| /** | size_t stdout_write(const void *buf, size_t size); |
| scans for @a delim[default \n] in @a *row_ref, | |
| @return piece of line before it or end of string, if no @a delim found | void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname); |
| assigns @a *row_ref to point right after delimiter if there were one | |
| or to zero if no @a delim were found. | int file_block_read(const int f, unsigned char* buffer, const size_t size); |
| /** | |
| String related functions | |
| */ | |
| /** under WIN32 "t" mode fixes DOS chars OK, | |
| can't say that about other systems/ line break styles | |
| */ | */ |
| void fix_line_breaks(char *str, size_t& length /* < may change! used to speedup next actions */); | |
| char *getrow(char **row_ref,char delim='\n'); | char *getrow(char **row_ref,char delim='\n'); |
| char *lsplit(char *string, char delim); | char *lsplit(char *string, char delim); |
| char *lsplit(char **string_ref,char delim); | char *lsplit(char **string_ref,char delim); |
| char *rsplit(char *string, char delim); | char *rsplit(char *string, char delim); |
| char *format(Pool& pool, double value, char *fmt); | |
| #ifndef max | const char* format(double value, const char *fmt); |
| inline int max(int a, int b) { return a>b?a:b; } | |
| inline int min(int a, int b){ return a<b?a:b; } | |
| inline size_t max(size_t a, size_t b) { return a>b?a:b; } | |
| inline size_t min(size_t a, size_t b){ return a<b?a:b; } | |
| #endif | |
| size_t stdout_write(const void *buf, size_t size); | char* unescape_chars(const char* cp, int len, Charset* client_charset=0, bool js=false/*true==decode \uXXXX and don't convert '+' to space*/); |
| char *unescape_chars(Pool& pool, const char *cp, int len); | char *search_stop(char*& current, char cstop_at); |
| /** | inline int pa_strncasecmp(const char* str, const char* substr, size_t count=0) { |
| $content-type[text/html] -> | return strncasecmp(str, substr, count ? count : strlen(substr)); |
| content-type: text/html | } |
| $content-type[$value[text/html] charset[windows-1251]] -> | |
| content-type: text/html; charset=windows-1251 | |
| */ | |
| const String& attributed_meaning_to_string(Value& meaning, String::Untaint_lang lang); | |
| #ifdef WIN32 | #ifdef WIN32 |
| void back_slashes_to_slashes(char *s); | void back_slashes_to_slashes(char *s); |
| //void slashes_to_back_slashes(char *s); | |
| #endif | #endif |
| #ifndef _qsort | size_t strpos(const char *str, const char *substr); |
| # define _qsort(names,cnt,sizeof_names,func_addr) \ | |
| qsort(names,cnt,sizeof_names,func_addr) | int remove_crlf(char *start, char *end); |
| #endif | |
| bool StrEqNc(const char *s1, const char *s2, bool strict=true); | inline bool pa_isalpha(unsigned char c) { return (((c>='A') && (c<='Z')) || ((c>='a') && (c<='z'))); } |
| inline bool pa_isalnum(unsigned char c) { return (((c>='0') && (c<='9')) || pa_isalpha(c)); } | |
| #define SECS_PER_DAY (60*60*24) | const char* capitalize(const char* s); |
| int getMonthDays(int year, int month); | char *str_lower(const char *s, size_t helper_length=0); |
| char *str_upper(const char *s, size_t helper_length=0); | |
| void remove_crlf(char *start, char *end); | const char* hex_string(unsigned char* bytes, size_t size, bool upcase); |
| extern const char* hex_digits; | |
| void pa_base64_decode(const char *in, size_t in_size, char*& result, size_t& result_size, bool strict=false); | |
| char* pa_base64_encode(const char *in, size_t in_size); | |
| char* pa_base64_encode(const String& file_spec); | |
| const char *pa_idna_encode(const char *in, Charset &source); | |
| const char *pa_idna_decode(const char *in, Charset &source); | |
| const unsigned long pa_crc32(const char *in, size_t in_size); | |
| const unsigned long pa_crc32(const String& file_spec); | |
| /** | |
| Mix functions | |
| */ | |
| #define PA_DEFAULT(A,B) ((A) ? (A):(B) ) | |
| // some stuff for use with .for_each | |
| static void copy_all_overwrite_to(HashStringValue::key_type key, HashStringValue::value_type value, HashStringValue* dest) { | |
| dest->put(key, value); | |
| } | |
| static void remove_key_from(HashStringValue::key_type key, HashStringValue::value_type /*value*/, HashStringValue* dest) { | |
| dest->remove(key); | |
| } | |
| Charset* detect_charset(const char* content_type); | |
| // globals | |
| extern const String file_status_name; | |
| // global defines for file options which are handled but not checked elsewhere, we check them | |
| #define PA_SQL_LIMIT_NAME "limit" | |
| #define PA_SQL_OFFSET_NAME "offset" | |
| #define PA_COLUMN_SEPARATOR_NAME "separator" | |
| #define PA_COLUMN_ENCLOSER_NAME "encloser" | |
| #define PA_CHARSET_NAME "charset" | |
| #define PA_RESPONSE_CHARSET_NAME "response-charset" | |
| // globals defines for sql options | |
| #define SQL_BIND_NAME "bind" | |
| #define SQL_DEFAULT_NAME "default" | |
| #define SQL_DISTINCT_NAME "distinct" | |
| #define SQL_VALUE_TYPE_NAME "type" | |
| #ifndef DOXYGEN | |
| enum Table2hash_distint { D_ILLEGAL, D_FIRST }; | |
| enum Table2hash_value_type { C_HASH, C_STRING, C_TABLE, C_CODE }; | |
| #endif | |
| #endif | #endif |