AbstractWriter.php
10.6 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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @see https://github.com/PHPOffice/PHPWord
* @copyright 2010-2018 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer;
use PhpOffice\PhpWord\Exception\CopyFileException;
use PhpOffice\PhpWord\Exception\Exception;
use PhpOffice\PhpWord\PhpWord;
use PhpOffice\PhpWord\Settings;
use PhpOffice\PhpWord\Shared\ZipArchive;
/**
* Abstract writer class
*
* @since 0.10.0
*/
abstract class AbstractWriter implements WriterInterface
{
/**
* PHPWord object
*
* @var \PhpOffice\PhpWord\PhpWord
*/
protected $phpWord = null;
/**
* Part name and file name pairs
*
* @var array
*/
protected $parts = array();
/**
* Individual writers
*
* @var array
*/
protected $writerParts = array();
/**
* Paths to store media files
*
* @var array
*/
protected $mediaPaths = array('image' => '', 'object' => '');
/**
* Use disk caching
*
* @var bool
*/
private $useDiskCaching = false;
/**
* Disk caching directory
*
* @var string
*/
private $diskCachingDirectory = './';
/**
* Temporary directory
*
* @var string
*/
private $tempDir = '';
/**
* Original file name
*
* @var string
*/
private $originalFilename;
/**
* Temporary file name
*
* @var string
*/
private $tempFilename;
/**
* Get PhpWord object
*
* @throws \PhpOffice\PhpWord\Exception\Exception
* @return \PhpOffice\PhpWord\PhpWord
*/
public function getPhpWord()
{
if (!is_null($this->phpWord)) {
return $this->phpWord;
}
throw new Exception('No PhpWord assigned.');
}
/**
* Set PhpWord object
*
* @param \PhpOffice\PhpWord\PhpWord
* @return self
*/
public function setPhpWord(PhpWord $phpWord = null)
{
$this->phpWord = $phpWord;
return $this;
}
/**
* Get writer part
*
* @param string $partName Writer part name
* @return mixed
*/
public function getWriterPart($partName = '')
{
if ($partName != '' && isset($this->writerParts[strtolower($partName)])) {
return $this->writerParts[strtolower($partName)];
}
return null;
}
/**
* Get use disk caching status
*
* @return bool
*/
public function isUseDiskCaching()
{
return $this->useDiskCaching;
}
/**
* Set use disk caching status
*
* @param bool $value
* @param string $directory
*
* @throws \PhpOffice\PhpWord\Exception\Exception
* @return self
*/
public function setUseDiskCaching($value = false, $directory = null)
{
$this->useDiskCaching = $value;
if (!is_null($directory)) {
if (is_dir($directory)) {
$this->diskCachingDirectory = $directory;
} else {
throw new Exception("Directory does not exist: $directory");
}
}
return $this;
}
/**
* Get disk caching directory
*
* @return string
*/
public function getDiskCachingDirectory()
{
return $this->diskCachingDirectory;
}
/**
* Get temporary directory
*
* @return string
*/
public function getTempDir()
{
return $this->tempDir;
}
/**
* Set temporary directory
*
* @param string $value
* @return self
*/
public function setTempDir($value)
{
if (!is_dir($value)) {
mkdir($value);
}
$this->tempDir = $value;
return $this;
}
/**
* Get temporary file name
*
* If $filename is php://output or php://stdout, make it a temporary file
*
* @param string $filename
* @return string
*/
protected function getTempFile($filename)
{
// Temporary directory
$this->setTempDir(Settings::getTempDir() . uniqid('/PHPWordWriter_', true) . '/');
// Temporary file
$this->originalFilename = $filename;
if (strpos(strtolower($filename), 'php://') === 0) {
$filename = tempnam(Settings::getTempDir(), 'PhpWord');
if (false === $filename) {
$filename = $this->originalFilename; // @codeCoverageIgnore
} // @codeCoverageIgnore
}
$this->tempFilename = $filename;
return $this->tempFilename;
}
/**
* Cleanup temporary file.
*
* @throws \PhpOffice\PhpWord\Exception\CopyFileException
*/
protected function cleanupTempFile()
{
if ($this->originalFilename != $this->tempFilename) {
// @codeCoverageIgnoreStart
// Can't find any test case. Uncomment when found.
if (false === copy($this->tempFilename, $this->originalFilename)) {
throw new CopyFileException($this->tempFilename, $this->originalFilename);
}
// @codeCoverageIgnoreEnd
@unlink($this->tempFilename);
}
$this->clearTempDir();
}
/**
* Clear temporary directory.
*/
protected function clearTempDir()
{
if (is_dir($this->tempDir)) {
$this->deleteDir($this->tempDir);
}
}
/**
* Get ZipArchive object
*
* @param string $filename
*
* @throws \Exception
*
* @return \PhpOffice\PhpWord\Shared\ZipArchive
*/
protected function getZipArchive($filename)
{
// Remove any existing file
if (file_exists($filename)) {
unlink($filename);
}
// Try opening the ZIP file
$zip = new ZipArchive();
// @codeCoverageIgnoreStart
// Can't find any test case. Uncomment when found.
if ($zip->open($filename, ZipArchive::OVERWRITE) !== true) {
if ($zip->open($filename, ZipArchive::CREATE) !== true) {
throw new \Exception("Could not open '{$filename}' for writing.");
}
}
// @codeCoverageIgnoreEnd
return $zip;
}
/**
* Open file for writing
*
* @since 0.11.0
*
* @param string $filename
*
* @throws \Exception
*
* @return resource
*/
protected function openFile($filename)
{
$filename = $this->getTempFile($filename);
$fileHandle = fopen($filename, 'w');
// @codeCoverageIgnoreStart
// Can't find any test case. Uncomment when found.
if ($fileHandle === false) {
throw new \Exception("Could not open '{$filename}' for writing.");
}
// @codeCoverageIgnoreEnd
return $fileHandle;
}
/**
* Write content to file.
*
* @since 0.11.0
*
* @param resource $fileHandle
* @param string $content
*/
protected function writeFile($fileHandle, $content)
{
fwrite($fileHandle, $content);
fclose($fileHandle);
$this->cleanupTempFile();
}
/**
* Add files to package.
*
* @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
* @param mixed $elements
*/
protected function addFilesToPackage(ZipArchive $zip, $elements)
{
foreach ($elements as $element) {
$type = $element['type']; // image|object|link
// Skip nonregistered types and set target
if (!isset($this->mediaPaths[$type])) {
continue;
}
$target = $this->mediaPaths[$type] . $element['target'];
// Retrive GD image content or get local media
if (isset($element['isMemImage']) && $element['isMemImage']) {
$image = call_user_func($element['createFunction'], $element['source']);
if ($element['imageType'] === 'image/png') {
// PNG images need to preserve alpha channel information
imagesavealpha($image, true);
}
ob_start();
call_user_func($element['imageFunction'], $image);
$imageContents = ob_get_contents();
ob_end_clean();
$zip->addFromString($target, $imageContents);
imagedestroy($image);
} else {
$this->addFileToPackage($zip, $element['source'], $target);
}
}
}
/**
* Add file to package.
*
* Get the actual source from an archive image.
*
* @param \PhpOffice\PhpWord\Shared\ZipArchive $zipPackage
* @param string $source
* @param string $target
*/
protected function addFileToPackage($zipPackage, $source, $target)
{
$isArchive = strpos($source, 'zip://') !== false;
$actualSource = null;
if ($isArchive) {
$source = substr($source, 6);
list($zipFilename, $imageFilename) = explode('#', $source);
$zip = new ZipArchive();
if ($zip->open($zipFilename) !== false) {
if ($zip->locateName($imageFilename)) {
$zip->extractTo($this->getTempDir(), $imageFilename);
$actualSource = $this->getTempDir() . DIRECTORY_SEPARATOR . $imageFilename;
}
}
$zip->close();
} else {
$actualSource = $source;
}
if (!is_null($actualSource)) {
$zipPackage->addFile($actualSource, $target);
}
}
/**
* Delete directory.
*
* @param string $dir
*/
private function deleteDir($dir)
{
foreach (scandir($dir) as $file) {
if ($file === '.' || $file === '..') {
continue;
} elseif (is_file($dir . '/' . $file)) {
unlink($dir . '/' . $file);
} elseif (is_dir($dir . '/' . $file)) {
$this->deleteDir($dir . '/' . $file);
}
}
rmdir($dir);
}
/**
* Get use disk caching status
*
* @deprecated 0.10.0
*
* @codeCoverageIgnore
*/
public function getUseDiskCaching()
{
return $this->isUseDiskCaching();
}
}