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