-
-
Notifications
You must be signed in to change notification settings - Fork 254
/
AbstractPart.php
448 lines (370 loc) · 12.1 KB
/
AbstractPart.php
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
437
438
439
440
441
442
443
444
445
446
447
448
<?php
declare(strict_types=1);
namespace Ddeboer\Imap\Message;
use Ddeboer\Imap\Exception\ImapFetchbodyException;
use Ddeboer\Imap\Exception\UnexpectedEncodingException;
use Ddeboer\Imap\ImapResourceInterface;
use Ddeboer\Imap\Message;
/**
* A message part.
*/
abstract class AbstractPart implements PartInterface
{
private const TYPES_MAP = [
\TYPETEXT => self::TYPE_TEXT,
\TYPEMULTIPART => self::TYPE_MULTIPART,
\TYPEMESSAGE => self::TYPE_MESSAGE,
\TYPEAPPLICATION => self::TYPE_APPLICATION,
\TYPEAUDIO => self::TYPE_AUDIO,
\TYPEIMAGE => self::TYPE_IMAGE,
\TYPEVIDEO => self::TYPE_VIDEO,
\TYPEMODEL => self::TYPE_MODEL,
\TYPEOTHER => self::TYPE_OTHER,
];
private const ENCODINGS_MAP = [
\ENC7BIT => self::ENCODING_7BIT,
\ENC8BIT => self::ENCODING_8BIT,
\ENCBINARY => self::ENCODING_BINARY,
\ENCBASE64 => self::ENCODING_BASE64,
\ENCQUOTEDPRINTABLE => self::ENCODING_QUOTED_PRINTABLE,
];
private const ATTACHMENT_KEYS = [
'name' => true,
'filename' => true,
'name*' => true,
'filename*' => true,
];
protected ImapResourceInterface $resource;
private bool $structureParsed = false;
/**
* @var AbstractPart[]
*/
private array $parts = [];
private string $partNumber;
private int $messageNumber;
private \stdClass $structure;
private Parameters $parameters;
private ?string $type = null;
private ?string $subtype = null;
private ?string $encoding = null;
private ?string $disposition = null;
private ?string $description = null;
private string|int|null $bytes;
private ?string $lines = null;
private ?string $content = null;
private ?string $decodedContent = null;
private int $key = 0;
/**
* Constructor.
*
* @param ImapResourceInterface $resource IMAP resource
* @param int $messageNumber Message number
* @param string $partNumber Part number
* @param \stdClass $structure Part structure
*/
public function __construct(
ImapResourceInterface $resource,
int $messageNumber,
string $partNumber,
\stdClass $structure
) {
$this->resource = $resource;
$this->messageNumber = $messageNumber;
$this->partNumber = $partNumber;
$this->setStructure($structure);
}
final public function getNumber(): int
{
$this->assertMessageExists($this->messageNumber);
return $this->messageNumber;
}
/**
* Ensure message exists.
*/
protected function assertMessageExists(int $messageNumber): void
{
}
/**
* @param \stdClass $structure Part structure
*/
final protected function setStructure(\stdClass $structure): void
{
$this->structure = $structure;
}
final public function getStructure(): \stdClass
{
$this->lazyLoadStructure();
return $this->structure;
}
/**
* Lazy load structure.
*/
protected function lazyLoadStructure(): void
{
}
final public function getParameters(): Parameters
{
$this->lazyParseStructure();
return $this->parameters;
}
final public function getCharset(): ?string
{
$this->lazyParseStructure();
$charset = $this->parameters->get('charset');
\assert(null === $charset || \is_string($charset));
return '' !== $charset ? $charset : null;
}
final public function getType(): ?string
{
$this->lazyParseStructure();
return $this->type;
}
final public function getSubtype(): ?string
{
$this->lazyParseStructure();
return $this->subtype;
}
final public function getEncoding(): ?string
{
$this->lazyParseStructure();
return $this->encoding;
}
final public function getDisposition(): ?string
{
$this->lazyParseStructure();
return $this->disposition;
}
final public function getDescription(): ?string
{
$this->lazyParseStructure();
return $this->description;
}
final public function getBytes()
{
$this->lazyParseStructure();
return $this->bytes;
}
final public function getLines(): ?string
{
$this->lazyParseStructure();
return $this->lines;
}
final public function getContent(): string
{
if (null === $this->content) {
$this->content = $this->doGetContent($this->getContentPartNumber());
}
return $this->content;
}
/**
* Get content part number.
*/
protected function getContentPartNumber(): string
{
return $this->partNumber;
}
final public function getPartNumber(): string
{
return $this->partNumber;
}
final public function getDecodedContent(): string
{
if (null === $this->decodedContent) {
if (self::ENCODING_UNKNOWN === $this->getEncoding()) {
throw new UnexpectedEncodingException('Cannot decode a content with an uknown encoding');
}
$content = $this->getContent();
if (self::ENCODING_BASE64 === $this->getEncoding()) {
$content = \base64_decode($content, false);
} elseif (self::ENCODING_QUOTED_PRINTABLE === $this->getEncoding()) {
$content = \quoted_printable_decode($content);
}
if (false === $content) {
throw new UnexpectedEncodingException('Cannot decode content');
}
// If this part is a text part, convert its charset to UTF-8.
// We don't want to decode an attachment's charset.
if (!$this instanceof Attachment && null !== $this->getCharset() && self::TYPE_TEXT === $this->getType()) {
$content = Transcoder::decode($content, $this->getCharset());
}
$this->decodedContent = $content;
}
return $this->decodedContent;
}
/**
* Get raw message content.
*/
final protected function doGetContent(string $partNumber): string
{
$return = \imap_fetchbody(
$this->resource->getStream(),
$this->getNumber(),
$partNumber,
\FT_UID | \FT_PEEK
);
if (false === $return) {
throw new ImapFetchbodyException('imap_fetchbody failed');
}
return $return;
}
/**
* Save raw message content to file.
*
* @param resource|string $file the path to the saved file as a string, or a valid file descriptor
*/
final protected function doSaveContent($file, string $partNumber): void
{
$return = \imap_savebody(
$this->resource->getStream(),
$file,
$this->getNumber(),
$partNumber,
\FT_UID | \FT_PEEK
);
if (false === $return) {
throw new ImapFetchbodyException('imap_savebody failed');
}
}
final public function getParts(): array
{
$this->lazyParseStructure();
return $this->parts;
}
/**
* Get current child part.
*/
#[\ReturnTypeWillChange]
final public function current()
{
$this->lazyParseStructure();
return $this->parts[$this->key];
}
#[\ReturnTypeWillChange]
final public function getChildren()
{
return $this->current();
}
#[\ReturnTypeWillChange]
final public function hasChildren()
{
$this->lazyParseStructure();
return \count($this->parts) > 0;
}
/**
* @return int
*/
#[\ReturnTypeWillChange]
final public function key()
{
return $this->key;
}
#[\ReturnTypeWillChange]
final public function next()
{
++$this->key;
}
#[\ReturnTypeWillChange]
final public function rewind()
{
$this->key = 0;
}
#[\ReturnTypeWillChange]
final public function valid()
{
$this->lazyParseStructure();
return isset($this->parts[$this->key]);
}
/**
* Parse part structure.
*/
private function lazyParseStructure(): void
{
if (true === $this->structureParsed) {
return;
}
$this->structureParsed = true;
$this->lazyLoadStructure();
$this->type = self::TYPES_MAP[$this->structure->type] ?? self::TYPE_UNKNOWN;
// In our context, \ENCOTHER is as useful as an unknown encoding
$this->encoding = self::ENCODINGS_MAP[$this->structure->encoding] ?? self::ENCODING_UNKNOWN;
if (isset($this->structure->subtype)) {
$this->subtype = $this->structure->subtype;
}
if (isset($this->structure->bytes)) {
$this->bytes = $this->structure->bytes;
}
if ($this->structure->ifdisposition) {
$this->disposition = $this->structure->disposition;
}
if ($this->structure->ifdescription) {
$this->description = $this->structure->description;
}
$this->parameters = new Parameters();
if ($this->structure->ifparameters) {
$this->parameters->add($this->structure->parameters);
}
if ($this->structure->ifdparameters) {
$this->parameters->add($this->structure->dparameters);
}
// When the message is not multipart and the body is the attachment content
// Prevents infinite recursion
if (!$this instanceof Attachment && self::isAttachment($this->structure)) {
$this->parts[] = new Attachment($this->resource, $this->getNumber(), '1', $this->structure);
}
if (isset($this->structure->parts)) {
$parts = $this->structure->parts;
// https://secure.php.net/manual/en/function.imap-fetchbody.php#89002
if ($this instanceof Attachment && $this->isEmbeddedMessage() && 1 === \count($parts) && \TYPEMULTIPART === $parts[0]->type) {
$parts = $parts[0]->parts;
}
foreach ($parts as $key => $partStructure) {
$partNumber = (!$this instanceof Message) ? $this->partNumber . '.' : '';
$partNumber .= $key + 1;
$newPartClass = self::isAttachment($partStructure)
? Attachment::class
: SimplePart::class;
$this->parts[] = new $newPartClass($this->resource, $this->getNumber(), $partNumber, $partStructure);
}
}
}
/**
* Check if the given part is an attachment.
*/
private static function isAttachment(\stdClass $part): bool
{
if (isset(self::TYPES_MAP[$part->type]) && self::TYPE_MULTIPART === self::TYPES_MAP[$part->type]) {
return false;
}
// Attachment with correct Content-Disposition header
if ($part->ifdisposition) {
if ('attachment' === \strtolower($part->disposition)) {
return true;
}
if (
'inline' === \strtolower($part->disposition)
&& self::SUBTYPE_PLAIN !== \strtoupper($part->subtype)
&& self::SUBTYPE_HTML !== \strtoupper($part->subtype)
) {
return true;
}
}
// Attachment without Content-Disposition header
if ($part->ifparameters) {
foreach ($part->parameters as $parameter) {
if (isset(self::ATTACHMENT_KEYS[\strtolower($parameter->attribute)])) {
return true;
}
}
}
/*
if ($part->ifdparameters) {
foreach ($part->dparameters as $parameter) {
if (isset(self::$attachmentKeys[\strtolower($parameter->attribute)])) {
return true;
}
}
}
*/
return self::SUBTYPE_RFC822 === \strtoupper($part->subtype);
}
}