search/Zend/Search/Lucene/Storage/File/Filesystem.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Search_Lucene
  17  * @subpackage Storage
  18  * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  */
  21
  22
  23 /** Zend_Search_Lucene_Storage_File */
  24 require_once $CFG->dirroot.'/search/Zend/Search/Lucene/Storage/File.php';
  25
  26 /** Zend_Search_Lucene_Exception */
  27 require_once $CFG->dirroot.'/search/Zend/Search/Lucene/Exception.php';
  28
  29
  30 /**
  31  * @category   Zend
  32  * @package    Zend_Search_Lucene
  33  * @subpackage Storage
  34  * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  35  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  36  */
  37 class Zend_Search_Lucene_Storage_File_Filesystem extends Zend_Search_Lucene_Storage_File
  38 {
  39     /**
  40      * Resource of the open file
  41      *
  42      * @var resource
  43      */
  44     private $_fileHandle;
  45
  46     /**
  47      * Class constructor.  Open the file.
  48      *
  49      * @param string $filename
  50      * @param string $mode
  51      */
  52     public function __construct($filename, $mode='r+b')
  53     {
  54         global $php_errormsg;
  55
  56         $trackErrors = ini_get('track_errors');
  57         ini_set('track_errors', '1');
  58
  59         $this->_fileHandle = @fopen($filename, $mode);
  60
  61         if ($this->_fileHandle === false) {
  62             ini_set('track_errors', $trackErrors);
  63             throw new Zend_Search_Lucene_Exception($php_errormsg);
  64         }
  65
  66         ini_set('track_errors', $trackErrors);
  67     }
  68
  69     /**
  70      * Sets the file position indicator and advances the file pointer.
  71      * The new position, measured in bytes from the beginning of the file,
  72      * is obtained by adding offset to the position specified by whence,
  73      * whose values are defined as follows:
  74      * SEEK_SET - Set position equal to offset bytes.
  75      * SEEK_CUR - Set position to current location plus offset.
  76      * SEEK_END - Set position to end-of-file plus offset. (To move to
  77      * a position before the end-of-file, you need to pass a negative value
  78      * in offset.)
  79      * SEEK_CUR is the only supported offset type for compound files
  80      *
  81      * Upon success, returns 0; otherwise, returns -1
  82      *
  83      * @param integer $offset
  84      * @param integer $whence
  85      * @return integer
  86      */
  87     public function seek($offset, $whence=SEEK_SET)
  88     {
  89         return fseek($this->_fileHandle, $offset, $whence);
  90     }
  91
  92
  93     /**
  94      * Get file position.
  95      *
  96      * @return integer
  97      */
  98     public function tell()
  99     {
 100         return ftell($this->_fileHandle);
 101     }
 102
 103     /**
 104      * Flush output.
 105      *
 106      * Returns true on success or false on failure.
 107      *
 108      * @return boolean
 109      */
 110     public function flush()
 111     {
 112         return fflush($this->_fileHandle);
 113     }
 114
 115     /**
 116      * Close File object
 117      */
 118     public function close()
 119     {
 120         if ($this->_fileHandle !== null ) {
 121             @fclose($this->_fileHandle);
 122             $this->_fileHandle = null;
 123         }
 124     }
 125
 126     /**
 127      * Get the size of the already opened file
 128      *
 129      * @return integer
 130      */
 131     public function size()
 132     {
 133         $position = ftell($this->_fileHandle);
 134         fseek($this->_fileHandle, 0, SEEK_END);
 135         $size = ftell($this->_fileHandle);
 136         fseek($this->_fileHandle,$position);
 137
 138         return $size;
 139     }
 140
 141     /**
 142      * Read a $length bytes from the file and advance the file pointer.
 143      *
 144      * @param integer $length
 145      * @return string
 146      */
 147     protected function _fread($length=1)
 148     {
 149         if ($length == 0) {
 150             return '';
 151         }
 152
 153         if ($length < 1024) {
 154             return fread($this->_fileHandle, $length);
 155         }
 156
 157         $data = '';
 158         while ( $length > 0 && ($nextBlock = fread($this->_fileHandle, $length)) != false ) {
 159             $data .= $nextBlock;
 160             $length -= strlen($nextBlock);
 161         }
 162         return $data;
 163     }
 164
 165
 166     /**
 167      * Writes $length number of bytes (all, if $length===null) to the end
 168      * of the file.
 169      *
 170      * @param string $data
 171      * @param integer $length
 172      */
 173     protected function _fwrite($data, $length=null)
 174     {
 175         if ($length === null ) {
 176             fwrite($this->_fileHandle, $data);
 177         } else {
 178             fwrite($this->_fileHandle, $data, $length);
 179         }
 180     }
 181
 182     /**
 183      * Lock file
 184      *
 185      * Lock type may be a LOCK_SH (shared lock) or a LOCK_EX (exclusive lock)
 186      *
 187      * @param integer $lockType
 188      * @param boolean $nonBlockinLock
 189      * @return boolean
 190      */
 191     public function lock($lockType, $nonBlockinLock = false)
 192     {
 193         if ($nonBlockinLock) {
 194             return flock($this->_fileHandle, $lockType | LOCK_NB);
 195         } else {
 196             return flock($this->_fileHandle, $lockType);
 197         }
 198     }
 199
 200     /**
 201      * Unlock file
 202      *
 203      * Returns true on success
 204      *
 205      * @return boolean
 206      */
 207     public function unlock()
 208     {
 209         if ($this->_fileHandle !== null ) {
 210             return flock($this->_fileHandle, LOCK_UN);
 211         } else {
 212             return true;
 213         }
 214     }
 215 }
 216