name : zend_virtual_cwd.h /* +----------------------------------------------------------------------+ | Copyright (c) The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 3.01 of the PHP license, | | that is bundled with this package in the file LICENSE, and is | | available through the world-wide-web at the following url: | | https://www.php.net/license/3_01.txt | | If you did not receive a copy of the PHP license and are unable to | | obtain it through the world-wide-web, please send a note to | | license@php.net so we can mail you a copy immediately. | +----------------------------------------------------------------------+ | Authors: Andi Gutmans <andi@php.net> | | Sascha Schumann <sascha@schumann.cx> | | Pierre Joye <pierre@php.net> | +----------------------------------------------------------------------+ */ #ifndef VIRTUAL_CWD_H #define VIRTUAL_CWD_H #include "TSRM.h" #include <sys/types.h> #include <sys/stat.h> #include <ctype.h> #ifdef HAVE_UTIME_H #include <utime.h> #endif #include <stdarg.h> #include <limits.h> #if HAVE_SYS_PARAM_H # include <sys/param.h> #endif #ifndef MAXPATHLEN # if _WIN32 # include "win32/ioutil.h" # define MAXPATHLEN PHP_WIN32_IOUTIL_MAXPATHLEN # elif PATH_MAX # define MAXPATHLEN PATH_MAX # elif defined(MAX_PATH) # define MAXPATHLEN MAX_PATH # else # define MAXPATHLEN 256 # endif #endif #ifdef ZTS #define VIRTUAL_DIR #endif #ifndef ZEND_WIN32 #include <unistd.h> #else #include <direct.h> #endif #if defined(__osf__) || defined(_AIX) #include <errno.h> #endif #ifdef ZEND_WIN32 #include "win32/readdir.h" #include <sys/utime.h> #include "win32/ioutil.h" /* mode_t isn't defined on Windows */ typedef unsigned short mode_t; #define DEFAULT_SLASH '\\' #define DEFAULT_DIR_SEPARATOR ';' #define IS_SLASH(c) ((c) == '/' || (c) == '\\') #define IS_SLASH_P(c) (*(c) == '/' || \ (*(c) == '\\' && !IsDBCSLeadByte(*(c-1)))) /* COPY_WHEN_ABSOLUTE is 2 under Win32 because by chance both regular absolute paths in the file system and UNC paths need copying of two characters */ #define COPY_WHEN_ABSOLUTE(path) 2 #define IS_UNC_PATH(path, len) \ (len >= 2 && IS_SLASH(path[0]) && IS_SLASH(path[1])) #define IS_ABSOLUTE_PATH(path, len) \ (len >= 2 && (/* is local */isalpha(path[0]) && path[1] == ':' || /* is UNC */IS_SLASH(path[0]) && IS_SLASH(path[1]))) #else #ifdef HAVE_DIRENT_H #include <dirent.h> #endif #define DEFAULT_SLASH '/' #ifdef __riscos__ #define DEFAULT_DIR_SEPARATOR ';' #else #define DEFAULT_DIR_SEPARATOR ':' #endif #define IS_SLASH(c) ((c) == '/') #define IS_SLASH_P(c) (*(c) == '/') #endif #ifndef COPY_WHEN_ABSOLUTE #define COPY_WHEN_ABSOLUTE(path) 0 #endif #ifndef IS_ABSOLUTE_PATH #define IS_ABSOLUTE_PATH(path, len) \ (IS_SLASH(path[0])) #endif #ifdef TSRM_EXPORTS #define CWD_EXPORTS #endif #ifdef ZEND_WIN32 # ifdef CWD_EXPORTS # define CWD_API __declspec(dllexport) # else # define CWD_API __declspec(dllimport) # endif #elif defined(__GNUC__) && __GNUC__ >= 4 # define CWD_API __attribute__ ((visibility("default"))) #else # define CWD_API #endif #ifdef ZEND_WIN32 # define php_sys_stat_ex php_win32_ioutil_stat_ex # define php_sys_stat php_win32_ioutil_stat # define php_sys_lstat php_win32_ioutil_lstat # define php_sys_fstat php_win32_ioutil_fstat # define php_sys_readlink php_win32_ioutil_readlink # define php_sys_symlink php_win32_ioutil_symlink # define php_sys_link php_win32_ioutil_link #else # define php_sys_stat stat # define php_sys_lstat lstat # define php_sys_fstat fstat # ifdef HAVE_SYMLINK # define php_sys_readlink(link, target, target_len) readlink(link, target, target_len) # define php_sys_symlink symlink # define php_sys_link link # endif #endif typedef struct _cwd_state { char *cwd; size_t cwd_length; } cwd_state; typedef int (*verify_path_func)(const cwd_state *); CWD_API void virtual_cwd_startup(void); CWD_API void virtual_cwd_shutdown(void); CWD_API int virtual_cwd_activate(void); CWD_API int virtual_cwd_deactivate(void); CWD_API char *virtual_getcwd_ex(size_t *length); CWD_API char *virtual_getcwd(char *buf, size_t size); CWD_API int virtual_chdir(const char *path); CWD_API int virtual_chdir_file(const char *path, int (*p_chdir)(const char *path)); CWD_API int virtual_filepath(const char *path, char **filepath); CWD_API int virtual_filepath_ex(const char *path, char **filepath, verify_path_func verify_path); CWD_API char *virtual_realpath(const char *path, char *real_path); CWD_API FILE *virtual_fopen(const char *path, const char *mode); CWD_API int virtual_open(const char *path, int flags, ...); CWD_API int virtual_creat(const char *path, mode_t mode); CWD_API int virtual_rename(const char *oldname, const char *newname); CWD_API int virtual_stat(const char *path, zend_stat_t *buf); CWD_API int virtual_lstat(const char *path, zend_stat_t *buf); CWD_API int virtual_unlink(const char *path); CWD_API int virtual_mkdir(const char *pathname, mode_t mode); CWD_API int virtual_rmdir(const char *pathname); CWD_API DIR *virtual_opendir(const char *pathname); CWD_API FILE *virtual_popen(const char *command, const char *type); CWD_API int virtual_access(const char *pathname, int mode); #if HAVE_UTIME CWD_API int virtual_utime(const char *filename, struct utimbuf *buf); #endif CWD_API int virtual_chmod(const char *filename, mode_t mode); #if !defined(ZEND_WIN32) CWD_API int virtual_chown(const char *filename, uid_t owner, gid_t group, int link); #endif /* One of the following constants must be used as the last argument in virtual_file_ex() call. */ // TODO Make this into an enum #define CWD_EXPAND 0 /* expand "." and ".." but don't resolve symlinks */ #define CWD_FILEPATH 1 /* resolve symlinks if file is exist otherwise expand */ #define CWD_REALPATH 2 /* call realpath(), resolve symlinks. File must exist */ CWD_API int virtual_file_ex(cwd_state *state, const char *path, verify_path_func verify_path, int use_realpath); CWD_API char *tsrm_realpath(const char *path, char *real_path); #define REALPATH_CACHE_TTL (2*60) /* 2 minutes */ #define REALPATH_CACHE_SIZE 0 /* disabled while php.ini isn't loaded */ typedef struct _realpath_cache_bucket { zend_ulong key; char *path; char *realpath; struct _realpath_cache_bucket *next; time_t expires; uint16_t path_len; uint16_t realpath_len; uint8_t is_dir:1; #ifdef ZEND_WIN32 uint8_t is_rvalid:1; uint8_t is_readable:1; uint8_t is_wvalid:1; uint8_t is_writable:1; #endif } realpath_cache_bucket; typedef struct _virtual_cwd_globals { cwd_state cwd; zend_long realpath_cache_size; zend_long realpath_cache_size_limit; zend_long realpath_cache_ttl; realpath_cache_bucket *realpath_cache[1024]; } virtual_cwd_globals; #ifdef ZTS extern ts_rsrc_id cwd_globals_id; extern size_t cwd_globals_offset; # define CWDG(v) ZEND_TSRMG_FAST(cwd_globals_offset, virtual_cwd_globals *, v) #else extern virtual_cwd_globals cwd_globals; # define CWDG(v) (cwd_globals.v) #endif CWD_API void realpath_cache_clean(void); CWD_API void realpath_cache_del(const char *path, size_t path_len); CWD_API realpath_cache_bucket* realpath_cache_lookup(const char *path, size_t path_len, time_t t); CWD_API zend_long realpath_cache_size(void); CWD_API zend_long realpath_cache_max_buckets(void); CWD_API realpath_cache_bucket** realpath_cache_get_buckets(void); #ifdef CWD_EXPORTS extern void virtual_cwd_main_cwd_init(uint8_t); #endif /* The actual macros to be used in programs using TSRM * If the program defines VIRTUAL_DIR it will use the * virtual_* functions */ #ifdef VIRTUAL_DIR #define VCWD_GETCWD(buff, size) virtual_getcwd(buff, size) #define VCWD_FOPEN(path, mode) virtual_fopen(path, mode) /* Because open() has two modes, we have to macros to replace it */ #define VCWD_OPEN(path, flags) virtual_open(path, flags) #define VCWD_OPEN_MODE(path, flags, mode) virtual_open(path, flags, mode) #define VCWD_CREAT(path, mode) virtual_creat(path, mode) #define VCWD_CHDIR(path) virtual_chdir(path) #define VCWD_CHDIR_FILE(path) virtual_chdir_file(path, virtual_chdir) #define VCWD_GETWD(buf) #define VCWD_REALPATH(path, real_path) virtual_realpath(path, real_path) #define VCWD_RENAME(oldname, newname) virtual_rename(oldname, newname) #define VCWD_STAT(path, buff) virtual_stat(path, buff) # define VCWD_LSTAT(path, buff) virtual_lstat(path, buff) #define VCWD_UNLINK(path) virtual_unlink(path) #define VCWD_MKDIR(pathname, mode) virtual_mkdir(pathname, mode) #define VCWD_RMDIR(pathname) virtual_rmdir(pathname) #define VCWD_OPENDIR(pathname) virtual_opendir(pathname) #define VCWD_POPEN(command, type) virtual_popen(command, type) #define VCWD_ACCESS(pathname, mode) virtual_access(pathname, mode) #if HAVE_UTIME #define VCWD_UTIME(path, time) virtual_utime(path, time) #endif #define VCWD_CHMOD(path, mode) virtual_chmod(path, mode) #if !defined(ZEND_WIN32) #define VCWD_CHOWN(path, owner, group) virtual_chown(path, owner, group, 0) #if HAVE_LCHOWN #define VCWD_LCHOWN(path, owner, group) virtual_chown(path, owner, group, 1) #endif #endif #else #define VCWD_CREAT(path, mode) creat(path, mode) /* rename on windows will fail if newname already exists. MoveFileEx has to be used */ #if defined(ZEND_WIN32) #define VCWD_FOPEN(path, mode) php_win32_ioutil_fopen(path, mode) #define VCWD_OPEN(path, flags) php_win32_ioutil_open(path, flags) #define VCWD_OPEN_MODE(path, flags, mode) php_win32_ioutil_open(path, flags, mode) # define VCWD_RENAME(oldname, newname) php_win32_ioutil_rename(oldname, newname) #define VCWD_MKDIR(pathname, mode) php_win32_ioutil_mkdir(pathname, mode) #define VCWD_RMDIR(pathname) php_win32_ioutil_rmdir(pathname) #define VCWD_UNLINK(path) php_win32_ioutil_unlink(path) #define VCWD_CHDIR(path) php_win32_ioutil_chdir(path) #define VCWD_ACCESS(pathname, mode) tsrm_win32_access(pathname, mode) #define VCWD_GETCWD(buff, size) php_win32_ioutil_getcwd(buff, size) #define VCWD_CHMOD(path, mode) php_win32_ioutil_chmod(path, mode) #else #define VCWD_FOPEN(path, mode) fopen(path, mode) #define VCWD_OPEN(path, flags) open(path, flags) #define VCWD_OPEN_MODE(path, flags, mode) open(path, flags, mode) # define VCWD_RENAME(oldname, newname) rename(oldname, newname) #define VCWD_MKDIR(pathname, mode) mkdir(pathname, mode) #define VCWD_RMDIR(pathname) rmdir(pathname) #define VCWD_UNLINK(path) unlink(path) #define VCWD_CHDIR(path) chdir(path) #define VCWD_ACCESS(pathname, mode) access(pathname, mode) #define VCWD_GETCWD(buff, size) getcwd(buff, size) #define VCWD_CHMOD(path, mode) chmod(path, mode) #endif #define VCWD_CHDIR_FILE(path) virtual_chdir_file(path, chdir) #define VCWD_GETWD(buf) getwd(buf) #define VCWD_STAT(path, buff) php_sys_stat(path, buff) #define VCWD_LSTAT(path, buff) lstat(path, buff) #define VCWD_OPENDIR(pathname) opendir(pathname) #define VCWD_POPEN(command, type) popen(command, type) #define VCWD_REALPATH(path, real_path) tsrm_realpath(path, real_path) #if HAVE_UTIME # ifdef ZEND_WIN32 # define VCWD_UTIME(path, time) win32_utime(path, time) # else # define VCWD_UTIME(path, time) utime(path, time) # endif #endif #if !defined(ZEND_WIN32) #define VCWD_CHOWN(path, owner, group) chown(path, owner, group) #if HAVE_LCHOWN #define VCWD_LCHOWN(path, owner, group) lchown(path, owner, group) #endif #endif #endif /* Global stat declarations */ #ifndef _S_IFDIR #define _S_IFDIR S_IFDIR #endif #ifndef _S_IFREG #define _S_IFREG S_IFREG #endif #ifndef S_IFLNK #define _IFLNK 0120000 /* symbolic link */ #define S_IFLNK _IFLNK #endif #ifndef S_ISDIR #define S_ISDIR(mode) (((mode)&S_IFMT) == S_IFDIR) #endif #ifndef S_ISREG #define S_ISREG(mode) (((mode)&S_IFMT) == S_IFREG) #endif #ifndef S_ISLNK #define S_ISLNK(mode) (((mode)&S_IFMT) == S_IFLNK) #endif #ifndef S_IXROOT #define S_IXROOT ( S_IXUSR | S_IXGRP | S_IXOTH ) #endif /* XXX should be _S_IFIFO? */ #ifndef S_IFIFO #define _IFIFO 0010000 /* fifo */ #define S_IFIFO _IFIFO #endif #ifndef S_IFBLK #define _IFBLK 0060000 /* block special */ #define S_IFBLK _IFBLK #endif #endif /* VIRTUAL_CWD_H */