616 lines
16 KiB
PHP
616 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* Convenience class for reading, writing and appending to files.
|
|
*
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
|
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* For full copyright and license information, please see the LICENSE.txt
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
|
* @package Cake.Utility
|
|
* @since CakePHP(tm) v 0.2.9
|
|
* @license http://www.opensource.org/licenses/mit-license.php MIT License
|
|
*/
|
|
|
|
App::uses('Folder', 'Utility');
|
|
|
|
/**
|
|
* Convenience class for reading, writing and appending to files.
|
|
*
|
|
* @package Cake.Utility
|
|
*/
|
|
class File {
|
|
|
|
/**
|
|
* Folder object of the file
|
|
*
|
|
* @var Folder
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$Folder
|
|
*/
|
|
public $Folder = null;
|
|
|
|
/**
|
|
* File name
|
|
*
|
|
* @var string
|
|
* http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$name
|
|
*/
|
|
public $name = null;
|
|
|
|
/**
|
|
* File info
|
|
*
|
|
* @var array
|
|
* http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$info
|
|
*/
|
|
public $info = array();
|
|
|
|
/**
|
|
* Holds the file handler resource if the file is opened
|
|
*
|
|
* @var resource
|
|
* http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$handle
|
|
*/
|
|
public $handle = null;
|
|
|
|
/**
|
|
* Enable locking for file reading and writing
|
|
*
|
|
* @var boolean
|
|
* http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$lock
|
|
*/
|
|
public $lock = null;
|
|
|
|
/**
|
|
* Path property
|
|
*
|
|
* Current file's absolute path
|
|
*
|
|
* @var mixed null
|
|
* http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$path
|
|
*/
|
|
public $path = null;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param string $path Path to file
|
|
* @param boolean $create Create file if it does not exist (if true)
|
|
* @param integer $mode Mode to apply to the folder holding the file
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File
|
|
*/
|
|
public function __construct($path, $create = false, $mode = 0755) {
|
|
$this->Folder = new Folder(dirname($path), $create, $mode);
|
|
if (!is_dir($path)) {
|
|
$this->name = basename($path);
|
|
}
|
|
$this->pwd();
|
|
$create && !$this->exists() && $this->safe($path) && $this->create();
|
|
}
|
|
|
|
/**
|
|
* Closes the current file if it is opened
|
|
*/
|
|
public function __destruct() {
|
|
$this->close();
|
|
}
|
|
|
|
/**
|
|
* Creates the file.
|
|
*
|
|
* @return boolean Success
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::create
|
|
*/
|
|
public function create() {
|
|
$dir = $this->Folder->pwd();
|
|
if (is_dir($dir) && is_writable($dir) && !$this->exists()) {
|
|
if (touch($this->path)) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Opens the current file with a given $mode
|
|
*
|
|
* @param string $mode A valid 'fopen' mode string (r|w|a ...)
|
|
* @param boolean $force If true then the file will be re-opened even if its already opened, otherwise it won't
|
|
* @return boolean True on success, false on failure
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::open
|
|
*/
|
|
public function open($mode = 'r', $force = false) {
|
|
if (!$force && is_resource($this->handle)) {
|
|
return true;
|
|
}
|
|
if ($this->exists() === false) {
|
|
if ($this->create() === false) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$this->handle = fopen($this->path, $mode);
|
|
if (is_resource($this->handle)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return the contents of this file as a string.
|
|
*
|
|
* @param string $bytes where to start
|
|
* @param string $mode A `fread` compatible mode.
|
|
* @param boolean $force If true then the file will be re-opened even if its already opened, otherwise it won't
|
|
* @return mixed string on success, false on failure
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::read
|
|
*/
|
|
public function read($bytes = false, $mode = 'rb', $force = false) {
|
|
if ($bytes === false && $this->lock === null) {
|
|
return file_get_contents($this->path);
|
|
}
|
|
if ($this->open($mode, $force) === false) {
|
|
return false;
|
|
}
|
|
if ($this->lock !== null && flock($this->handle, LOCK_SH) === false) {
|
|
return false;
|
|
}
|
|
if (is_int($bytes)) {
|
|
return fread($this->handle, $bytes);
|
|
}
|
|
|
|
$data = '';
|
|
while (!feof($this->handle)) {
|
|
$data .= fgets($this->handle, 4096);
|
|
}
|
|
|
|
if ($this->lock !== null) {
|
|
flock($this->handle, LOCK_UN);
|
|
}
|
|
if ($bytes === false) {
|
|
$this->close();
|
|
}
|
|
return trim($data);
|
|
}
|
|
|
|
/**
|
|
* Sets or gets the offset for the currently opened file.
|
|
*
|
|
* @param integer|boolean $offset The $offset in bytes to seek. If set to false then the current offset is returned.
|
|
* @param integer $seek PHP Constant SEEK_SET | SEEK_CUR | SEEK_END determining what the $offset is relative to
|
|
* @return mixed True on success, false on failure (set mode), false on failure or integer offset on success (get mode)
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::offset
|
|
*/
|
|
public function offset($offset = false, $seek = SEEK_SET) {
|
|
if ($offset === false) {
|
|
if (is_resource($this->handle)) {
|
|
return ftell($this->handle);
|
|
}
|
|
} elseif ($this->open() === true) {
|
|
return fseek($this->handle, $offset, $seek) === 0;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Prepares a ASCII string for writing. Converts line endings to the
|
|
* correct terminator for the current platform. If Windows, "\r\n" will be used,
|
|
* all other platforms will use "\n"
|
|
*
|
|
* @param string $data Data to prepare for writing.
|
|
* @param boolean $forceWindows
|
|
* @return string The with converted line endings.
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::prepare
|
|
*/
|
|
public static function prepare($data, $forceWindows = false) {
|
|
$lineBreak = "\n";
|
|
if (DIRECTORY_SEPARATOR === '\\' || $forceWindows === true) {
|
|
$lineBreak = "\r\n";
|
|
}
|
|
return strtr($data, array("\r\n" => $lineBreak, "\n" => $lineBreak, "\r" => $lineBreak));
|
|
}
|
|
|
|
/**
|
|
* Write given data to this file.
|
|
*
|
|
* @param string $data Data to write to this File.
|
|
* @param string $mode Mode of writing. {@link http://php.net/fwrite See fwrite()}.
|
|
* @param string $force Force the file to open
|
|
* @return boolean Success
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::write
|
|
*/
|
|
public function write($data, $mode = 'w', $force = false) {
|
|
$success = false;
|
|
if ($this->open($mode, $force) === true) {
|
|
if ($this->lock !== null) {
|
|
if (flock($this->handle, LOCK_EX) === false) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (fwrite($this->handle, $data) !== false) {
|
|
$success = true;
|
|
}
|
|
if ($this->lock !== null) {
|
|
flock($this->handle, LOCK_UN);
|
|
}
|
|
}
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Append given data string to this file.
|
|
*
|
|
* @param string $data Data to write
|
|
* @param string $force Force the file to open
|
|
* @return boolean Success
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::append
|
|
*/
|
|
public function append($data, $force = false) {
|
|
return $this->write($data, 'a', $force);
|
|
}
|
|
|
|
/**
|
|
* Closes the current file if it is opened.
|
|
*
|
|
* @return boolean True if closing was successful or file was already closed, otherwise false
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::close
|
|
*/
|
|
public function close() {
|
|
if (!is_resource($this->handle)) {
|
|
return true;
|
|
}
|
|
return fclose($this->handle);
|
|
}
|
|
|
|
/**
|
|
* Deletes the file.
|
|
*
|
|
* @return boolean Success
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::delete
|
|
*/
|
|
public function delete() {
|
|
if (is_resource($this->handle)) {
|
|
fclose($this->handle);
|
|
$this->handle = null;
|
|
}
|
|
if ($this->exists()) {
|
|
return unlink($this->path);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the file info as an array with the following keys:
|
|
*
|
|
* - dirname
|
|
* - basename
|
|
* - extension
|
|
* - filename
|
|
* - filesize
|
|
* - mime
|
|
*
|
|
* @return array File information.
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::info
|
|
*/
|
|
public function info() {
|
|
if (!$this->info) {
|
|
$this->info = pathinfo($this->path);
|
|
}
|
|
if (!isset($this->info['filename'])) {
|
|
$this->info['filename'] = $this->name();
|
|
}
|
|
if (!isset($this->info['filesize'])) {
|
|
$this->info['filesize'] = $this->size();
|
|
}
|
|
if (!isset($this->info['mime'])) {
|
|
$this->info['mime'] = $this->mime();
|
|
}
|
|
return $this->info;
|
|
}
|
|
|
|
/**
|
|
* Returns the file extension.
|
|
*
|
|
* @return string The file extension
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::ext
|
|
*/
|
|
public function ext() {
|
|
if (!$this->info) {
|
|
$this->info();
|
|
}
|
|
if (isset($this->info['extension'])) {
|
|
return $this->info['extension'];
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the file name without extension.
|
|
*
|
|
* @return string The file name without extension.
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::name
|
|
*/
|
|
public function name() {
|
|
if (!$this->info) {
|
|
$this->info();
|
|
}
|
|
if (isset($this->info['extension'])) {
|
|
return basename($this->name, '.' . $this->info['extension']);
|
|
} elseif ($this->name) {
|
|
return $this->name;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Makes file name safe for saving
|
|
*
|
|
* @param string $name The name of the file to make safe if different from $this->name
|
|
* @param string $ext The name of the extension to make safe if different from $this->ext
|
|
* @return string $ext The extension of the file
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::safe
|
|
*/
|
|
public function safe($name = null, $ext = null) {
|
|
if (!$name) {
|
|
$name = $this->name;
|
|
}
|
|
if (!$ext) {
|
|
$ext = $this->ext();
|
|
}
|
|
return preg_replace("/(?:[^\w\.-]+)/", "_", basename($name, $ext));
|
|
}
|
|
|
|
/**
|
|
* Get md5 Checksum of file with previous check of Filesize
|
|
*
|
|
* @param integer|boolean $maxsize in MB or true to force
|
|
* @return string|false md5 Checksum {@link http://php.net/md5_file See md5_file()}, or false in case of an error
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::md5
|
|
*/
|
|
public function md5($maxsize = 5) {
|
|
if ($maxsize === true) {
|
|
return md5_file($this->path);
|
|
}
|
|
|
|
$size = $this->size();
|
|
if ($size && $size < ($maxsize * 1024) * 1024) {
|
|
return md5_file($this->path);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the full path of the file.
|
|
*
|
|
* @return string Full path to the file
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::pwd
|
|
*/
|
|
public function pwd() {
|
|
if ($this->path === null) {
|
|
$this->path = $this->Folder->slashTerm($this->Folder->pwd()) . $this->name;
|
|
}
|
|
return $this->path;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the file exists.
|
|
*
|
|
* @return boolean True if it exists, false otherwise
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::exists
|
|
*/
|
|
public function exists() {
|
|
$this->clearStatCache();
|
|
return (file_exists($this->path) && is_file($this->path));
|
|
}
|
|
|
|
/**
|
|
* Returns the "chmod" (permissions) of the file.
|
|
*
|
|
* @return string|false Permissions for the file, or false in case of an error
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::perms
|
|
*/
|
|
public function perms() {
|
|
if ($this->exists()) {
|
|
return substr(sprintf('%o', fileperms($this->path)), -4);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the file size
|
|
*
|
|
* @return integer|false Size of the file in bytes, or false in case of an error
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::size
|
|
*/
|
|
public function size() {
|
|
if ($this->exists()) {
|
|
return filesize($this->path);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the file is writable.
|
|
*
|
|
* @return boolean True if it's writable, false otherwise
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::writable
|
|
*/
|
|
public function writable() {
|
|
return is_writable($this->path);
|
|
}
|
|
|
|
/**
|
|
* Returns true if the File is executable.
|
|
*
|
|
* @return boolean True if it's executable, false otherwise
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::executable
|
|
*/
|
|
public function executable() {
|
|
return is_executable($this->path);
|
|
}
|
|
|
|
/**
|
|
* Returns true if the file is readable.
|
|
*
|
|
* @return boolean True if file is readable, false otherwise
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::readable
|
|
*/
|
|
public function readable() {
|
|
return is_readable($this->path);
|
|
}
|
|
|
|
/**
|
|
* Returns the file's owner.
|
|
*
|
|
* @return integer|false The file owner, or false in case of an error
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::owner
|
|
*/
|
|
public function owner() {
|
|
if ($this->exists()) {
|
|
return fileowner($this->path);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the file's group.
|
|
*
|
|
* @return integer|false The file group, or false in case of an error
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::group
|
|
*/
|
|
public function group() {
|
|
if ($this->exists()) {
|
|
return filegroup($this->path);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns last access time.
|
|
*
|
|
* @return integer|false Timestamp of last access time, or false in case of an error
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::lastAccess
|
|
*/
|
|
public function lastAccess() {
|
|
if ($this->exists()) {
|
|
return fileatime($this->path);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns last modified time.
|
|
*
|
|
* @return integer|false Timestamp of last modification, or false in case of an error
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::lastChange
|
|
*/
|
|
public function lastChange() {
|
|
if ($this->exists()) {
|
|
return filemtime($this->path);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the current folder.
|
|
*
|
|
* @return Folder Current folder
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::Folder
|
|
*/
|
|
public function folder() {
|
|
return $this->Folder;
|
|
}
|
|
|
|
/**
|
|
* Copy the File to $dest
|
|
*
|
|
* @param string $dest Destination for the copy
|
|
* @param boolean $overwrite Overwrite $dest if exists
|
|
* @return boolean Success
|
|
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::copy
|
|
*/
|
|
public function copy($dest, $overwrite = true) {
|
|
if (!$this->exists() || is_file($dest) && !$overwrite) {
|
|
return false;
|
|
}
|
|
return copy($this->path, $dest);
|
|
}
|
|
|
|
/**
|
|
* Get the mime type of the file. Uses the finfo extension if
|
|
* its available, otherwise falls back to mime_content_type
|
|
*
|
|
* @return false|string The mimetype of the file, or false if reading fails.
|
|
*/
|
|
public function mime() {
|
|
if (!$this->exists()) {
|
|
return false;
|
|
}
|
|
if (function_exists('finfo_open')) {
|
|
$finfo = finfo_open(FILEINFO_MIME);
|
|
$finfo = finfo_file($finfo, $this->pwd());
|
|
if (!$finfo) {
|
|
return false;
|
|
}
|
|
list($type) = explode(';', $finfo);
|
|
return $type;
|
|
}
|
|
if (function_exists('mime_content_type')) {
|
|
return mime_content_type($this->pwd());
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Clear PHP's internal stat cache
|
|
*
|
|
* For 5.3 onwards it's possible to clear cache for just a single file. Passing true
|
|
* will clear all the stat cache.
|
|
*
|
|
* @param boolean $all Clear all cache or not
|
|
* @return void
|
|
*/
|
|
public function clearStatCache($all = false) {
|
|
if ($all === false && version_compare(PHP_VERSION, '5.3.0') >= 0) {
|
|
return clearstatcache(true, $this->path);
|
|
}
|
|
|
|
return clearstatcache();
|
|
}
|
|
|
|
/**
|
|
* Searches for a given text and replaces the text if found.
|
|
*
|
|
* @param string|array $search Text(s) to search for.
|
|
* @param string|array $replace Text(s) to replace with.
|
|
* @return boolean Success
|
|
*/
|
|
public function replaceText($search, $replace) {
|
|
if (!$this->open('r+')) {
|
|
return false;
|
|
}
|
|
|
|
if ($this->lock !== null) {
|
|
if (flock($this->handle, LOCK_EX) === false) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$replaced = $this->write(str_replace($search, $replace, $this->read()), 'w', true);
|
|
|
|
if ($this->lock !== null) {
|
|
flock($this->handle, LOCK_UN);
|
|
}
|
|
$this->close();
|
|
|
|
return $replaced;
|
|
}
|
|
|
|
}
|