-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Expand file tree
/
Copy pathOutputHandler.php
More file actions
304 lines (259 loc) · 9.51 KB
/
OutputHandler.php
File metadata and controls
304 lines (259 loc) · 9.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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<?php
declare(strict_types=1);
namespace PhpMyAdmin\Export;
use PhpMyAdmin\Core;
use PhpMyAdmin\Current;
use PhpMyAdmin\Encoding;
use PhpMyAdmin\Exceptions\InsufficientSpaceExportException;
use PhpMyAdmin\Message;
use PhpMyAdmin\MessageType;
use PhpMyAdmin\Util;
use PhpMyAdmin\Utils\UserAgentParser;
use PhpMyAdmin\ZipExtension;
use function __;
use function fclose;
use function file_exists;
use function fopen;
use function function_exists;
use function fwrite;
use function gzencode;
use function htmlspecialchars;
use function in_array;
use function ini_get;
use function is_file;
use function is_string;
use function is_writable;
use function ob_list_handlers;
use function preg_replace;
use function strlen;
use function substr;
use const ENT_COMPAT;
class OutputHandler
{
private string $dumpBuffer = '';
private int $dumpBufferLength = 0;
/** @var string[] */
private array $dumpBufferObjects = [];
public bool $outputCharsetConversion = false;
public bool $outputKanjiConversion = false;
public static bool $asFile = false;
private string $saveFilename = '';
/** @var resource|null */
private mixed $fileHandle = null;
/** @var ''|'zip'|'gzip' */
public string $compression = '';
public string $kanjiEncoding = '';
public string $xkana = '';
public int $memoryLimit = 0;
public bool $onFlyCompression = false;
/** @throws InsufficientSpaceExportException */
public function addLine(string $line): void
{
// Kanji encoding convert feature
if ($this->outputKanjiConversion) {
$line = Encoding::kanjiStrConv($line, $this->kanjiEncoding, $this->xkana);
}
// If we have to buffer data, we will perform everything at once at the end
if ($this->compression !== '') {
$this->dumpBuffer .= $line;
if ($this->onFlyCompression) {
$this->dumpBufferLength += strlen($line);
if ($this->dumpBufferLength > $this->memoryLimit) {
$this->convertBufferCharset();
if ($this->compression === 'gzip' && $this->gzencodeNeeded()) {
// as a gzipped file
// without the optional parameter level because it bugs
$this->dumpBuffer = (string) gzencode($this->dumpBuffer);
}
if ($this->fileHandle !== null) {
$writeResult = @fwrite($this->fileHandle, $this->dumpBuffer);
if ($writeResult !== strlen($this->dumpBuffer)) {
Current::$message = Message::error(__('Insufficient space to save the file %s.'));
Current::$message->addParam($this->saveFilename);
throw new InsufficientSpaceExportException();
}
} else {
echo $this->dumpBuffer;
}
$this->dumpBuffer = '';
$this->dumpBufferLength = 0;
}
}
return;
}
if (! self::$asFile) {
// We export as html - replace special chars
echo htmlspecialchars($line, ENT_COMPAT);
return;
}
if ($this->outputCharsetConversion) {
$line = Encoding::convertString('utf-8', Current::$charset ?? 'utf-8', $line);
}
if ($this->fileHandle !== null && $line !== '') {
$writeResult = @fwrite($this->fileHandle, $line);
if ($writeResult !== strlen($line)) {
Current::$message = Message::error(__('Insufficient space to save the file %s.'));
Current::$message->addParam($this->saveFilename);
throw new InsufficientSpaceExportException();
}
} else {
// We export as file - output normally
echo $line;
}
}
/**
* Saves the dump buffer for a particular table in an array
* Used in separate files export
*
* @param string $objectName the name of current object to be stored
* @param bool $append optional boolean to append to an existing index or not
*/
public function saveObjectInBuffer(string $objectName, bool $append = false): void
{
if ($this->dumpBuffer !== '') {
if ($append && isset($this->dumpBufferObjects[$objectName])) {
$this->dumpBufferObjects[$objectName] .= $this->dumpBuffer;
} else {
$this->dumpBufferObjects[$objectName] = $this->dumpBuffer;
}
}
// Re - initialize
$this->dumpBuffer = '';
$this->dumpBufferLength = 0;
}
/**
* Sets the compression method
*
* @param 'zip'|'gzip' $compression
*/
public function setCompression(string $compression, bool $compressOnFly = false): void
{
$this->compression = $compression;
if ($compression !== 'gzip' || ! $compressOnFly) {
return;
}
$this->onFlyCompression = true;
}
public function compress(bool $separateFiles, string $filename): void
{
$dumpBuffer = $separateFiles
? $this->dumpBufferObjects
: $this->dumpBuffer;
if ($this->compression === 'zip' && function_exists('gzcompress')) {
$zipExtension = new ZipExtension();
$filename = substr($filename, 0, -4); // remove extension (.zip)
$this->dumpBuffer = $zipExtension->createFile($dumpBuffer, $filename);
} elseif ($this->compression === 'gzip' && $this->gzencodeNeeded() && is_string($dumpBuffer)) {
// without the optional parameter level because it bugs
$this->dumpBuffer = gzencode($dumpBuffer);
}
}
public function openFile(
string $user,
string $saveDirectory,
string $filename,
bool $quickExport,
bool $quickOverwriteFile,
bool $overwriteFile,
): Message|null {
$this->saveFilename = Util::userDir($user, $saveDirectory) . preg_replace('@[/\\\\]@', '_', $filename);
if (
@file_exists($this->saveFilename)
&& ((! $quickExport && ! $overwriteFile)
|| ($quickExport && ! $quickOverwriteFile))
) {
$message = Message::error(
__(
'File %s already exists on server, change filename or check overwrite option.',
),
);
$message->addParam($this->saveFilename);
return $message;
}
if (@is_file($this->saveFilename) && ! @is_writable($this->saveFilename)) {
$message = Message::error(
__(
'The web server does not have permission to save the file %s.',
),
);
$message->addParam($this->saveFilename);
return $message;
}
$fileHandle = @fopen($this->saveFilename, 'w');
if ($fileHandle === false) {
$message = Message::error(
__(
'The web server does not have permission to save the file %s.',
),
);
$message->addParam($this->saveFilename);
return $message;
}
$this->fileHandle = $fileHandle;
return null;
}
public function closeFile(): Message
{
if ($this->fileHandle !== null) {
$fileHandle = $this->fileHandle;
$this->fileHandle = null;
$writeResult = @fwrite($fileHandle, $this->dumpBuffer);
fclose($fileHandle);
if ($this->dumpBuffer !== '' && $writeResult !== strlen($this->dumpBuffer)) {
return new Message(
__('Insufficient space to save the file %s.'),
MessageType::Error,
[$this->saveFilename],
);
}
}
return new Message(
__('Dump has been saved to file %s.'),
MessageType::Success,
[$this->saveFilename],
);
}
public function clearBuffer(): void
{
$this->dumpBuffer = '';
$this->dumpBufferLength = 0;
}
public function getBuffer(): string
{
return $this->dumpBuffer;
}
public function convertBufferCharset(): void
{
if (! $this->outputCharsetConversion || $this->dumpBuffer === '') {
return;
}
$this->dumpBuffer = Encoding::convertString('utf-8', Current::$charset ?? 'utf-8', $this->dumpBuffer);
}
/**
* Detect whether gzencode is needed; it might not be needed if
* the server is already compressing by itself
*/
private function gzencodeNeeded(): bool
{
/**
* We should gzencode only if the function exists
* but we don't want to compress twice, therefore
* gzencode only if transparent compression is not enabled
* but transparent compression does not apply when saving to server
*/
return function_exists('gzencode')
&& ((! ini_get('zlib.output_compression')
&& ! $this->isGzHandlerEnabled())
|| $this->fileHandle !== null
|| (new UserAgentParser(Core::getEnv('HTTP_USER_AGENT')))->getUserBrowserAgent() === 'CHROME');
}
/**
* Detect ob_gzhandler
*/
private function isGzHandlerEnabled(): bool
{
/** @var string[] $handlers */
$handlers = ob_list_handlers();
return in_array('ob_gzhandler', $handlers, true);
}
}