SilverStripe\Dev\Install\InstallConfig

Complexity

Total Complexity

44

Size/Duplication

Total Lines	257
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getTheme()	0	7	2
B	alreadyInstalled()	0	16	5
A	canSendStats()	0	3	1
B	getFrameworkVersion()	0	16	6
A	getConfigPath()	0	3	1
A	getDatabaseClass()	0	14	4
A	getEnvPath()	0	3	1
A	getLocales()	0	59	1
C	getDatabaseConfig()	0	30	15
B	getAdminConfig()	0	15	8

<?php

namespace SilverStripe\Dev\Install;

use SilverStripe\Core\Environment;

/**
 * Provides environment settings from the current request + environment
 *
 * @skipUpgrade
 */
class InstallConfig
{
    /**
     * List of preferred DB classes in order
     *
     * @var array
     */
    protected $preferredDatabases = [
        'MySQLPDODatabase',
        'MySQLDatabase',
    ];

    /**
     * Get database config from the current environment
     *
     * @param array $request Request object
     * @param array $databaseClasses Supported database config
     * @param bool $realPassword Set to true to get the real password. If false, any non-posted
     * password will be redacted as '********'. Note: Posted passwords are considered disclosed and
     * never redacted.
     * @return array
     */
    public function getDatabaseConfig($request, $databaseClasses, $realPassword = true)
    {
        // Get config from request
        if (isset($request['db']['type'])) {
            $type = $request['db']['type'];
            if (isset($request['db'][$type])) {
                $config = $request['db'][$type];
                // The posted placeholder must be substituted with the real password
                if (isset($config['password']) && $config['password'] === Installer::PASSWORD_PLACEHOLDER) {
                    $config['password'] = Environment::getEnv('SS_DATABASE_PASSWORD') ?: '';
                }
                return array_merge([ 'type' => $type ], $config);
            }
        }

        // Guess database config
        return [
            'type' => $this->getDatabaseClass($databaseClasses),
            'server' => Environment::getEnv('SS_DATABASE_SERVER') ?: 'localhost',
            'username' => Environment::getEnv('SS_DATABASE_USERNAME') ?: 'root',
            'password' => $realPassword
                ? (Environment::getEnv('SS_DATABASE_PASSWORD') ?: '')
                : Installer::PASSWORD_PLACEHOLDER, // Avoid password disclosure
            'database' => Environment::getEnv('SS_DATABASE_NAME') ?: 'SS_mysite',
            'path' => Environment::getEnv('SS_DATABASE_PATH')
                ?: Environment::getEnv('SS_SQLITE_DATABASE_PATH') // sqlite compat
                ?: null,
            'key' => Environment::getEnv('SS_DATABASE_KEY')
                ?: Environment::getEnv('SS_SQLITE_DATABASE_KEY') // sqlite compat
                ?: null,
        ];
    }

    /**
     * Get admin config from the environment
     *
     * @param array $request
     * @param bool $realPassword Set to true to get the real password. If false, any non-posted
     * password will be redacted as '********'. Note: Posted passwords are considered disclosed and
     * never redacted.
     * @return array
     */
    public function getAdminConfig($request, $realPassword = true)
    {
        if (isset($request['admin'])) {
            $config = $request['admin'];
            if (isset($config['password']) && $config['password'] === Installer::PASSWORD_PLACEHOLDER) {
                $config['password'] = Environment::getEnv('SS_DEFAULT_ADMIN_PASSWORD') ?: '';
            }
            return $request['admin'];
        }

        return [
            'username' => Environment::getEnv('SS_DEFAULT_ADMIN_USERNAME') ?: 'admin',
            'password' => $realPassword
                ? (Environment::getEnv('SS_DEFAULT_ADMIN_PASSWORD') ?: '')
                : Installer::PASSWORD_PLACEHOLDER, // Avoid password disclosure
        ];
    }

    /**
     * Check if this site has already been installed
     *
     * @return bool
     */
    public function alreadyInstalled()
    {
        if (file_exists($this->getEnvPath())) {
            return true;
        }
        if (!file_exists($this->getConfigPath())) {
            return false;
        }
        $configContents = file_get_contents($this->getConfigPath());
        if (strstr($configContents, '$databaseConfig')) {

It seems like $configContents can also be of type false; however, parameter $haystack of strstr() does only seem to accept string, maybe add an additional type check?

            return true;
        }
        if (strstr($configContents, '$database')) {
            return true;
        }
        return false;
    }

    /**
     * @return string
     */
    protected function getConfigPath()
    {
        return BASE_PATH . '/mysite/_config.php';
    }

    /**
     * @return string
     */
    protected function getEnvPath()
    {
        return BASE_PATH . '/.env';
    }

    /**
     * Database configs available for configuration
     *
     * @param array $databaseClasses
     * @return string
     */
    protected function getDatabaseClass($databaseClasses)
    {
        $envDatabase = Environment::getEnv('SS_DATABASE_CLASS');
        if ($envDatabase) {
            return $envDatabase;
        }

        // Check supported versions
        foreach ($this->preferredDatabases as $candidate) {
            if (!empty($databaseClasses[$candidate]['supported'])) {
                return $candidate;
            }
        }
        return null;
    }

    /**
     * Get string representation of the framework version
     *
     * @return string
     */
    public function getFrameworkVersion()
    {
        $composerLockPath = BASE_PATH . '/composer.lock';
        if (!file_exists($composerLockPath)) {
            return 'unknown';
        }
        $lockData = json_decode(file_get_contents($composerLockPath), true);

It seems like file_get_contents($composerLockPath) can also be of type false; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

        if (json_last_error() || empty($lockData['packages'])) {
            return 'unknown';
        }
        foreach ($lockData['packages'] as $package) {
            if ($package['name'] === 'silverstripe/framework') {
                return $package['version'];
            }
        }
        return 'unknown';
    }

    /**
     * Check if stats should be sent
     *
     * @param array $request
     * @return bool
     */
    public function canSendStats($request)
    {
        return !empty($request['stats']);
    }

    /**
     * Get configured locales
     *
     * @return array
     */
    public function getLocales()
    {
        return [
            'af_ZA' => 'Afrikaans (South Africa)',
            'ar_EG' => 'Arabic (Egypt)',
            'hy_AM' => 'Armenian (Armenia)',
            'ast_ES' => 'Asturian (Spain)',
            'az_AZ' => 'Azerbaijani (Azerbaijan)',
            'bs_BA' => 'Bosnian (Bosnia and Herzegovina)',
            'bg_BG' => 'Bulgarian (Bulgaria)',
            'ca_ES' => 'Catalan (Spain)',
            'zh_CN' => 'Chinese (China)',
            'zh_TW' => 'Chinese (Taiwan)',
            'hr_HR' => 'Croatian (Croatia)',
            'cs_CZ' => 'Czech (Czech Republic)',
            'da_DK' => 'Danish (Denmark)',
            'nl_NL' => 'Dutch (Netherlands)',
            'en_GB' => 'English (United Kingdom)',
            'en_US' => 'English (United States)',
            'eo_XX' => 'Esperanto',
            'et_EE' => 'Estonian (Estonia)',
            'fo_FO' => 'Faroese (Faroe Islands)',
            'fi_FI' => 'Finnish (Finland)',
            'fr_FR' => 'French (France)',
            'de_DE' => 'German (Germany)',
            'el_GR' => 'Greek (Greece)',
            'he_IL' => 'Hebrew (Israel)',
            'hu_HU' => 'Hungarian (Hungary)',
            'is_IS' => 'Icelandic (Iceland)',
            'id_ID' => 'Indonesian (Indonesia)',
            'it_IT' => 'Italian (Italy)',
            'ja_JP' => 'Japanese (Japan)',
            'km_KH' => 'Khmer (Cambodia)',
            'lc_XX' => 'LOLCAT',
            'lv_LV' => 'Latvian (Latvia)',
            'lt_LT' => 'Lithuanian (Lithuania)',
            'ms_MY' => 'Malay (Malaysia)',
            'mi_NZ' => 'Maori (New Zealand)',
            'ne_NP' => 'Nepali (Nepal)',
            'nb_NO' => 'Norwegian',
            'fa_IR' => 'Persian (Iran)',
            'pl_PL' => 'Polish (Poland)',
            'pt_BR' => 'Portuguese (Brazil)',
            'pa_IN' => 'Punjabi (India)',
            'ro_RO' => 'Romanian (Romania)',
            'ru_RU' => 'Russian (Russia)',
            'sr_RS' => 'Serbian (Serbia)',
            'si_LK' => 'Sinhalese (Sri Lanka)',
            'sk_SK' => 'Slovak (Slovakia)',
            'sl_SI' => 'Slovenian (Slovenia)',
            'es_AR' => 'Spanish (Argentina)',
            'es_MX' => 'Spanish (Mexico)',
            'es_ES' => 'Spanish (Spain)',
            'sv_SE' => 'Swedish (Sweden)',
            'th_TH' => 'Thai (Thailand)',
            'tr_TR' => 'Turkish (Turkey)',
            'uk_UA' => 'Ukrainian (Ukraine)',
            'uz_UZ' => 'Uzbek (Uzbekistan)',
            'vi_VN' => 'Vietnamese (Vietnam)',
        ];
    }

    /**
     * Get theme selected
     *
     * @param $request
     * @return string
     */
    public function getTheme($request)
    {
        if (isset($request['template'])) {
            return $request['template'];
        }
        // Default theme
        return 'simple';
    }
}