Message::getUid() - Code Metrics - Inspection of "Added option for optional attachment download (#76..." - Webklex/laravel-imap - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 803c46...a0c155 )

by Malte
created 2018-04-04 20:57 UTC
Message::getUid() A

↳ Parent: Message
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
c	0
b	0
f	0
<?php
/*
* File:     Message.php
* Category: -
* Author:   M. Goldenbaum
* Created:  19.01.17 22:21
* Updated:  -
*
* Description:
*  -
*/

namespace Webklex\IMAP;

use Carbon\Carbon;
use Webklex\IMAP\Support\AttachmentCollection;

/**
 * Class Message
 *
 * @package Webklex\IMAP
 */
class Message {

    /**
     * Client instance
     *
     * @var Client
     */
    private $client = Client::class;

    /**
     * U ID
     *
     * @var string
     */
    public $uid = '';

    /**
     * Fetch body options
     *
     * @var string
     */
    public $fetch_options = null;

    /**
     * Fetch attachments options
     *
     * @var bool
     */
    public $fetch_attachment = null;

    /**
     * @var int $msglist
     */
    public $msglist = 1;

    /**
     * @var string $header
     */
    public $header = null;

    /**
     * @var null|object $header_info
     */
    public $header_info = null;

    /** @var null|object $raw_body */
    public $raw_body = null;

    /**
     * Message header components
     *
     * @var string  $message_id
     * @var mixed   $message_no
     * @var string  $subject
     * @var mixed   $date
     * @var array   $from
     * @var array   $to
     * @var array   $cc
     * @var array   $bcc
     * @var array   $reply_to
     * @var string  $in_reply_to
     * @var array   $sender
     */
    public $message_id = '';
    public $message_no = null;
    public $subject = '';
    public $date = null;
    public $from = [];
    public $to = [];
    public $cc = [];
    public $bcc = [];
    public $reply_to = [];
    public $in_reply_to = '';
    public $sender = [];

    /**
     * Message body components
     *
     * @var array   $bodies
     * @var AttachmentCollection|array  $attachments
     */
    public $bodies = [];
    public $attachments = [];

    /**
     * Message const
     *
     * @const integer   TYPE_TEXT
     * @const integer   TYPE_MULTIPART
     *
     * @const integer   ENC_7BIT
     * @const integer   ENC_8BIT
     * @const integer   ENC_BINARY
     * @const integer   ENC_BASE64
     * @const integer   ENC_QUOTED_PRINTABLE
     * @const integer   ENC_OTHER
     */
    const TYPE_TEXT = 0;
    const TYPE_MULTIPART = 1;

    const ENC_7BIT = 0;
    const ENC_8BIT = 1;
    const ENC_BINARY = 2;
    const ENC_BASE64 = 3;
    const ENC_QUOTED_PRINTABLE = 4;
    const ENC_OTHER = 5;

    /**
     * Message constructor.
     *
     * @param integer       $uid
     * @param integer|null  $msglist
     * @param Client        $client
     * @param integer|null  $fetch_options
     * @param boolean       $parse_body
     * @param boolean       $fetch_attachment
     */
    public function __construct($uid, $msglist, Client $client, $fetch_options = null, $parse_body = false, $fetch_attachment = false) {
        $this->setFetchOption($fetch_options);
        $this->setFetchAttachment($fetch_attachment);

        $this->attachments = AttachmentCollection::make([]);
        
        $this->msglist = $msglist;
        $this->client = $client;
        $this->uid = ($this->fetch_options == FT_UID) ? $uid : imap_msgno($this->client->getConnection(), $uid);
        
        $this->parseHeader();

        if ($parse_body !== false) {
            $this->parseBody();
        }
    }

    /**
     * Copy the current Messages to a mailbox
     *
     * @param $mailbox
     * @param int $options
     *
     * @return bool
     */
    public function copy($mailbox, $options = 0) {
        return imap_mail_copy($this->client->getConnection(), $this->msglist, $mailbox, $options);
    }

    /**
     * Move the current Messages to a mailbox
     *
     * @param $mailbox
     * @param int $options
     *
     * @return bool
     */
    public function move($mailbox, $options = 0) {
        return imap_mail_move($this->client->getConnection(), $this->msglist, $mailbox, $options);
    }

    /**
     * Check if the Message has a text body
     *
     * @return bool
     */
    public function hasTextBody() {
        return isset($this->bodies['text']);
    }

    /**
     * Get the Message text body
     *
     * @return mixed
     */
    public function getTextBody() {
        if (!isset($this->bodies['text'])) {
            return false;
        }

        return $this->bodies['text']->content;
    }

    /**
     * Check if the Message has a html body
     *
     * @return bool
     */
    public function hasHTMLBody() {
        return isset($this->bodies['html']);
    }

    /**
     * Get the Message html body
     *
     * @var bool $replaceImages
     *
     * @return mixed
     */
    public function getHTMLBody($replaceImages = false) {
        if (!isset($this->bodies['html'])) {
            return false;
        }

        $body = $this->bodies['html']->content;
        if ($replaceImages) {
            $this->attachments->each(function($oAttachment) use(&$body){
                if ($oAttachment->id && isset($oAttachment->img_src)) {
                    $body = str_replace('cid:'.$oAttachment->id, $oAttachment->img_src, $body);
                }
            });
        }

        return $body;
    }

    /**
     * Parse all defined headers
     *
     * @return void
     */
    private function parseHeader() {
        $this->header = $header = imap_fetchheader($this->client->getConnection(), $this->uid, $this->fetch_options);
        $this->header = $header = imap_fetchheader($this->client->getConnection(), $this->uid, /** @scrutinizer ignore-type */ $this->fetch_options);
        if ($this->header) {
            $header = imap_rfc822_parse_headers($this->header);
        }

        if (property_exists($header, 'subject')) {
            $this->subject = imap_utf8($header->subject);
        }
        if (property_exists($header, 'date')) {
            $date = $header->date;

            /**
             * Exception handling for invalid dates
             * Will be extended in the future
             *
             * Currently known invalid formats:
             * ^ Datetime                                   ^ Problem                           ^ Cause                 
             * | Mon, 20 Nov 2017 20:31:31 +0800 (GMT+8:00) | Double timezone specification     | A Windows feature
             * |                                            | and invalid timezone (max 6 char) |
             * | 04 Jan 2018 10:12:47 UT                    | Missing letter "C"                | Unknown
             *
             * Please report any new invalid timestamps to [#45](https://github.com/Webklex/laravel-imap/issues/45)
             */
            try {
                $this->date = Carbon::parse($date);
            } catch(\Exception $e) {
                switch (true) {
                    case preg_match('/([A-Z]{2,3}\,\ [0-9]{1,2}\ [A-Z]{2,3}\ [0-9]{4}\ [0-9]{1,2}\:[0-9]{1,2}\:[0-9]{1,2}\ \+[0-9]{4}\ \([A-Z]{2,3}\+[0-9]{1,2}\:[0-9]{1,2})\)+$/i', $date) > 0:
                        $array = explode('(', $date);
                        $array = array_reverse($array);
                        $date = trim(array_pop($array));
                        break;
                    case preg_match('/([0-9]{1,2}\ [A-Z]{2,3}\ [0-9]{4}\ [0-9]{1,2}\:[0-9]{1,2}\:[0-9]{1,2}\ UT)+$/i', $date) > 0:
                        $date .= 'C';
                        break;
                }
                $this->date = Carbon::parse($date);
            }
        }

        if (property_exists($header, 'from')) {
            $this->from = $this->parseAddresses($header->from);
        }
        if (property_exists($header, 'to')) {
            $this->to = $this->parseAddresses($header->to);
        }
        if (property_exists($header, 'cc')) {
            $this->cc = $this->parseAddresses($header->cc);
        }
        if (property_exists($header, 'bcc')) {
            $this->bcc = $this->parseAddresses($header->bcc);
        }

        if (property_exists($header, 'reply_to')) {
            $this->reply_to = $this->parseAddresses($header->reply_to);
        }
        if (property_exists($header, 'in_reply_to')) {
            $this->in_reply_to = str_replace(['<', '>'], '', $header->in_reply_to);
        }
        if (property_exists($header, 'sender')) {
            $this->sender = $this->parseAddresses($header->sender);
        }

        if (property_exists($header, 'message_id')) {
            $this->message_id = str_replace(['<', '>'], '', $header->message_id);
        }
        if (property_exists($header, 'Msgno')) {
            $this->message_no = ($this->fetch_options == FT_UID) ? trim($header->Msgno) : imap_msgno($this->client->getConnection(), trim($header->Msgno));
            $this->message_no = ($this->fetch_options == FT_UID) ? trim($header->Msgno) : imap_msgno($this->client->getConnection(), /** @scrutinizer ignore-type */ trim($header->Msgno));
        } else{
            $this->message_no = imap_msgno($this->client->getConnection(), $this->getUid());
        }
    }

    /**
     * Get the current Message header info
     *
     * @return object
     */
    public function getHeaderInfo() {
        if ($this->header_info == null) {
            $this->header_info =
            $this->header_info = imap_headerinfo($this->client->getConnection(), $this->getMessageNo()); ;
        }

        return $this->header_info;
    }

    /**
     * Parse Addresses
     *
     * @param $list
     *
     * @return array
     */
    private function parseAddresses($list) {
        $addresses = [];

        foreach ($list as $item) {
            $address = (object) $item;

            if (!property_exists($address, 'mailbox')) {
                $address->mailbox = false;
            }
            if (!property_exists($address, 'host')) {
                $address->host = false;
            }
            if (!property_exists($address, 'personal')) {
                $address->personal = false;
            }

            $address->personal = imap_utf8($address->personal);

            $address->mail = ($address->mailbox && $address->host) ? $address->mailbox.'@'.$address->host : false;
            $address->full = ($address->personal) ? $address->personal.' <'.$address->mail.'>' : $address->mail;
            $address->full = ($address->personal) ? $address->personal.' <'./** @scrutinizer ignore-type */ $address->mail.'>' : $address->mail;

            $addresses[] = $address;
        }

        return $addresses;
    }

    /**
     * Parse the Message body
     *
     * @return $this
     */
    public function parseBody() {
        $structure = imap_fetchstructure($this->client->getConnection(), $this->uid, $this->fetch_options);
        $structure = imap_fetchstructure($this->client->getConnection(), /** @scrutinizer ignore-type */ $this->uid, $this->fetch_options);

        $this->fetchStructure($structure);

        return $this;
    }

    /**
     * Fetch the Message structure
     *
     * @param $structure
     * @param mixed $partNumber
     */
    private function fetchStructure($structure, $partNumber = null) {
        if ($structure->type == self::TYPE_TEXT &&
            ($structure->ifdisposition == 0 ||
                ($structure->ifdisposition == 1 && !isset($structure->parts) && $partNumber == null)
            )
        ) {
            if ($structure->subtype == "PLAIN") {
                if (!$partNumber) {
                    $partNumber = 1;
                }

                $encoding = $this->getEncoding($structure);

                $content = imap_fetchbody($this->client->getConnection(), $this->uid, $partNumber, $this->fetch_options);
                $content = imap_fetchbody($this->client->getConnection(), /** @scrutinizer ignore-type */ $this->uid, $partNumber, $this->fetch_options);
                $content = $this->decodeString($content, $structure->encoding);
                $content = $this->convertEncoding($content, $encoding);

                $body = new \stdClass;
                $body->type = "text";
                $body->content = $content;

                $this->bodies['text'] = $body;

                $this->fetchAttachment($structure, $partNumber);

            } elseif ($structure->subtype == "HTML") {
                if (!$partNumber) {
                    $partNumber = 1;
                }

                $encoding = $this->getEncoding($structure);

                $content = imap_fetchbody($this->client->getConnection(), $this->uid, $partNumber, $this->fetch_options);
                $content = $this->decodeString($content, $structure->encoding);
                $content = $this->convertEncoding($content, $encoding);

                $body = new \stdClass;
                $body->type = "html";
                $body->content = $content;

                $this->bodies['html'] = $body;
            }
        } elseif ($structure->type == self::TYPE_MULTIPART) {
            foreach ($structure->parts as $index => $subStruct) {
                $prefix = "";
                if ($partNumber) {
                    $prefix = $partNumber.".";
                }
                $this->fetchStructure($subStruct, $prefix.($index + 1));
            }
        } else {
            if ($this->fetch_attachment === true) {
                $this->fetchAttachment($structure, $partNumber);
            }
        }
    }

    /**
     * Fetch the Message attachment
     *
     * @param object $structure
     * @param mixed  $partNumber
     */
    protected function fetchAttachment($structure, $partNumber) {

        $oAttachment = new Attachment($this, $structure, $partNumber);

        if ($oAttachment->getName() != null) {

            if ($oAttachment->getId() != null) {

                $this->attachments->put($oAttachment->getId(), $oAttachment);
            } else {
                $this->attachments->push($oAttachment);
            }
        }
    }

    /**
     * Fail proof setter for $fetch_option
     *
     * @param $option
     *
     * @return $this
     */
    public function setFetchOption($option) {
        if (is_long($option) == true) {

            $this->fetch_options = $option;
        } elseif(is_null($option) == true) {

            $config = config('imap.options.fetch', FT_UID);
            $this->fetch_options = is_long($config) ? $config : 1;
        }

        return $this;
    }
    /**
     * Fail proof setter for $fetch_attachment
     *
     * @param $option
     *
     * @return $this
     */
    public function setFetchAttachment($option) {
        if (is_bool($option) == true) {

            $this->fetch_attachment = $option;
        } elseif(is_null($option) == true) {

            $config = config('imap.options.attachments', false);
            $this->fetch_attachment = is_bool($config) ? $config : false;
        }

        return $this;
    }

    /**
     * Decode a given string
     *
     * @param $string
     * @param $encoding
     *
     * @return string
     */
    public function decodeString($string, $encoding) {
        switch ($encoding) {
            case self::ENC_7BIT:
                return $string;
            case self::ENC_8BIT:
                return quoted_printable_decode(imap_8bit($string));
            case self::ENC_BINARY:
                return imap_binary($string);
            case self::ENC_BASE64:
                return imap_base64($string);
            case self::ENC_QUOTED_PRINTABLE:
                return quoted_printable_decode($string);
            case self::ENC_OTHER:
                return $string;
            default:
                return $string;
        }
    }

    /**
     * Convert the encoding
     *
     * @param $str
     * @param string $from
     * @param string $to
     *
     * @return mixed|string
     */
    private function convertEncoding($str, $from = "ISO-8859-2", $to = "UTF-8") {
        if (function_exists('iconv') && $from != 'UTF-7' && $to != 'UTF-7') {
            return iconv($from, $to.'//IGNORE', $str);
        } else {
            if (!$from) {
                return mb_convert_encoding($str, $to);
            }
            return mb_convert_encoding($str, $to, $from);
        }
    }

    /**
     * Get the encoding of a given abject
     *
     * @param object $structure
     *
     * @return null|string
     */
    private function getEncoding($structure) {
        if (property_exists($structure, 'parameters')) {
            foreach ($structure->parameters as $parameter) {
                if (strtolower($parameter->attribute) == "charset") {
                    return strtoupper($parameter->value);
                }
            }
        }
        return null;
    }

    /**
     * Move the Message into an other Folder
     *
     * @param string $mailbox
     *
     * @return bool
     */
    public function moveToFolder($mailbox = 'INBOX') {
        $this->client->createFolder($mailbox);

        if (imap_mail_move($this->client->getConnection(), $this->msglist, $mailbox) == true) {

            return true;
        }
        return false;
    }

    /**
     * Delete the current Message
     *
     * @return bool
     */
    public function delete() {
        $status = imap_delete($this->client->getConnection(), $this->uid, $this->fetch_options);
        $status = imap_delete($this->client->getConnection(), $this->uid, /** @scrutinizer ignore-type */ $this->fetch_options);
        $this->client->expunge();

        return $status;
    }

    /**
     * Restore a deleted Message
     *
     * @return bool
     */
    public function restore() {
        return imap_undelete($this->client->getConnection(), $this->message_no);
        return imap_undelete($this->client->getConnection(), /** @scrutinizer ignore-type */ $this->message_no);
    }

    /**
     * Get all message attachments.
     *
     * @return AttachmentCollection
     */
    public function getAttachments() {
        return $this->attachments;
    }

    /**
     * Set a given flag
     * @param string|array $flag
     *
     * @return bool
     */
    public function setFlag($flag) {
        $flag = "\\".trim(is_array($flag) ? implode(" \\", $flag) : $flag);
        return imap_setflag_full($this->client->getConnection(), $this->getUid(), $flag, SE_UID);
    }

    /**
     * Unset a given flag
     * @param string|array $flag
     *
     * @return bool
     */
    public function unsetFlag($flag) {
        $flag = "\\".trim(is_array($flag) ? implode(" \\", $flag) : $flag);
        return imap_clearflag_full($this->client->getConnection(), $this->getUid(), "\\$flag", SE_UID);
    }

    /**
     * @return null|object|string
     */
    public function getRawBody() {
        if ($this->raw_body == null) {
            $this->raw_body = imap_fetchbody($this->client->getConnection(), $this->getUid(), '');
            $this->raw_body = imap_fetchbody($this->client->getConnection(), /** @scrutinizer ignore-type */ $this->getUid(), '');
        }

        return $this->raw_body;
    }

    /**
     * @return string
     */
    public function getHeader() {
        return $this->header;
    }

    /**
     * @return Client
     */
    public function getClient() {
        return $this->client;
    }

    /**
     * @return string
     */
    public function getUid() {
        return $this->uid;
    }

    /**
     * @return string
     */
    public function getFetchOptions() {
        return $this->fetch_options;
    }

    /**
     * @return int
     */
    public function getMsglist() {
        return $this->msglist;
    }

    /**
     * @return mixed
     */
    public function getMessageId() {
        return $this->message_id;
    }

    /**
     * @return int
     */
    public function getMessageNo() {
        return $this->message_no;

    }

    /**
     * @return string
     */
    public function getSubject() {
        return $this->subject;
    }

    /**
     * @return null
     */
    public function getDate() {
        return $this->date;
    }

    /**
     * @return array
     */
    public function getFrom() {
        return $this->from;
    }

    /**
     * @return array
     */
    public function getTo() {
        return $this->to;
    }

    /**
     * @return array
     */
    public function getCc() {
        return $this->cc;
    }

    /**
     * @return array
     */
    public function getBcc() {
        return $this->bcc;
    }

    /**
     * @return array
     */
    public function getReplyTo() {
        return $this->reply_to;
    }
    
    /**
     * @return string
     */
    public function getInReplyTo() {
        return $this->in_reply_to;
    }

    /**
     * @return array
     */
    public function getSender() {
        return $this->sender;
    }

    /**
     * @return mixed
     */
    public function getBodies() {
        return $this->bodies;
    }
}

Webklex / laravel-imap

Push — master ( 803c46...a0c155 )

Message::getUid() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
