Introduced isReachableFilePath() and isReadableFile().

[core.git] / inc / classes / main / file_directories / io / class_FrameworkFileInputOutputPointer.php

diff --git a/inc/classes/main/file_directories/io/class_FrameworkFileInputOutputPointer.php b/inc/classes/main/file_directories/io/class_FrameworkFileInputOutputPointer.php
index b703f094e9962c27b81fcf951f1b9120fc29f96a..edf9f5728a4dae33058261bed2f3af15fbd3e56d 100644 (file)
--- a/inc/classes/main/file_directories/io/class_FrameworkFileInputOutputPointer.php
+++ b/inc/classes/main/file_directories/io/class_FrameworkFileInputOutputPointer.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -48,12 +48,15 @@ class FrameworkFileInputOutputPointer extends BaseFileIo implements InputOutputP
                if ((is_null($fileName)) || (empty($fileName))) {
                        // No filename given
                        throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-               } elseif ((file_exists($fileName)) && (!is_readable($fileName))) {
+               } elseif (!BaseFrameworkSystem::isReachableFilePath($fileName)) {
+                       // File exists but cannot be read
+                       throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
+               } elseif (!BaseFrameworkSystem::isReadableFile($fileName)) {
                        // File exists but cannot be read
                        throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
-               } elseif ((file_exists($fileName)) && (!is_writable($fileName))) {
+               } elseif (!is_writable($fileName)) {
                        // File exists but cannot be written
-                       throw new FileWriteProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
+                       throw new FileWriteProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_WRITTEN);
                }
 
                // Try to open a handler
@@ -124,6 +127,21 @@ class FrameworkFileInputOutputPointer extends BaseFileIo implements InputOutputP
                return fwrite($this->getPointer(), $dataStream, strlen($dataStream));
        }
 
+       /**
+        * Writes at given position by seeking to it.
+        *
+        * @param       $seekPosition   Seek position in file
+        * @param       $data                   Data to be written
+        * @return      mixed                   Number of writes bytes or FALSE on error
+        */
+       public function writeAtPosition ($seekPosition, $data) {
+               // First seek to it
+               $this->seek($seekPosition);
+
+               // Then write the data at that position
+               return $this->writeToFile($data);
+       }
+
        /**
         * Rewinds to the beginning of the file
         *
@@ -152,21 +170,34 @@ class FrameworkFileInputOutputPointer extends BaseFileIo implements InputOutputP
                return fseek($this->getPointer(), $seekPosition, $whence);
        }
 
+       /**
+        * Reads a line, maximum 4096 Bytes from current file pointer
+        *
+        * @return      $data   Read data from file
+        */
+       public function readLine () {
+               // Read whole line
+               return $this->read();
+       }
+
        /**
         * Reads given amount of bytes from file.
         *
         * @param       $bytes  Amount of bytes to read
         * @return      $data   Data read from file
         */
-       public function read ($bytes) {
+       public function read ($bytes = NULL) {
                // Validate the pointer
                $this->validateFilePointer();
 
-               // Try to read given characters
-               $data = fread($this->getPointer(), $bytes);
-
-               // Was this successfull?
-               assert(is_string($data));
+               // Is $bytes set?
+               if (is_int($bytes)) {
+                       // Try to read given characters
+                       $data = fread($this->getPointer(), $bytes);
+               } else {
+                       // Try to read whole line
+                       $data = fread($this->getPointer());
+               }
 
                // Then return it
                return $data;
@@ -214,6 +245,25 @@ class FrameworkFileInputOutputPointer extends BaseFileIo implements InputOutputP
        public function key () {
                throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
        }
+
+       /**
+        * "Getter" for file size
+        *
+        * @return      $fileSize       Size of currently loaded file
+        */
+       public function getFileSize () {
+               // Check if the pointer is still valid
+               $this->validateFilePointer();
+
+               // Get file's data
+               $fileData = fstat($this->getPointer());
+
+               // Make sure the required array key is there
+               assert(isset($fileData['size']));
+
+               // Return size
+               return $fileData['size'];
+       }
 }
 
 // [EOF]