3 namespace CoreFramework\Filesystem\Pointer\Input;
5 // Import framework stuff
6 use CoreFramework\Bootstrap\FrameworkBootstrap;
7 use CoreFramework\FileSystem\BaseFileIo;
8 use CoreFramework\Filesystem\Pointer\InputPointer;
9 use CoreFramework\Generic\NullPointerException;
10 use CoreFramework\Object\BaseFrameworkSystem;
13 * A class for reading files
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class FrameworkRawFileInputPointer extends BaseFileIo implements InputPointer {
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Create a file pointer based on the given file. The file will also
49 * @param $fileName The file name we shall pass to fopen()
50 * @throws FileIsEmptyException If the provided file name is empty.
51 * @throws FileIoException If the file is not reachable
52 * @throws FileReadProtectedException If the file is not found or cannot be read
53 * @throws FileNotFoundException If the file does not exist
56 public static final function createFrameworkRawFileInputPointer ($fileName) {
57 // Some pre-sanity checks...
58 if ((is_null($fileName)) || (empty($fileName))) {
60 throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
61 } elseif (!FrameworkBootstrap::isReachableFilePath($fileName)) {
62 // File cannot be accessed (due to open_basedir restriction)
63 throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
64 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (file_exists($fileName))) {
65 // File exists but cannot be read from
66 throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
67 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (!file_exists($fileName))) {
68 // File does not exist
69 throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
72 // Try to open a handler
73 $filePointer = fopen($fileName, 'rb');
74 if ((is_null($filePointer)) || ($filePointer === false)) {
75 // Something bad happend
76 throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
79 // Create new instance
80 $pointerInstance = new FrameworkRawFileInputPointer();
82 // Set file pointer and file name
83 $pointerInstance->setPointer($filePointer);
84 $pointerInstance->setFileName($fileName);
86 // Return the instance
87 return $pointerInstance;
91 * Read data a file pointer
93 * @return mixed The result of fread()
94 * @throws NullPointerException If the file pointer instance
95 * is not set by setPointer()
96 * @throws InvalidResourceException If there is being set
98 public function readFromFile () {
99 if (is_null($this->getPointer())) {
100 // Pointer not initialized
101 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
102 } elseif (!is_resource($this->getPointer())) {
103 // Pointer is not a valid resource!
104 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
107 // Read data from the file pointer and return it
108 return $this->read(1024);
112 * Reads a line, maximum 4096 Bytes from current file pointer
114 * @return $data Read data from file
115 * @throws UnsupportedOperationException If this method is called
117 public function readLine () {
118 // Not supported in binary files ...
119 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
123 * Reads given amount of bytes from file.
125 * @param $bytes Amount of bytes to read
126 * @return $data Data read from file
128 public function read ($bytes = NULL) {
129 // $bytes shall be integer
130 assert(is_int($bytes));
132 // Try to read given characters
133 $data = fread($this->getPointer(), $bytes);
140 * Analyzes entries in index file. This will count all found (and valid)
141 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
142 * only gaps are found, the file is considered as "virgin" (no entries).
145 * @throws UnsupportedOperationException If this method is called
147 public function analyzeFile () {
148 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
152 * Advances to next "block" of bytes
155 * @throws UnsupportedOperationException If this method is called
157 public function next () {
158 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
162 * Checks wether the current entry is valid (not at the end of the file).
163 * This method will return true if an emptied (nulled) entry has been found.
165 * @return $isValid Whether the next entry is valid
166 * @throws UnsupportedOperationException If this method is called
168 public function valid () {
169 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
173 * Gets current seek position ("key").
175 * @return $key Current key in iteration
176 * @throws UnsupportedOperationException If this method is called
178 public function key () {
179 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);