Scanner::run() - Code Metrics - Inspection of "Mail scanner rebuild (support for OAuth2) (#16638..." - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — developer ( 4e3135...f5c82a )

by Radosław

created 2022-11-08 11:43 UTC

Scanner::run() C

↳ Parent: Scanner

Complexity

Conditions	15
Paths	5

Size

Total Lines	45
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	33
dl	0
loc	45
rs	5.9166
c	1
b	0
f	0
cc	15
nc	5
nop	1

How to fix Complexity

<?php
/**
 * Mail scanner file.
 *
 * @package App
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Radosław Skrzypczak <[email protected]>
 */

namespace App\Mail;

/**
 * Mail scanner class.
 */
class Scanner extends \App\Base
{
	/** @var string Base module name */
	public const MODULE_NAME = 'MailAccount';
	/** @var string Name of the scanned folder table */
	public const FOLDER_TABLE = 'u_#__mailscanner_folders';
	/** @var string Logs table name */
	public const LOG_TABLE = 'vtiger_ossmails_logs';

	/** @var \App\Mail\Account */
	private $account;
	/** @var int Limit of scanned e-mails */
	private $limit = 100;
	/** @var int Number of scanned e-mails */
	private $count = 0;
	/** @var ScannerLog Scanner log */
	private $log;

	/**
	 * Constructor.
	 */
	public function __construct()
	{
		$this->log = new ScannerLog();
	}

	/**
	 * Set limit.
	 *
	 * @param int $limit
	 *
	 * @return $this
	 */
	public function setLimit(int $limit)
	{
		$this->limit = $limit;
		return $this;
	}

	/**
	 * Set Mail Account.
	 *
	 * @param Account $account
	 *
	 * @return $this
	 */
	public function setAccount(Account $account)
	{
		$this->account = $account;
		return $this;
	}

	/**
	 * Run scanner.
	 *
	 * @param callable|null $callback Conditions for scanning subsequent emails
	 *
	 * @return void
	 */
	public function run(?callable $callback = null)
	{
		$folders = $this->account->getFolders();
		$actions = $this->account->getActions();
		if ($folders && $actions && ($imap = $this->getImapConnection()) && ($folders = array_intersect($folders, array_keys($imap->getFolders(false))))) {

			$flagSeen = \App\Mail::getConfig('scanner', 'flag_seen');
			foreach ($folders as $folderName) {
				$this->log->start();
				$uid = $this->account->getLastUid($folderName);
				if (!\is_int($uid)) {
					continue;
				}

				$messageCollection = $imap->getMessagesGreaterThanUid($folderName, $uid, $this->limit);
				foreach ($messageCollection as $message) {
					if (!$this->log->isRunning()) {
						return;
					}
					if (($callback && $callback($this))) {
						break 2;
					}
					--$this->limit;
					$messageObject = (new Message\Imap())->setMessage($message);
					try {
						foreach ($actions as $action) {
							$this->getAction($action)->setAccount($this->account)->setMessage($messageObject)->process();
						}
						++$this->count;
						$this->account->setLastUid($messageObject->getMsgUid(), $folderName);
						$this->log->updateCount($this->count);
						if ($flagSeen) {
							$messageObject->setFlag('Seen');
						}
					} catch (\Throwable $th) {
						$message = $th->getMessage();
						\App\Log::error("Mail Scanner - Account: {$this->account->getSource()->getId()}, folder: {$folderName}, UID: {$messageObject->getMsgUid()}, message: " . $message);
						if ($th instanceof \App\Exceptions\AppException) {
							$message = $th->getDisplayMessage();
						}
						$this->log->close(ScannerLog::STATUS_ERROR, $message, $action);

						break;
					}
				}
			}
			$this->log->close();
		}
	}

	/**
	 * Get imap connection.
	 *
	 * @return Connections\Imap|null
	 */
	public function getImapConnection(): ?Connections\Imap
	{
		try {
			$imap = $this->account->openImap();
		} catch (\Throwable $th) {
			$this->account->lock($th->getMessage());
			$imap = null;
		}

		return $imap;
	}

	/**
	 * Get action object.
	 *
	 * @param string $name
	 *
	 * @return ScannerAction\Base
	 */
	public function getAction(string $name): ScannerAction\Base
	{
		$class = "App\\Mail\\ScannerAction\\{$name}";
		return new $class();
	}

	/**
	 * Check if ready.
	 *
	 * @return bool
	 */
	public function isReady(): bool
	{
		return !ScannerLog::isScannRunning();
	}
}


1			<?php
2			/**
3			* Mail scanner file.
4			*
5			* @package App
6			*
7			* @copyright YetiForce S.A.
8			* @license YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
9			* @author Radosław Skrzypczak <[email protected]>
10			*/
11
12			namespace App\Mail;
13
14			/**
15			* Mail scanner class.
16			*/
17			class Scanner extends \App\Base
18			{
19			/** @var string Base module name */
20			public const MODULE_NAME = 'MailAccount';
21			/** @var string Name of the scanned folder table */
22			public const FOLDER_TABLE = 'u_#__mailscanner_folders';
23			/** @var string Logs table name */
24			public const LOG_TABLE = 'vtiger_ossmails_logs';
25
26			/** @var \App\Mail\Account */
27			private $account;
28			/** @var int Limit of scanned e-mails */
29			private $limit = 100;
30			/** @var int Number of scanned e-mails */
31			private $count = 0;
32			/** @var ScannerLog Scanner log */
33			private $log;
34
35			/**
36			* Constructor.
37			*/
38			public function __construct()
39			{
40			$this->log = new ScannerLog();
41			}
42
43			/**
44			* Set limit.
45			*
46			* @param int $limit
47			*
48			* @return $this
49			*/
50			public function setLimit(int $limit)
51			{
52			$this->limit = $limit;
53			return $this;
54			}
55
56			/**
57			* Set Mail Account.
58			*
59			* @param Account $account
60			*
61			* @return $this
62			*/
63			public function setAccount(Account $account)
64			{
65			$this->account = $account;
66			return $this;
67			}
68
69			/**
70			* Run scanner.
71			*
72			* @param callable\|null $callback Conditions for scanning subsequent emails
73			*
74			* @return void
75			*/
76			public function run(?callable $callback = null)
77			{
78			$folders = $this->account->getFolders();
79			$actions = $this->account->getActions();
80			if ($folders && $actions && ($imap = $this->getImapConnection()) && ($folders = array_intersect($folders, array_keys($imap->getFolders(false))))) {
			0 ignored issues – show introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report `$folders` is an empty array, thus is always `false`. Loading history... Bug Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The expression `$folders` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
81			$flagSeen = \App\Mail::getConfig('scanner', 'flag_seen');
82			foreach ($folders as $folderName) {
83			$this->log->start();
84			$uid = $this->account->getLastUid($folderName);
85			if (!\is_int($uid)) {
86			continue;
87			}
88
89			$messageCollection = $imap->getMessagesGreaterThanUid($folderName, $uid, $this->limit);
90			foreach ($messageCollection as $message) {
91			if (!$this->log->isRunning()) {
92			return;
93			}
94			if (($callback && $callback($this))) {
95			break 2;
96			}
97			--$this->limit;
98			$messageObject = (new Message\Imap())->setMessage($message);
99			try {
100			foreach ($actions as $action) {
101			$this->getAction($action)->setAccount($this->account)->setMessage($messageObject)->process();
102			}
103			++$this->count;
104			$this->account->setLastUid($messageObject->getMsgUid(), $folderName);
105			$this->log->updateCount($this->count);
106			if ($flagSeen) {
107			$messageObject->setFlag('Seen');
108			}
109			} catch (\Throwable $th) {
110			$message = $th->getMessage();
111			\App\Log::error("Mail Scanner - Account: {$this->account->getSource()->getId()}, folder: {$folderName}, UID: {$messageObject->getMsgUid()}, message: " . $message);
112			if ($th instanceof \App\Exceptions\AppException) {
113			$message = $th->getDisplayMessage();
114			}
115			$this->log->close(ScannerLog::STATUS_ERROR, $message, $action);
			0 ignored issues – show Comprehensibility Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The variable `$action` does not seem to be defined for all execution paths leading up to this point. Loading history...
116			break;
117			}
118			}
119			}
120			$this->log->close();
121			}
122			}
123
124			/**
125			* Get imap connection.
126			*
127			* @return Connections\Imap\|null
128			*/
129			public function getImapConnection(): ?Connections\Imap
130			{
131			try {
132			$imap = $this->account->openImap();
133			} catch (\Throwable $th) {
134			$this->account->lock($th->getMessage());
135			$imap = null;
136			}
137
138			return $imap;
139			}
140
141			/**
142			* Get action object.
143			*
144			* @param string $name
145			*
146			* @return ScannerAction\Base
147			*/
148			public function getAction(string $name): ScannerAction\Base
149			{
150			$class = "App\\Mail\\ScannerAction\\{$name}";
151			return new $class();
152			}
153
154			/**
155			* Check if ready.
156			*
157			* @return bool
158			*/
159			public function isReady(): bool
160			{
161			return !ScannerLog::isScannRunning();
162			}
163			}
164

YetiForceCompany / YetiForceCRM

Push — developer ( 4e3135...f5c82a )

Scanner::run() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like