Mail::getTemplateList() - Code Metrics - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Mail::getTemplateList() A
last analyzed 2024-09-13 12:00 UTC

↳ Parent: Mail

Complexity

Conditions	4
Paths	8

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
eloc	9
dl	0
loc	14
ccs	0
cts	8
cp	0
rs	9.9666
c	0
b	0
f	0
cc	4
nc	8
nop	4
crap	20

<?php

namespace App;

/**
 * Mail basic class.
 *
 * @package App
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <[email protected]>
 * @author    Radosław Skrzypczak <[email protected]>
 */
class Mail
{
	/**
	 * Get smtp server by id.
	 *
	 * @param int $smtpId
	 *
	 * @return array
	 */
	public static function getSmtpById(int $smtpId): array
	{
		if (Cache::has('SmtpServer', $smtpId)) {
			return Cache::get('SmtpServer', $smtpId);
		}
		$servers = static::getAll();
		$smtp = [];
		if (isset($servers[$smtpId])) {
			$smtp = $servers[$smtpId];
		}
		Cache::save('SmtpServer', $smtpId, $smtp, Cache::LONG);

		return $smtp;
	}

	/**
	 * Get a list of all smtp servers.
	 *
	 * @return array
	 */
	public static function getAll()
	{
		if (Cache::has('SmtpServers', 'all')) {
			return Cache::get('SmtpServers', 'all');
		}
		$all = (new Db\Query())->from('s_#__mail_smtp')->indexBy('id')->all(Db::getInstance('admin'));
		Cache::save('SmtpServers', 'all', $all, Cache::LONG);

		return $all;
	}

	/**
	 * Get default smtp Id.
	 *
	 * @return int
	 */
	public static function getDefaultSmtp()
	{
		if (Cache::has('DefaultSmtp', '')) {
			return Cache::get('DefaultSmtp', '');
		}
		$id = (new Db\Query())->select(['id'])->from('s_#__mail_smtp')->where(['default' => 1])->scalar(Db::getInstance('admin'));
		if (!$id) {
			$id = (new Db\Query())->select(['id'])->from('s_#__mail_smtp')->limit(1)->scalar(Db::getInstance('admin'));
		}
		Cache::save('DefaultSmtp', '', $id, Cache::LONG);

		return $id;

	}

	/**
	 * Get template list for module.
	 *
	 * @param string   $moduleName
	 * @param string   $type
	 * @param bool     $hideSystem
	 * @param int|null $userId
	 *
	 * @return array
	 */
	public static function getTemplateList(string $moduleName = '', string $type = '', bool $hideSystem = true, ?int $userId = null)
	{
		$queryGenerator = new \App\QueryGenerator('EmailTemplates', $userId ?? \App\User::getCurrentUserId());
		$queryGenerator->setFields(['id', 'name', 'module_name']);
		if ($moduleName) {
			$queryGenerator->addCondition('module_name', $moduleName, 'e');
		}
		if ($type) {
			$queryGenerator->addCondition('email_template_type', $type, 'e');
		}
		if ($hideSystem) {
			$queryGenerator->addNativeCondition(['u_#__emailtemplates.sys_name' => [null, '']]);
		}
		return $queryGenerator->createQuery()->all();
	}

	/**
	 * Get mail template.
	 *
	 * @param int|string $id
	 * @param bool       $attachments
	 *
	 * @return array
	 */
	public static function getTemplate($id, bool $attachments = true): array
	{
		if (!is_numeric($id)) {
			$id = self::getTemplateIdFromSysName($id);
		}
		if (!$id || !\App\Record::isExists($id, 'EmailTemplates')) {
			return [];
		}
		$template = \Vtiger_Record_Model::getInstanceById($id, 'EmailTemplates');
		if (!$attachments) {
			return $template->getData();
		}
		return array_merge(
			$template->getData(), static::getAttachmentsFromTemplate($template->getId())
		);
	}

	/**
	 * Get template ID.
	 *
	 * @param string $name
	 *
	 * @return int|null
	 */
	public static function getTemplateIdFromSysName(string $name): ?int
	{
		$cacheName = 'TemplateIdFromSysName';
		if (Cache::has($cacheName, '')) {
			$templates = Cache::get($cacheName, '');
		} else {
			$queryGenerator = new \App\QueryGenerator('EmailTemplates');
			$queryGenerator->setFields(['id']);
			$queryGenerator->permissions = false;
			$queryGenerator->addNativeCondition(['not', ['sys_name' => null]]);
			$templates = $queryGenerator->createQuery()->select(['sys_name', 'emailtemplatesid'])->createCommand()->queryAllByGroup();
			Cache::save($cacheName, '', $templates, Cache::LONG);
		}
		return $templates[$name] ?? null;
	}

	/**
	 * Get attachments email template.
	 *
	 * @param int|string $id
	 *
	 * @return array
	 */
	public static function getAttachmentsFromTemplate($id)
	{
		if (Cache::has('MailAttachmentsFromTemplete', $id)) {
			return Cache::get('MailAttachmentsFromTemplete', $id);
		}
		$ids = (new \App\Db\Query())->select(['u_#__documents_emailtemplates.crmid'])->from('u_#__documents_emailtemplates')
			->innerJoin('vtiger_crmentity', 'u_#__documents_emailtemplates.relcrmid = vtiger_crmentity.crmid')
			->where(['vtiger_crmentity.deleted' => 0, 'u_#__documents_emailtemplates.relcrmid' => $id])->column();
		$attachments = [];
		if ($ids) {
			$attachments['attachments'] = ['ids' => $ids];
		}
		Cache::save('MailAttachmentsFromTemplete', $id, $attachments, Cache::LONG);
		return $attachments;
	}

	/**
	 * Get attachments from document.
	 *
	 * @param int|int[] $ids
	 * @param mixed     $returnOnlyName
	 *
	 * @return array
	 */
	public static function getAttachmentsFromDocument($ids, $returnOnlyName = true)
	{
		$cacheId = "$returnOnlyName|" . \is_array($ids) ? implode(',', $ids) : $ids;
		if (Cache::has('MailAttachmentsFromDocument', $cacheId)) {
			return Cache::get('MailAttachmentsFromDocument', $cacheId);
		}
		$query = (new \App\Db\Query())->select(['vtiger_attachments.*'])->from('vtiger_attachments')
			->innerJoin('vtiger_seattachmentsrel', 'vtiger_attachments.attachmentsid = vtiger_seattachmentsrel.attachmentsid')
			->where(['vtiger_seattachmentsrel.crmid' => $ids]);
		$attachments = [];
		$dataReader = $query->createCommand()->query();
		while ($row = $dataReader->read()) {
			$filePath = realpath(ROOT_DIRECTORY . \DIRECTORY_SEPARATOR . $row['path'] . $row['attachmentsid']);
			if (is_file($filePath)) {
				$attachments[$filePath] = $returnOnlyName ? Purifier::decodeHtml($row['name']) : $row;
			}
		}
		Cache::save('MailAttachmentsFromDocument', $cacheId, $attachments, Cache::LONG);
		return $attachments;
	}

	/**
	 * Check if the user has access to the mail client.
	 *
	 * @return bool
	 */
	public static function checkMailClient(): bool
	{
		if (Cache::staticHas('MailCheckMailClient')) {
			return Cache::staticGet('MailCheckMailClient');
		}
		$return = \Config\Main::$isActiveSendingMails && \App\Privilege::isPermitted('OSSMail');
filter:
    dependency_paths: ["lib/*"]
		Cache::staticSave('MailCheckMailClient', '', $return);
		return $return;
	}

	/**
	 * Check if the user has access to the internal mail client.
	 *
	 * @return bool
	 */
	public static function checkInternalMailClient(): bool
	{
		if (Cache::staticHas('MailCheckInternalMailClient')) {
			return Cache::staticGet('MailCheckInternalMailClient');
		}
		$return = self::checkMailClient() && 1 === (int) \App\User::getCurrentUserModel()->getDetail('internal_mailer') && file_exists(ROOT_DIRECTORY . '/public_html/modules/OSSMail/roundcube/');
		Cache::staticSave('MailCheckInternalMailClient', '', $return);
		return $return;
	}
}


1		<?php
2
3		namespace App;
4
5		/**
6		* Mail basic class.
7		*
8		* @package App
9		*
10		* @copyright YetiForce S.A.
11		* @license YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
12		* @author Mariusz Krzaczkowski <[email protected]>
13		* @author Radosław Skrzypczak <[email protected]>
14		*/
15		class Mail
16		{
17		/**
18		* Get smtp server by id.
19		*
20		* @param int $smtpId
21		*
22		* @return array
23		*/
24		public static function getSmtpById(int $smtpId): array
25		{
26		if (Cache::has('SmtpServer', $smtpId)) {
27		return Cache::get('SmtpServer', $smtpId);
28		}
29		$servers = static::getAll();
30		$smtp = [];
31		if (isset($servers[$smtpId])) {
32		$smtp = $servers[$smtpId];
33		}
34		Cache::save('SmtpServer', $smtpId, $smtp, Cache::LONG);
35
36		return $smtp;
37		}
38
39		/**
40		* Get a list of all smtp servers.
41		*
42		* @return array
43		*/
44		public static function getAll()
45		{
46		if (Cache::has('SmtpServers', 'all')) {
47		return Cache::get('SmtpServers', 'all');
48		}
49		$all = (new Db\Query())->from('s_#__mail_smtp')->indexBy('id')->all(Db::getInstance('admin'));
50		Cache::save('SmtpServers', 'all', $all, Cache::LONG);
51
52		return $all;
53		}
54
55		/**
56		* Get default smtp Id.
57	1	*
58		* @return int
59	1	*/
60		public static function getDefaultSmtp()
61		{
62	1	if (Cache::has('DefaultSmtp', '')) {
63	1	return Cache::get('DefaultSmtp', '');
64	1	}
65		$id = (new Db\Query())->select(['id'])->from('s_#__mail_smtp')->where(['default' => 1])->scalar(Db::getInstance('admin'));
66	1	if (!$id) {
67		$id = (new Db\Query())->select(['id'])->from('s_#__mail_smtp')->limit(1)->scalar(Db::getInstance('admin'));
68	1	}
69		Cache::save('DefaultSmtp', '', $id, Cache::LONG);
70
71		return $id;
		0 ignored issues – show Bug Best Practice introduced 2021-04-24 21:59 UTC by Report Bug Copy Issue Report The expression `return $id` also could return the type `false\|string` which is incompatible with the documented return type `integer`. Loading history...
72		}
73
74		/**
75		* Get template list for module.
76		*
77		* @param string $moduleName
78		* @param string $type
79		* @param bool $hideSystem
80		* @param int\|null $userId
81		*
82		* @return array
83		*/
84		public static function getTemplateList(string $moduleName = '', string $type = '', bool $hideSystem = true, ?int $userId = null)
85		{
86		$queryGenerator = new \App\QueryGenerator('EmailTemplates', $userId ?? \App\User::getCurrentUserId());
87		$queryGenerator->setFields(['id', 'name', 'module_name']);
88		if ($moduleName) {
89		$queryGenerator->addCondition('module_name', $moduleName, 'e');
90		}
91		if ($type) {
92		$queryGenerator->addCondition('email_template_type', $type, 'e');
93		}
94		if ($hideSystem) {
95		$queryGenerator->addNativeCondition(['u_#__emailtemplates.sys_name' => [null, '']]);
96		}
97		return $queryGenerator->createQuery()->all();
98		}
99
100		/**
101		* Get mail template.
102		*
103		* @param int\|string $id
104		* @param bool $attachments
105	1	*
106		* @return array
107	1	*/
108	1	public static function getTemplate($id, bool $attachments = true): array
109		{
110	1	if (!is_numeric($id)) {
111	1	$id = self::getTemplateIdFromSysName($id);
112	1	}
113		if (!$id \|\| !\App\Record::isExists($id, 'EmailTemplates')) {
114		return [];
115		}
116		$template = \Vtiger_Record_Model::getInstanceById($id, 'EmailTemplates');
117		if (!$attachments) {
118		return $template->getData();
119		}
120		return array_merge(
121		$template->getData(), static::getAttachmentsFromTemplate($template->getId())
122		);
123	1	}
124
125	1	/**
126	1	* Get template ID.
127		*
128		* @param string $name
129	1	*
130	1	* @return int\|null
131	1	*/
132	1	public static function getTemplateIdFromSysName(string $name): ?int
133	1	{
134	1	$cacheName = 'TemplateIdFromSysName';
135		if (Cache::has($cacheName, '')) {
136	1	$templates = Cache::get($cacheName, '');
137		} else {
138		$queryGenerator = new \App\QueryGenerator('EmailTemplates');
139		$queryGenerator->setFields(['id']);
140		$queryGenerator->permissions = false;
141		$queryGenerator->addNativeCondition(['not', ['sys_name' => null]]);
142		$templates = $queryGenerator->createQuery()->select(['sys_name', 'emailtemplatesid'])->createCommand()->queryAllByGroup();
143		Cache::save($cacheName, '', $templates, Cache::LONG);
144		}
145		return $templates[$name] ?? null;
146	1	}
147
148	1	/**
149		* Get attachments email template.
150		*
151	1	* @param int\|string $id
152	1	*
153	1	* @return array
154	1	*/
155	1	public static function getAttachmentsFromTemplate($id)
156		{
157		if (Cache::has('MailAttachmentsFromTemplete', $id)) {
158	1	return Cache::get('MailAttachmentsFromTemplete', $id);
159		}
160	1	$ids = (new \App\Db\Query())->select(['u_#__documents_emailtemplates.crmid'])->from('u_#__documents_emailtemplates')
161		->innerJoin('vtiger_crmentity', 'u_#__documents_emailtemplates.relcrmid = vtiger_crmentity.crmid')
162		->where(['vtiger_crmentity.deleted' => 0, 'u_#__documents_emailtemplates.relcrmid' => $id])->column();
163		$attachments = [];
164		if ($ids) {
165		$attachments['attachments'] = ['ids' => $ids];
166		}
167		Cache::save('MailAttachmentsFromTemplete', $id, $attachments, Cache::LONG);
168		return $attachments;
169		}
170
171		/**
172		* Get attachments from document.
173		*
174		* @param int\|int[] $ids
175		* @param mixed $returnOnlyName
176		*
177		* @return array
178		*/
179		public static function getAttachmentsFromDocument($ids, $returnOnlyName = true)
180		{
181		$cacheId = "$returnOnlyName\|" . \is_array($ids) ? implode(',', $ids) : $ids;
182		if (Cache::has('MailAttachmentsFromDocument', $cacheId)) {
183		return Cache::get('MailAttachmentsFromDocument', $cacheId);
184		}
185		$query = (new \App\Db\Query())->select(['vtiger_attachments.*'])->from('vtiger_attachments')
186		->innerJoin('vtiger_seattachmentsrel', 'vtiger_attachments.attachmentsid = vtiger_seattachmentsrel.attachmentsid')
187		->where(['vtiger_seattachmentsrel.crmid' => $ids]);
188		$attachments = [];
189		$dataReader = $query->createCommand()->query();
190		while ($row = $dataReader->read()) {
191		$filePath = realpath(ROOT_DIRECTORY . \DIRECTORY_SEPARATOR . $row['path'] . $row['attachmentsid']);
192		if (is_file($filePath)) {
193		$attachments[$filePath] = $returnOnlyName ? Purifier::decodeHtml($row['name']) : $row;
194		}
195		}
196		Cache::save('MailAttachmentsFromDocument', $cacheId, $attachments, Cache::LONG);
197		return $attachments;
198		}
199
200		/**
201		* Check if the user has access to the mail client.
202		*
203		* @return bool
204		*/
205		public static function checkMailClient(): bool
206		{
207		if (Cache::staticHas('MailCheckMailClient')) {
208		return Cache::staticGet('MailCheckMailClient');
209		}
210		$return = \Config\Main::$isActiveSendingMails && \App\Privilege::isPermitted('OSSMail');
		0 ignored issues – show Bug introduced 2022-05-20 08:14 UTC by Report Bug Copy Issue Report The type `Config\Main` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
211		Cache::staticSave('MailCheckMailClient', '', $return);
212		return $return;
213		}
214
215		/**
216		* Check if the user has access to the internal mail client.
217		*
218		* @return bool
219		*/
220		public static function checkInternalMailClient(): bool
221		{
222		if (Cache::staticHas('MailCheckInternalMailClient')) {
223		return Cache::staticGet('MailCheckInternalMailClient');
224		}
225		$return = self::checkMailClient() && 1 === (int) \App\User::getCurrentUserModel()->getDetail('internal_mailer') && file_exists(ROOT_DIRECTORY . '/public_html/modules/OSSMail/roundcube/');
226		Cache::staticSave('MailCheckInternalMailClient', '', $return);
227		return $return;
228		}
229		}
230

YetiForceCompany / YetiForceCRM

Mail::getTemplateList() A last analyzed 2024-09-13 12:00 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Mail::getTemplateList() A
last analyzed 2024-09-13 12:00 UTC