(no commit message)

[shipsimu.git] / inc / classes / main / compressor / class_GzipCompressor.php

diff --git a/inc/classes/main/compressor/class_GzipCompressor.php b/inc/classes/main/compressor/class_GzipCompressor.php
new file mode 100644 (file)
index 0000000..f00b2d0
--- /dev/null
+++ b/inc/classes/main/compressor/class_GzipCompressor.php
@@ -0,0 +1,122 @@
+<?php
+/**
+ * GZIP compression and decompression class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+class GzipCompressor extends BaseFrameworkSystem implements Compressor {
+       /**
+        * Private constructor
+        *
+        * @return      void
+        */
+       private function __construct () {
+               // Call parent constructor!
+               parent::constructor(__CLASS__);
+
+               // Debug message
+               if (((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
+                       $this->__toString()
+               ));
+
+               // Set description
+               $this->setPartDescr("GZIP-Kompressor");
+
+               // Create an unique ID
+               $this->createUniqueID();
+       }
+
+       /**
+        * Create a new compressor channel based a given compression handler
+        *
+        * @return      $cInstance      An instance of this class
+        */
+       public final static function createGzipCompressor () {
+               // Get new instance
+               if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
+                       // Compressor can maybe be used
+                       $cInstance = new GzipCompressor();
+
+                       // Debug message
+                       if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] GZIP-Kompression wird verwendet.<br />\n",
+                               $cInstance->__toString()
+                       ));
+               } else {
+                       // Routines not found!
+                       $cInstance = null;
+
+                       // Debug message
+                       if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] GZIP-Kompressionsroutinen <strong>nicht</strong> gefunden.<br />\n",
+                               $cInstance->__toString()
+                       ));
+               }
+
+               // Return the compressor instance
+               return $cInstance;
+       }
+
+       /**
+        * GZIP compression stream
+        *
+        * @param               $streamData                     Mixed non-object stream data
+        * @return      $streamData                     The compressed stream data      
+        * @throws      InvalidObjectException  If the stream is an object
+        */
+       public function compressStream ($streamData) {
+               if (is_object($streamData)) {
+                       // Throw an exception
+                       throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
+               }
+
+               // Return the compressed stream
+               return gzcompress($streamData, 1);
+       }
+
+       /**
+        * GZIP decompression stream
+        *
+        * @param               $streamData                     Mixed non-object stream data
+        * @return      $streamData                     The decompressed stream data    
+        * @throws      InvalidObjectException  If the stream is an object
+        */
+       public function decompressStream ($streamData) {
+               if (is_object($streamData)) {
+                       // Throw an exception
+                       throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
+               }
+
+               // Return the decompressed stream
+               return gzuncompress($streamData);
+       }
+
+       /**
+        * Getter for the file extension of this compressor
+        *
+        * @return      $string Returns always "gz"
+        */
+       public final function getCompressorExtension () {
+               if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",
+                       $this->__toString()
+               ));
+               return "gz";
+       }
+}
+
+// [EOF]
+?>