← Back to branch summary

~olivier-chatelain/php-addressbook/trunk

« back to all changes in this revision

Viewing changes to z-push/lib/utils/stringstreamwrapper.php

  • Committer: chatelao
  • Date: 2016-09-11 07:59:37 UTC
  • Revision ID: git-v1:03926e44d99a04a3b05d4761e322a1f5e8a405d7
Chg: Upgrade z-push from 2.0.3 to 2.2.12 (stable)

Show diffs side-by-side

added added

removed removed

Lines of Context:
z-push/lib/utils/stringstreamwrapper.php
 
1
<?php
 
2
/***********************************************
 
3
* File      :   stringstreamwrapper.php
 
4
* Project   :   Z-Push
 
5
* Descr     :   Wraps a string as a standard php stream
 
6
*               The used method names are predefined and can not be altered.
 
7
*
 
8
* Created   :   24.11.2011
 
9
*
 
10
* Copyright 2007 - 2013, 2015 Zarafa Deutschland GmbH
 
11
*
 
12
* This program is free software: you can redistribute it and/or modify
 
13
* it under the terms of the GNU Affero General Public License, version 3,
 
14
* as published by the Free Software Foundation with the following additional
 
15
* term according to sec. 7:
 
16
*
 
17
* According to sec. 7 of the GNU Affero General Public License, version 3,
 
18
* the terms of the AGPL are supplemented with the following terms:
 
19
*
 
20
* "Zarafa" is a registered trademark of Zarafa B.V.
 
21
* "Z-Push" is a registered trademark of Zarafa Deutschland GmbH
 
22
* The licensing of the Program under the AGPL does not imply a trademark license.
 
23
* Therefore any rights, title and interest in our trademarks remain entirely with us.
 
24
*
 
25
* However, if you propagate an unmodified version of the Program you are
 
26
* allowed to use the term "Z-Push" to indicate that you distribute the Program.
 
27
* Furthermore you may use our trademarks where it is necessary to indicate
 
28
* the intended purpose of a product or service provided you use it in accordance
 
29
* with honest practices in industrial or commercial matters.
 
30
* If you want to propagate modified versions of the Program under the name "Z-Push",
 
31
* you may only do so if you have a written permission by Zarafa Deutschland GmbH
 
32
* (to acquire a permission please contact Zarafa at trademark@zarafa.com).
 
33
*
 
34
* This program is distributed in the hope that it will be useful,
 
35
* but WITHOUT ANY WARRANTY; without even the implied warranty of
 
36
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
37
* GNU Affero General Public License for more details.
 
38
*
 
39
* You should have received a copy of the GNU Affero General Public License
 
40
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
41
*
 
42
* Consult LICENSE file for details
 
43
************************************************/
 
44
 
 
45
class StringStreamWrapper {
 
46
    const PROTOCOL = "stringstream";
 
47
 
 
48
    private $stringstream;
 
49
    private $position;
 
50
    private $stringlength;
 
51
 
 
52
    /**
 
53
     * Opens the stream
 
54
     * The string to be streamed is passed over the context
 
55
     *
 
56
     * @param string    $path           Specifies the URL that was passed to the original function
 
57
     * @param string    $mode           The mode used to open the file, as detailed for fopen()
 
58
     * @param int       $options        Holds additional flags set by the streams API
 
59
     * @param string    $opened_path    If the path is opened successfully, and STREAM_USE_PATH is set in options,
 
60
     *                                  opened_path should be set to the full path of the file/resource that was actually opened.
 
61
     *
 
62
     * @access public
 
63
     * @return boolean
 
64
     */
 
65
    public function stream_open($path, $mode, $options, &$opened_path) {
 
66
        $contextOptions = stream_context_get_options($this->context);
 
67
        if (!isset($contextOptions[self::PROTOCOL]['string']))
 
68
            return false;
 
69
 
 
70
        $this->position = 0;
 
71
 
 
72
        // this is our stream!
 
73
        $this->stringstream = $contextOptions[self::PROTOCOL]['string'];
 
74
 
 
75
        $this->stringlength = strlen($this->stringstream);
 
76
        ZLog::Write(LOGLEVEL_DEBUG, sprintf("StringStreamWrapper::stream_open(): initialized stream length: %d", $this->stringlength));
 
77
 
 
78
        return true;
 
79
    }
 
80
 
 
81
    /**
 
82
     * Reads from stream
 
83
     *
 
84
     * @param int $len      amount of bytes to be read
 
85
     *
 
86
     * @access public
 
87
     * @return string
 
88
     */
 
89
    public function stream_read($len) {
 
90
        $data = substr($this->stringstream, $this->position, $len);
 
91
        $this->position += strlen($data);
 
92
        return $data;
 
93
    }
 
94
 
 
95
    /**
 
96
     * Writes data to the stream.
 
97
     *
 
98
     * @param string $data
 
99
     * @return int
 
100
     */
 
101
    public function stream_write($data){
 
102
        $l = strlen($data);
 
103
        $this->stringstream = substr($this->stringstream, 0, $this->position) . $data . substr($this->stringstream, $this->position += $l);
 
104
        $this->stringlength = strlen($this->stringstream);
 
105
        return $l;
 
106
    }
 
107
 
 
108
    /**
 
109
     * Stream "seek" functionality.
 
110
     *
 
111
     * @param int $offset
 
112
     * @param int $whence
 
113
     * @return boolean
 
114
     */
 
115
    public function stream_seek($offset, $whence = SEEK_SET) {
 
116
        if ($whence == SEEK_CUR) {
 
117
            $this->position += $offset;
 
118
        }
 
119
        else if ($whence == SEEK_END) {
 
120
            $this->position = $this->stringlength + $offset;
 
121
        }
 
122
        else {
 
123
            $this->position = $offset;
 
124
        }
 
125
        return true;
 
126
    }
 
127
 
 
128
    /**
 
129
     * Returns the current position on stream
 
130
     *
 
131
     * @access public
 
132
     * @return int
 
133
     */
 
134
    public function stream_tell() {
 
135
        return $this->position;
 
136
    }
 
137
 
 
138
   /**
 
139
     * Indicates if 'end of file' is reached
 
140
     *
 
141
     * @access public
 
142
     * @return boolean
 
143
     */
 
144
    public function stream_eof() {
 
145
        return ($this->position >= $this->stringlength);
 
146
    }
 
147
 
 
148
    /**
 
149
    * Retrieves information about a stream
 
150
    *
 
151
    * @access public
 
152
    * @return array
 
153
    */
 
154
    public function stream_stat() {
 
155
        return array(
 
156
            7               => $this->stringlength,
 
157
            'size'          => $this->stringlength,
 
158
        );
 
159
    }
 
160
 
 
161
   /**
 
162
     * Instantiates a StringStreamWrapper
 
163
     *
 
164
     * @param string    $string     The string to be wrapped
 
165
     *
 
166
     * @access public
 
167
     * @return StringStreamWrapper
 
168
     */
 
169
     static public function Open($string) {
 
170
        $context = stream_context_create(array(self::PROTOCOL => array('string' => &$string)));
 
171
        return fopen(self::PROTOCOL . "://",'r', false, $context);
 
172
    }
 
173
}
 
174
 
 
175
stream_wrapper_register(StringStreamWrapper::PROTOCOL, "StringStreamWrapper")
 
176
 
 
177
?>
 
 
b'\\ No newline at end of file'