Base::findRelatedRecordsByEmail() - 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

Base::findRelatedRecordsByEmail() A

↳ Parent: Base

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0

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

namespace App\Mail\ScannerAction;

/**
 * Base mail scanner action class.
 */
abstract class Base
{
	/** @var int Action priority. */
	public static $priority = 9;

	/** @var string[] Scope of availability. */
	public static $available = ['Users', 'MailAccount'];

	/** @var string Action label */
	protected $label;

	/** @var \App\Mail\Message\Imap Message instance. */
	protected $message;

	/**
	 * Get action name.
	 * Action name | File name.
	 *
	 * @return string
	 */
	public function getName(): string
	{
		return basename(str_replace('\\', '/', static::class));
	}

	/**
	 * Main function to execute action.
	 *
	 * @return void
	 */
	abstract public function process(): void;

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

		return $this;
	}

	public function setMessage(\App\Mail\Message\Base $message)
	{
		$this->message = $message;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
		return $this;
	}

	public function findRelatedRecords(bool $onlyId = false): array
	{
		$ids = $this->findRelatedRecordsByEmail();
		if ($idsBySubject = $this->findRelatedRecordsBySubject()) {
			$ids[] = current($idsBySubject);
		}
		if (!$onlyId) {
			foreach ($ids as &$id) {
				$id = [
					'id' => $id,
					'module' => \App\Record::getType($id),
					'label' => \App\Record::getLabel($id),
				];
			}
		}
		return $ids;
	}

	public function findRelatedRecordsByEmail(): array
	{
		if (!isset($this->message->processData['findByEmail'])) {
			$emails = array_unique(array_merge($this->message->getEmail('from'), $this->message->getEmail('to'), $this->message->getEmail('cc'), $this->message->getEmail('bcc')));
			$this->message->setProcessData('findByEmail', \App\Utils::flatten(\App\Mail\RecordFinder::findByEmail($emails, $this->getEmailsFields())));
		}

		return $this->message->processData['findByEmail'];
	}

	public function findRelatedRecordsBySubject(): array
	{
		if (!isset($this->message->processData['findBySubject'])) {
			$this->message->processData['findBySubject'] = \App\Mail\RecordFinder::findBySubject($this->message->getSubject(), $this->getNumberFields());
		}

		return $this->message->processData['findBySubject'];
	}

	public function getEmailsFields(?string $searchModuleName = null): array
	{
		$cacheKey = $searchModuleName ?? '-';
		if (isset($this->emailsFieldsCache[$cacheKey])) {
			return $this->emailsFieldsCache[$cacheKey];
		}

		$fields = [];
		if ($mailScannerFields = $this->account->getSource()->get('scanner_fields')) {
			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
				$field = explode('|', $field);
				if (($searchModuleName && $searchModuleName !== $field[1]) || !\in_array($field[3], [13, 319])) {
					continue;
				}
				$fields[$field[1]][$field[3]][] = $field[2];
			}
		}
		$this->emailsFieldsCache[$cacheKey] = $fields;


		return $fields;
	}

	public function getNumberFields(?string $searchModuleName = null): array
	{
		$cacheKey = $searchModuleName ?? '-';
		if (isset($this->numberFieldsCache[$cacheKey])) {
			return $this->numberFieldsCache[$cacheKey];
		}

		$fields = [];
		if ($mailScannerFields = $this->account->getSource()->get('scanner_fields')) {
			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
				$field = explode('|', $field);
				if (($searchModuleName && $searchModuleName !== $field[1]) || 4 !== (int) $field[3]) {
					continue;
				}
				$fields[$field[1]][$field[3]][] = $field[2];
			}
		}
		$this->numberFieldsCache[$cacheKey] = $fields;


		return $fields;
	}

	public function checkExceptions(): bool
	{
		$domainExceptions = array_filter(explode(',', $this->account->getSource()->get('domain_exceptions') ?: ''));
		$emailExceptions = array_column(\App\Json::decode($this->account->getSource()->get('email_exceptions') ?: '[]'), 'e');
		if ($domainGlobalExceptions = \App\Mail::getConfig('scanner', 'domain_exceptions')) {
			$domainExceptions = array_merge($domainExceptions, array_filter(explode(',', $domainGlobalExceptions)));
		}
		if ($emailGlobalExceptions = \App\Mail::getConfig('scanner', 'email_exceptions')) {
			$emailExceptions = array_merge(array_column(\App\Json::decode($emailGlobalExceptions), 'e'));
		}
		$mails = (0 === $this->message->getMailType()) ? $this->message->getEmail('to') : $this->message->getEmail('from');

		return $mails && ($domainExceptions || $emailExceptions) && (

			\array_intersect($mails, $emailExceptions)
			|| \array_intersect(array_map(fn ($email) => (substr(strrchr($email, '@'), 1)), $mails), $domainExceptions)
		);
	}
}


1			<?php
2			/**
3			* Base mail scanner action 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 Mariusz Krzaczkowski <[email protected]>
10			* @author Radosław Skrzypczak <[email protected]>
11			*/
12
13			namespace App\Mail\ScannerAction;
14
15			/**
16			* Base mail scanner action class.
17			*/
18			abstract class Base
19			{
20			/** @var int Action priority. */
21			public static $priority = 9;
22
23			/** @var string[] Scope of availability. */
24			public static $available = ['Users', 'MailAccount'];
25
26			/** @var string Action label */
27			protected $label;
28
29			/** @var \App\Mail\Message\Imap Message instance. */
30			protected $message;
31
32			/**
33			* Get action name.
34			* Action name \| File name.
35			*
36			* @return string
37			*/
38			public function getName(): string
39			{
40			return basename(str_replace('\\', '/', static::class));
41			}
42
43			/**
44			* Main function to execute action.
45			*
46			* @return void
47			*/
48			abstract public function process(): void;
49
50			/**
51			* Set mail account.
52			*
53			* @param \App\Mail\Account $account
54			*
55			* @return $this
56			*/
57			public function setAccount(\App\Mail\Account $account)
58			{
59			$this->account = $account;
			0 ignored issues – show Bug Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The property `account` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
60			return $this;
61			}
62
63			public function setMessage(\App\Mail\Message\Base $message)
64			{
65			$this->message = $message;
			0 ignored issues – show Documentation Bug introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report `$message` is of type `App\Mail\Message\Base`, but the property `$message` was declared to be of type `App\Mail\Message\Imap`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
66			return $this;
67			}
68
69			public function findRelatedRecords(bool $onlyId = false): array
70			{
71			$ids = $this->findRelatedRecordsByEmail();
72			if ($idsBySubject = $this->findRelatedRecordsBySubject()) {
73			$ids[] = current($idsBySubject);
74			}
75			if (!$onlyId) {
76			foreach ($ids as &$id) {
77			$id = [
78			'id' => $id,
79			'module' => \App\Record::getType($id),
80			'label' => \App\Record::getLabel($id),
81			];
82			}
83			}
84			return $ids;
85			}
86
87			public function findRelatedRecordsByEmail(): array
88			{
89			if (!isset($this->message->processData['findByEmail'])) {
90			$emails = array_unique(array_merge($this->message->getEmail('from'), $this->message->getEmail('to'), $this->message->getEmail('cc'), $this->message->getEmail('bcc')));
91			$this->message->setProcessData('findByEmail', \App\Utils::flatten(\App\Mail\RecordFinder::findByEmail($emails, $this->getEmailsFields())));
92			}
93
94			return $this->message->processData['findByEmail'];
95			}
96
97			public function findRelatedRecordsBySubject(): array
98			{
99			if (!isset($this->message->processData['findBySubject'])) {
100			$this->message->processData['findBySubject'] = \App\Mail\RecordFinder::findBySubject($this->message->getSubject(), $this->getNumberFields());
101			}
102
103			return $this->message->processData['findBySubject'];
104			}
105
106			public function getEmailsFields(?string $searchModuleName = null): array
107			{
108			$cacheKey = $searchModuleName ?? '-';
109			if (isset($this->emailsFieldsCache[$cacheKey])) {
110			return $this->emailsFieldsCache[$cacheKey];
111			}
112
113			$fields = [];
114			if ($mailScannerFields = $this->account->getSource()->get('scanner_fields')) {
115			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
116			$field = explode('\|', $field);
117			if (($searchModuleName && $searchModuleName !== $field[1]) \|\| !\in_array($field[3], [13, 319])) {
118			continue;
119			}
120			$fields[$field[1]][$field[3]][] = $field[2];
121			}
122			}
123			$this->emailsFieldsCache[$cacheKey] = $fields;
			0 ignored issues – show Bug Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The property `emailsFieldsCache` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
124
125			return $fields;
126			}
127
128			public function getNumberFields(?string $searchModuleName = null): array
129			{
130			$cacheKey = $searchModuleName ?? '-';
131			if (isset($this->numberFieldsCache[$cacheKey])) {
132			return $this->numberFieldsCache[$cacheKey];
133			}
134
135			$fields = [];
136			if ($mailScannerFields = $this->account->getSource()->get('scanner_fields')) {
137			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
138			$field = explode('\|', $field);
139			if (($searchModuleName && $searchModuleName !== $field[1]) \|\| 4 !== (int) $field[3]) {
140			continue;
141			}
142			$fields[$field[1]][$field[3]][] = $field[2];
143			}
144			}
145			$this->numberFieldsCache[$cacheKey] = $fields;
			0 ignored issues – show Bug Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The property `numberFieldsCache` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
146
147			return $fields;
148			}
149
150			public function checkExceptions(): bool
151			{
152			$domainExceptions = array_filter(explode(',', $this->account->getSource()->get('domain_exceptions') ?: ''));
153			$emailExceptions = array_column(\App\Json::decode($this->account->getSource()->get('email_exceptions') ?: '[]'), 'e');
154			if ($domainGlobalExceptions = \App\Mail::getConfig('scanner', 'domain_exceptions')) {
155			$domainExceptions = array_merge($domainExceptions, array_filter(explode(',', $domainGlobalExceptions)));
156			}
157			if ($emailGlobalExceptions = \App\Mail::getConfig('scanner', 'email_exceptions')) {
158			$emailExceptions = array_merge(array_column(\App\Json::decode($emailGlobalExceptions), 'e'));
159			}
160			$mails = (0 === $this->message->getMailType()) ? $this->message->getEmail('to') : $this->message->getEmail('from');
161
162			return $mails && ($domainExceptions \|\| $emailExceptions) && (
			0 ignored issues – show Bug Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The expression `$mails` 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... Bug Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The expression `$emailExceptions` 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... Bug Best Practice introduced 2022-11-08 10:35 UTC by Report Bug Copy Issue Report The expression `$domainExceptions` 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...
163			\array_intersect($mails, $emailExceptions)
164			\|\| \array_intersect(array_map(fn ($email) => (substr(strrchr($email, '@'), 1)), $mails), $domainExceptions)
165			);
166			}
167			}
168

YetiForceCompany / YetiForceCRM

Push — developer ( 4e3135...f5c82a )

Base::findRelatedRecordsByEmail() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like