|
|
| version 1.45, 2001/07/07 17:59:02 | version 1.104, 2005/11/22 11:12:39 |
|---|---|
| Line 1 | Line 1 |
| /** @file | /** @file |
| Parser: commonly used functions. | Parser: commonly used functions. |
| Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) | Copyright (c) 2001-2005 ArtLebedev Group (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | |
| Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf) | |
| $Id$ | |
| */ | */ |
| #ifndef PA_COMMON_H | #ifndef PA_COMMON_H |
| #define PA_COMMON_H | #define PA_COMMON_H |
| #include "pa_config_includes.h" | static const char * const IDENT_COMMON_H="$Date$"; |
| #include "pa_pool.h" | |
| #include "pa_string.h" | #include "pa_string.h" |
| #include "pa_hash.h" | |
| class Value; | class Value; |
| typedef Hash<const String::Body , Value*> HashStringValue; | |
| #if _MSC_VER | // replace system s*nprintf with our versions |
| #undef vsnprintf | |
| #ifndef open | int __vsnprintf(char *, size_t, const char* , va_list); |
| # define open _open | #define vsnprintf __vsnprintf |
| #endif | #undef snprintf |
| #ifndef close | int __snprintf(char *, size_t, const char* , ...); |
| # define close _close | #define snprintf __snprintf |
| #endif | |
| #ifndef read | |
| # define read _read | |
| #endif | |
| #ifndef write | |
| # define write _write | |
| #endif | |
| #ifndef stat | |
| # define stat _stat | |
| #endif | |
| #ifndef lseek | |
| # define lseek _lseek | |
| #endif | |
| #ifndef vsnprintf | #if _MSC_VER |
| int __vsnprintf(char *, size_t, const char *, va_list); | /* |
| # define vsnprintf __vsnprintf | inline int open( const char* filename, int oflag ) { return _open(filename, oflag); } |
| #endif | inline int close( int handle ) { return _close(handle); } |
| #ifndef snprintf | inline int read( int handle, void *buffer, unsigned int count ) { return _read(handle,buffer,count); } |
| int __snprintf(char *, size_t, const char *, ...); | inline int write( int handle, const void *buffer, unsigned int count ) { return _write(handle,buffer,count); } |
| # define snprintf __snprintf | inline int stat( const char* path, struct _stat *buffer ) { return _stat(path, buffer); } |
| #endif | 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 69 int __snprintf(char *, size_t, const cha | Line 56 int __snprintf(char *, size_t, const cha |
| #endif | #endif |
| /** 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 | |
| ); | |
| 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); | |
| typedef void (*File_read_action)( | |
| struct stat& finfo, | |
| int f, | |
| const String& file_spec, const char* fname, bool as_text, | |
| void *context); | |
| /** | /** |
| read specified text file using pool, | shared-lock specified file, |
| do actions under lock. | |
| if fail_on_read_problem is true[default] throws an exception | if fail_on_read_problem is true[default] throws an exception |
| @returns true if read OK | |
| */ | |
| bool file_read_action_under_lock(const String& file_spec, | |
| 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(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/*, HashStringValue* * out_fields=0*/); | |
| 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! | |
| @returns true if read OK | |
| */ | */ |
| 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, |
| HashStringValue* options=0, | |
| bool fail_on_read_problem=true, | bool fail_on_read_problem=true, |
| size_t offset=0, size_t limit=0); | char* buf=0, size_t offset=0, size_t size=0); |
| typedef void (*File_write_action)(int f, void *context); | |
| /** | /** |
| write data to specified file using pool, | lock specified file exclusively, |
| do actions under lock. | |
| throws an exception in case of problems | |
| if block=false does non-blocking lock | |
| @returns true if locked OK, or false if non-blocking locking failed | |
| */ | |
| bool file_write_action_under_lock( | |
| const String& file_spec, | |
| const char* action_name, File_write_action action, void *context, | |
| bool as_text=false, | |
| bool do_append=false, | |
| bool do_block=true, | |
| bool fail_on_lock_problem=true); | |
| /** | |
| write data to specified file, | |
| throws an exception in case of problems | throws an exception in case of problems |
| */ | */ |
| void file_write(Pool& pool, | void file_write( |
| 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 exclusive=false*/); | bool do_append=false); |
| /** | /** |
| delete specified file | delete specified file |
| throws an exception in case of problems | throws an exception in case of problems |
| */ | */ |
| void file_delete(Pool& pool, const String& file_spec); | bool file_delete(const String& file_spec, bool fail_on_problem=true); |
| /** | |
| move specified file | |
| throws an exception in case of problems | |
| */ | |
| void file_move(const String& old_spec, const String& new_spec); | |
| 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 file_readable(const String& file_spec); |
| bool dir_readable(const String& file_spec); | bool dir_readable(const String& file_spec); |
| const String* file_readable(const String& path, const String& name); | |
| bool file_executable(const String& file_spec); | bool file_executable(const String& file_spec); |
| size_t file_size(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); | |
| /** | /** |
| scans for @a delim[default \n] in @a *row_ref, | scans for @a delim[default \n] in @a *row_ref, |
| Line 116 size_t file_size(const String& file_spec | Line 182 size_t file_size(const String& file_spec |
| or to zero if no @a delim were found. | or to zero if no @a delim were found. |
| */ | */ |
| 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); | const char* format(double value, char *fmt); |
| #ifndef max | |
| inline int max(int a,int b) { return a>b?a:b; } | |
| inline int min(int a,int b){ return a<b?a:b; } | |
| #endif | |
| size_t stdout_write(const void *buf, size_t size); | size_t stdout_write(const void *buf, size_t size); |
| const char *unescape_chars(Pool& pool, const char *cp, int len); | char *unescape_chars(const char* cp, int len); |
| /** | |
| $content-type[text/html] -> | |
| 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); |
| Line 148 void back_slashes_to_slashes(char *s); | Line 201 void back_slashes_to_slashes(char *s); |
| qsort(names,cnt,sizeof_names,func_addr) | qsort(names,cnt,sizeof_names,func_addr) |
| #endif | #endif |
| bool StrEqNc(const char *s1, const char *s2, bool strict=true); | bool StrEqNc(const char* s1, const char* s2, bool strict=true); |
| char *unquote(char*& current, char stop_at); | |
| #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); |
| void remove_crlf(char *start, char *end); | |
| #ifdef PA_SAFE_MODE | |
| void check_safe_mode(struct stat finfo, const String& file_spec, const char* fname); | |
| #endif | |
| char* pa_base64_encode(const char *in, size_t in_size); | |
| void pa_base64_decode(const char *in, size_t in_size, void*& result, size_t& result_size); | |
| // 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" | |
| #endif | #endif |