Initial commit
[moodle.git] / 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) 2006 Zend Technologies USA Inc. (http://www.zend.com)
19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20  */
23 /** Zend_Search_Lucene_Storage_File */
24 require_once 'Zend/Search/Lucene/Storage/File.php';
26 /** Zend_Search_Lucene_Exception */
27 require_once 'Zend/Search/Lucene/Exception.php';
30 /**
31  * @category   Zend
32  * @package    Zend_Search_Lucene
33  * @subpackage Storage
34  * @copyright  Copyright (c) 2006 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;
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;
56         $trackErrors = ini_get( "track_errors");
57         ini_set('track_errors', '1');
59         $this->_fileHandle = @fopen($filename, $mode);
61         if ($this->_fileHandle===false) {
62             ini_set('track_errors', $trackErrors);
63             throw new Zend_Search_Lucene_Exception($php_errormsg);
64         }
66         ini_set('track_errors', $trackErrors);
67     }
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     }
93     /**
94      * Get file position.
95      *
96      * @return integer
97      */
98     public function tell()
99     {
100         return ftell($this->_fileHandle);
101     }
104     /**
105      * Close File object
106      */
107     public function close()
108     {
109         if ($this->_fileHandle !== null ) {
110             @fclose($this->_fileHandle);
111             $this->_fileHandle = null;
112         }
113     }
115     /**
116      * Get the size of the already opened file
117      *
118      * @return integer
119      */
120     public function size()
121     {
122         $position = ftell($this->_fileHandle);
123         fseek($this->_fileHandle, 0, SEEK_END);
124         $size = ftell($this->_fileHandle);
125         fseek($this->_fileHandle,$position);
127         return $size;
128     }
130     /**
131      * Read a $length bytes from the file and advance the file pointer.
132      *
133      * @param integer $length
134      * @return string
135      */
136     protected function _fread($length=1)
137     {
138         if ($length == 0) {
139             return '';
140         }
142         if ($length < 1024) {
143             return fread($this->_fileHandle, $length);
144         }
146         $data = '';
147         while ( $length > 0 && ($nextBlock = fread($this->_fileHandle, $length)) != false ) {
148             $data .= $nextBlock;
149             $length -= strlen($nextBlock);
150         }
151         return $data;
152     }
155     /**
156      * Writes $length number of bytes (all, if $length===null) to the end
157      * of the file.
158      *
159      * @param string $data
160      * @param integer $length
161      */
162     protected function _fwrite($data, $length=null)
163     {
164         if ($length === null ) {
165             fwrite($this->_fileHandle, $data);
166         } else {
167             fwrite($this->_fileHandle, $data, $length);
168         }
169     }