Zikula\BlocksModule\BlocksModuleInstaller

Complexity

Total Complexity

42

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	install()	0	16	2
D	upgrade()	0	117	33
A	uninstall()	0	5	1
B	defaultdata()	0	85	4
A	isSerialized()	0	4	2

<?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\BlocksModule;

use Zikula\BlocksModule\Entity\BlockEntity;
use Zikula\BlocksModule\Entity\BlockPlacementEntity;
use Zikula\BlocksModule\Entity\BlockPositionEntity;
use Zikula\BlocksModule\Helper\InstallerHelper;
use Zikula\Core\AbstractExtensionInstaller;

/**
 * Installation and upgrade routines for the blocks module.
 */
class BlocksModuleInstaller extends AbstractExtensionInstaller
{
    /**
     * @var array
     */
    private $entities = [
        'Zikula\BlocksModule\Entity\BlockEntity',
        'Zikula\BlocksModule\Entity\BlockPositionEntity',
        'Zikula\BlocksModule\Entity\BlockPlacementEntity',
    ];

    /**
     * initialise the blocks module
     *
     * @return bool true on success, false otherwise
     */
    public function install()
    {
        try {
            $this->schemaTool->create($this->entities);
        } catch (\Exception $e) {
            return false;
        }

        // Set a default value for a module variable
        $this->setVar('collapseable', false);

        $this->hookApi->installSubscriberHooks($this->bundle->getMetaData());

        // Initialisation successful
        return true;
    }

    /**
     * upgrade the blocks module
     *
     * @param string $oldversion version being upgraded
     *
     * @return bool true if successful, false otherwise
     */
    public function upgrade($oldversion)
    {
        // Upgrade dependent on old version number
        switch ($oldversion) {
            case '3.8.1':

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

                $this->hookApi->installSubscriberHooks($this->bundle->getMetaData());
            case '3.8.2':
            case '3.9.0':

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

                $sql = "SELECT * FROM blocks";
                $blocks = $this->entityManager->getConnection()->fetchAll($sql);
                foreach ($blocks as $block) {
                    $content = $block['content'];
                    if ($this->isSerialized($content)) {
                        $content = unserialize($content);
                        foreach ($content as $k => $item) {
                            if (is_string($item)) {
                                if (strpos($item, 'blocks_block_extmenu_topnav.tpl') !== false) {
                                    $content[$k] = str_replace('blocks_block_extmenu_topnav.tpl', 'Block/Extmenu/topnav.tpl', $item);
                                } elseif (strpos($item, 'blocks_block_extmenu.tpl') !== false) {
                                    $content[$k] = str_replace('blocks_block_extmenu.tpl', 'Block/Extmenu/extmenu.tpl', $item);
                                } elseif (strpos($item, 'menutree/blocks_block_menutree_') !== false) {
                                    $content[$k] = str_replace('menutree/blocks_block_menutree_', 'Block/Menutree/', $item);
                                }
                            }
                        }
                        $this->entityManager->getConnection()->executeUpdate("UPDATE blocks SET content=? WHERE bid=?", [serialize($content), $block['bid']]);
                    }
                }

                // check if request is available (#2073)
                $templateWarning = $this->__('Warning: Block template locations modified, you may need to fix your template overrides if you have any.');
                if (is_object($this->container->get('request')) && method_exists($this->container->get('request'), 'getSession') && is_object($this->container->get('request')->getSession())) {
                    $this->addFlash('warning', $templateWarning);
                }
            case '3.9.1':

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

                // make all content fields of blocks serialized.
                $sql = "SELECT * FROM blocks";
                $blocks = $this->entityManager->getConnection()->fetchAll($sql);
                $oldContent = [];
                foreach ($blocks as $block) {
                    $block['content'] = !empty($block['content']) ? $block['content'] : '';
                    $oldContent[$block['bid']] = $this->isSerialized($block['content']) ? unserialize($block['content']) : ['content' => $block['content']];
                }
                $this->schemaTool->update($this->entities);
                $this->entityManager->getConnection()->executeQuery("UPDATE blocks SET properties='a:0:{}'");

                $blocks = $this->entityManager->getRepository('ZikulaBlocksModule:BlockEntity')->findAll();
                $installerHelper = new InstallerHelper();
                /** @var \Zikula\BlocksModule\Entity\BlockEntity $block */
                foreach ($blocks as $block) {
                    $block->setProperties($oldContent[$block->getBid()]);
                    $block->setFilters($installerHelper->upgradeFilterArray($block->getFilters()));
                    $block->setBlocktype(preg_match('/.*Block$/', $block->getBkey()) ? substr($block->getBkey(), 0, -5) : $block->getBkey());
                    $block->setBkey($installerHelper->upgradeBkeyToFqClassname($this->container->get('kernel'), $block));
                }
                $this->entityManager->flush();

                $collapseable = $this->getVar('collapseable');
                $this->setVar('collapseable', (bool) $collapseable);

            case '3.9.2':

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

                // convert Text and Html block types so properties is proper array
                $blocks = $this->entityManager->getRepository('ZikulaBlocksModule:BlockEntity')->findBy(['blocktype' => ['Html', 'Text']]);
                foreach ($blocks as $block) {
                    $properties = $block->getProperties();
                    if (!is_array($properties)) {
                        $block->setProperties(['content' => $properties]);
                    }
                }
                $this->entityManager->flush();
            case '3.9.3':

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

                $this->schemaTool->drop(['Zikula\BlocksModule\Entity\UserBlockEntity']);
            case '3.9.4':

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

                // convert integer values to boolean for search block settings
                $searchBlocks = $this->entityManager->getRepository('ZikulaBlocksModule:BlockEntity')->findBy(['blocktype' => 'Search']);
                foreach ($searchBlocks as $searchBlock) {
                    $properties = $searchBlock->getProperties();
                    $properties['displaySearchBtn'] = (bool) $properties['displaySearchBtn'];
                    if (isset($properties['active'])) {
                        foreach ($properties['active'] as $module => $active) {

The expression $properties['active'] of type boolean is not traversable.

                            $properties['active'][$module] = (bool) $active;
                        }
                    }
                    $searchBlock->setProperties($properties);
                }
                $this->entityManager->flush();
            case '3.9.5':

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

                $loginBlocks = $this->entityManager->getRepository('ZikulaBlocksModule:BlockEntity')->findBy(['blocktype' => 'Login']);
                foreach ($loginBlocks as $loginBlock) {
                    $filters = $loginBlock->getFilters();
                    $filters[] = [
                        'attribute' => '_route',
                        'queryParameter' => null,
                        'comparator' => '!=',
                        'value' => 'zikulausersmodule_access_login'
                    ];
                    $loginBlock->setFilters($filters);
                }
                $this->entityManager->flush();
            case '3.9.6':

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

                $blocks = $this->entityManager->getConnection()->executeQuery("SELECT * FROM blocks WHERE blocktype = 'Lang'");
                if (count($blocks) > 0) {
                    $this->entityManager->getConnection()->executeQuery("UPDATE blocks set bkey=?, blocktype=?, properties=? WHERE blocktype = 'Lang'", [
                        'ZikulaSettingsModule:Zikula\SettingsModule\Block\LocaleBlock',
                        'Locale',
                        'a:0:{}'
                    ]);
                    $this->addFlash('success', $this->__('All instances of LangBlock have been converted to LocaleBlock.'));
                }
                $this->entityManager->getConnection()->executeQuery("UPDATE group_perms SET component = REPLACE(component, 'Languageblock', 'LocaleBlock') WHERE component LIKE 'Languageblock%'");
            case '3.9.7':
                // future upgrade routines
        }

        // Update successful
        return true;
    }

    /**
     * delete the blocks module
     *
     * Since the blocks module should never be deleted we'all always return false here
     * @return bool false
     */
    public function uninstall()
    {
        // Deletion not allowed
        return false;
    }

    /**
     * Add default block data for new installs
     * This is called after a complete installation since the blocks
     * need to be populated with module id's which are only available
     * once the install has been completed
     */
    public function defaultdata()
    {
        // create the default block positions - left, right and center for the traditional 3 column layout
        $positions = [
            'left' => $this->__('Left blocks'),
            'right' => $this->__('Right blocks'),
            'center' => $this->__('Center blocks'),
            'search' => $this->__('Search block'),
            'header' => $this->__('Header block'),
            'footer' => $this->__('Footer block'),
            'topnav' => $this->__('Top navigation block'),
            'bottomnav' => $this->__('Bottom navigation block'),
            ];
        foreach ($positions as $name => $description) {
            $positions[$name] = new BlockPositionEntity();
            $positions[$name]->setName($name);
            $positions[$name]->setDescription($description);

It seems like $description defined by $description on line 212 can also be of type object<Zikula\BlocksModule\Entity\BlockPositionEntity>; however, Zikula\BlocksModule\Entity\BlockPositionEntity::setDescription() does only seem to accept string, maybe add an additional type check?

            $this->entityManager->persist($positions[$name]);
        }
        $this->entityManager->flush();

        $hellomessage = $this->__('<p><a href="http://zikula.org/">Zikula</a> is a content management system (CMS) and application framework. It is secure and stable, and is a good choice for sites with a large volume of traffic.</p><p>With Zikula:</p><ul><li>you can customise all aspects of the site\'s appearance through themes, with support for CSS style sheets, JavaScript, Flash and all other modern web development technologies;</li><li>you can mark content as being suitable for either a single language or for all languages, and can control all aspects of localisation and internationalisation of your site;</li><li>you can be sure that your pages will display properly in all browsers, thanks to Zikula\'s full compliance with W3C HTML standards;</li><li>you get a standard application-programming interface (API) that lets you easily augment your site\'s functionality through modules, blocks and other extensions;</li><li>you can get help and support from the Zikula community of webmasters and developers at <a href="http://www.zikula.org">zikula.org</a>.</li></ul><p>Enjoy using Zikula!</p><p><strong>The Zikula team</strong></p><p><em>Note: Zikula is Free Open Source Software (FOSS) licensed under the GNU General Public License.</em></p>');

        $blocks = [];
        $extensionRepo = $this->entityManager->getRepository('\Zikula\ExtensionsModule\Entity\ExtensionEntity');
        $blocksModuleEntity = $extensionRepo->findOneBy(['name' => 'ZikulaBlocksModule']);
        $searchModuleEntity = $extensionRepo->findOneBy(['name' => 'ZikulaSearchModule']);
        $usersModuleEntity = $extensionRepo->findOneBy(['name' => 'ZikulaUsersModule']);
        $blocks[] = [
            'bkey' => 'ZikulaSearchModule:\Zikula\SearchModule\Block\SearchBlock',
            'blocktype' => 'Search',
            'language' => '',
            'module' => $searchModuleEntity,
            'title' => $this->__('Search box'),
            'description' => $this->__('Search block'),
            'properties' => [
                'displaySearchBtn' => true,
                'active' => ['ZikulaUsersModule' => 1]
            ],
            'position' => $positions['left']
        ];
        $blocks[] = [
            'bkey' => 'ZikulaBlocksModule:\Zikula\BlocksModule\Block\HtmlBlock',
            'blocktype' => 'Html',
            'language' => '',
            'module' => $blocksModuleEntity,
            'title' => $this->__("This site is powered by Zikula!"),
            'description' => $this->__('HTML block'),
            'properties' => ['content' => $hellomessage],
            'position' => $positions['center']
        ];
        $blocks[] = [
            'bkey' => 'ZikulaUsersModule:\Zikula\UsersModule\Block\LoginBlock',
            'blocktype' => 'Login',
            'language' => '',
            'module' => $usersModuleEntity,
            'title' => $this->__('User log-in'),
            'description' => $this->__('Login block'),
            'position' => $positions['topnav'],
            'order' => 1,
            'filters' => [[
                'attribute' => '_route',
                'queryParameter' => null,
                'comparator' => '!=',
                'value' => 'zikulausersmodule_access_login'
            ]]
        ];

        foreach ($blocks as $block) {
            $blockEntity = new BlockEntity();
            $position = $block['position'];
            $sortOrder = !empty($block['order']) ? $block['order'] : 0;
            unset($block['position'], $block['order']);
            $blockEntity->merge($block);
            $this->entityManager->persist($blockEntity);
            $placement = new BlockPlacementEntity();
            $placement->setBlock($blockEntity);
            $placement->setPosition($position);
            $placement->setSortorder($sortOrder);
            $this->entityManager->persist($placement);
        }
        $this->entityManager->flush();

        return;
    }

    private function isSerialized($string)
    {
        return $string === 'b:0;' || @unserialize($string) !== false;
    }
}