Introduced isReachableFilePath() and isReadableFile().
[core.git] / inc / classes / main / file_directories / input / text / class_FrameworkTextFileInputPointer.php
1 <?php
2 /**
3  * A class for reading text files
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Create a file pointer based on the given file. The file will also
37          * be verified here.
38          *
39          * @param       $fileName       The file name we shall pass to fopen()
40          * @throws      FileIsEmptyException            If the provided file name is empty.
41          * @throws      FileIoException                         If the file is not reachable
42          * @throws      FileReadProtectedException      If the file cannot be read from
43          * @return      void
44          */
45         public static final function createFrameworkTextFileInputPointer ($fileName) {
46                 // Some pre-sanity checks...
47                 if ((is_null($fileName)) || (empty($fileName))) {
48                         // No filename given
49                         throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
50                 } elseif (!BaseFrameworkSystem::isReachableFilePath($fileName)) {
51                         // File does not exist!
52                         throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
53                 } elseif (!BaseFrameworkSystem::isReadableFile($fileName)) {
54                         // File does not exist!
55                         throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
56                 }
57
58                 // Try to open a handler
59                 $filePointer = fopen($fileName, 'r');
60                 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
61                         // Something bad happend
62                         throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
63                 } // END - if
64
65                 // Create new instance
66                 $pointerInstance = new FrameworkTextFileInputPointer();
67
68                 // Set file pointer and file name
69                 $pointerInstance->setPointer($filePointer);
70                 $pointerInstance->setFileName($fileName);
71
72                 // Return the instance
73                 return $pointerInstance;
74         }
75
76         /**
77          * Read data a file pointer
78          *
79          * @return      $data   Read data from file
80          */
81         public function readFromFile () {
82                 // Read 1024 Byte data from the file pointer and return it
83                 return $this->read(1024);
84         }
85
86         /**
87          * Reads a line, maximum 4096 Bytes from current file pointer
88          *
89          * @return      $data   Read data from file
90          */
91         public function readLine () {
92                 // Read whole line from the file pointer and return it
93                 return $this->read();
94         }
95
96         /**
97          * Reads given amount of bytes from file.
98          *
99          * @param       $bytes  Amount of bytes to read or whole line (only text files)
100          * @return      $data   Data read from file
101          * @throws      NullPointerException    If the file pointer instance
102          *                                                                      is not set by setPointer()
103          * @throws      InvalidResourceException        If there is being set
104          */
105         public function read ($bytes = NULL) {
106                 // Some sanity checks
107                 if (is_null($this->getPointer())) {
108                         // Pointer not initialized
109                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
110                 } elseif (!is_resource($this->getPointer())) {
111                         // Pointer is not a valid resource!
112                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
113                 }
114
115                 // Is $bytes set?
116                 if (is_int($bytes)) {
117                         // Try to read given characters
118                         $data = fgets($this->getPointer(), $bytes);
119                 } else {
120                         // Try to read whole line
121                         $data = fgets($this->getPointer());
122                 }
123
124                 // Then return it
125                 return $data;
126         }
127
128         /**
129          * Analyzes entries in index file. This will count all found (and valid)
130          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
131          * only gaps are found, the file is considered as "virgin" (no entries).
132          *
133          * @return      void
134          * @throws      UnsupportedOperationException   If this method is called
135          */
136         public function analyzeFile () {
137                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
138         }
139
140         /**
141          * Advances to next "block" of bytes
142          *
143          * @return      void
144          * @throws      UnsupportedOperationException   If this method is called
145          */
146         public function next () {
147                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
148         }
149
150         /**
151          * Checks wether the current entry is valid (not at the end of the file).
152          * This method will return TRUE if an emptied (nulled) entry has been found.
153          *
154          * @return      $isValid        Whether the next entry is valid
155          * @throws      UnsupportedOperationException   If this method is called
156          */
157         public function valid () {
158                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
159         }
160
161         /**
162          * Gets current seek position ("key").
163          *
164          * @return      $key    Current key in iteration
165          * @throws      UnsupportedOperationException   If this method is called
166          */
167         public function key () {
168                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
169         }
170 }
171
172 // [EOF]
173 ?>