Rewritten:
[core.git] / framework / main / classes / file_directories / input / raw / class_FrameworkRawFileInputPointer.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Filesystem\Pointer\Input;
4
5 // Import framework stuff
6 use CoreFramework\Bootstrap\FrameworkBootstrap;
7 use CoreFramework\FileSystem\BaseFileIo;
8 use CoreFramework\Filesystem\FileNotFoundException;
9 use CoreFramework\FileSystem\FileReadProtectedException;
10 use CoreFramework\Filesystem\Pointer\InputPointer;
11 use CoreFramework\Generic\NullPointerException;
12 use CoreFramework\Generic\UnsupportedOperationException;
13 use CoreFramework\Object\BaseFrameworkSystem;
14
15 // Import SPL stuff
16 use \SplFileInfo;
17
18 /**
19  * A class for reading files
20  *
21  * @author              Roland Haeder <webmaster@shipsimu.org>
22  * @version             0.0.0
23  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
24  * @license             GNU GPL 3.0 or any newer version
25  * @link                http://www.shipsimu.org
26  *
27  * This program is free software: you can redistribute it and/or modify
28  * it under the terms of the GNU General Public License as published by
29  * the Free Software Foundation, either version 3 of the License, or
30  * (at your option) any later version.
31  *
32  * This program is distributed in the hope that it will be useful,
33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
35  * GNU General Public License for more details.
36  *
37  * You should have received a copy of the GNU General Public License
38  * along with this program. If not, see <http://www.gnu.org/licenses/>.
39  */
40 class FrameworkRawFileInputPointer extends BaseFileIo implements InputPointer {
41         /**
42          * Protected constructor
43          *
44          * @return      void
45          */
46         protected function __construct () {
47                 // Call parent constructor
48                 parent::__construct(__CLASS__);
49         }
50
51         /**
52          * Create a file pointer based on the given file. The file will also
53          * be verified here.
54          *
55          * @param       $infoInstance   An instance of a SplFileInfo class
56          * @throws      FileIoException                         If the file is not reachable
57          * @throws      FileReadProtectedException      If the file is not found or cannot be read
58          * @throws      FileNotFoundException           If the file does not exist
59          * @return      void
60          */
61         public static final function createFrameworkRawFileInputPointer (SplFileInfo $infoInstance) {
62                 // Some pre-sanity checks...
63                 if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {
64                         // File cannot be accessed (due to open_basedir restriction)
65                         throw new FileIoException($infoInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
66                 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && (!$infoInstance->isFile())) {
67                         // File does not exist
68                         throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_NOT_FOUND);
69                 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
70                         // File exists but cannot be read from
71                         throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
72                 }
73
74                 // Try to open a handler
75                 $fileObject = $infoInstance->openFile('rb');
76                 if ((is_null($fileObject)) || ($fileObject === false)) {
77                         // Something bad happend
78                         throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);
79                 } // END - if
80
81                 // Create new instance
82                 $pointerInstance = new FrameworkRawFileInputPointer();
83
84                 // Set file pointer and file name
85                 $pointerInstance->setFileObject($fileObject);
86
87                 // Return the instance
88                 return $pointerInstance;
89         }
90
91         /**
92          * Read data a file pointer
93          *
94          * @return      mixed   The result of fread()
95          * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
96          * @throws      LogicException  If there is no object being set
97          */
98         public function readFromFile () {
99                 if (is_null($this->getFileObject())) {
100                         // Pointer not initialized
101                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
102                 } elseif (!is_object($this->getFileObject())) {
103                         // Pointer is not a valid resource!
104                         throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
105                 }
106
107                 // Read data from the file pointer and return it
108                 return $this->read(1024);
109         }
110
111         /**
112          * Reads a line, maximum 4096 Bytes from current file pointer
113          *
114          * @return      $data   Read data from file
115          * @throws      UnsupportedOperationException   If this method is called
116          */
117         public function readLine () {
118                 // Not supported in binary files ...
119                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
120         }
121
122         /**
123          * Reads given amount of bytes from file.
124          *
125          * @param       $bytes  Amount of bytes to read
126          * @return      $data   Data read from file
127          */
128         public function read ($bytes = NULL) {
129                 // $bytes shall be integer
130                 assert(is_int($bytes));
131
132                 // Try to read given characters
133                 $data = $this->getFileObject()->fread($bytes);
134
135                 // Then return it
136                 return $data;
137         }
138
139         /**
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).
143          *
144          * @return      void
145          * @throws      UnsupportedOperationException   If this method is called
146          */
147         public function analyzeFile () {
148                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
149         }
150
151         /**
152          * Advances to next "block" of bytes
153          *
154          * @return      void
155          * @throws      UnsupportedOperationException   If this method is called
156          */
157         public function next () {
158                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
159         }
160
161         /**
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.
164          *
165          * @return      $isValid        Whether the next entry is valid
166          * @throws      UnsupportedOperationException   If this method is called
167          */
168         public function valid () {
169                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
170         }
171
172         /**
173          * Gets current seek position ("key").
174          *
175          * @return      $key    Current key in iteration
176          * @throws      UnsupportedOperationException   If this method is called
177          */
178         public function key () {
179                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
180         }
181
182 }