Zikula\SettingsModule\SettingsModuleInstaller

Complexity

Total Complexity

25

Size/Duplication

Total Lines	175
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	install()	0	62	4
C	upgrade()	0	56	14
A	uninstall()	0	5	1
A	setSystemVar()	0	4	1
A	getSystemVar()	0	4	1
A	setGuestTimeZone()	0	16	4

<?php

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula Foundation - http://zikula.org/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\SettingsModule;

use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaKernel;
use Zikula\Core\AbstractExtensionInstaller;
use Zikula\ExtensionsModule\Api\VariableApi;

/**
 * Installation and upgrade routines for the settings module.
 *
 * PLEASE NOTE CAREFULLY.  The use of System::get/set/delVar() is deliberate
 * we cannot use $this->get/set/delVar() because the keys will be incorrectly
 * generated (System instead of ZConfig).
 */
class SettingsModuleInstaller extends AbstractExtensionInstaller
{
    /**
     * Initialise the settings module.
     *
     * @return boolean
     */
    public function install()
    {
        // Set up an initial value for a module variable. Note that all module
        // variables should be initialised with some value in this way rather
        // than just left blank, this helps the user-side code and means that
        // there doesn't need to be a check to see if the variable is set in
        // the rest of the code as it always will be.
        $this->setSystemVar('debug', '0');
        $this->setSystemVar('startdate', date('m/Y', time()));
        $this->setSystemVar('adminmail', 'example@example.com');
        $this->setSystemVar('Default_Theme', 'ZikulaBootstrapTheme');
        $this->setSystemVar('timezone', date_default_timezone_get());
        $this->setSystemVar('funtext', '1');
        $this->setSystemVar('reportlevel', '0');
        $this->setSystemVar('startpage', '');
        $this->setSystemVar('Version_Num', ZikulaKernel::VERSION);
        $this->setSystemVar('Version_Sub', ZikulaKernel::VERSION_SUB);
        $this->setSystemVar('debug_sql', '0');
        $this->setSystemVar('multilingual', '1');
        $this->setSystemVar('useflags', '0');
        $this->setSystemVar('theme_change', '0');
        $this->setSystemVar('UseCompression', '0');
        $this->setSystemVar('siteoff', 0);
        $this->setSystemVar('siteoffreason', '');
        $this->setSystemVar('startargs', '');
        $this->setSystemVar('entrypoint', 'index.php');
        $this->setSystemVar('language_detect', 0);
        // Multilingual support
        foreach ($this->container->get('zikula_settings_module.locale_api')->getSupportedLocales() as $lang) {
            $this->setSystemVar('sitename_' . $lang, $this->__('Site name'));
            $this->setSystemVar('slogan_' . $lang, $this->__('Site description'));
            $this->setSystemVar('metakeywords_' . $lang, $this->__('zikula, portal, open source, web site, website, weblog, blog, content management system, cms, application framework'));
            $this->setSystemVar('defaultpagetitle_' . $lang, $this->__('Site name'));
            $this->setSystemVar('defaultmetadescription_' . $lang, $this->__('Site description'));
        }

        if (function_exists('apache_get_modules') && in_array('mod_rewrite', apache_get_modules())) {
            // Only strip entry point if "mod_rewrite" is available.
            $this->setSystemVar('shorturlsstripentrypoint', true);
        } else {
            $this->setSystemVar('shorturlsstripentrypoint', false);
        }

        $this->setSystemVar('shorturlsdefaultmodule', '');
        $this->setSystemVar(SettingsConstant::SYSTEM_VAR_PROFILE_MODULE, '');
        $this->setSystemVar(SettingsConstant::SYSTEM_VAR_MESSAGE_MODULE, '');
        $this->setSystemVar('languageurl', 0);
        $this->setSystemVar('ajaxtimeout', 5000);
        //! this is a comma-separated list of special characters to search for in permalinks
        $this->setSystemVar('permasearch', $this->__('À,Á,Â,Ã,Å,à,á,â,ã,å,Ò,Ó,Ô,Õ,Ø,ò,ó,ô,õ,ø,È,É,Ê,Ë,è,é,ê,ë,Ç,ç,Ì,Í,Î,Ï,ì,í,î,ï,Ù,Ú,Û,ù,ú,û,ÿ,Ñ,ñ,ß,ä,Ä,ö,Ö,ü,Ü'));
        //! this is a comma-separated list of special characters to replace in permalinks
        $this->setSystemVar('permareplace', $this->__('A,A,A,A,A,a,a,a,a,a,O,O,O,O,O,o,o,o,o,o,E,E,E,E,e,e,e,e,C,c,I,I,I,I,i,i,i,i,U,U,U,u,u,u,y,N,n,ss,ae,Ae,oe,Oe,ue,Ue'));

        $locale = $this->container->getParameter('locale');
        $this->setSystemVar('locale', $locale);
        $this->setSystemVar('language_i18n', $locale);

        $this->setSystemVar('idnnames', 1);

        // Initialisation successful
        return true;
    }

    /**
     * upgrade the module from an old version
     *
     * @param  string $oldversion version number string to upgrade from
     *
     * @return bool|string true on success, last valid version string or false if fails
     */
    public function upgrade($oldversion)
    {
        $request = $this->container->get('request_stack')->getMasterRequest();
        // Upgrade dependent on old version number
        switch ($oldversion) {
            case '2.9.7':
            case '2.9.8':

There must be a comment when fall-through is intentional in a non-empty case body

                $permasearch = $this->getSystemVar('permasearch');
                if (empty($permasearch)) {
                    $this->setSystemVar('permasearch', $this->__('À,Á,Â,Ã,Å,à,á,â,ã,å,Ò,Ó,Ô,Õ,Ø,ò,ó,ô,õ,ø,È,É,Ê,Ë,è,é,ê,ë,Ç,ç,Ì,Í,Î,Ï,ì,í,î,ï,Ù,Ú,Û,ù,ú,û,ÿ,Ñ,ñ,ß,ä,Ä,ö,Ö,ü,Ü'));
                }
                $permareplace = $this->getSystemVar('permareplace');
                if (empty($permareplace)) {
                    $this->setSystemVar('permareplace', $this->__('A,A,A,A,A,a,a,a,a,a,O,O,O,O,O,o,o,o,o,o,E,E,E,E,e,e,e,e,C,c,I,I,I,I,i,i,i,i,U,U,U,u,u,u,y,N,n,ss,ae,Ae,oe,Oe,ue,Ue'));
                }
                $locale = $this->getSystemVar('locale');
                if (empty($locale)) {
                    $this->setSystemVar('locale', $request->getLocale());
                }

            case '2.9.9':

There must be a comment when fall-through is intentional in a non-empty case body

                // update certain System vars to multilingual. provide default values for all locales using current value.
                // must directly manipulate System vars at DB level because using $this->getSystemVar() returns empty values
                $varsToChange = ['sitename', 'slogan', 'metakeywords', 'defaultpagetitle', 'defaultmetadescription'];
                $SystemVars = $this->entityManager->getRepository('Zikula\ExtensionsModule\Entity\ExtensionVarEntity')->findBy(['modname' => VariableApi::CONFIG]);
                /** @var \Zikula\ExtensionsModule\Entity\ExtensionVarEntity $modVar */
                foreach ($SystemVars as $modVar) {
                    if (in_array($modVar->getName(), $varsToChange)) {
                        foreach ($this->container->get('zikula_settings_module.locale_api')->getSupportedLocales() as $langcode) {
                            $newModVar = clone $modVar;
                            $newModVar->setName($modVar->getName() . '_' . $langcode);
                            $this->entityManager->persist($newModVar);
                        }
                        $this->entityManager->remove($modVar);
                    }
                }
                $this->entityManager->flush();

            case '2.9.10':

There must be a comment when fall-through is intentional in a non-empty case body

                $this->setSystemVar('startController', '');
                $newStargArgs = str_replace(',', '&', $this->getSystemVar('startargs')); // replace comma with `&`
                $this->setSystemVar('startargs', $newStargArgs);
            case '2.9.11':

There must be a comment when fall-through is intentional in a non-empty case body

                $this->setSystemVar('shorturls', (bool) $this->getSystemVar('shorturls'));
                $this->setSystemVar('shorturlsstripentrypoint', (bool) $this->getSystemVar('shorturlsstripentrypoint'));
                $this->setSystemVar('useCompression', (bool) $this->getSystemVar('useCompression'));
            case '2.9.12': // ship with Core-1.4.4

There must be a comment when fall-through is intentional in a non-empty case body

                // reconfigure TZ settings
                $this->setGuestTimeZone();
            case '2.9.13': // ship with Core-1.5.0
                // current version
        }

        // Update successful
        return true;
    }

    /**
     * Delete the settings module.
     *
     * @return boolean false
     */
    public function uninstall()
    {
        // This module cannot be uninstalled.
        return false;
    }

    private function setSystemVar($name, $value = '')
    {
        return $this->container->get('zikula_extensions_module.api.variable')->set(VariableApi::CONFIG, $name, $value);
    }

    private function getSystemVar($name)
    {
        return $this->container->get('zikula_extensions_module.api.variable')->getSystemVar($name);
    }

    /**
     * upgrade helper method
     */
    private function setGuestTimeZone()
    {
        $existingOffset = $this->getSystemVar('timezone_offset');
        $actualOffset = floatval($existingOffset) * 60; // express in minutes
        $timezoneAbbreviations = \DateTimeZone::listAbbreviations();
        $timeZone = date_default_timezone_get();
        foreach ($timezoneAbbreviations as $abbreviation => $zones) {
            foreach ($zones as $zone) {
                if ($zone['offset'] == $actualOffset) {
                    $timeZone = $zone['timezone_id'];
                    break 2;
                }
            }
        }
        $this->setSystemVar('timezone', $timeZone);
    }
}