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