file.php

Go to the documentation of this file.

<?php
/* SVN FILE: $Id: file.php 8189 2009-06-04 21:29:26Z DarkAngelBGE $ */
/**
 * Convenience class for reading, writing and appending to files.
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) :  Rapid Development Framework (http://www.cakephp.org)
 * Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @filesource
 * @copyright     Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org)
 * @link          http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
 * @package       cake
 * @subpackage    cake.cake.libs
 * @since         CakePHP(tm) v 0.2.9
 * @version       $Revision: 8189 $
 * @modifiedby    $LastChangedBy: DarkAngelBGE $
 * @lastmodified  $Date: 2009-06-04 17:29:26 -0400 (Thu, 04 Jun 2009) $
 * @license       http://www.opensource.org/licenses/mit-license.php The MIT License
 */
/**
 * Included libraries.
 *
 */
if (!class_exists('Object')) {
    uses('object');
}
if (!class_exists('Folder')) {
    require LIBS . 'folder.php';
}
/**
 * Convenience class for reading, writing and appending to files.
 *
 * @package       cake
 * @subpackage    cake.cake.libs
 */
class File extends Object {
/**
 * Folder object of the File
 *
 * @var Folder
 * @access public
 */
    var $Folder = null;
/**
 * Filename
 *
 * @var string
 * @access public
 */
    var $name = null;
/**
 * file info
 *
 * @var string
 * @access public
 */
    var $info = array();
/**
 * Holds the file handler resource if the file is opened
 *
 * @var resource
 * @access public
 */
    var $handle = null;
/**
 * enable locking for file reading and writing
 *
 * @var boolean
 * @access public
 */
    var $lock = null;
/**
 * path property
 *
 * Current file's absolute path
 *
 * @var mixed null
 * @access public
 */
    var $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
 * @access private
 */
    function __construct($path, $create = false, $mode = 0755) {
        parent::__construct();
        $this->Folder =& new Folder(dirname($path), $create, $mode);
        if (!is_dir($path)) {
            $this->name = basename($path);
        }
        $this->pwd();

        if (!$this->exists()) {
            if ($create === true) {
                if ($this->safe($path) && $this->create() === false) {
                    return false;
                }
            } else {
                return false;
            }
        }
    }
/**
 * Closes the current file if it is opened
 *
 * @access private
 */
    function __destruct() {
        $this->close();
    }
/**
 * Creates the File.
 *
 * @return boolean Success
 * @access public
 */
    function create() {
        $dir = $this->Folder->pwd();
        if (is_dir($dir) && is_writable($dir) && !$this->exists()) {
            $old = umask(0);
            if (touch($this->path)) {
                umask($old);
                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
 * @access public
 */
    function open($mode = 'r', $force = false) {
        if (!$force && is_resource($this->handle)) {
            return true;
        }
        clearstatcache();
        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
 * @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
 * @access 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);
        }
        $data = trim($data);

        if ($this->lock !== null) {
            flock($this->handle, LOCK_UN);
        }
        if ($bytes === false) {
            $this->close();
        }
        return $data;
    }
/**
 * Sets or gets the offset for the currently opened file.
 *
 * @param mixed $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)
 * @access 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
 * fixes line endings
 *
 * @param string $data Data to prepare for writing.
 * @return string
 * @access public
 */
    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
 * @access 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
 * @access 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
 * @access public
 */
    function close() {
        if (!is_resource($this->handle)) {
            return true;
        }
        return fclose($this->handle);
    }
/**
 * Deletes the File.
 *
 * @return boolean Success
 * @access public
 */
    function delete() {
        clearstatcache();
        if ($this->exists()) {
            return unlink($this->path);
        }
        return false;
    }
/**
 * Returns the File extension.
 *
 * @return string The File extension
 * @access public
 */
    function info() {
        if ($this->info == null) {
            $this->info = pathinfo($this->path);
        }
        if (!isset($this->info['filename'])) {
            $this->info['filename'] = $this->name();
        }
        return $this->info;
    }
/**
 * Returns the File extension.
 *
 * @return string The File extension
 * @access public
 */
    function ext() {
        if ($this->info == null) {
            $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.
 * @access public
 */
    function name() {
        if ($this->info == null) {
            $this->info();
        }
        if (isset($this->info['extension'])) {
            return basename($this->name, '.'.$this->info['extension']);
        } elseif ($this->name) {
            return $this->name;
        }
        return false;
    }
/**
 * makes filename safe for saving
 *
 * @param string $name the name of the file to make safe if different from $this->name
 * @return string $ext the extension of the file
 * @access 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 mixed $maxsize in MB or true to force
 * @return string md5 Checksum {@link http://php.net/md5_file See md5_file()}
 * @access 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 file
 * @access public
 */
    function pwd() {
        if (is_null($this->path)) {
            $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
 * @access public
 */
    function exists() {
        return (file_exists($this->path) && is_file($this->path));
    }
/**
 * Returns the "chmod" (permissions) of the File.
 *
 * @return string Permissions for the file
 * @access public
 */
    function perms() {
        if ($this->exists()) {
            return substr(sprintf('%o', fileperms($this->path)), -4);
        }
        return false;
    }
/**
 * Returns the Filesize
 *
 * @return integer size of the file in bytes, or false in case of an error
 * @access public
 */
    function size() {
        if ($this->exists()) {
            return filesize($this->path);
        }
        return false;
    }
/**
 * Returns true if the File is writable.
 *
 * @return boolean true if its writable, false otherwise
 * @access public
 */
    function writable() {
        return is_writable($this->path);
    }
/**
 * Returns true if the File is executable.
 *
 * @return boolean true if its executable, false otherwise
 * @access public
 */
    function executable() {
        return is_executable($this->path);
    }
/**
 * Returns true if the File is readable.
 *
 * @return boolean true if file is readable, false otherwise
 * @access public
 */
    function readable() {
        return is_readable($this->path);
    }
/**
 * Returns the File's owner.
 *
 * @return integer the Fileowner
 * @access public
 */
    function owner() {
        if ($this->exists()) {
            return fileowner($this->path);
        }
        return false;
    }
/**
 * Returns the File group.
 *
 * @return integer the Filegroup
 * @access public
 */
    function group() {
        if ($this->exists()) {
            return filegroup($this->path);
        }
        return false;
    }
/**
 * Returns last access time.
 *
 * @return integer timestamp Timestamp of last access time
 * @access public
 */
    function lastAccess() {
        if ($this->exists()) {
            return fileatime($this->path);
        }
        return false;
    }
/**
 * Returns last modified time.
 *
 * @return integer timestamp Timestamp of last modification
 * @access public
 */
    function lastChange() {
        if ($this->exists()) {
            return filemtime($this->path);
        }
        return false;
    }
/**
 * Returns the current folder.
 *
 * @return Folder Current folder
 * @access public
 */
    function &Folder() {
        return $this->Folder;
    }
}
?>

---