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