getProSupport() - Code Metrics - Inspection of "Admin: Remove notification modal about Official pr..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 3da7f5...514a9d )

by Yannick
created 2024-03-29 12:42 UTC
getProSupport() A

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines	20
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	2
eloc	10
c	1
b	0
f	1
nc	2
nop	0
dl	0
loc	20
rs	9.9332
<?php

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

use Chamilo\CoreBundle\Entity\BranchSync;
use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CoreBundle\Repository\BranchSyncRepository;
use GuzzleHttp\Client;
use League\Flysystem\Filesystem;

require_once __DIR__.'/../global.inc.php';

api_protect_admin_script();

$action = isset($_REQUEST['a']) ? $_REQUEST['a'] : null;

switch ($action) {
    case 'update_changeable_setting':
        $url_id = api_get_current_access_url_id();

        if (api_is_global_platform_admin() && 1 == $url_id) {
            if (isset($_GET['id']) && !empty($_GET['id'])) {
                $params = ['variable = ? ' => [$_GET['id']]];
                $data = api_get_settings_params($params);
                if (!empty($data)) {
                    foreach ($data as $item) {
                        $params = ['id' => $item['id'], 'access_url_changeable' => $_GET['changeable']];
                        api_set_setting_simple($params);
                    }
                }
                echo '1';
            }
        }
        break;
    case 'version':
        // Fix session block when loading admin/index.php and changing page
        session_write_close();
        echo version_check();
        break;
    case 'get_extra_content':
        $blockName = isset($_POST['block']) ? Security::remove_XSS($_POST['block']) : null;

        if (empty($blockName)) {
            exit;
        }

        /** @var Filesystem $fileSystem */
        $fileSystem = Container::$container->get('home_filesystem');
        $dir = 'admin/';

        if (api_is_multiple_url_enabled()) {
            $accessUrlId = api_get_current_access_url_id();

            if (-1 != $accessUrlId) {
                $urlInfo = api_get_access_url($accessUrlId);
                $url = api_remove_trailing_slash(preg_replace('/https?:\/\//i', '', $urlInfo['url']));
                $cleanUrl = str_replace('/', '-', $url);
                $dir = "$cleanUrl/admin/";
            }
        }

        $filePath = $dir.$blockName.'_extra.html';

        if ($fileSystem->has($filePath)) {
            echo $fileSystem->read($dir.$blockName.'_extra.html');
        }

        break;
    case 'get_latest_news':
        try {
            $latestNews = getLatestNews();
            $latestNews = json_decode($latestNews, true);

            echo Security::remove_XSS($latestNews['text'], COURSEMANAGER);
            break;
        } catch (Exception $e) {
            break;
        }
    case 'get_support':
        try {
            $latestNews = getProSupport();
            $latestNews = json_decode($latestNews, true);

            echo Security::remove_XSS($latestNews['text'], COURSEMANAGER);
            break;
        } catch (Exception $e) {
            break;
        }
}

/**
 * Displays either the text for the registration or the message that the installation is (not) up to date.
 *
 * @return string html code
 *
 * @author Patrick Cool <[email protected]>, Ghent University
 *
 * @version august 2006
 *
 * @todo have a 6 monthly re-registration
 */
function version_check()
{
    $tbl_settings = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
    $sql = 'SELECT selected_value FROM '.$tbl_settings.' WHERE variable = "registered" ';
    $result = Database::query($sql);
    $row = Database::fetch_assoc($result);

    // The site has not been registered yet.
    $return = '';
    if ('false' == $row['selected_value']) {
        check_system_version();
    } else {
        // site not registered. Call anyway
        $return .= check_system_version();
    }

    return $return;
}

/**
 * Check if the current installation is up to date
 * The code is borrowed from phpBB and slighlty modified.
 *
 * @throws \Exception
 * @throws \InvalidArgumentException
 *
 * @return string language string with some layout (color)
 */
function check_system_version()
{
    // Check if curl is available.
    if (!in_array('curl', get_loaded_extensions())) {
        return '<span style="color:red">'.
            get_lang('Impossible to contact the version server right now. Please try again later.').'</span>';
    }

    $url = 'https://version.chamilo.org';
    $options = [
        'verify' => false,
    ];

    $urlValidated = false;

    try {
        $client = new GuzzleHttp\Client();
        $res = $client->request('GET', $url, $options);
        if ('200' == $res->getStatusCode() || '301' == $res->getStatusCode()) {
            $urlValidated = true;
        }
    } catch (Exception $e) {

    }

    // the chamilo version of your installation
    $system_version = '';
    $versionStatus = '';
    $versionFile =__DIR__.'/../../install/version.php';
    if (is_file($versionFile)) {
        $versionDetails = include($versionFile);
        $system_version = trim($versionDetails['new_version']);
        if (!empty($versionDetails['new_version_status']) &&  $versionDetails['new_version_status'] != 'stable') {
            $versionStatus = ' ('.$versionDetails['new_version_status'].')';
        }
    }

    if ($urlValidated) {
        // The number of courses
        $number_of_courses = Statistics::countCourses();

        // The number of users
        $number_of_users = Statistics::countUsers();
        $number_of_active_users = Statistics::countUsers(
            null,
            null,
            true,
            true
        );

        // The number of sessions
        $number_of_sessions = SessionManager::count_sessions(api_get_current_access_url_id());
        $packager = api_get_setting('platform.packager');
        if (empty($packager)) {
            $packager = 'chamilo';
        }

        $uniqueId = '';
        $entityManager = Database::getManager();
        /** @var BranchSyncRepository $repository */
        $repository = $entityManager->getRepository(BranchSync::class);
        /** @var BranchSync $branch */
        $branch = $repository->getTopBranch();
        if (is_a($branch, BranchSync::class)) {
            $uniqueId = $branch->getUniqueId();
        }

        $data = [
            'url' => api_get_path(WEB_PATH),
            'campus' => api_get_setting('siteName'),
            'contact' => api_get_setting('emailAdministrator'), // the admin's e-mail, with the only purpose of being able to contact admins to inform about critical security issues
            'version' => $system_version,
            'numberofcourses' => $number_of_courses, // to sum up into non-personal statistics - see https://version.chamilo.org/stats/
            'numberofusers' => $number_of_users, // to sum up into non-personal statistics
            'numberofactiveusers' => $number_of_active_users, // to sum up into non-personal statistics
            'numberofsessions' => $number_of_sessions,
            //The donotlistcampus setting recovery should be improved to make
            // it true by default - this does not affect numbers counting
            'donotlistcampus' => api_get_setting('donotlistcampus'),
            'organisation' => api_get_setting('Institution'),
            'language' => api_get_setting('platformLanguage'), //helps us know the spread of language usage for campuses, by main language
            'adminname' => api_get_setting('administratorName').' '.api_get_setting('administratorSurname'), //not sure this is necessary...
            'adminname' => api_get_setting('administratorName').' './** @scrutinizer ignore-type */ api_get_setting('administratorSurname'), //not sure this is necessary...
            'ip' => $_SERVER['REMOTE_ADDR'], //the admin's IP address, with the only purpose of trying to geolocate portals around the globe to draw a map
            // Reference to the packager system or provider through which
            // Chamilo is installed/downloaded. Packagers can change this in
            // the default config file (main/install/configuration.dist.php)
            // or in the installed config file. The default value is 'chamilo'
            'packager' => $packager,
            'unique_id' => $uniqueId,
        ];

        $version = null;
        $client = new GuzzleHttp\Client();
        $url .= '?';
        foreach ($data as $k => $v) {
            $url .= urlencode($k).'='.urlencode($v).'&';
        }
        $res = $client->request('GET', $url, $options);
        if ('200' == $res->getStatusCode()) {
            $versionData = $res->getHeader('X-Chamilo-Version');
            if (isset($versionData[0])) {
                $version = trim($versionData[0]);
            }
        }

        if (version_compare($system_version, $version, '<')) {
            $output = '<span style="color:red">'.
                get_lang('Your version is not up-to-date').'<br />'.
                get_lang('The latest version is').' <b>Chamilo '.$version.'</b>.  <br />'.
                get_lang('Your version is').' <b>Chamilo '.$system_version.$versionStatus.'</b>.  <br />'.
                str_replace(
                    'https://chamilo.org/download',
                    '<a href="https://chamilo.org/download">https://chamilo.org/download</a>',
                    get_lang('Please visit our website: https://chamilo.org/download')
                ).
                '</span>';
        } else {
            $output = '<span style="color:green">'.
                get_lang('Your version is up-to-date').'<br />'.
                get_lang('The latest version is').' <b>Chamilo '.$version.'</b>.  <br />'.
                get_lang('Your version is').' <b>Chamilo '.$system_version.$versionStatus.'</b>.  <br />'.
                '</span>';
        }

        return $output;
    }

    return '<span style="color:red">'.
        get_lang('Impossible to contact the version server right now. Please try again later.').'</span>';
}

/**
 * Display the latest news from the Chamilo Association for admins.
 *
 * @throws \GuzzleHttp\Exception\GuzzleException
 * @throws Exception
 *
 * @return string|void
 */
function getLatestNews()
{
    $url = 'https://version.chamilo.org/news/latest.php';

    $client = new Client();
    $response = $client->request(
        'GET',
        $url,
        [
            'query' => [
                'language' => api_get_language_isocode(),
            ],
        ]
    );

    if (200 !== $response->getStatusCode()) {
        throw new Exception(get_lang('Deny access'));
    }

    return $response->getBody()->getContents();
}

/**
 * Display the latest support services block.
 *
 * @throws \GuzzleHttp\Exception\GuzzleException
 * @throws Exception
 *
 * @return string|void
 */
function getProSupport()
{
    $url = 'https://version.chamilo.org/support/latest.php';

    $client = new Client();
    $response = $client->request(
        'GET',
        $url,
        [
            'query' => [
                'language' => api_get_language_isocode(),
            ],
        ]
    );

    if (200 !== $response->getStatusCode()) {
        throw new Exception(get_lang('Deny access'));
    }

    return $response->getBody()->getContents();
}

chamilo / chamilo-lms

Push — master ( 3da7f5...514a9d )

getProSupport() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
