inc/main/classes/file_directories/input/raw/class_FrameworkRawFileInputPointer.php

   1 <?php
   2 /**
   3  * A class for reading 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 FrameworkRawFileInputPointer 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 is not found or cannot be read
  43          * @throws      FileNotFoundException           If the file does not exist
  44          * @return      void
  45          */
  46         public static final function createFrameworkRawFileInputPointer ($fileName) {
  47                 // Some pre-sanity checks...
  48                 if ((is_null($fileName)) || (empty($fileName))) {
  49                         // No filename given
  50                         throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  51                 } elseif (!BaseFrameworkSystem::isReachableFilePath($fileName)) {
  52                         // File cannot be accessed (due to open_basedir restriction)
  53                         throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
  54                 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (file_exists($fileName))) {
  55                         // File exists but cannot be read from
  56                         throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
  57                 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (!file_exists($fileName))) {
  58                         // File does not exist
  59                         throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
  60                 }
  61
  62                 // Try to open a handler
  63                 $filePointer = fopen($fileName, 'rb');
  64                 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
  65                         // Something bad happend
  66                         throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
  67                 } // END - if
  68
  69                 // Create new instance
  70                 $pointerInstance = new FrameworkRawFileInputPointer();
  71
  72                 // Set file pointer and file name
  73                 $pointerInstance->setPointer($filePointer);
  74                 $pointerInstance->setFileName($fileName);
  75
  76                 // Return the instance
  77                 return $pointerInstance;
  78         }
  79
  80         /**
  81          * Read data a file pointer
  82          *
  83          * @return      mixed   The result of fread()
  84          * @throws      NullPointerException    If the file pointer instance
  85          *                                                                      is not set by setPointer()
  86          * @throws      InvalidResourceException        If there is being set
  87          */
  88         public function readFromFile () {
  89                 if (is_null($this->getPointer())) {
  90                         // Pointer not initialized
  91                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
  92                 } elseif (!is_resource($this->getPointer())) {
  93                         // Pointer is not a valid resource!
  94                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
  95                 }
  96
  97                 // Read data from the file pointer and return it
  98                 return $this->read(1024);
  99         }
 100
 101         /**
 102          * Reads a line, maximum 4096 Bytes from current file pointer
 103          *
 104          * @return      $data   Read data from file
 105          * @throws      UnsupportedOperationException   If this method is called
 106          */
 107         public function readLine () {
 108                 // Not supported in binary files ...
 109                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 110         }
 111
 112         /**
 113          * Reads given amount of bytes from file.
 114          *
 115          * @param       $bytes  Amount of bytes to read
 116          * @return      $data   Data read from file
 117          */
 118         public function read ($bytes = NULL) {
 119                 // $bytes shall be integer
 120                 assert(is_int($bytes));
 121
 122                 // Try to read given characters
 123                 $data = fread($this->getPointer(), $bytes);
 124
 125                 // Then return it
 126                 return $data;
 127         }
 128
 129         /**
 130          * Analyzes entries in index file. This will count all found (and valid)
 131          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
 132          * only gaps are found, the file is considered as "virgin" (no entries).
 133          *
 134          * @return      void
 135          * @throws      UnsupportedOperationException   If this method is called
 136          */
 137         public function analyzeFile () {
 138                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 139         }
 140
 141         /**
 142          * Advances to next "block" of bytes
 143          *
 144          * @return      void
 145          * @throws      UnsupportedOperationException   If this method is called
 146          */
 147         public function next () {
 148                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 149         }
 150
 151         /**
 152          * Checks wether the current entry is valid (not at the end of the file).
 153          * This method will return TRUE if an emptied (nulled) entry has been found.
 154          *
 155          * @return      $isValid        Whether the next entry is valid
 156          * @throws      UnsupportedOperationException   If this method is called
 157          */
 158         public function valid () {
 159                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 160         }
 161
 162         /**
 163          * Gets current seek position ("key").
 164          *
 165          * @return      $key    Current key in iteration
 166          * @throws      UnsupportedOperationException   If this method is called
 167          */
 168         public function key () {
 169                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 170         }
 171 }
 172
 173 // [EOF]
 174 ?>