MemoryArchive.php
6.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Base class for all the archiveWriters that can only work on complete files
* (the write data function may be called with small chunks of data)
*
* PHP versions 4 and 5
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330,Boston,MA 02111-1307 USA
*
* @category File Formats
* @package File_Archive
* @author Vincent Lascaux <vincentlascaux@php.net>
* @copyright 1997-2005 The PHP Group
* @license http://www.gnu.org/copyleft/lesser.html LGPL
* @version CVS: $Id: MemoryArchive.php,v 1.16 2005/06/02 12:24:43 vincentlascaux Exp $
* @link http://pear.php.net/package/File_Archive
*/
require_once "File/Archive/Writer/Archive.php";
require_once "File/Archive/Writer/Memory.php";
/**
* Base class for all the archiveWriters that can only work on complete files
* (the write data function may be called with small chunks of data)
*/
class File_Archive_Writer_MemoryArchive extends File_Archive_Writer_Archive
{
/**
* @var File_Archive_Writer_Memory A buffer where the data will be put
* waiting for the file to be complete
* @access private
*/
var $buffer = '';
/**
* @var string Name of the file which data are coming
* @access private
*/
var $currentFilename = null;
/**
* @var array Stats of the file which data are coming
* @access private
*/
var $currentStat = null;
/**
* @var string URL of the file being treated if it is a physical file
* @access private
*/
var $currentDataFile = null;
/**
* @var int Number of times newFile function has been called
* @access protected
*/
var $nbFiles = 0;
/**
* @see File_Archive_Writer::File_Archive_Writer()
*/
function File_Archive_Writer_MemoryArchive
($filename, &$t, $stat = array(), $autoClose = true)
{
parent::File_Archive_Writer_Archive($filename, $t, $stat, $autoClose);
}
/**
* @see File_Archive_Writer::newFile()
*/
function newFile($filename, $stat = array(),
$mime = "application/octet-stream")
{
if ($this->nbFiles == 0) {
$error = $this->sendHeader();
if (PEAR::isError($error)) {
return $error;
}
} else {
$error = $this->flush();
if (PEAR::isError($error)) {
return $error;
}
}
$this->nbFiles++;
$this->currentFilename = $filename;
$this->currentStat = $stat;
return true;
}
/**
* @see File_Archive_Writer::close()
*/
function close()
{
$error = $this->flush();
if (PEAR::isError($error)) {
return $error;
}
$error = $this->sendFooter();
if (PEAR::isError($error)) {
return $error;
}
return parent::close();
}
/**
* Indicate that all the data have been read from the current file
* and send it to appendFileData
* Send the current data to the appendFileData function
*
* @access private
*/
function flush()
{
if ($this->currentFilename !== null) {
if ($this->currentDataFile !== null) {
$error = $this->appendFile($this->currentFilename,
$this->currentDataFile);
} else {
$error = $this->appendFileData($this->currentFilename,
$this->currentStat,
$this->buffer);
}
if (PEAR::isError($error)) {
return $error;
}
$this->currentFilename = null;
$this->currentDataFile = null;
$this->buffer = '';
}
}
/**
* @see File_Archive_Writer::writeData()
*/
function writeData($data)
{
if ($this->currentDataFile !== null) {
$this->buffer .= file_get_contents($this->currentDataFile);
$this->currentDataFile = null;
}
$this->buffer .= $data;
}
/**
* @see File_Archive_Writer::writeFile()
*/
function writeFile($filename)
{
if ($this->currentDataFile === null && empty($this->buffer)) {
$this->currentDataFile = $filename;
} else {
if ($this->currentDataFile !== null) {
$this->buffer .= file_get_contents($this->currentDataFile);
$this->currentDataFile = null;
}
$this->buffer .= file_get_contents($filename);
}
}
//MUST REWRITE FUNCTIONS
/**
* The subclass must treat the data $data
* $data is the entire data of the filename $filename
* $stat is the stat of the file
*
* @access protected
*/
function appendFileData($filename, $stat, &$data) { }
//SHOULD REWRITE FUNCTIONS
/**
* The subclass may rewrite the sendHeader function if it needs to execute
* code before the first file
*
* @access protected
*/
function sendHeader() { }
/**
* The subclass may rewrite the sendFooter function if it needs to execute
* code before closing the archive
*
* @access protected
*/
function sendFooter() { }
/**
* The subclass may rewrite this class if it knows an efficient way to treat
* a physical file.
*
* @access protected
*/
function appendFile($filename, $dataFilename)
{
return $this->appendFileData(
$filename,
stat($dataFilename),
file_get_contents($dataFilename));
}
}
?>