Revert "Use realpath() to secure file and path names."
[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 - 2013 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 {
25         /**
26          * The current path we are working in
27          */
28         private $pathName = '';
29
30         /**
31          * The directory iterator instance
32          */
33         private $directoryInstance = 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->getDirectoryInstance() 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                 // Get an iterator for the directory
103                 $directoryInstance = new DirectoryIterator($pathName);
104
105                 // Create new instance
106                 $pointerInstance = new FrameworkDirectoryPointer();
107
108                 // Set directory pointer and path name
109                 $pointerInstance->setDirectoryInstance($directoryInstance);
110                 $pointerInstance->setPathName($pathName);
111
112                 // Return the instance
113                 return $pointerInstance;
114         }
115
116         /**
117          * Read raw lines of data from a directory pointer and return the data
118          *
119          * @return      $current        Current entry from encapsulated iterator
120          */
121         public function readRawDirectory () {
122                 // Can the next entry be read?
123                 assert($this->getDirectoryInstance()->valid());
124
125                 // Default is FALSE
126                 $current = FALSE;
127
128                 // Is it a dot directory?
129                 if (!$this->getDirectoryInstance()->isDot()) {
130                         // Read data from the directory pointer and return it
131                         $current = $this->getDirectoryInstance()->current();
132                 } // END - if
133
134                 // Advance to next entry
135                 $this->getDirectoryInstance()->next();
136
137                 // Return found entry
138                 return $current;
139         }
140
141         /**
142          * Read lines from the current directory pointer except some parts
143          *
144          * @param       $except         Some parts of a directory we want to ignore. Valid: directory and file names, other values will be silently ignored
145          * @return      string          Directory and/or file names read from the current directory pointer
146          */
147         public function readDirectoryExcept (array $except = array()) {
148                 // No exceptions given?
149                 if (count($except) == 0) {
150                         // No exception given, so read all files and directories, but not recursive
151                         self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: No exceptions given, please use readRawDirectory() instead!');
152                         return $this->readRawDirectory();
153                 } // END - if
154
155                 // Read a raw line...
156                 $rawLine = $this->readRawDirectory();
157                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
158
159                 // Shall we exclude directories?
160                 if ((!is_null($rawLine)) && ($rawLine !== FALSE) && (!in_array($rawLine, $except))) {
161                         // Return read data
162                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
163                         return $rawLine;
164                 } elseif ((!is_null($rawLine)) && ($rawLine !== FALSE)) {
165                         // Exclude this part
166                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawline[' . gettype($rawLine) . ']=' . $rawLine . ' - Recursive call!');
167                         return $this->readDirectoryExcept($except);
168                 }
169
170                 // End pointer reached
171                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: Returning NULL!');
172                 return NULL;
173         }
174
175         /**
176          * Close a directory source and set it's instance to null and the path name
177          * to empty
178          *
179          * @return      void
180          */
181         public function closeDirectory () {
182                 // Close the directory by unsetting it
183                 $this->setDirectoryInstance(NULL);
184                 $this->setPathName('');
185         }
186
187         /**
188          * Setter for the directory pointer
189          *
190          * @param       $directoryInstance      An instanceof a DirectoryIterator class or NULL to unset ("close") it.
191          * @return      void
192          */
193         protected final function setDirectoryInstance (DirectoryIterator $directoryInstance = NULL) {
194                 // Set instance (or NULL)
195                 $this->directoryInstance = $directoryInstance;
196         }
197
198         /**
199          * Getter for the directory pointer
200          *
201          * @return      $directoryInstance      The directory pointer which shall be a valid directory resource
202          */
203         public final function getDirectoryInstance () {
204                 return $this->directoryInstance;
205         }
206
207         /**
208          * Setter for path name
209          *
210          * @param       $pathName       The new path name
211          * @return      void
212          */
213         public final function setPathName ($pathName) {
214                 $pathName = (string) $pathName;
215                 $this->pathName = $pathName;
216         }
217
218         /**
219          * Getter for path name
220          *
221          * @return      $pathName       The current path name
222          */
223         public final function getPathName () {
224                 return $this->pathName;
225         }
226 }
227
228 // [EOF]
229 ?>