Version20250707212800::migrateMailConf() - Code Metrics - Inspection of "Mail: Use mailer DSN as setting" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6495)

by Angel Fernando Quiroz

created 2025-07-22 17:52 UTC

Version20250707212800::migrateMailConf() B

↳ Parent: Version20250707212800

Complexity

Conditions	8
Paths	9

Size

Total Lines	64
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	8
eloc	45
c	2
b	0
f	0
nc	9
nop	1
dl	0
loc	64
rs	7.9555

How to fix Long Method

<?php

/* For licensing terms, see /license.txt */

declare(strict_types=1);

namespace Chamilo\CoreBundle\Migrations\Schema\V200;

use Chamilo\CoreBundle\Migrations\AbstractMigrationChamilo;
use Doctrine\DBAL\Schema\Schema;

use const FILE_IGNORE_NEW_LINES;
use const PHP_EOL;

final class Version20250707212800 extends AbstractMigrationChamilo
{
    public function getDescription(): string
    {
        return 'Migrate settings from mail.conf.php to settings';
    }

    public function up(Schema $schema): void
    {
        $updateRootPath = $this->getUpdateRootPath();
        $oldMailConfPath = $updateRootPath.'/app/config/mail.conf.php';

        $envSettings = $this->migrateMailConf($oldMailConfPath);

        if (!empty($envSettings)) {
            $this->updateEnvFiles($envSettings);
        }
    }

    private function migrateMailConf(string $oldMailConfPath): array
    {
        if (!file_exists($oldMailConfPath)) {
            return [];
        }

        include $oldMailConfPath;

        global $platform_email;

        $mailerScheme = 'null';
        $query = '';

        if (!empty($smtpSecure)) {

            $mailerScheme = 'smtp';

            if ($smtpSecure === 'ssl') {
                $mailerScheme = 'smtps';
            } elseif ($smtpSecure === 'tls') {

                $query = '?encryption=tls';
            }
        }

        $dsn = sprintf(
            '%s://%s%s@%s:%s%s',
            $mailerScheme,
            !empty($platform_email['SMTP_AUTH']) ? ($platform_email['SMTP_USER'] ?? '') : '',
            !empty($platform_email['SMTP_AUTH']) ? ':'.($platform_email['SMTP_PASS'] ?? '') : '',
            $platform_email['SMTP_HOST'] ?? '',
            $platform_email['SMTP_PORT'] ?? '',
            $query
        );

        $dkim = [
            'enable' => $platform_email['DKIM'] ?? false,
            'selector' => $platform_email['DKIM_SELECTOR'] ?? '',
            'domain' => $platform_email['DKIM_DOMAIN'] ?? '',
            'private_key_string' => $platform_email['DKIM_PRIVATE_KEY_STRING'] ?? '',
            'private_key' => $platform_email['DKIM_PRIVATE_KEY'] ?? '',
            'passphrase' => $platform_email['DKIM_PASSPHRASE'] ?? '',
        ];

        $xoauth2 = [
            'method' => $platform_email['XOAUTH2_METHOD'] ?? false,
            'url_authorize' => $platform_email['XOAUTH2_URL_AUTHORIZE'] ?? '',
            'url_access_token' => $platform_email['XOAUTH2_URL_ACCES_TOKEN'] ?? '',
            'url_resource_owner_details' => $platform_email['XOAUTH2_URL_RESOURCE_OWNER_DETAILS'] ?? '',
            'scopes' => $platform_email['XOAUTH2_SCOPES'] ?? '',
            'client_id' => $platform_email['XOAUTH2_CLIENT_ID'] ?? '',
            'client_secret' => $platform_email['XOAUTH2_CLIENT_SECRET'] ?? '',
            'refresh_token' => $platform_email['XOAUTH2_REFRESH_TOKEN'] ?? '',
        ];

        // SMTP_UNIQUE_SENDER intentionally ignored as requested.

        return [
            'mailer_from_email' => $platform_email['SMTP_FROM_EMAIL'] ?? '',
            'mailer_from_name' => $platform_email['SMTP_FROM_NAME'] ?? '',
            'mailer_dsn' => $dsn,
            'mailer_mails_charset' => $platform_email['SMTP_CHARSET'] ?? 'UTF-8',
            'mailer_debug_enable' => !empty($platform_email['SMTP_DEBUG']) ? 'true' : 'false',
            'mailer_exclude_json' => $platform_email['EXCLUDE_JSON'] ?? false,
            'mailer_dkim' => json_encode($dkim),
            'mailer_xoauth2' => json_encode($xoauth2),
        ];
    }

    private function updateEnvFiles(array $envSettings): void
    {
        foreach ($envSettings as $variable => $value) {
            $this->addSql(
                sprintf(
                    "UPDATE settings SET selected_value = '%s' WHERE variable = '%s' AND category = 'mail'",
                    $value,
                    $variable
                )
            );
        }
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			declare(strict_types=1);
6
7			namespace Chamilo\CoreBundle\Migrations\Schema\V200;
8
9			use Chamilo\CoreBundle\Migrations\AbstractMigrationChamilo;
10			use Doctrine\DBAL\Schema\Schema;
11
12			use const FILE_IGNORE_NEW_LINES;
13			use const PHP_EOL;
14
15			final class Version20250707212800 extends AbstractMigrationChamilo
16			{
17			public function getDescription(): string
18			{
19			return 'Migrate settings from mail.conf.php to settings';
20			}
21
22			public function up(Schema $schema): void
23			{
24			$updateRootPath = $this->getUpdateRootPath();
25			$oldMailConfPath = $updateRootPath.'/app/config/mail.conf.php';
26
27			$envSettings = $this->migrateMailConf($oldMailConfPath);
28
29			if (!empty($envSettings)) {
30			$this->updateEnvFiles($envSettings);
31			}
32			}
33
34			private function migrateMailConf(string $oldMailConfPath): array
35			{
36			if (!file_exists($oldMailConfPath)) {
37			return [];
38			}
39
40			include $oldMailConfPath;
41
42			global $platform_email;
43
44			$mailerScheme = 'null';
45			$query = '';
46
47			if (!empty($smtpSecure)) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2025-07-22 17:59 UTC by Report Bug Copy Issue Report The variable `$smtpSecure` seems to never exist and therefore `empty` should always be `true`. Loading history...
48			$mailerScheme = 'smtp';
49
50			if ($smtpSecure === 'ssl') {
51			$mailerScheme = 'smtps';
52			} elseif ($smtpSecure === 'tls') {
			0 ignored issues – show Comprehensibility Best Practice introduced 2025-07-22 17:59 UTC by Report Bug Copy Issue Report The variable `$smtpSecure` seems to be never defined. Loading history...
53			$query = '?encryption=tls';
54			}
55			}
56
57			$dsn = sprintf(
58			'%s://%s%s@%s:%s%s',
59			$mailerScheme,
60			!empty($platform_email['SMTP_AUTH']) ? ($platform_email['SMTP_USER'] ?? '') : '',
61			!empty($platform_email['SMTP_AUTH']) ? ':'.($platform_email['SMTP_PASS'] ?? '') : '',
62			$platform_email['SMTP_HOST'] ?? '',
63			$platform_email['SMTP_PORT'] ?? '',
64			$query
65			);
66
67			$dkim = [
68			'enable' => $platform_email['DKIM'] ?? false,
69			'selector' => $platform_email['DKIM_SELECTOR'] ?? '',
70			'domain' => $platform_email['DKIM_DOMAIN'] ?? '',
71			'private_key_string' => $platform_email['DKIM_PRIVATE_KEY_STRING'] ?? '',
72			'private_key' => $platform_email['DKIM_PRIVATE_KEY'] ?? '',
73			'passphrase' => $platform_email['DKIM_PASSPHRASE'] ?? '',
74			];
75
76			$xoauth2 = [
77			'method' => $platform_email['XOAUTH2_METHOD'] ?? false,
78			'url_authorize' => $platform_email['XOAUTH2_URL_AUTHORIZE'] ?? '',
79			'url_access_token' => $platform_email['XOAUTH2_URL_ACCES_TOKEN'] ?? '',
80			'url_resource_owner_details' => $platform_email['XOAUTH2_URL_RESOURCE_OWNER_DETAILS'] ?? '',
81			'scopes' => $platform_email['XOAUTH2_SCOPES'] ?? '',
82			'client_id' => $platform_email['XOAUTH2_CLIENT_ID'] ?? '',
83			'client_secret' => $platform_email['XOAUTH2_CLIENT_SECRET'] ?? '',
84			'refresh_token' => $platform_email['XOAUTH2_REFRESH_TOKEN'] ?? '',
85			];
86
87			// SMTP_UNIQUE_SENDER intentionally ignored as requested.
88
89			return [
90			'mailer_from_email' => $platform_email['SMTP_FROM_EMAIL'] ?? '',
91			'mailer_from_name' => $platform_email['SMTP_FROM_NAME'] ?? '',
92			'mailer_dsn' => $dsn,
93			'mailer_mails_charset' => $platform_email['SMTP_CHARSET'] ?? 'UTF-8',
94			'mailer_debug_enable' => !empty($platform_email['SMTP_DEBUG']) ? 'true' : 'false',
95			'mailer_exclude_json' => $platform_email['EXCLUDE_JSON'] ?? false,
96			'mailer_dkim' => json_encode($dkim),
97			'mailer_xoauth2' => json_encode($xoauth2),
98			];
99			}
100
101			private function updateEnvFiles(array $envSettings): void
102			{
103			foreach ($envSettings as $variable => $value) {
104			$this->addSql(
105			sprintf(
106			"UPDATE settings SET selected_value = '%s' WHERE variable = '%s' AND category = 'mail'",
107			$value,
108			$variable
109			)
110			);
111			}
112			}
113			}
114

chamilo / chamilo-lms

Pull Request — master (#6495)

Version20250707212800::migrateMailConf() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like