|
|
| version 1.124, 2008/07/15 12:50:24 | version 1.147, 2012/05/24 12:53:06 |
|---|---|
| Line 1 | Line 1 |
| /** @file | /** @file |
| Parser: commonly used functions. | Parser: commonly used functions. |
| Copyright (c) 2001-2005 ArtLebedev Group (http://www.artlebedev.com) | Copyright (c) 2001-2012 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 * const IDENT_COMMON_H="$Date$"; | #define IDENT_PA_COMMON_H "$Id$" |
| #include "pa_string.h" | #include "pa_string.h" |
| #include "pa_hash.h" | #include "pa_hash.h" |
| class Request; | |
| // defines | // defines |
| #define HTTP_USER_AGENT "USER-AGENT" | #define HTTP_USER_AGENT "user-agent" |
| #define HTTP_CONTENT_TYPE "CONTENT-TYPE" | |
| #define HTTP_CONTENT_TYPE_FORM_URLENCODED "application/x-www-form-urlencoded" | #define HTTP_STATUS "status" |
| #define HTTP_CONTENT_TYPE_MULTIPART "multipart/form-data" | #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 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 CONTENT_TRANSFER_ENCODING_NAME "content-transfer-encoding" | |
| #define CONTENT_TRANSFER_ENCODING_CAPITALIZED "Content-Transfer-Encoding" | |
| #define CONTENT_DISPOSITION "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 BASE64_STRICT_OPTION_NAME "strict" | |
| const String http_content_type(HTTP_CONTENT_TYPE); | |
| const String content_transfer_encoding_name(CONTENT_TRANSFER_ENCODING_NAME); | |
| const String content_disposition(CONTENT_DISPOSITION); | |
| const String content_disposition_inline(CONTENT_DISPOSITION_INLINE); | |
| const String content_disposition_attachment(CONTENT_DISPOSITION_ATTACHMENT); | |
| 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<const String::Body , Value*> HashStringValue; | typedef HASH_STRING<Value*> HashStringValue; |
| // replace system s*nprintf with our versions | // replace system s*nprintf with our versions |
| #undef vsnprintf | #undef vsnprintf |
| Line 62 inline long lseek( int handle, long offs | Line 103 inline long lseek( int handle, long offs |
| #endif | #endif |
| const char* capitalize(const char* s); | |
| /** under WIN32 "t" mode fixes DOS chars OK, | /** under WIN32 "t" mode fixes DOS chars OK, |
| can't say that about other systems/ line break styles | can't say that about other systems/ line break styles |
| */ | */ |
| void fix_line_breaks( | void fix_line_breaks( |
| char *str, | char *str, |
| size_t& length///< may change! used to speedup next actions | size_t& length///< may change! used to speedup next actions |
| ); | ); |
| int pa_lock_shared_blocking(int fd); | int pa_lock_shared_blocking(int fd); |
| int pa_lock_exclusive_blocking(int fd); | int pa_lock_exclusive_blocking(int fd); |
| Line 78 int pa_unlock(int fd); | Line 121 int pa_unlock(int fd); |
| void create_dir_for_file(const String& file_spec); | void create_dir_for_file(const String& file_spec); |
| typedef void (*File_read_action)( | typedef void (*File_read_action)( |
| struct stat& finfo, | struct stat& finfo, |
| int f, | int f, |
| const String& file_spec, const char* fname, bool as_text, | const String& file_spec, const char* fname, bool as_text, |
| void *context); | void *context); |
| /** | /** |
| shared-lock specified file, | shared-lock specified file, |
| Line 94 bool file_read_action_under_lock(const S | Line 137 bool file_read_action_under_lock(const S |
| const char* action_name, File_read_action action, void *context, | const char* action_name, File_read_action action, void *context, |
| bool as_text=false, | bool as_text=false, |
| bool fail_on_read_problem=true); | bool fail_on_read_problem=true); |
| /** | /** |
| read specified text file using | 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! | WARNING: charset is used for http header case conversion, it's not a charset of input file! |
| @returns true if read OK | |
| */ | */ |
| char *file_read_text(Request_charsets& charsets, | 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, | HashStringValue* options=0, |
| bool transcode_result=true); | 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 { | struct File_read_result { |
| bool success; | bool success; |
| Line 119 struct File_read_result { | Line 167 struct File_read_result { |
| 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! | WARNING: charset is used for http header case conversion, it's not a charset of input file! |
| @returns true if read OK | |
| */ | */ |
| File_read_result file_read(Request_charsets& charsets, | File_read_result file_read(Request_charsets& charsets, |
| const String& file_spec, | const String& file_spec, |
| bool as_text, | bool as_text, |
| HashStringValue* options=0, | HashStringValue* options=0, |
| bool fail_on_read_problem=true, | bool fail_on_read_problem=true, |
| char* buf=0, size_t offset=0, size_t size=0, bool transcode_text_result=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); | typedef void (*File_write_action)(int f, void *context); |
| Line 154 bool file_write_action_under_lock( | Line 207 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 char* 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 |
| Line 178 const String* file_exist(const String& p | Line 234 const String* file_exist(const String& p |
| 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, |
| size_t& rsize, | size_t& rsize, |
| time_t& ratime, | time_t& ratime, |
| time_t& rmtime, | time_t& rmtime, |
| time_t& rctime, | time_t& rctime, |
| bool fail_on_read_problem=true); | bool fail_on_read_problem=true); |
| /** | /** |
| scans for @a delim[default \n] in @a *row_ref, | scans for @a delim[default \n] in @a *row_ref, |
| Line 198 const char* format(double value, char *f | Line 254 const char* format(double value, char *f |
| size_t stdout_write(const void *buf, size_t size); | size_t stdout_write(const void *buf, size_t size); |
| char* unescape_chars(const char* cp, int len, Charset* client_charset=0, bool ignore_plus=false); | char* unescape_chars(const char* cp, int len, Charset* client_charset=0, bool js=false/*true==decode \uXXXX and don't convert '+' to space*/); |
| #ifdef WIN32 | #ifdef WIN32 |
| void back_slashes_to_slashes(char *s); | void back_slashes_to_slashes(char *s); |
| Line 214 bool StrStartFromNC(const char* str, con | Line 270 bool StrStartFromNC(const char* str, con |
| size_t strpos(const char *str, const char *substr); | size_t strpos(const char *str, const char *substr); |
| Charset* detect_charset(const char* content_type); | Charset* detect_charset(const char* content_type); |
| Charset* detect_charset(Charset& source_charset, const String& content_type); | |
| #define SECS_PER_DAY (60*60*24) | #define SECS_PER_DAY (60*60*24) |
| int getMonthDays(int year, int month); | int getMonthDays(int year, int month); |
| int remove_crlf(char *start, char *end); | int remove_crlf(char *start, char *end); |
| #ifdef PA_SAFE_MODE | 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)); | |
| } | |
| void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname); | void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname); |
| #endif | |
| void pa_base64_decode(const char *in, size_t in_size, char*& result, size_t& result_size); | 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 char *in, size_t in_size); |
| struct File_base64_action_info { | struct File_base64_action_info { |
| unsigned char** base64; | unsigned char** base64; |
| }; | }; |
| char* pa_base64_encode(const String& file_spec); | char* pa_base64_encode(const String& file_spec); |
| static void file_base64_file_action( | static void file_base64_file_action( |
| struct stat& finfo, | struct stat& finfo, |
| int f, | int f, |
| const String&, const char* /*fname*/, bool, | const String&, const char* /*fname*/, bool, |
| void *context); | void *context); |
| #define FILE_BUFFER_SIZE 4096 | #define FILE_BUFFER_SIZE 4096 |
| static unsigned long crc32Table[256]; | static unsigned long crc32Table[256]; |
| Line 271 inline void CalcCrc32(const unsigned cha | Line 332 inline void CalcCrc32(const unsigned cha |
| const unsigned long pa_crc32(const char *in, size_t in_size); | const unsigned long pa_crc32(const char *in, size_t in_size); |
| const unsigned long pa_crc32(const String& file_spec); | const unsigned long pa_crc32(const String& file_spec); |
| static void file_crc32_file_action( | static void file_crc32_file_action( |
| struct stat& finfo, | struct stat& finfo, |
| int f, | int f, |
| const String&, const char* /*fname*/, bool, | const String&, const char* /*fname*/, bool, |
| void *context); | void *context); |
| static const char* hex_string(unsigned char* bytes, size_t size, bool upcase) { | static const char* hex_string(unsigned char* bytes, size_t size, bool upcase) { |
| char *bytes_hex=new(PointerFreeGC) char [size*2/*byte->hh*/+1/*for zero-teminator*/]; | char *bytes_hex=new(PointerFreeGC) char [size*2/*byte->hh*/+1/*for zero-teminator*/]; |
| Line 285 static const char* hex_string(unsigned c | Line 346 static const char* hex_string(unsigned c |
| const char *hex=upcase?"0123456789ABCDEF":"0123456789abcdef"; | const char *hex=upcase?"0123456789ABCDEF":"0123456789abcdef"; |
| for(; src<end; src++) { | for(; src<end; src++) { |
| *dest++=hex[*src/0x10]; | *dest++=hex[*src/0x10]; |
| *dest++=hex[*src%0x10]; | *dest++=hex[*src%0x10]; |
| } | } |
| *dest=0; | *dest=0; |
| Line 297 int pa_get_valid_file_options_count(Hash | Line 358 int pa_get_valid_file_options_count(Hash |
| // some stuff for use with .for_each | // some stuff for use with .for_each |
| static void copy_all_overwrite_to( | static void copy_all_overwrite_to( |
| HashStringValue::key_type key, | HashStringValue::key_type key, |
| HashStringValue::value_type value, | HashStringValue::value_type value, |
| HashStringValue* dest) { | HashStringValue* dest) { |
| dest->put(key, value); | dest->put(key, value); |
| } | } |
| Line 325 static String::C date_gmt_string(tm* tms | Line 386 static String::C date_gmt_string(tm* tms |
| tms->tm_hour,tms->tm_min,tms->tm_sec)); | tms->tm_hour,tms->tm_min,tms->tm_sec)); |
| } | } |
| // globals | // globals |
| extern const String file_status_name; | extern const String file_status_name; |