ProfileModuleInstaller.php

<?php

declare(strict_types=1);

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

namespace Zikula\ProfileModule;

use Doctrine\Persistence\ManagerRegistry;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\TimezoneType;
use Symfony\Component\Form\Extension\Core\Type\UrlType;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Contracts\Translation\TranslatorInterface;
use Zikula\Bundle\CoreBundle\Doctrine\Helper\SchemaHelper;
use Zikula\ExtensionsModule\AbstractExtension;
use Zikula\ExtensionsModule\Api\ApiInterface\VariableApiInterface;
use Zikula\ExtensionsModule\Installer\AbstractExtensionInstaller;
use Zikula\ProfileModule\Entity\PropertyEntity;
use Zikula\ProfileModule\Form\Type\AvatarType;
use Zikula\ProfileModule\Helper\UpgradeHelper;
use Zikula\UsersModule\Constant as UsersConstant;
use Zikula\UsersModule\Entity\UserAttributeEntity;

/**
 * Profile module installer.
 */
class ProfileModuleInstaller extends AbstractExtensionInstaller
{
    /**
     * @var array
     */
    private $entities = [
        PropertyEntity::class
    ];

    /**
     * @var UpgradeHelper
     */
    private $upgradeHelper;

    /**
     * @var string
     */
    private $prefix;

    public function __construct(
        AbstractExtension $extension,
        ManagerRegistry $managerRegistry,
        SchemaHelper $schemaTool,
        RequestStack $requestStack,
        TranslatorInterface $translator,
        VariableApiInterface $variableApi,
        UpgradeHelper $upgradeHelper,
        string $prefix
    ) {
        parent::__construct($extension, $managerRegistry, $schemaTool, $requestStack, $translator, $variableApi);
        $this->upgradeHelper = $upgradeHelper;
        $this->prefix = $prefix;
    }

    /**
     * Provides an array containing default values for module variables (settings).
     */
    protected function getDefaultModVars(): array
    {
        return [
            'viewregdate' => false,
            'memberslistitemsperpage' => 20,
            'onlinemembersitemsperpage' => 20,
            'recentmembersitemsperpage' => 10,
            'filterunverified' => true,
            'activeminutes' => 10,
            'allowUploads' => false,
            'shrinkLargeImages' => true,
            'maxSize' => 12000,
            'maxWidth' => 80,
            'maxHeight' => 80
        ];
    }

    public function install(): bool
    {
        $this->schemaTool->create($this->entities);
        $this->setVars($this->getDefaultModVars());

        // create the default data for the module
        $request = null !== $this->requestStack ? $this->requestStack->getMainRequest() : null;
        // fall back to English for CLI installations (#105)
        $locale = null !== $request ? $request->getLocale() : 'en';
        $this->defaultdata($locale);

        // Initialisation successful
        return true;
    }

    public function upgrade(string $oldVersion): bool
    {
        // Only support upgrade from version 1.6 and up. Notify users if they have a version below that one.
        if (version_compare($oldVersion, '2.0', '<')) {
            // Inform user about error, and how he can upgrade to this version
            $this->addFlash('error', $this->trans('Notice: This version does not support upgrades from versions less than 2.0. Please upgrade before upgrading again to this version.'));

            return false;
        }

        switch ($oldVersion) {
            case '2.0.0':
                // nothing
            case '2.1.0':
                // get old data and drop table
                $sql = 'SELECT * FROM `user_property`';
                $properties = $this->entityManager->getConnection()->fetchAll($sql);
                $sql = 'DROP TABLE `user_property`';
                $this->entityManager->getConnection()->executeQuery($sql);
                // create new table & insert upgraded data
                $this->schemaTool->create($this->entities);
                $propertyToIdMap = [];

                $request = null !== $this->requestStack ? $this->requestStack->getMainRequest() : null;
                // fall back to English for CLI installations (#105)
                $locale = null !== $request ? $this->requestStack->getLocale() : 'en';

                foreach ($properties as $property) {
                    $newProperty = $this->upgradeHelper->mergeToNewProperty($property, $locale);
                    $this->entityManager->persist($newProperty);
                    $this->entityManager->flush();
                    $propertyToIdMap[$property['attributename']] = $newProperty->getId();
                }
                // upgrade user attribute data to match new ids
                $attributes = $this->entityManager->getRepository(UserAttributeEntity::class)->findAll();
                $i = 0;
                foreach ($attributes as $attribute) {
                    if (array_key_exists($attribute->getName(), $propertyToIdMap)) {
                        $attribute->setName($this->prefix . ':' . $propertyToIdMap[$attribute->getName()]);
                        $attribute->setValue($this->upgradeHelper->getModifiedAttributeValue($attribute, $this->prefix));
                        $i++;
                    }
                    if ($i > 50) {
                        $this->entityManager->flush();
                        $i = 0;
                    }
                }
                $this->entityManager->flush();
                // update boolean vars
                $this->setVar('viewregdate', (bool) $this->getVar('viewregdate'));
                $this->setVar('filterunverified', (bool) $this->getVar('filterunverified'));
                $this->setVar('activeminutes', 10);
                // add new vars
                $this->setVar('allowUploads', false);
                $this->setVar('shrinkLargeImages', true);
                $this->setVar('maxSize', 12000);
                $this->setVar('maxWidth', 80);
                $this->setVar('maxHeight', 80);
                // no break
            case '3.0.0':
            case '3.0.1':
            case '3.0.2':
            case '3.0.3':
            case '3.0.4':
            case '3.0.5': // 3.0.5 was the last version delivered with Zikula 2.*
                $avatarPath = $this->getVariableApi()->get(UsersConstant::MODNAME, 'avatarpath', 'images/avatar');
                if ('images/avatar' === $avatarPath) {
                    $this->getVariableApi()->set(UsersConstant::MODNAME, 'avatarpath', 'public/uploads/avatar');
                }
                // no break
            case '3.0.12':
            case '3.1.15':
                // reduce field length to avoid too long key with utf8mb4 collation
                $sql = 'ALTER TABLE `user_property` MODIFY `id` VARCHAR(190)';
                $this->entityManager->getConnection()->executeQuery($sql);
                // no break
            case '3.1.16':
                // future upgrades
        }

        return true;
    }

    public function uninstall(): bool
    {
        $this->schemaTool->drop($this->entities);
        $this->delVars();

        return true;
    }

    /**
     * Create the default data for the Profile module.
     */
    protected function defaultdata(string $locale): void
    {
        $prop = new PropertyEntity();
        $prop->setId(ProfileConstant::ATTRIBUTE_NAME_DISPLAY_NAME);
        $prop->setFormType(TextType::class);
        $prop->setLabels([$locale => $this->trans('Real Name')]);
        $prop->setWeight(1);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('publicemail');
        $prop->setFormType(EmailType::class);
        $prop->setLabels([$locale => $this->trans('Public Email')]);
        $prop->setWeight(2);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('url');
        $prop->setFormType(UrlType::class);
        $prop->setLabels([$locale => $this->trans('Homepage')]);
        $prop->setWeight(3);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('timezone');
        $prop->setFormType(TimezoneType::class);
        $prop->setLabels([$locale => $this->trans('Timezone')]);
        $prop->setWeight(4);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('avatar');
        $prop->setFormType(AvatarType::class);
        $prop->setLabels([$locale => $this->trans('Avatar')]);
        $prop->setWeight(5);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('city');
        $prop->setFormType(TextType::class);
        $prop->setLabels([$locale => $this->trans('Location')]);
        $prop->setWeight(6);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('occupation');
        $prop->setFormType(TextType::class);
        $prop->setLabels([$locale => $this->trans('Occupation')]);
        $prop->setWeight(7);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('signature');
        $prop->setFormType(TextType::class);
        $prop->setLabels([$locale => $this->trans('Signature')]);
        $prop->setWeight(8);
        $this->entityManager->persist($prop);

        $prop = new PropertyEntity();
        $prop->setId('extrainfo');
        $prop->setFormType(TextareaType::class);
        $prop->setLabels([$locale => $this->trans('Extra info')]);
        $prop->setWeight(9);
        $this->entityManager->persist($prop);

        $this->entityManager->flush();
    }
}