Connection::searchMessages() - Code Metrics - Inspection of "IMAP client added: manage folders, get raw message..." - kakserpom/phpdaemon - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#259)

unknown
created 2016-05-26 09:36 UTC
Connection::searchMessages() A

↳ Parent: Connection
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	1
eloc	3
c	1
b	0
f	1
nc	1
nop	2
dl	0
loc	5
rs	9.4285
<?php

namespace PHPDaemon\Clients\IMAP;

use PHPDaemon\Network\ClientConnection;
use PHPDaemon\Core\Daemon;

class Connection extends ClientConnection
{
    const STATE_CONNECTING  = 0;
    const STATE_CONNECTED   = 1;
    const STATE_CREDS_SENT  = 2;
    const STATE_AUTHORIZED  = 3;

    const FLAG_PASSED       = '\Passed';
    const FLAG_ANSWERED     = '\Answered';
    const FLAG_SEEN         = '\Seen';
    const FLAG_UNSEEN       = '\Unseen';
    const FLAG_DELETED      = '\Deleted';
    const FLAG_DRAFT        = '\Draft';
    const FLAG_FLAGGED      = '\Flagged';

    /**
     * IMAP flags to search criteria
     * @var array
     */
    protected $searchFlags = [
        '\Recent'   => 'RECENT',
        '\Answered' => 'ANSWERED',
        '\Seen'     => 'SEEN',
        '\Unseen'   => 'UNSEEN',
        '\Deleted'  => 'DELETED',
        '\Draft'    => 'DRAFT',
        '\Flagged'  => 'FLAGGED',
    ];

    const TAG_LOGIN         = 'a01';
    const TAG_LIST          = 'a02';
    const TAG_SELECT        = 'a03';
    const TAG_FETCH         = 'a04';
    const TAG_SEARCH        = 'a05';
    const TAG_COUNT         = 'a06';
    const TAG_SIZE          = 'a07';
    const TAG_GETRAWMESSAGE = 'a08';
    const TAG_GETRAWHEADER  = 'a09';
    const TAG_GETRAWCONTENT = 'a10';
    const TAG_GETUID        = 'a11';
    const TAG_CREATEFOLDER  = 'a12';
    const TAG_DELETEFOLDER  = 'a13';
    const TAG_RENAMEFOLDER  = 'a14';
    const TAG_STORE         = 'a15';
    const TAG_DELETEMESSAGE = 'a16';
    const TAG_EXPUNGE       = 'a17';
    const TAG_LOGOUT        = 'a18';
    const TAG_STARTTLS      = 'a19';

    public $eventList = [
        self::TAG_LOGIN         => 'onauth',
        self::TAG_LIST          => 'onlist',
        self::TAG_SELECT        => 'onselect',
        self::TAG_FETCH         => 'onfetch',
        self::TAG_SEARCH        => 'onsearch',
        self::TAG_COUNT         => 'oncount',
        self::TAG_SIZE          => 'onsize',
        self::TAG_GETRAWMESSAGE => 'onrawmessage',
        self::TAG_GETRAWHEADER  => 'onrawheader',
        self::TAG_GETRAWCONTENT => 'onrawcontent',
        self::TAG_GETUID        => 'ongetuid',
        self::TAG_CREATEFOLDER  => 'oncreatefolder',
        self::TAG_DELETEFOLDER  => 'ondeletefolder',
        self::TAG_RENAMEFOLDER  => 'onrenamefolder',
        self::TAG_STORE         => 'onstore',
        self::TAG_DELETEMESSAGE => 'ondeletemessage',
        self::TAG_EXPUNGE       => 'onexpunge',
        self::TAG_LOGOUT        => 'onlogout',
        self::TAG_STARTTLS      => 'onstarttls'
    ];

    protected $state;
    protected $lines = [];
    protected $blob = '';
    protected $blobOctetsLeft = 0;

    protected $bevConnectEnabled = false;

    public function onReady()
    {
        $this->state = self::STATE_CONNECTING;
    }

    /**
     * escape a single literal
     * @param  $string
     * @return string escaped list for imap
     */
    private function escapeString($string)
    {
        return '"' . str_replace(['\\', '"'], ['\\\\', '\\"'], $string) . '"';
    }

    /**
     * escape a list with literals or lists
     *
     * @param  array $list list with literals or lists as PHP array
     * @return string escaped list for imap
     */
    private function escapeList($list)
    {
        $result = [];
        foreach ($list as $v) {
            if (!is_array($v)) {
                $result[] = $v;
                continue;
            }
            $result[] = $this->escapeList($v);
        }
        return '(' . implode(' ', $result) . ')';
    }

    /**
     * split a given line in tokens. a token is literal of any form or a list
     *
     * @param  string $line line to decode
     * @return array tokens, literals are returned as string, lists as array
     */
    protected function decodeLine($line)
    {
        $tokens = [];
        $stack = [];
        /*

            We start to decode the response here. The understood tokens are:
                literal
                "literal" or also "lit\\er\"al"
                (literals*)
            All tokens are returned in an array. Literals in braces (the last understood
            token in the list) are returned as an array of tokens. I.e. the following response:
                "foo" baz bar ("f\\\"oo" bar)
            would be returned as:
                array('foo', 'baz', 'bar', array('f\\\"oo', 'bar'));
        */
        //  replace any trailing <NL> including spaces with a single space
        $line = rtrim($line) . ' ';
        while (($pos = strpos($line, ' ')) !== false) {
            $token = substr($line, 0, $pos);
            if (!strlen($token)) {
                continue;
            }
            while ($token[0] == '(') {
                array_push($stack, $tokens);
                $tokens = [];
                $token = substr($token, 1);
            }
            if ($token[0] == '"') {
                if (preg_match('%^\(*"((.|\\\\|\\")*?)" *%', $line, $matches)) {
                    $tokens[] = $matches[1];
                    $line = substr($line, strlen($matches[0]));
                    continue;
                }
            }
            if ($stack && $token[strlen($token) - 1] == ')') {

                // closing braces are not separated by spaces, so we need to count them
                $braces = strlen($token);
                $token = rtrim($token, ')');
                // only count braces if more than one
                $braces -= strlen($token) + 1;
                // only add if token had more than just closing braces
                if (rtrim($token) != '') {
                    $tokens[] = rtrim($token);
                }
                $token = $tokens;
                $tokens = array_pop($stack);
                // special handline if more than one closing brace
                while ($braces-- > 0) {
                    $tokens[] = $token;
                    $token = $tokens;
                    $tokens = array_pop($stack);
                }
            }
            $tokens[] = $token;
            $line = substr($line, $pos + 1);
        }
        // maybe the server forgot to send some closing braces
        while ($stack) {

            $child = $tokens;
            $tokens = array_pop($stack);
            $tokens[] = $child;
        }
        return $tokens;
    }

    /**
     * @param array $lines
     */
    protected function decodeLines($lines)
    {
        $tokenArray = [];
        foreach ($lines as $line) {
            $tokenArray[] = $this->decodeLine($line);
        }
        return $tokenArray;
    }

    /**
      * @param array $items
      * @param string $from
      * @param string $to

      * @param bool $uid
      * @param string $tag
     */
    public function fetch($items, $from, $to = null, $uid = false, $tag = self::TAG_FETCH)
    {
        if (is_array($from)) {
            $set = implode(',', $from);
        } elseif ($to === null) {
            $set = (int) $from;
        } elseif ($to === INF) {
            $set = (int) $from . ':*';
        } else {
            $set = (int) $from . ':' . (int) $to;
        }
        $query = $tag .($uid ? ' UID' : '')." FETCH $set ". $this->escapeList((array)$items) ."\r\n";
        $this->write($query);
    }

    /**
     * @param array $flags
     * @param string $from
     * @param string $to

     * @param string $mode (+/-)

     * @param bool $silent
     * @param string $tag
    */
    public function store(array $flags, $from, $to = null, $mode = null, $silent = true, $tag = self::TAG_STORE)
    {
        $item = 'FLAGS';
        if ($mode == '+' || $mode == '-') {
            $item = $mode . $item;
        }
        if ($silent) {
            $item .= '.SILENT';
        }
        $flags = $this->escapeList($flags);
        $set = (int)$from;
        if ($to !== null) {
            $set .= ':' . ($to == INF ? '*' : (int)$to);
        }
        $query = $tag . ' UID STORE ' . $set . ' ' . $item . ' ' . $flags ."\r\n";
        $this->write($query);
    }

    /**
    * @param string $reference
    * @param string $mailbox
    */
    public function listFolders($reference = '', $mailbox = '*')
    {
        $query = self::TAG_LIST .' LIST ' . $this->escapeString($reference)
            . ' ' .  $this->escapeString($mailbox) . "\r\n";
        $this->write($query);
    }

    /**
    * @param string $box
    */
    public function selectBox($box = 'INBOX')
    {
        $query = self::TAG_SELECT .' SELECT ' . $this->escapeString($box) . "\r\n";
        $this->write($query);
    }

    /**
    * @param string $tag
    */
    public function expunge($tag = self::TAG_EXPUNGE)
    {
        $query = $tag .' EXPUNGE' . "\r\n";
        $this->write($query);
    }

    /**
    * @param string $haystack
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
    * @param string $needle
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
    */
    public function auth($login, $password)
    {
        $this->write(self::TAG_LOGIN . " LOGIN $login $password\r\n");
    }

    /**
     * @param array $params
     * @param string $tag
     */
    public function searchMessages($params, $tag = self::TAG_SEARCH)
    {
        $query = "$tag UID SEARCH ".implode(' ', $params)."\r\n";
        $this->write($query);
    }

    /**
     * @param string $haystack
     * @param string $needle
     */
    protected function startsWith($haystack, $needle)
    {
        // search backwards starting from haystack length characters from the end
        return $needle === "" || strrpos($haystack, $needle, -strlen($haystack)) !== false;
    }

    /**
     * @param array $lines
     */
    protected function decodeList($lines)
    {
        $list = [];
        foreach ($this->decodeLines($lines) as $tokens) {
            $folderEntry = [];
            if (empty($tokens[0]) || $tokens[0] !== 'LIST') {
                continue;
            }
            if (!empty($tokens[3])) {
                $folderEntry['name'] = $tokens[3];
            } else {
                continue;
            }
            if (!empty($tokens[1])) {
                $folderEntry['flags'] = $tokens[1];
            } else {
                continue;
            }
            $list[] = $folderEntry;
        }
        return $list;
    }

    /**
     * @param array $lines
     */
    protected function decodeCount($lines)
    {
        foreach ($this->decodeLines($lines) as $tokens) {
            if (empty($tokens[0]) || $tokens[0] !== 'SEARCH') {
                continue;
            }
            return count($tokens) - 1;
        }
        return 0;
    }

    /**
     * @param array $lines
     */
    protected function decodeGetUniqueId($lines)
    {
        $uids = [];
        foreach ($this->decodeLines($lines) as $tokens) {
            //Daemon::log(print_r($tokens, true));

            if (empty($tokens[1]) || $tokens[1] !== 'FETCH') {
                continue;
            }
            if (empty($tokens[2][0]) || $tokens[2][0] !== 'UID') {

                continue;
            }
            if (empty($tokens[0]) || empty($tokens[2][1])) {
                continue;
            }
            $uids[$tokens[0]] = $tokens[2][1];
        }
        return $uids;
    }

    /*
     * @param array $lines
     */
    protected function decodeSize($lines)
    {
        $sizes = [];
        foreach ($this->decodeLines($lines) as $tokens) {
            if (empty($tokens[1]) || $tokens[1] !== 'FETCH') {
                continue;
            }
            if (empty($tokens[2][0]) || $tokens[2][0] !== 'UID') {

                continue;
            }
            if (empty($tokens[2][2]) || $tokens[2][2] !== 'RFC822.SIZE') {

                continue;
            }
            if (empty($tokens[2][1]) || empty($tokens[2][3])) {
                continue;
            }
            $sizes[$tokens[2][1]] = $tokens[2][3];
        }
        return $sizes;
    }

    /**
     *
     * @param string    $tag response tag
     * @param string    $type OK, NO, BAD
     * @param string    $line last response line
     * @param array     $lines full response
     * @param string    $blob
     */
    protected function onCommand($tag, $type, $line, $lines, $blob)
    {
        $ok = $type === 'OK';
        $no = $type === 'NO';
        if ($type === 'BAD') {
            Daemon::log("Server said: " . $line);
        }
        $raw = ['lines' => $lines, 'blob' => $blob];
        switch ($tag) {
            case self::TAG_LOGIN:
                if ($ok) {
                    $this->state = self::STATE_AUTHORIZED;
                    $this->event($this->eventList[$tag], $line);
                } elseif ($no) {
                    Daemon::log("Failed to login: " . $line);
                    $this->finish();
                }
                break;

            case self::TAG_LIST:
                $this->event($this->eventList[$tag], $ok, $this->decodeList($lines));
                break;

            case self::TAG_GETUID:
                $this->event($this->eventList[$tag], $ok, $this->decodeGetUniqueId($lines));
                break;

            case self::TAG_COUNT:
                $this->event($this->eventList[$tag], $ok, $this->decodeCount($lines));
                break;

            case self::TAG_SIZE:
                $this->event($this->eventList[$tag], $ok, $this->decodeSize($lines));
                break;

            case self::TAG_DELETEMESSAGE:
                $this->expunge();
                break;

            case self::TAG_EXPUNGE:
                $this->event('onremovemessage', count($lines) - 1, $raw);
                break;

            case self::TAG_GETRAWMESSAGE:
                $this->event($this->eventList[$tag], !empty($blob), $raw);
                break;

            case self::TAG_GETRAWHEADER:
                $this->event($this->eventList[$tag], !empty($blob), $raw);
                break;

            case self::TAG_GETRAWCONTENT:
                $this->event($this->eventList[$tag], !empty($blob), $raw);
                break;

            default:
                if (isset($this->eventList[$tag])) {
                    $this->event($this->eventList[$tag], $ok, $raw);
                }
                break;
        }
    }

    public function onRead()
    {
        while (($rawLine = $this->readLine(\EventBuffer::EOL_CRLF_STRICT)) !== null) {
            //Daemon::log("RAWLINE: #" . $rawLine . '#');

            if ($this->blobOctetsLeft > 0) {
                $this->blob .= $rawLine . "\r\n";
                $this->blobOctetsLeft -= strlen($rawLine) + 2;
                continue;
            }
            if (preg_match('~\{([0-9]+)\}$~', $rawLine, $matches)) {
                $this->blob = '';
                $this->blobOctetsLeft = $matches[1];
$answer = 42;

$correct = false;

$correct = (bool) $answer;
            }
            @list($tag, $line) = @explode(' ', $rawLine, 2);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            @list($type, $restLine) = @explode(' ', $line, 2);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

            if ($this->state == self::STATE_CONNECTING) {
                if ($this->startsWith($rawLine, '* OK')) {
                    $this->state = self::STATE_CONNECTED;
                    $this->connected = true;
                } else {
                    Daemon::log("IMAP hello failed");
                    $this->finish();
                    return;
                }
                if ($this->onConnected) {
                    $this->onConnected->executeAll($this->connected ? $this : false);
                    $this->onConnected = null;
                }
                return;
            } elseif ($this->state != self::STATE_CONNECTING) {
                if ($tag === '*') {
                    $this->lines[] = $line;
                    continue;
                }
                if (!in_array($type, ['OK', 'BAD', 'NO'])) {
                    $this->lines[] = $rawLine;
                    continue;
                }
                $this->lines[] = $line;
                $this->onCommand($tag, $type, $line, $this->lines, $this->blob);
                $this->lines = [];
            }
        }
    }

    /**
     * Count messages all messages in current box
     * @param null $flags
     */
    public function countMessages($flags = null)
    {
        if ($flags === null) {
            $this->searchMessages(['ALL'], self::TAG_COUNT);
            return;
        }

        $params = [];
        foreach ((array) $flags as $flag) {
            if (isset($this->searchFlags[$flag])) {
                $params[] = $this->searchFlags[$flag];
            } else {
                $params[] = 'KEYWORD';
                $params[] = $this->escapeString($flag);
            }
        }

        $this->searchMessages($params, self::TAG_COUNT);
    }

    /**
     * get a list of messages with number and size
     * @param int $uid number of message
     */
    public function getSize($uid = 0)

    {
        if ($uid) {
            $this->fetch('RFC822.SIZE', $uid, null, true, self::TAG_SIZE);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $this->fetch('RFC822.SIZE', 1, INF, true, self::TAG_SIZE);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    /**
     * Fetch a message
     * @param int $uid unique number of message
     */
    public function getRawMessage($uid, $byUid = true)
    {
        $this->fetch(['FLAGS', 'BODY[]'], $uid, null, $byUid, self::TAG_GETRAWMESSAGE);
    }

    /*
     * Get raw header of message or part
     * @param  int  $uid unique number of message
     */
    public function getRawHeader($uid, $byUid = true)
    {
        $this->fetch(['FLAGS', 'RFC822.HEADER'], $uid, null, $byUid, self::TAG_GETRAWHEADER);
    }

    /*
     * Get raw content of message or part
     *
     * @param  int $uid   number of message
     */
    public function getRawContent($uid, $byUid = true)
    {
        $this->fetch(['FLAGS', 'RFC822.TEXT'], $uid, null, $byUid, self::TAG_GETRAWCONTENT);
    }

    /**
     * get unique id for one or all messages
     *
     * @param int|null $id message number
     */
    public function getUniqueId($id = null)

    {
        if ($id) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $this->fetch('UID', $id, null, false, self::TAG_GETUID);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $this->fetch('UID', 1, INF, false, self::TAG_GETUID);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    /**
     * create a new folder (and parent folders if needed)
     *
     * @param string $folder folder name
     * @return bool success

     */
    public function createFolder($folder, $parentFolder = null)
    {
        if ($parentFolder) {
            $folder =  $parentFolder . '/' . $folder ;
        }
        $query = self::TAG_CREATEFOLDER . " CREATE ".$this->escapeString($folder)."\r\n";
        $this->write($query);
    }

    /**
     * remove a folder
     *
     * @param  string $name name or instance of folder
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function removeFolder($folder)
    {
        $query = self::TAG_DELETEFOLDER . " DELETE ".$this->escapeString($folder)."\r\n";
        $this->write($query);
    }

    /**
     * rename and/or move folder
     * @param  string $oldName name or instance of folder
     * @param  string $newName new global name of folder
     */
    public function renameFolder($oldName, $newName)
    {
        $query = self::TAG_RENAMEFOLDER . " RENAME "
            .$this->escapeString($oldName)." ".$this->escapeString($newName)."\r\n";
        $this->write($query);
    }

    /**
     * Remove a message from server.
     * @param  int $uid unique number of message
     */
    public function removeMessage($uid)
    {
        $this->store([self::FLAG_DELETED], $uid, null, '+', true, self::TAG_DELETEMESSAGE);
    }

    /**
     * logout of imap server
     */
    public function logout()
    {
        $query = self::TAG_LOGOUT . " LOGOUT\r\n";
        $this->write($query);
    }

    public function onFinish()
    {
        $this->onResponse->executeAll(false);
        parent::onFinish();
    }
}

1			<?php
2
3			namespace PHPDaemon\Clients\IMAP;
4
5			use PHPDaemon\Network\ClientConnection;
6			use PHPDaemon\Core\Daemon;
7
8			class Connection extends ClientConnection
9			{
10			const STATE_CONNECTING = 0;
11			const STATE_CONNECTED = 1;
12			const STATE_CREDS_SENT = 2;
13			const STATE_AUTHORIZED = 3;
14
15			const FLAG_PASSED = '\Passed';
16			const FLAG_ANSWERED = '\Answered';
17			const FLAG_SEEN = '\Seen';
18			const FLAG_UNSEEN = '\Unseen';
19			const FLAG_DELETED = '\Deleted';
20			const FLAG_DRAFT = '\Draft';
21			const FLAG_FLAGGED = '\Flagged';
22
23			/**
24			* IMAP flags to search criteria
25			* @var array
26			*/
27			protected $searchFlags = [
28			'\Recent' => 'RECENT',
29			'\Answered' => 'ANSWERED',
30			'\Seen' => 'SEEN',
31			'\Unseen' => 'UNSEEN',
32			'\Deleted' => 'DELETED',
33			'\Draft' => 'DRAFT',
34			'\Flagged' => 'FLAGGED',
35			];
36
37			const TAG_LOGIN = 'a01';
38			const TAG_LIST = 'a02';
39			const TAG_SELECT = 'a03';
40			const TAG_FETCH = 'a04';
kakserpom / phpdaemon

Pull Request — master (#259)

Connection::searchMessages() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
