SP\Modules\Web\Controllers\ConfigGeneralController

Complexity

Total Complexity

29

Size/Duplication

Total Lines	257
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
D	saveAction()	0	130	20
A	downloadConfigBackupAction()	0	45	4
A	initialize()	0	12	2
A	downloadLogAction()	0	38	3

<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      https://syspass.org
 * @copyright 2012-2019, Rubén Domínguez nuxsmin@$syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * sysPass is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 *  along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SP\Modules\Web\Controllers;

use Exception;
use RuntimeException;
use SP\Config\ConfigUtil;
use SP\Core\Acl\Acl;
use SP\Core\Acl\UnauthorizedPageException;
use SP\Core\Context\SessionContext;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Core\Exceptions\SessionTimeout;
use SP\Core\Exceptions\SPException;
use SP\Http\JsonResponse;
use SP\Modules\Web\Controllers\Traits\ConfigTrait;
use SP\Services\Config\ConfigBackupService;
use SP\Storage\File\FileHandler;
use SP\Util\Util;

/**
 * Class ConfigGeneral
 *
 * @package SP\Modules\Web\Controllers
 */
final class ConfigGeneralController extends SimpleControllerBase
{
    use ConfigTrait;

    /**
     * saveAction
     *
     * @throws SPException
     */
    public function saveAction()
    {
        $this->checkSecurityToken($this->previousSk, $this->request);

        $configData = $this->config->getConfigData();
        $eventMessage = EventMessage::factory();

        // General
        $siteLang = $this->request->analyzeString('sitelang');
        $siteTheme = $this->request->analyzeString('sitetheme', 'material-blue');
        $sessionTimeout = $this->request->analyzeInt('session_timeout', 300);
        $applicationUrl = $this->request->analyzeString('app_url');
        $httpsEnabled = $this->request->analyzeBool('https_enabled', false);
        $debugEnabled = $this->request->analyzeBool('debug_enabled', false);
        $maintenanceEnabled = $this->request->analyzeBool('maintenance_enabled', false);
        $checkUpdatesEnabled = $this->request->analyzeBool('check_updates_enabled', false);
        $checkNoticesEnabled = $this->request->analyzeBool('check_notices_enabled', false);
        $encryptSessionEnabled = $this->request->analyzeBool('encrypt_session_enabled', false);

        $configData->setSiteLang($siteLang);
        $configData->setSiteTheme($siteTheme);
        $configData->setSessionTimeout($sessionTimeout);
        $configData->setApplicationUrl($applicationUrl);
        $configData->setHttpsEnabled($httpsEnabled);
        $configData->setDebug($debugEnabled);
        $configData->setMaintenance($maintenanceEnabled);
        $configData->setCheckUpdates($checkUpdatesEnabled);
        $configData->setChecknotices($checkNoticesEnabled);
        $configData->setEncryptSession($encryptSessionEnabled);

        // Events
        $logEnabled = $this->request->analyzeBool('log_enabled', false);
        $syslogEnabled = $this->request->analyzeBool('syslog_enabled', false);
        $remoteSyslogEnabled = $this->request->analyzeBool('remotesyslog_enabled', false);
        $syslogServer = $this->request->analyzeString('remotesyslog_server');
        $syslogPort = $this->request->analyzeInt('remotesyslog_port', 0);

        $configData->setLogEnabled($logEnabled);
        $configData->setLogEvents($this->request->analyzeArray('log_events', function ($items) {

It seems like $this->request->analyzeArray('log_events', function(...) { /* ... */ }, array()) can also be of type null; however, parameter $logEvents of SP\Config\ConfigData::setLogEvents() does only seem to accept array, maybe add an additional type check?

            return ConfigUtil::eventsAdapter($items);
        }, []));

        $configData->setSyslogEnabled($syslogEnabled);

        if ($remoteSyslogEnabled) {
            if (!$syslogServer || !$syslogPort) {
                return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('Missing remote syslog parameters'));
            }

            $configData->setSyslogRemoteEnabled(true);
            $configData->setSyslogServer($syslogServer);
            $configData->setSyslogPort($syslogPort);

            if ($configData->isSyslogRemoteEnabled() === false) {
                $eventMessage->addDescription(__u('Remote syslog enabled'));
            }
        } elseif ($remoteSyslogEnabled === false && $configData->isSyslogRemoteEnabled()) {
            $configData->setSyslogRemoteEnabled(false);

            $eventMessage->addDescription(__u('Remote syslog disabled'));
        }

        // Proxy
        $proxyEnabled = $this->request->analyzeBool('proxy_enabled', false);
        $proxyServer = $this->request->analyzeString('proxy_server');
        $proxyPort = $this->request->analyzeInt('proxy_port', 8080);
        $proxyUser = $this->request->analyzeString('proxy_user');
        $proxyPass = $this->request->analyzeEncrypted('proxy_pass');


        // Valores para Proxy
        if ($proxyEnabled && (!$proxyServer || !$proxyPort)) {
            return $this->returnJsonResponse(JsonResponse::JSON_ERROR, __u('Missing Proxy parameters '));
        }

        if ($proxyEnabled) {
            $configData->setProxyEnabled(true);
            $configData->setProxyServer($proxyServer);
            $configData->setProxyPort($proxyPort);
            $configData->setProxyUser($proxyUser);

            if ($proxyPass !== '***') {
                $configData->setProxyPass($proxyPass);
            }

            if ($configData->isProxyEnabled() === false) {
                $eventMessage->addDescription(__u('Proxy enabled'));
            }
        } elseif ($proxyEnabled === false && $configData->isProxyEnabled()) {
            $configData->setProxyEnabled(false);

            $eventMessage->addDescription(__u('Proxy disabled'));
        }

        // Autentificación
        $authBasicEnabled = $this->request->analyzeBool('authbasic_enabled', false);
        $authBasicAutologinEnabled = $this->request->analyzeBool('authbasicautologin_enabled', false);
        $authBasicDomain = $this->request->analyzeString('authbasic_domain');
        $authSsoDefaultGroup = $this->request->analyzeInt('sso_defaultgroup');
        $authSsoDefaultProfile = $this->request->analyzeInt('sso_defaultprofile');

        // Valores para Autentificación
        if ($authBasicEnabled) {
            $configData->setAuthBasicEnabled(true);
            $configData->setAuthBasicAutoLoginEnabled($authBasicAutologinEnabled);
            $configData->setAuthBasicDomain($authBasicDomain);
            $configData->setSsoDefaultGroup($authSsoDefaultGroup);
            $configData->setSsoDefaultProfile($authSsoDefaultProfile);

            if ($configData->isAuthBasicEnabled() === false) {
                $eventMessage->addDescription(__u('Auth Basic enabled'));
            }
        } elseif ($authBasicEnabled === false && $configData->isAuthBasicEnabled()) {
            $configData->setAuthBasicEnabled(false);
            $configData->setAuthBasicAutoLoginEnabled(false);

            $eventMessage->addDescription(__u('Auth Basic disabled'));
        }

        return $this->saveConfig(
            $configData,
            $this->config,
            function () use ($eventMessage, $configData) {
                if ($configData->isMaintenance()) {
                    Util::lockApp($this->session->getUserData()->getId(), 'config');
                }

                $this->eventDispatcher->notifyEvent(
                    'save.config.general',
                    new Event($this, $eventMessage)
                );
            }
        );
    }

    /**
     * @return bool
     * @throws SPException
     */
    public function downloadLogAction()
    {
        $this->checkSecurityToken($this->previousSk, $this->request);

        if ($this->configData->isDemoEnabled()) {
            return __('Ey, this is a DEMO!!');

The expression return __('Ey, this is a DEMO!!') returns the type string which is incompatible with the documented return type boolean.

        }

        try {
            SessionContext::close();

            $file = new FileHandler(LOG_FILE);
            $file->checkFileExists();

            $this->eventDispatcher->notifyEvent('download.logFile',
                new Event($this, EventMessage::factory()
                    ->addDescription(__u('File downloaded'))
                    ->addDetail(__u('File'), str_replace(APP_ROOT, '', $file->getFile())))
            );

            $response = $this->router->response();
            $response->header('Cache-Control', 'max-age=60, must-revalidate');
            $response->header('Content-length', $file->getFileSize());
            $response->header('Content-type', $file->getFileType());
            $response->header('Content-Description', ' sysPass file');
            $response->header('Content-transfer-encoding', 'chunked');
            $response->header('Content-Disposition', 'attachment; filename="' . basename($file->getFile()) . '"');
            $response->header('Set-Cookie', 'fileDownload=true; path=/');
            $response->send();

            $file->readChunked();
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));
        }

        return '';

The expression return '' returns the type string which is incompatible with the documented return type boolean.

    }

    /**
     * @param string $type
     *
     * @return bool
     * @throws SPException
     */
    public function downloadConfigBackupAction($type)
    {
        $this->checkSecurityToken($this->previousSk, $this->request);

        if ($this->configData->isDemoEnabled()) {
            return __('Ey, this is a DEMO!!');

The expression return __('Ey, this is a DEMO!!') returns the type string which is incompatible with the documented return type boolean.

        }

        try {
            $this->eventDispatcher->notifyEvent('download.configBackupFile',
                new Event($this, EventMessage::factory()
                    ->addDescription(__u('File downloaded'))
                    ->addDetail(__u('File'), 'config.json'))
            );

            $configBackupService = $this->dic->get(ConfigBackupService::class);

            switch ($type) {
                case 'json':
                    $data = ConfigBackupService::configToJson($configBackupService->getBackup());
                    break;
                default:
                    throw new RuntimeException('Not implemented');
            }

            $response = $this->router->response();
            $response->header('Cache-Control', 'max-age=60, must-revalidate');
            $response->header('Content-length', strlen($data));
            $response->header('Content-type', 'application/json');
            $response->header('Content-Description', ' sysPass file');
            $response->header('Content-transfer-encoding', 'chunked');
            $response->header('Content-Disposition', 'attachment; filename="config.json"');
            $response->header('Set-Cookie', 'fileDownload=true; path=/');
            $response->header('Content-transfer-encoding', 'binary');
            $response->header('Set-Cookie', 'fileDownload=true; path=/');

            $response->body($data);
            $response->send(true);
        } catch (Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception', new Event($e));
        }

        return '';

The expression return '' returns the type string which is incompatible with the documented return type boolean.

    }

    /**
     * @return bool
     * @throws SessionTimeout
     */
    protected function initialize()
    {
        try {
            $this->checks();
            $this->checkAccess(Acl::CONFIG_GENERAL);
        } catch (UnauthorizedPageException $e) {
            $this->eventDispatcher->notifyEvent('exception', new Event($e));

            return $this->returnJsonResponseException($e);

The expression return $this->returnJsonResponseException($e) returns the type boolean which is incompatible with the return type mandated by SP\Modules\Web\Controllers\SimpleControllerBase::initialize() of void.

        }

        return true;

The expression return true returns the type true which is incompatible with the return type mandated by SP\Modules\Web\Controllers\SimpleControllerBase::initialize() of void.

    }
}