--- parser3/src/include/pa_common.h 2003/11/20 16:34:24 1.97 +++ parser3/src/include/pa_common.h 2013/10/14 19:45:13 1.154 @@ -1,20 +1,67 @@ /** @file Parser: commonly used functions. - Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) + Copyright (c) 2001-2012 Art. Lebedev Studio (http://www.artlebedev.com) Author: Alexandr Petrosian (http://paf.design.ru) */ #ifndef PA_COMMON_H #define PA_COMMON_H -static const char * const IDENT_COMMON_H="$Date: 2003/11/20 16:34:24 $"; +#define IDENT_PA_COMMON_H "$Id: pa_common.h,v 1.154 2013/10/14 19:45:13 moko Exp $" #include "pa_string.h" #include "pa_hash.h" +class Request; + +// defines +#define HTTP_USER_AGENT "user-agent" + +#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 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; -typedef Hash HashStringValue; +typedef HASH_STRING HashStringValue; // replace system s*nprintf with our versions #undef vsnprintf @@ -24,15 +71,7 @@ int __vsnprintf(char *, size_t, const ch int __snprintf(char *, size_t, const char* , ...); #define snprintf __snprintf -#if _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); } -*/ +#ifdef _MSC_VER //access #define F_OK 0 @@ -43,37 +82,29 @@ inline long lseek( int handle, long offs #ifndef strcasecmp # define strcasecmp _stricmp #endif -#ifndef strncasecmp -# define strncasecmp _strnicmp -#endif -#ifndef mkdir -# define mkdir(path, mode) _mkdir(path) -#endif -#ifndef putenv -# define putenv _putenv #endif -#endif - -/** under WIN32 "t" mode fixes DOS chars OK, - can't say that about other systems/ line break styles +/** + file related functions */ -void fix_line_breaks( - char *str, - size_t& length///< may change! used to speedup next actions - ); + +#define FILE_BUFFER_SIZE 4096 int pa_lock_shared_blocking(int fd); int pa_lock_exclusive_blocking(int fd); int pa_lock_exclusive_nonblocking(int fd); int pa_unlock(int fd); +void create_dir_for_file(const String& file_spec); + +int pa_get_valid_file_options_count(HashStringValue& options); + typedef void (*File_read_action)( - struct stat& finfo, - int f, - const String& file_spec, const char* fname, bool as_text, - void *context); + struct stat& finfo, + int f, + const String& file_spec, const char* fname, bool as_text, + void *context); /** shared-lock specified file, @@ -86,18 +117,24 @@ bool file_read_action_under_lock(const S const char* action_name, File_read_action action, void *context, bool as_text=false, bool fail_on_read_problem=true); + /** read specified text file using 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! - - @returns true if read OK */ char *file_read_text(Request_charsets& charsets, - const String& file_spec, - bool fail_on_read_problem=true, - HashStringValue* options=0/*, HashStringValue* * out_fields=0*/); + const String& file_spec, + 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; @@ -110,14 +147,20 @@ struct File_read_result { 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! - - @returns true if read OK */ -File_read_result file_read(Request_charsets& charsets, - const String& file_spec, - bool as_text, - HashStringValue* options=0, - bool fail_on_read_problem=true); +File_read_result file_read(Request_charsets& charsets, + 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); + +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); @@ -131,7 +174,9 @@ typedef void (*File_write_action)(int f, */ bool file_write_action_under_lock( const String& file_spec, - const char* action_name, File_write_action action, void *context, + const char* action_name, + File_write_action action, + void *context, bool as_text=false, bool do_append=false, bool do_block=true, @@ -142,75 +187,143 @@ bool file_write_action_under_lock( throws an exception in case of problems */ void file_write( + Request_charsets& charsets, const String& file_spec, - const char* data, size_t size, + const char* data, + size_t size, bool as_text, - bool do_append=false); + bool do_append=false, + Charset* asked_charset=0); /** delete specified file throws an exception in case of problems */ -bool file_delete(const String& file_spec, bool fail_on_problem=true); +bool file_delete(const String& file_spec, bool fail_on_problem=true, bool keep_empty_dirs=false); /** move specified file 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 entry_exists(const char* fname, struct stat *afinfo=0); bool entry_exists(const String& file_spec); -bool file_readable(const String& file_spec); -bool dir_readable(const String& file_spec); -const 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_stat(const String& file_spec, - size_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); -/** - 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 - assigns @a *row_ref to point right after delimiter if there were one - or to zero if no @a delim were found. +size_t stdout_write(const void *buf, size_t size); + +void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname); + +int file_block_read(const int f, unsigned char* buffer, const size_t size); + +/** + String related functions */ + +const char* capitalize(const char* s); + +/** 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 *lsplit(char *string, char delim); char *lsplit(char **string_ref,char delim); char *rsplit(char *string, char delim); -const char* format(double value, char *fmt); +const char* format(double value, const char *fmt); -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(const char* cp, int len); +char *search_stop(char*& current, char cstop_at); #ifdef WIN32 void back_slashes_to_slashes(char *s); -//void slashes_to_back_slashes(char *s); #endif -#ifndef _qsort -# define _qsort(names,cnt,sizeof_names,func_addr) \ - qsort(names,cnt,sizeof_names,func_addr) -#endif +bool StrStartFromNC(const char* str, const char* substr, bool equal=false); +size_t strpos(const char *str, const char *substr); -bool StrEqNc(const char* s1, const char* s2, bool strict=true); +int remove_crlf(char *start, char *end); + +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)); +} + +const char* hex_string(unsigned char* bytes, size_t size, bool upcase); + +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 unsigned long pa_crc32(const char *in, size_t in_size); +const unsigned long pa_crc32(const String& file_spec); + +/** + Mix functions +*/ + +// 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); #define SECS_PER_DAY (60*60*24) -int getMonthDays(int year, int month); -void remove_crlf(char *start, char *end); +int getMonthDays(int year, int month); -#ifdef PA_SAFE_MODE -void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname); -#endif +String::C date_gmt_string(tm* tms); // 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 }; +#endif + #endif +