*/ /** * Contains methods for accessing file system * * @author NAVER (developers@xpressengine.com) */ class FileHandler { /** * Changes path of target file, directory into absolute path * * @param string $source path to change into absolute path * @return string Absolute path */ function getRealPath($source) { if(strlen($source) >= 2 && substr_compare($source, './', 0, 2) === 0) { return _XE_PATH_ . substr($source, 2); } return $source; } /** * Copy a directory to target * * If target directory does not exist, this function creates it * * @param string $source_dir Path of source directory * @param string $target_dir Path of target dir * @param string $filter Regex to filter files. If file matches this regex, the file is not copied. * @param string $type If set as 'force'. Even if the file exists in target, the file is copied. * @return void */ function copyDir($source_dir, $target_dir, $filter = null, $type = null) { $source_dir = self::getRealPath($source_dir); $target_dir = self::getRealPath($target_dir); if(!is_dir($source_dir)) { return FALSE; } // generate when no target exists self::makeDir($target_dir); if(substr($source_dir, -1) != DIRECTORY_SEPARATOR) { $source_dir .= DIRECTORY_SEPARATOR; } if(substr($target_dir, -1) != DIRECTORY_SEPARATOR) { $target_dir .= DIRECTORY_SEPARATOR; } $oDir = dir($source_dir); while($file = $oDir->read()) { if($file{0} == '.') { continue; } if($filter && preg_match($filter, $file)) { continue; } if(is_dir($source_dir . $file)) { self::copyDir($source_dir . $file, $target_dir . $file, $type); } else { if($type == 'force') { @unlink($target_dir . $file); } else { if(!file_exists($target_dir . $file)) { @copy($source_dir . $file, $target_dir . $file); } } } } $oDir->close(); } /** * Copy a file to target * * @param string $source Path of source file * @param string $target Path of target file * @param string $force Y: overwrite * @return void */ function copyFile($source, $target, $force = 'Y') { setlocale(LC_CTYPE, 'en_US.UTF8', 'ko_KR.UTF8'); $source = self::getRealPath($source); $target_dir = self::getRealPath(dirname($target)); $target = basename($target); self::makeDir($target_dir); if($force == 'Y') { @unlink($target_dir . DIRECTORY_SEPARATOR . $target); } @copy($source, $target_dir . DIRECTORY_SEPARATOR . $target); } /** * Returns the content of the file * * @param string $filename Path of target file * @return string The content of the file. If target file does not exist, this function returns nothing. */ function readFile($filename) { if(($filename = self::exists($filename)) === FALSE || filesize($filename) < 1) { return; } return @file_get_contents($filename); } /** * Write $buff into the specified file * * @param string $filename Path of target file * @param string $buff Content to be written * @param string $mode a(append) / w(write) * @return void */ function writeFile($filename, $buff, $mode = "w") { $filename = self::getRealPath($filename); $pathinfo = pathinfo($filename); self::makeDir($pathinfo['dirname']); $flags = 0; if(strtolower($mode) == 'a') { $flags = FILE_APPEND; } @file_put_contents($filename, $buff, $flags|LOCK_EX); @chmod($filename, 0644); } /** * Remove a file * * @param string $filename path of target file * @return bool Returns TRUE on success or FALSE on failure. */ function removeFile($filename) { return (($filename = self::exists($filename)) !== FALSE) && @unlink($filename); } /** * Rename a file * * In order to move a file, use this function. * * @param string $source Path of source file * @param string $target Path of target file * @return bool Returns TRUE on success or FALSE on failure. */ function rename($source, $target) { return @rename(self::getRealPath($source), self::getRealPath($target)); } /** * Move a file * * @param string $source Path of source file * @param string $target Path of target file * @return bool Returns TRUE on success or FALSE on failure. */ function moveFile($source, $target) { if(($source = self::exists($source)) !== FALSE) { self::removeFile($target); return self::rename($source, $target); } return FALSE; } /** * Move a directory * * This function just wraps rename function. * * @param string $source_dir Path of source directory * @param string $target_dir Path of target directory * @return void */ function moveDir($source_dir, $target_dir) { self::rename($source_dir, $target_dir); } /** * Return list of the files in the path * * The array does not contain files, such as '.', '..', and files starting with '.' * * @param string $path Path of target directory * @param string $filter If specified, return only files matching with the filter * @param bool $to_lower If TRUE, file names will be changed into lower case. * @param bool $concat_prefix If TRUE, return file name as absolute path * @return string[] Array of the filenames in the path */ function readDir($path, $filter = '', $to_lower = FALSE, $concat_prefix = FALSE) { $path = self::getRealPath($path); $output = array(); if(substr($path, -1) != '/') { $path .= '/'; } if(!is_dir($path)) { return $output; } $files = scandir($path); foreach($files as $file) { if($file{0} == '.' || ($filter && !preg_match($filter, $file))) { continue; } if($to_lower) { $file = strtolower($file); } if($filter) { $file = preg_replace($filter, '$1', $file); } if($concat_prefix) { $file = sprintf('%s%s', str_replace(_XE_PATH_, '', $path), $file); } $output[] = str_replace(array('/\\', '//'), '/', $file); } return $output; } /** * Creates a directory * * This function creates directories recursively, which means that if ancestors of the target directory does not exist, they will be created too. * * @param string $path_string Path of target directory * @return bool TRUE if success. It might return nothing when ftp is used and connection to the ftp address failed. */ function makeDir($path_string) { if(self::exists($path_string) !== FALSE) { return TRUE; } if(!ini_get('safe_mode')) { @mkdir($path_string, 0755, TRUE); @chmod($path_string, 0755); } // if safe_mode is on, use FTP else { static $oFtp = NULL; $ftp_info = Context::getFTPInfo(); if($oFtp == NULL) { if(!Context::isFTPRegisted()) { return; } require_once(_XE_PATH_ . 'libs/ftp.class.php'); $oFtp = new ftp(); if(!$ftp_info->ftp_host) { $ftp_info->ftp_host = "127.0.0.1"; } if(!$ftp_info->ftp_port) { $ftp_info->ftp_port = 21; } if(!$oFtp->ftp_connect($ftp_info->ftp_host, $ftp_info->ftp_port)) { return; } if(!$oFtp->ftp_login($ftp_info->ftp_user, $ftp_info->ftp_password)) { $oFtp->ftp_quit(); return; } } if(!($ftp_path = $ftp_info->ftp_root_path)) { $ftp_path = DIRECTORY_SEPARATOR; } $path_string = str_replace(_XE_PATH_, '', $path_string); $path_list = explode(DIRECTORY_SEPARATOR, $path_string); $path = _XE_PATH_; for($i = 0, $c = count($path_list); $i < $c; $i++) { if(!$path_list[$i]) { continue; } $path .= $path_list[$i] . DIRECTORY_SEPARATOR; $ftp_path .= $path_list[$i] . DIRECTORY_SEPARATOR; if(!is_dir($path)) { $oFtp->ftp_mkdir($ftp_path); $oFtp->ftp_site("CHMOD 777 " . $ftp_path); } } } return is_dir($path_string); } /** * Remove all files under the path * * @param string $path Path of the target directory * @return void */ function removeDir($path) { if(($path = self::isDir($path)) === FALSE) { return; } if(self::isDir($path)) { $files = array_diff(scandir($path), array('..', '.')); foreach($files as $file) { if(($target = self::getRealPath($path . DIRECTORY_SEPARATOR . $file)) === FALSE) { continue; } if(is_dir($target)) { self::removeDir($target); } else { unlink($target); } } rmdir($path); } else { unlink($path); } } /** * Remove a directory only if it is empty * * @param string $path Path of the target directory * @return void */ function removeBlankDir($path) { if(($path = self::isDir($path)) === FALSE) { return; } $files = array_diff(scandir($path), array('..', '.')); if(count($files) < 1) { rmdir($path); return; } foreach($files as $file) { if(($target = self::isDir($path . DIRECTORY_SEPARATOR . $file)) === FALSE) { continue; } self::removeBlankDir($target); } } /** * Remove files in the target directory * * This function keeps the directory structure. * * @param string $path Path of the target directory * @return void */ function removeFilesInDir($path) { if(($path = self::getRealPath($path)) === FALSE) { return; } if(is_dir($path)) { $files = array_diff(scandir($path), array('..', '.')); foreach($files as $file) { if(($target = self::getRealPath($path . DIRECTORY_SEPARATOR . $file)) === FALSE) { continue; } if(is_dir($target)) { self::removeFilesInDir($target); } else { unlink($target); } } } else { if(self::exists($path)) unlink($path); } } /** * Makes file size byte into KB, MB according to the size * * @see self::returnBytes() * @param int $size Number of the size * @return string File size string */ function filesize($size) { if(!$size) { return '0Byte'; } if($size === 1) { return '1Byte'; } if($size < 1024) { return $size . 'Bytes'; } if($size >= 1024 && $size < 1024 * 1024) { return sprintf("%0.1fKB", $size / 1024); } return sprintf("%0.2fMB", $size / (1024 * 1024)); } /** * Return remote file's content via HTTP * * If the target is moved (when return code is 300~399), this function follows the location specified response header. * * @param string $url The address of the target file * @param string $body HTTP request body * @param int $timeout Connection timeout * @param string $method GET/POST * @param string $content_type Content type header of HTTP request * @param string[] $headers Headers key value array. * @param string[] $cookies Cookies key value array. * @param string $post_data Request arguments array for POST method * @return string If success, the content of the target file. Otherwise: none */ function getRemoteResource($url, $body = null, $timeout = 3, $method = 'GET', $content_type = null, $headers = array(), $cookies = array(), $post_data = array(), $request_config = array()) { try { requirePear(); require_once('HTTP/Request.php'); $parsed_url = parse_url(__PROXY_SERVER__); if($parsed_url["host"]) { $oRequest = new HTTP_Request(__PROXY_SERVER__); $oRequest->setMethod('POST'); $oRequest->_timeout = $timeout; $oRequest->addPostData('arg', serialize(array('Destination' => $url, 'method' => $method, 'body' => $body, 'content_type' => $content_type, "headers" => $headers, "post_data" => $post_data))); } else { $oRequest = new HTTP_Request($url); if(count($request_config) && method_exists($oRequest, 'setConfig')) { foreach($request_config as $key=>$val) { $oRequest->setConfig($key, $val); } } if(count($headers) > 0) { foreach($headers as $key => $val) { $oRequest->addHeader($key, $val); } } if($cookies[$host]) { foreach($cookies[$host] as $key => $val) { $oRequest->addCookie($key, $val); } } if(count($post_data) > 0) { foreach($post_data as $key => $val) { $oRequest->addPostData($key, $val); } } if(!$content_type) $oRequest->addHeader('Content-Type', 'text/html'); else $oRequest->addHeader('Content-Type', $content_type); $oRequest->setMethod($method); if($body) $oRequest->setBody($body); } $oRequest->setConfig('timeout', $timeout); $oResponse = $oRequest->sendRequest(); $code = $oRequest->getResponseCode(); $header = $oRequest->getResponseHeader(); $response = $oRequest->getResponseBody(); if($c = $oRequest->getResponseCookies()) { foreach($c as $k => $v) { $cookies[$host][$v['name']] = $v['value']; } } if($code > 300 && $code < 399 && $header['location']) { return self::getRemoteResource($header['location'], $body, $timeout, $method, $content_type, $headers, $cookies, $post_data); } if($code != 200) return; return $response; } catch(Exception $e) { return NULL; } } /** * Retrieves remote file, then stores it into target path. * * @param string $url The address of the target file * @param string $target_filename The location to store * @param string $body HTTP request body * @param string $timeout Connection timeout * @param string $method GET/POST * @param string $content_type Content type header of HTTP request * @param string[] $headers Headers key value array. * @return bool TRUE: success, FALSE: failed */ function getRemoteFile($url, $target_filename, $body = null, $timeout = 3, $method = 'GET', $content_type = null, $headers = array(), $cookies = array(), $post_data = array(), $request_config = array()) { if(!($body = self::getRemoteResource($url, $body, $timeout, $method, $content_type, $headers,$cookies,$post_data,$request_config))) { return FALSE; } self::writeFile($target_filename, $body); return TRUE; } /** * Convert size in string into numeric value * * @see self::filesize() * @param $val Size in string (ex., 10, 10K, 10M, 10G ) * @return int converted size */ function returnBytes($val) { $unit = strtoupper(substr($val, -1)); $val = (float)$val; switch ($unit) { case 'G': $val *= 1024; case 'M': $val *= 1024; case 'K': $val *= 1024; } return round($val); } /** * Check available memory to load image file * * @param array $imageInfo Image info retrieved by getimagesize function * @return bool TRUE: it's ok, FALSE: otherwise */ function checkMemoryLoadImage(&$imageInfo) { $K64 = 65536; $TWEAKFACTOR = 2.0; $channels = $imageInfo['channels']; if(!$channels) { $channels = 6; //for png } $memoryNeeded = round(($imageInfo[0] * $imageInfo[1] * $imageInfo['bits'] * $channels / 8 + $K64 ) * $TWEAKFACTOR); $availableMemory = self::returnBytes(ini_get('memory_limit')) - memory_get_usage(); if($availableMemory < $memoryNeeded) { return FALSE; } return TRUE; } /** * Moves an image file (resizing is possible) * * @param string $source_file Path of the source file * @param string $target_file Path of the target file * @param int $resize_width Width to resize * @param int $resize_height Height to resize * @param string $target_type If $target_type is set (gif, jpg, png, bmp), result image will be saved as target type * @param string $thumbnail_type Thumbnail type(crop, ratio) * @return bool TRUE: success, FALSE: failed */ function createImageFile($source_file, $target_file, $resize_width = 0, $resize_height = 0, $target_type = '', $thumbnail_type = 'crop') { // check params if (($source_file = self::exists($source_file)) === FALSE) { return; } $target_file = self::getRealPath($target_file); if(!$resize_width) { $resize_width = 100; } if(!$resize_height) { $resize_height = $resize_width; } // retrieve source image's information $imageInfo = getimagesize($source_file); if(!self::checkMemoryLoadImage($imageInfo)) { return FALSE; } list($width, $height, $type, $attrs) = $imageInfo; if($width < 1 || $height < 1) { return; } switch($type) { case '1' : $type = 'gif'; break; case '2' : $type = 'jpg'; break; case '3' : $type = 'png'; break; case '6' : $type = 'bmp'; break; default : return; } if(!$target_type) { $target_type = $type; } $target_type = strtolower($target_type); // if original image is larger than specified size to resize, calculate the ratio $width_per = ($resize_width > 0 && $width >= $resize_width) ? $resize_width / $width : 1; $height_per = ($resize_height > 0 && $height >= $resize_height) ? $resize_height / $height : 1; $per = NULL; if($thumbnail_type == 'ratio') { $per = ($width_per > $height_per) ? $height_per : $width_per; $resize_width = $width * $per; $resize_height = $height * $per; } else { $per = ($width_per < $height_per) ? $height_per : $width_per; } // create temporary image with target size $thumb = NULL; if(function_exists('imagecreateTRUEcolor')) { $thumb = imagecreateTRUEcolor($resize_width, $resize_height); } else if(function_exists('imagecreate')) { $thumb = imagecreate($resize_width, $resize_height); } if(!$thumb) { return FALSE; } imagefilledrectangle($thumb, 0, 0, $resize_width - 1, $resize_height - 1, imagecolorallocate($thumb, 255, 255, 255)); // create temporary image having original type $source = NULL; switch($type) { case 'gif' : if(function_exists('imagecreatefromgif')) { $source = @imagecreatefromgif($source_file); } break; case 'jpeg' : case 'jpg' : if(function_exists('imagecreatefromjpeg')) { $source = @imagecreatefromjpeg($source_file); } break; case 'png' : if(function_exists('imagecreatefrompng')) { $source = @imagecreatefrompng($source_file); } break; case 'wbmp' : case 'bmp' : if(function_exists('imagecreatefromwbmp')) { $source = @imagecreatefromwbmp($source_file); } break; } if(!$source) { imagedestroy($thumb); return FALSE; } // resize original image and put it into temporary image $new_width = (int) ($width * $per); $new_height = (int) ($height * $per); $x = 0; $y = 0; if($thumbnail_type == 'crop') { $x = (int) ($resize_width / 2 - $new_width / 2); $y = (int) ($resize_height / 2 - $new_height / 2); } if(function_exists('imagecopyresampled')) { imagecopyresampled($thumb, $source, $x, $y, 0, 0, $new_width, $new_height, $width, $height); } else { imagecopyresized($thumb, $source, $x, $y, 0, 0, $new_width, $new_height, $width, $height); } // create directory self::makeDir(dirname($target_file)); // write into the file $output = NULL; switch($target_type) { case 'gif' : if(function_exists('imagegif')) { $output = imagegif($thumb, $target_file); } break; case 'jpeg' : case 'jpg' : if(function_exists('imagejpeg')) { $output = imagejpeg($thumb, $target_file, 100); } break; case 'png' : if(function_exists('imagepng')) { $output = imagepng($thumb, $target_file, 9); } break; case 'wbmp' : case 'bmp' : if(function_exists('imagewbmp')) { $output = imagewbmp($thumb, $target_file, 100); } break; } imagedestroy($thumb); imagedestroy($source); if(!$output) { return FALSE; } @chmod($target_file, 0644); return TRUE; } /** * Reads ini file, and puts result into array * * @see self::writeIniFile() * @param string $filename Path of the ini file * @return array ini array (if the target file does not exist, it returns FALSE) */ function readIniFile($filename) { if(($filename = self::exists($filename)) === FALSE) { return FALSE; } $arr = parse_ini_file($filename, TRUE); if(is_array($arr) && count($arr) > 0) { return $arr; } else { return array(); } } /** * Write array into ini file * * $ini['key1'] = 'value1';
* $ini['key2'] = 'value2';
* $ini['section']['key1_in_section'] = 'value1_in_section';
* $ini['section']['key2_in_section'] = 'value2_in_section';
* self::writeIniFile('exmple.ini', $ini); * * @see self::readIniFile() * @param string $filename Target ini file name * @param array $arr Array * @return bool if array contains nothing it returns FALSE, otherwise TRUE */ function writeIniFile($filename, $arr) { if(!is_array($arr) || count($arr) == 0) { return FALSE; } self::writeFile($filename, self::_makeIniBuff($arr)); return TRUE; } /** * Make array to ini string * * @param array $arr Array * @return string */ function _makeIniBuff($arr) { $return = array(); foreach($arr as $key => $val) { // section if(is_array($val)) { $return[] = sprintf("[%s]", $key); foreach($val as $k => $v) { $return[] = sprintf("%s=\"%s\"", $k, $v); } // value } else if(is_object($val)) { continue; } else { $return[] = sprintf("%s=\"%s\"", $key, $val); } } return join("\n", $return); } /** * Returns a file object * * If the directory of the file does not exist, create it. * * @param string $filename Target file name * @param string $mode File mode for fopen * @return FileObject File object */ function openFile($filename, $mode) { $pathinfo = pathinfo($filename); self::makeDir($pathinfo['dirname']); require_once("FileObject.class.php"); return new FileObject($filename, $mode); } /** * Check whether the given file has the content. * * @param string $filename Target file name * @return bool Returns TRUE if the file exists and contains something. */ function hasContent($filename) { return (is_readable($filename) && (filesize($filename) > 0)); } /** * Check file exists. * * @param string $filename Target file name * @return bool Returns FALSE if the file does not exists, or Returns full path file(string). */ function exists($filename) { $filename = self::getRealPath($filename); return file_exists($filename) ? $filename : FALSE; } /** * Check it is dir * * @param string $dir Target dir path * @return bool Returns FALSE if the dir is not dir, or Returns full path of dir(string). */ function isDir($path) { $path = self::getRealPath($path); return is_dir($path) ? $path : FALSE; } /** * Check is writable dir * * @param string $path Target dir path * @return bool */ function isWritableDir($path) { $path = self::getRealPath($path); if(is_dir($path)==FALSE) { return FALSE; } $checkFile = $path . '/_CheckWritableDir'; $fp = fopen($checkFile, 'w'); if(!is_resource($fp)) { return FALSE; } fclose($fp); self::removeFile($checkFile); return TRUE; } } /* End of file FileHandler.class.php */ /* Location: ./classes/file/FileHandler.class.php */