zbateson /
mail-mime-parser
| Total Complexity | 51 |
| Total Lines | 404 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like MultipartHelper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use MultipartHelper, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 25 | class MultipartHelper extends AbstractHelper |
||
| 26 | { |
||
| 27 | /** |
||
| 28 | * @var GenericHelper a GenericHelper instance |
||
| 29 | */ |
||
| 30 | private $genericHelper; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * @param MimePartFactory $mimePartFactory |
||
| 34 | * @param UUEncodedPartFactory $uuEncodedPartFactory |
||
| 35 | * @param PartBuilderFactory $partBuilderFactory |
||
| 36 | * @param GenericHelper $genericHelper |
||
| 37 | */ |
||
| 38 | public function __construct( |
||
| 39 | MimePartFactory $mimePartFactory, |
||
| 40 | UUEncodedPartFactory $uuEncodedPartFactory, |
||
| 41 | PartBuilderFactory $partBuilderFactory, |
||
| 42 | GenericHelper $genericHelper |
||
| 43 | ) { |
||
| 44 | parent::__construct($mimePartFactory, $uuEncodedPartFactory, $partBuilderFactory); |
||
| 45 | $this->genericHelper = $genericHelper; |
||
| 46 | } |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Creates and returns a unique boundary. |
||
| 50 | * |
||
| 51 | * @param string $mimeType first 3 characters of a multipart type are used, |
||
| 52 | * e.g. REL for relative or ALT for alternative |
||
| 53 | * @return string |
||
| 54 | */ |
||
| 55 | public function getUniqueBoundary($mimeType) |
||
| 56 | { |
||
| 57 | $type = ltrim(strtoupper(preg_replace('/^(multipart\/(.{3}).*|.*)$/i', '$2-', $mimeType)), '-'); |
||
| 58 | return uniqid('----=MMP-' . $type . '.', true); |
||
| 59 | } |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Creates a unique mime boundary and assigns it to the passed part's |
||
| 63 | * Content-Type header with the passed mime type. |
||
| 64 | * |
||
| 65 | * @param ParentHeaderPart $part |
||
| 66 | * @param string $mimeType |
||
| 67 | */ |
||
| 68 | public function setMimeHeaderBoundaryOnPart(ParentHeaderPart $part, $mimeType) |
||
| 69 | { |
||
| 70 | $part->setRawHeader( |
||
| 71 | 'Content-Type', |
||
| 72 | "$mimeType;\r\n\tboundary=\"" |
||
| 73 | . $this->getUniqueBoundary($mimeType) . '"' |
||
| 74 | ); |
||
| 75 | } |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Sets the passed message as multipart/mixed. |
||
| 79 | * |
||
| 80 | * If the message has content, a new part is created and added as a child of |
||
| 81 | * the message. The message's content and content headers are moved to the |
||
| 82 | * new part. |
||
| 83 | * |
||
| 84 | * @param Message $message |
||
| 85 | */ |
||
| 86 | public function setMessageAsMixed(Message $message) |
||
| 87 | { |
||
| 88 | if ($message->hasContent()) { |
||
| 89 | $part = $this->genericHelper->createNewContentPartFrom($message); |
||
| 90 | $message->addChild($part, 0); |
||
| 91 | } |
||
| 92 | $this->setMimeHeaderBoundaryOnPart($message, 'multipart/mixed'); |
||
| 93 | $atts = $message->getAllAttachmentParts(); |
||
| 94 | if (!empty($atts)) { |
||
| 95 | foreach ($atts as $att) { |
||
| 96 | $att->markAsChanged(); |
||
| 97 | } |
||
| 98 | } |
||
| 99 | } |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Sets the passed message as multipart/alternative. |
||
| 103 | * |
||
| 104 | * If the message has content, a new part is created and added as a child of |
||
| 105 | * the message. The message's content and content headers are moved to the |
||
| 106 | * new part. |
||
| 107 | * |
||
| 108 | * @param Message $message |
||
| 109 | */ |
||
| 110 | public function setMessageAsAlternative(Message $message) |
||
| 111 | { |
||
| 112 | if ($message->hasContent()) { |
||
| 113 | $part = $this->genericHelper->createNewContentPartFrom($message); |
||
| 114 | $message->addChild($part, 0); |
||
| 115 | } |
||
| 116 | $this->setMimeHeaderBoundaryOnPart($message, 'multipart/alternative'); |
||
| 117 | } |
||
| 118 | |||
| 119 | /** |
||
| 120 | * Searches the passed $alternativePart for a part with the passed mime type |
||
| 121 | * and returns its parent. |
||
| 122 | * |
||
| 123 | * Used for alternative mime types that have a multipart/mixed or |
||
| 124 | * multipart/related child containing a content part of $mimeType, where |
||
| 125 | * the whole mixed/related part should be removed. |
||
| 126 | * |
||
| 127 | * @param string $mimeType the content-type to find below $alternativePart |
||
| 128 | * @param ParentHeaderPart $alternativePart The multipart/alternative part to look |
||
| 129 | * under |
||
| 130 | * @return boolean|MimePart false if a part is not found |
||
| 131 | */ |
||
| 132 | public function getContentPartContainerFromAlternative($mimeType, ParentHeaderPart $alternativePart) |
||
| 133 | { |
||
| 134 | $part = $alternativePart->getPart(0, PartFilter::fromInlineContentType($mimeType)); |
||
| 135 | $contPart = null; |
||
|
Unused Code
introduced
by
|
|||
| 136 | do { |
||
| 137 | if ($part === null) { |
||
| 138 | return false; |
||
| 139 | } |
||
| 140 | $contPart = $part; |
||
| 141 | $part = $part->getParent(); |
||
| 142 | } while ($part !== $alternativePart); |
||
| 143 | return $contPart; |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Removes all parts of $mimeType from $alternativePart. |
||
| 148 | * |
||
| 149 | * If $alternativePart contains a multipart/mixed or multipart/relative part |
||
| 150 | * with other parts of different content-types, the multipart part is |
||
| 151 | * removed, and parts of different content-types can optionally be moved to |
||
| 152 | * the main message part. |
||
| 153 | * |
||
| 154 | * @param Message $message |
||
| 155 | * @param string $mimeType |
||
| 156 | * @param ParentHeaderPart $alternativePart |
||
| 157 | * @param bool $keepOtherContent |
||
| 158 | * @return bool |
||
| 159 | */ |
||
| 160 | public function removeAllContentPartsFromAlternative(Message $message, $mimeType, ParentHeaderPart $alternativePart, $keepOtherContent) |
||
| 161 | { |
||
| 162 | $rmPart = $this->getContentPartContainerFromAlternative($mimeType, $alternativePart); |
||
| 163 | if ($rmPart === false) { |
||
| 164 | return false; |
||
| 165 | } |
||
| 166 | if ($keepOtherContent) { |
||
| 167 | $this->moveAllPartsAsAttachmentsExcept($message, $rmPart, $mimeType); |
||
| 168 | $alternativePart = $message->getPart(0, PartFilter::fromInlineContentType('multipart/alternative')); |
||
| 169 | } else { |
||
| 170 | $rmPart->removeAllParts(); |
||
| 171 | } |
||
| 172 | $message->removePart($rmPart); |
||
| 173 | if ($alternativePart !== null) { |
||
| 174 | if ($alternativePart->getChildCount() === 1) { |
||
| 175 | $this->genericHelper->replacePart($message, $alternativePart, $alternativePart->getChild(0)); |
||
| 176 | } elseif ($alternativePart->getChildCount() === 0) { |
||
| 177 | $message->removePart($alternativePart); |
||
| 178 | } |
||
| 179 | } |
||
| 180 | while ($message->getChildCount() === 1) { |
||
| 181 | $this->genericHelper->replacePart($message, $message, $message->getChild(0)); |
||
| 182 | } |
||
| 183 | return true; |
||
| 184 | } |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Creates a new mime part as a multipart/alternative and assigns the passed |
||
| 188 | * $contentPart as a part below it before returning it. |
||
| 189 | * |
||
| 190 | * @param Message $message |
||
| 191 | * @param MessagePart $contentPart |
||
| 192 | * @return MimePart the alternative part |
||
| 193 | */ |
||
| 194 | public function createAlternativeContentPart(Message $message, MessagePart $contentPart) |
||
| 195 | { |
||
| 196 | $altPart = $this->partBuilderFactory->newPartBuilder($this->mimePartFactory)->createMessagePart(); |
||
| 197 | $this->setMimeHeaderBoundaryOnPart($altPart, 'multipart/alternative'); |
||
| 198 | $message->removePart($contentPart); |
||
| 199 | $message->addChild($altPart, 0); |
||
| 200 | $altPart->addChild($contentPart, 0); |
||
| 201 | return $altPart; |
||
| 202 | } |
||
| 203 | |||
| 204 | /** |
||
| 205 | * Moves all parts under $from into this message except those with a |
||
| 206 | * content-type equal to $exceptMimeType. If the message is not a |
||
| 207 | * multipart/mixed message, it is set to multipart/mixed first. |
||
| 208 | * |
||
| 209 | * @param Message $message |
||
| 210 | * @param ParentHeaderPart $from |
||
| 211 | * @param string $exceptMimeType |
||
| 212 | */ |
||
| 213 | public function moveAllPartsAsAttachmentsExcept(Message $message, ParentHeaderPart $from, $exceptMimeType) |
||
| 214 | { |
||
| 215 | $parts = $from->getAllParts(new PartFilter([ |
||
| 216 | 'multipart' => PartFilter::FILTER_EXCLUDE, |
||
| 217 | 'headers' => [ |
||
| 218 | PartFilter::FILTER_EXCLUDE => [ |
||
| 219 | 'Content-Type' => $exceptMimeType |
||
| 220 | ] |
||
| 221 | ] |
||
| 222 | ])); |
||
| 223 | if (strcasecmp($message->getContentType(), 'multipart/mixed') !== 0) { |
||
| 224 | $this->setMessageAsMixed($message); |
||
| 225 | } |
||
| 226 | foreach ($parts as $part) { |
||
| 227 | $from->removePart($part); |
||
| 228 | $message->addChild($part); |
||
| 229 | } |
||
| 230 | } |
||
| 231 | |||
| 232 | /** |
||
| 233 | * Enforces the message to be a mime message for a non-mime (e.g. uuencoded |
||
| 234 | * or unspecified) message. If the message has uuencoded attachments, sets |
||
| 235 | * up the message as a multipart/mixed message and creates a separate |
||
| 236 | * content part. |
||
| 237 | * |
||
| 238 | * @param Message $message |
||
| 239 | */ |
||
| 240 | public function enforceMime(Message $message) |
||
| 241 | { |
||
| 242 | if (!$message->isMime()) { |
||
| 243 | if ($message->getAttachmentCount()) { |
||
| 244 | $this->setMessageAsMixed($message); |
||
| 245 | } else { |
||
| 246 | $message->setRawHeader('Content-Type', "text/plain;\r\n\tcharset=\"iso-8859-1\""); |
||
| 247 | } |
||
| 248 | $message->setRawHeader('Mime-Version', '1.0'); |
||
| 249 | } |
||
| 250 | } |
||
| 251 | |||
| 252 | /** |
||
| 253 | * Creates a multipart/related part out of 'inline' children of $parent and |
||
| 254 | * returns it. |
||
| 255 | * |
||
| 256 | * @param ParentHeaderPart $parent |
||
| 257 | * @return MimePart |
||
| 258 | */ |
||
| 259 | public function createMultipartRelatedPartForInlineChildrenOf(ParentHeaderPart $parent) |
||
| 260 | { |
||
| 261 | $builder = $this->partBuilderFactory->newPartBuilder($this->mimePartFactory); |
||
| 262 | $relatedPart = $builder->createMessagePart(); |
||
| 263 | $this->setMimeHeaderBoundaryOnPart($relatedPart, 'multipart/related'); |
||
| 264 | foreach ($parent->getChildParts(PartFilter::fromDisposition('inline', PartFilter::FILTER_EXCLUDE)) as $part) { |
||
| 265 | $parent->removePart($part); |
||
| 266 | $relatedPart->addChild($part); |
||
| 267 | } |
||
| 268 | $parent->addChild($relatedPart, 0); |
||
| 269 | return $relatedPart; |
||
| 270 | } |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Finds an alternative inline part in the message and returns it if one |
||
| 274 | * exists. |
||
| 275 | * |
||
| 276 | * If the passed $mimeType is text/plain, searches for a text/html part. |
||
| 277 | * Otherwise searches for a text/plain part to return. |
||
| 278 | * |
||
| 279 | * @param Message $message |
||
| 280 | * @param string $mimeType |
||
| 281 | * @return MimeType or null if not found |
||
| 282 | */ |
||
| 283 | public function findOtherContentPartFor(Message $message, $mimeType) |
||
| 284 | { |
||
| 285 | $altPart = $message->getPart( |
||
| 286 | 0, |
||
| 287 | PartFilter::fromInlineContentType(($mimeType === 'text/plain') ? 'text/html' : 'text/plain') |
||
| 288 | ); |
||
| 289 | if ($altPart !== null && $altPart->getParent() !== null && $altPart->getParent()->isMultiPart()) { |
||
| 290 | $altPartParent = $altPart->getParent(); |
||
| 291 | if ($altPartParent->getPartCount(PartFilter::fromDisposition('inline', PartFilter::FILTER_EXCLUDE)) !== 1) { |
||
| 292 | $altPart = $this->createMultipartRelatedPartForInlineChildrenOf($altPartParent); |
||
| 293 | } |
||
| 294 | } |
||
| 295 | return $altPart; |
||
| 296 | } |
||
| 297 | |||
| 298 | /** |
||
| 299 | * Creates a new content part for the passed mimeType and charset, making |
||
| 300 | * space by creating a multipart/alternative if needed |
||
| 301 | * |
||
| 302 | * @param Message $message |
||
| 303 | * @param string $mimeType |
||
| 304 | * @param string $charset |
||
| 305 | * @return MimePart |
||
| 306 | */ |
||
| 307 | public function createContentPartForMimeType(Message $message, $mimeType, $charset) |
||
| 308 | { |
||
| 309 | $builder = $this->partBuilderFactory->newPartBuilder($this->mimePartFactory); |
||
| 310 | $builder->addHeader('Content-Type', "$mimeType;\r\n\tcharset=\"$charset\""); |
||
| 311 | $builder->addHeader('Content-Transfer-Encoding', 'quoted-printable'); |
||
| 312 | $this->enforceMime($message); |
||
| 313 | $mimePart = $builder->createMessagePart(); |
||
| 314 | |||
| 315 | $altPart = $this->findOtherContentPartFor($message, $mimeType); |
||
| 316 | |||
| 317 | if ($altPart === $message) { |
||
| 318 | $this->setMessageAsAlternative($message); |
||
| 319 | $message->addChild($mimePart); |
||
| 320 | } elseif ($altPart !== null) { |
||
| 321 | $mimeAltPart = $this->createAlternativeContentPart($message, $altPart); |
||
| 322 | $mimeAltPart->addChild($mimePart, 1); |
||
| 323 | } else { |
||
| 324 | $message->addChild($mimePart, 0); |
||
| 325 | } |
||
| 326 | |||
| 327 | return $mimePart; |
||
| 328 | } |
||
| 329 | |||
| 330 | /** |
||
| 331 | * Creates and returns a MimePart for use with a new attachment part being |
||
| 332 | * created. |
||
| 333 | * |
||
| 334 | * @param Message $message |
||
| 335 | * @param string $mimeType |
||
| 336 | * @param string $filename |
||
| 337 | * @param string $disposition |
||
| 338 | * @return MimePart |
||
| 339 | */ |
||
| 340 | public function createPartForAttachment(Message $message, $mimeType, $filename, $disposition) |
||
| 358 | } |
||
| 359 | |||
| 360 | /** |
||
| 361 | * Removes the content part of the message with the passed mime type. If |
||
| 362 | * there is a remaining content part and it is an alternative part of the |
||
| 363 | * main message, the content part is moved to the message part. |
||
| 364 | * |
||
| 365 | * If the content part is part of an alternative part beneath the message, |
||
| 366 | * the alternative part is replaced by the remaining content part, |
||
| 367 | * optionally keeping other parts if $keepOtherContent is set to true. |
||
| 368 | * |
||
| 369 | * @param Message $message |
||
| 370 | * @param string $mimeType |
||
| 371 | * @param bool $keepOtherContent |
||
| 372 | * @return boolean true on success |
||
| 373 | */ |
||
| 374 | public function removeAllContentPartsByMimeType(Message $message, $mimeType, $keepOtherContent = false) |
||
| 375 | { |
||
| 376 | $alt = $message->getPart(0, PartFilter::fromInlineContentType('multipart/alternative')); |
||
| 377 | if ($alt !== null) { |
||
| 378 | return $this->removeAllContentPartsFromAlternative($message, $mimeType, $alt, $keepOtherContent); |
||
| 379 | } |
||
| 380 | $message->removeAllParts(PartFilter::fromInlineContentType($mimeType)); |
||
| 381 | return true; |
||
| 382 | } |
||
| 383 | |||
| 384 | /** |
||
| 385 | * Removes the 'inline' part with the passed contentType, at the given index |
||
| 386 | * defaulting to the first |
||
| 387 | * |
||
| 388 | * @param Message $message |
||
| 389 | * @param string $mimeType |
||
| 390 | * @param int $index |
||
| 391 | * @return boolean true on success |
||
| 392 | */ |
||
| 393 | public function removePartByMimeType(Message $message, $mimeType, $index = 0) |
||
| 408 | } |
||
| 409 | |||
| 410 | /** |
||
| 411 | * Either creates a mime part or sets the existing mime part with the passed |
||
| 412 | * mimeType to $strongOrHandle. |
||
| 413 | * |
||
| 414 | * @param Message $message |
||
| 415 | * @param string $mimeType |
||
| 416 | * @param string|resource $stringOrHandle |
||
| 417 | * @param string $charset |
||
| 418 | */ |
||
| 419 | public function setContentPartForMimeType(Message $message, $mimeType, $stringOrHandle, $charset) |
||
| 429 | } |
||
| 430 | } |
||
| 431 |
Loading history...