[7589] | 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 - 2012 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 | * Returns the current position on stream |
---|
| 97 | * |
---|
| 98 | * @access public |
---|
| 99 | * @return int |
---|
| 100 | */ |
---|
| 101 | public function stream_tell() { |
---|
| 102 | return $this->position; |
---|
| 103 | } |
---|
| 104 | |
---|
| 105 | /** |
---|
| 106 | * Indicates if 'end of file' is reached |
---|
| 107 | * |
---|
| 108 | * @access public |
---|
| 109 | * @return boolean |
---|
| 110 | */ |
---|
| 111 | public function stream_eof() { |
---|
| 112 | return ($this->position >= $this->stringlength); |
---|
| 113 | } |
---|
| 114 | |
---|
| 115 | /** |
---|
| 116 | * Retrieves information about a stream |
---|
| 117 | * |
---|
| 118 | * @access public |
---|
| 119 | * @return array |
---|
| 120 | */ |
---|
| 121 | public function stream_stat() { |
---|
| 122 | return array( |
---|
| 123 | 7 => $this->stringlength, |
---|
| 124 | 'size' => $this->stringlength, |
---|
| 125 | ); |
---|
| 126 | } |
---|
| 127 | |
---|
| 128 | /** |
---|
| 129 | * Instantiates a StringStreamWrapper |
---|
| 130 | * |
---|
| 131 | * @param string $string The string to be wrapped |
---|
| 132 | * |
---|
| 133 | * @access public |
---|
| 134 | * @return StringStreamWrapper |
---|
| 135 | */ |
---|
| 136 | static public function Open($string) { |
---|
| 137 | $context = stream_context_create(array(self::PROTOCOL => array('string' => &$string))); |
---|
| 138 | return fopen(self::PROTOCOL . "://",'r', false, $context); |
---|
| 139 | } |
---|
| 140 | } |
---|
| 141 | |
---|
| 142 | stream_wrapper_register(StringStreamWrapper::PROTOCOL, "StringStreamWrapper") |
---|
| 143 | |
---|
| 144 | ?> |
---|