42380fd142469c9834e39a3abf9878f167383e90
[core.git] / inc / classes / main / file_directories / directory / class_FrameworkDirectoryPointer.php
1 <?php
2 /**
3  * A class for directory reading and getting its contents, no recursion!
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 FrameworkDirectoryPointer extends BaseFrameworkSystem implements FrameworkDirectory {
25         /**
26          * The current path we are working in
27          */
28         private $pathName = '';
29
30         /**
31          * The directory iterator instance
32          */
33         private $iteratorInstance = NULL;
34
35         /**
36          * Protected constructor
37          */
38         protected function __construct () {
39                 // Call parent constructor
40                 parent::__construct(__CLASS__);
41         }
42
43         /**
44          * Destructor for cleaning purposes, etc
45          */
46         public function __destruct() {
47                 // Is there a resource pointer? Then we have to close the directory here!
48                 if ($this->getDirectoryIteratorInstance() instanceof DirectoryIterator) {
49                         // Try to close a directory
50                         $this->closeDirectory();
51                 } // END - if
52
53                 // Call the parent destructor
54                 parent::__destruct();
55         }
56
57         /**
58          * Create a directory pointer based on the given path. The path will also
59          * be verified here.
60          *
61          * @param       $pathName               The path name we shall pass to opendir()
62          * @param       $inConstructor  If we are in de/con-structor or from somewhere else
63          * @return      $pointerInstance        A prepared instance of FrameworkDirectoryPointer
64          * @throws      PathIsEmptyException    If the provided path name is empty
65          * @throws      InvalidPathStringException      If the provided path name is not a string
66          * @throws      PathIsNoDirectoryException      If the provided path name is not valid
67          * @throws      PathReadProtectedException      If the provided path name is read-protected
68          * @todo        Get rid of inConstructor, could be old-lost code.
69          */
70         public static final function createFrameworkDirectoryPointer ($pathName, $inConstructor = FALSE) {
71                 // Some pre-sanity checks...
72                 if (is_null($pathName)) {
73                         // No pathname given
74                         if ($inConstructor) {
75                                 return NULL;
76                         } else {
77                                 throw new PathIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
78                         }
79                 } elseif (!is_string($pathName)) {
80                         // Is not a string
81                         if ($inConstructor) {
82                                 return NULL;
83                         } else {
84                                 throw new InvalidPathStringException(NULL, self::EXCEPTION_INVALID_STRING);
85                         }
86                 } elseif (!is_dir($pathName)) {
87                         // Not a directory
88                         if ($inConstructor) {
89                                 return NULL;
90                         } else {
91                                 throw new PathIsNoDirectoryException($pathName, self::EXCEPTION_INVALID_PATH_NAME);
92                         }
93                 } elseif (!is_readable($pathName)) {
94                         // Not readable
95                         if ($inConstructor) {
96                                 return NULL;
97                         } else {
98                                 throw new PathReadProtectedException($pathName, self::EXCEPTION_READ_PROTECED_PATH);
99                         }
100                 }
101
102                 // Create new instance
103                 $pointerInstance = new FrameworkDirectoryPointer();
104
105                 // Get an iterator for the directory
106                 $iteratorInstance = new DirectoryIterator($pathName);
107
108                 // ... and rewind back
109                 $iteratorInstance->rewind();
110
111                 // Set directory pointer and path name
112                 $pointerInstance->setDirectoryIteratorInstance($iteratorInstance);
113                 $pointerInstance->setPathName($pathName);
114
115                 // Return the instance
116                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: Opened pathName=' . $pathName . ' - EXIT!');
117                 return $pointerInstance;
118         }
119
120         /**
121          * Read raw lines of data from a directory pointer and return the data
122          *
123          * @return      $currentEntry   Current entry from encapsulated iterator
124          */
125         public function readRawDirectory () {
126                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . '] - CALLED!');
127
128                 // Can the next entry be read?
129                 assert($this->getDirectoryIteratorInstance()->valid());
130
131                 // Default is FALSE
132                 $currentEntry = FALSE;
133
134                 // Read data from the directory pointer and return it
135                 $currentEntry = $this->getDirectoryIteratorInstance()->current();
136
137                 // Return found entry
138                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: currentEntry[]=' . gettype($currentEntry) . ' - EXIT!');
139                 return $currentEntry;
140         }
141
142         /**
143          * Read lines from the current directory pointer except some parts
144          *
145          * @param       $except         Some parts of a directory we want to ignore. Valid: directory and file names, other values will be silently ignored
146          * @return      string          Directory and/or file names read from the current directory pointer
147          */
148         public function readDirectoryExcept (array $except = array()) {
149                 // No exceptions given?
150                 if (count($except) == 0) {
151                         // No exception given, so read all files and directories, but not recursive
152                         self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: No exceptions given, please use readRawDirectory() instead!');
153                         return $this->readRawDirectory();
154                 } elseif (!$this->getDirectoryIteratorInstance()->valid()) {
155                         // No more left to read
156                         return NULL;
157                 }
158
159                 // Init raw line
160                 $rawLine = NULL;
161
162                 // Read a raw line...
163                 $currentEntry = $this->readRawDirectory();
164                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: currentEntry[]=' . gettype($currentEntry));
165
166                 // Shall we exclude directories?
167                 if (is_object($currentEntry)) {
168                         // Get file name
169                         $rawLine = $currentEntry->getFilename();
170                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
171
172                         // Is it not excluded?
173                         if (in_array($rawLine, $except)) {
174                                 // To next entry
175                                 $this->getDirectoryIteratorInstance()->next();
176
177                                 // Exclude this part
178                                 $rawLine = $this->readDirectoryExcept($except);
179                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawline[' . gettype($rawLine) . ']=' . $rawLine . ' - Recursive call!');
180                         } // END - if
181                 } // END - if
182
183                 // To next entry
184                 $this->getDirectoryIteratorInstance()->next();
185
186                 // Return read line
187                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
188                 return $rawLine;
189         }
190
191         /**
192          * Close a directory source and set it's instance to null and the path name
193          * to empty
194          *
195          * @return      void
196          */
197         public function closeDirectory () {
198                 // Close the directory by unsetting it
199                 $this->unsetDirectoryIteratorInstance();
200                 $this->setPathName('');
201         }
202
203         /**
204          * Setter for the directory pointer
205          *
206          * @param       $iteratorInstance       An instanceof a DirectoryIterator class
207          * @return      void
208          */
209         protected final function setDirectoryIteratorInstance (DirectoryIterator $iteratorInstance) {
210                 // Set instance
211                 $this->iteratorInstance = $iteratorInstance;
212         }
213
214         /**
215          * Getter for the directory pointer
216          *
217          * @return      $iteratorInstance       The directory pointer which shall be a valid directory resource
218          */
219         public final function getDirectoryIteratorInstance () {
220                 return $this->iteratorInstance;
221         }
222
223         /**
224          * Remove directory iterator instance (effectively closing it) by setting
225          * it to NULL. This will trigger a call on the destructor which will then
226          * "close" the iterator.
227          *
228          * @param       $iteratorInstance       An instanceof a DirectoryIterator class
229          * @return      void
230          */
231         protected final function unsetDirectoryIteratorInstance (e) {
232                 // "Unset" the instance
233                 $this->iteratorInstance = NULL;
234         }
235
236         /**
237          * Setter for path name
238          *
239          * @param       $pathName       The new path name
240          * @return      void
241          */
242         protected final function setPathName ($pathName) {
243                 $pathName = (string) $pathName;
244                 $this->pathName = $pathName;
245         }
246
247         /**
248          * Getter for path name
249          *
250          * @return      $pathName       The current path name
251          */
252         public final function getPathName () {
253                 return $this->pathName;
254         }
255 }
256
257 // [EOF]
258 ?>