ZP-150 #comment added custom stream filter for padding and removed padding...

ZP-150 #comment added custom stream filter for padding and removed padding from mapistreamwrapper  #time 4h

git-svn-id: https://z-push.org/svn/z-push/trunk@1398 b7dd7b3b-3a3c-0410-9da9-bee62a6cc5b5

src/backend/zarafa/mapistreamwrapper.php

@@ -77,10 +77,6 @@ class MAPIStreamWrapper {
         $stat = mapi_stream_stat($this->mapistream);
         $this->streamlength = $stat["cb"];
 
-        // pad the stream to the multiple of 4
-        if ($this->streamlength % 4 != 0 )
-            $this->streampad = $this->streamlength + 4 - ($this->streamlength % 4);
-
         ZLog::Write(LOGLEVEL_DEBUG, sprintf("MAPIStreamWrapper::stream_open(): initialized mapistream: %s streamlength: %d", $this->mapistream, $this->streamlength));
 
         return true;
@@ -95,11 +91,9 @@ class MAPIStreamWrapper {
      * @return string
      */
     public function stream_read($len) {
+        $len = ($this->position + $len > $this->streamlength) ? ($this->streamlength - $this->position) : $len;
         $data = mapi_stream_read($this->mapistream, $len);
         $this->position += strlen($data);
-        if ($this->position == $this->streamlength && $this->streampad != 0 )
-            $data = str_pad($data, $this->streampad, 0x0);
-
         return $data;
     }
 

src/index.php

@@ -60,6 +60,7 @@ include_once('lib/core/statemanager.php');
 include_once('lib/core/devicemanager.php');
 include_once('lib/core/zpush.php');
 include_once('lib/core/zlog.php');
+include_once('lib/core/paddingfilter.php');
 include_once('lib/interface/ibackend.php');
 include_once('lib/interface/ichanges.php');
 include_once('lib/interface/iexportchanges.php');

src/lib/core/paddingfilter.php

+<?php
+/***********************************************
+* File      :   paddingfilter.php
+* Project   :   Z-Push
+* Descr     :   Our own filter for stream padding with zero strings.
+*
+* Created   :   18.07.2012
+*
+* Copyright 2007 - 2012 Zarafa Deutschland GmbH
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Affero General Public License, version 3,
+* as published by the Free Software Foundation with the following additional
+* term according to sec. 7:
+*
+* According to sec. 7 of the GNU Affero General Public License, version 3,
+* the terms of the AGPL are supplemented with the following terms:
+*
+* "Zarafa" is a registered trademark of Zarafa B.V.
+* "Z-Push" is a registered trademark of Zarafa Deutschland GmbH
+* The licensing of the Program under the AGPL does not imply a trademark license.
+* Therefore any rights, title and interest in our trademarks remain entirely with us.
+*
+* However, if you propagate an unmodified version of the Program you are
+* allowed to use the term "Z-Push" to indicate that you distribute the Program.
+* Furthermore you may use our trademarks where it is necessary to indicate
+* the intended purpose of a product or service provided you use it in accordance
+* with honest practices in industrial or commercial matters.
+* If you want to propagate modified versions of the Program under the name "Z-Push",
+* you may only do so if you have a written permission by Zarafa Deutschland GmbH
+* (to acquire a permission please contact Zarafa at trademark@zarafa.com).
+*
+* 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 Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+* Consult LICENSE file for details
+************************************************/
+
+/* Define our filter class
+ *
+ * Usage: stream_filter_append($stream, 'padding.X');
+ * where X is a number a stream will be padded to be
+ * multiple of (e.g. padding.3 will pad the stream
+ * to be multiple of 3 which is useful in base64
+ * encoding).
+ *
+ * */
+class padding_filter extends php_user_filter {
+    private $padding = 4; // default padding
+
+    /**
+     * This method is called whenever data is read from or written to the attached stream
+     *
+     * @see php_user_filter::filter()
+     *
+     * @param resource      $in
+     * @param resource      $out
+     * @param int           $consumed
+     * @param boolean       $closing
+     *
+     * @access public
+     * @return int
+     *
+     */
+    function filter($in, $out, &$consumed, $closing) {
+        while ($bucket = stream_bucket_make_writeable($in)) {
+            $padding = $this->padding - ($bucket->datalen % $this->padding);
+            if ($bucket->datalen < 8192 && $padding != $this->padding) {
+                $bucket->data .= str_pad($bucket->data, $padding, 0x0);
+            }
+
+            $consumed += ($padding != $this->padding) ? ($bucket->datalen + $padding) : $bucket->datalen;
+            stream_bucket_append($out, $bucket);
+        }
+        return PSFS_PASS_ON;
+    }
+
+    /**
+     * Called when creating the filter
+     *
+     * @see php_user_filter::onCreate()
+     *
+     * @access public
+     * @return boolean
+     */
+    function onCreate() {
+        $delim = strrpos($this->filtername, '.');
+        if ($delim !== false) {
+            $padding = substr($this->filtername, $delim + 1);
+            if (is_numeric($padding))
+                $this->padding = $padding;
+        }
+        return true;
+    }
+}
+
+stream_filter_register("padding.*", "padding_filter");
+?>
\ No newline at end of file

src/lib/core/streamer.php

@@ -309,8 +309,8 @@ class Streamer implements Serializable {
                     }
                     else if(isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM) {
                         //encode stream with base64
-                        //TODO stream chunked without loading the complete attachment into memory
                         $stream = $this->$map[self::STREAMER_VAR];
+                        $paddingfilter = stream_filter_append($stream, 'padding.3');
                         $base64filter = stream_filter_append($stream, 'convert.base64-encode');
                         $d = "";
                         while (!feof($stream)) {
@@ -318,6 +318,7 @@ class Streamer implements Serializable {
                         }
                         $encoder->content($d);
                         stream_filter_remove($base64filter);
+                        stream_filter_remove($paddingfilter);
                     }
                     // implode comma or semicolon arrays into a string
                     else if(isset($map[self::STREAMER_TYPE]) && is_array($this->$map[self::STREAMER_VAR]) &&