LocalPickup.php

<?php

/*
 * This file is part of the Thelia package.
 * http://www.thelia.net
 *
 * (c) OpenStudio <info@thelia.net>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/*      Copyright (c) OpenStudio */
/*      email : info@thelia.net */
/*      web : http://www.thelia.net */

/*      This program 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 */

/*      This program 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 this program. If not, see <http://www.gnu.org/licenses/>. */

namespace LocalPickup;

use Propel\Runtime\Connection\ConnectionInterface;
use Symfony\Component\DependencyInjection\Loader\Configurator\ServicesConfigurator;
use Thelia\Core\Install\Database;
use Thelia\Model\AreaDeliveryModule;
use Thelia\Model\AreaDeliveryModuleQuery;
use Thelia\Model\CountryAreaQuery;
use Thelia\Model\Country;
use Thelia\Model\Message;
use Thelia\Model\MessageQuery;
use Thelia\Model\OrderPostage;
use Thelia\Model\State;
use Thelia\Module\AbstractDeliveryModuleWithState;

/**
 * Class LocalPickup.
 *
 * @author Thelia <info@thelia.net>
 */
class LocalPickup extends AbstractDeliveryModuleWithState
{
    public const DOMAIN_NAME = 'localpickup';

    public const PRICE_VAR_NAME = 'price';
    public const DESCRIPTION_VAR_NAME = 'description';
    public const EMAIL_VAR_NAME = 'email';
    public const SMS_VAR_NAME = 'sms';

    public const EMAIL_CUSTOM_LOCAL_PICKUP = 'email_custom_local_pickup';
    public const SMS_CUSTOM_LOCAL_PICKUP = 'sms_custom_local_pickup';

    public function getPostage(Country $country, ?State $state = null): float|\Thelia\Model\OrderPostage
    {
        $request = $this->getRequest();
        $locale = $request->hasSession()
            ? $request->getSession()->getLang()->getLocale()
            : (\Thelia\Model\LangQuery::create()->findOneByByDefault(true)?->getLocale() ?? 'en_US');

        return $this->buildOrderPostage(self::getConfigValue(self::PRICE_VAR_NAME, 0), $country, $locale);
    }

    /**
     * A fresh install has to be usable as is: the pickup is offered in the shipping zones
     * of the shop's own country, and the notification messages exist. A merchant who
     * already chose the zones keeps them.
     */
    public function postActivation(?ConnectionInterface $con = null): void
    {
        $this->attachToShopCountryAreas($con);
        $this->createMessages($con);
    }

    public function update($currentVersion, $newVersion, ?ConnectionInterface $con = null): void
    {
        $this->createMessages($con);

        if ($newVersion === '1.2') {
            $db = new Database($con);

            // Migrate previous price from database to module config
            try {
                $statement = $db->execute('select price from local_pickup_shipping order by id desc limit 1');

                $price = (float) $statement->fetchColumn(0);

                self::setConfigValue(self::PRICE_VAR_NAME, $price);
            } catch (\Exception $ex) {
                // Nothing special
            }
        }
    }

    private function attachToShopCountryAreas(?ConnectionInterface $con): void
    {
        $moduleId = $this->getModuleModel()->getId();

        if (AreaDeliveryModuleQuery::create()->filterByDeliveryModuleId($moduleId)->count($con) > 0) {
            return;
        }

        $areaIds = CountryAreaQuery::create()
            ->filterByCountryId(Country::getShopLocation()->getId())
            ->select(['AreaId'])
            ->find($con)
            ->toArray();

        foreach (array_unique($areaIds) as $areaId) {
            (new AreaDeliveryModule())
                ->setAreaId((int) $areaId)
                ->setDeliveryModuleId($moduleId)
                ->save($con);
        }
    }

    private function createMessages(?ConnectionInterface $con): void
    {
        if (null === MessageQuery::create()->findOneByName(self::EMAIL_CUSTOM_LOCAL_PICKUP, $con)) {
            (new Message())
                ->setName(self::EMAIL_CUSTOM_LOCAL_PICKUP)
                ->setHtmlTemplateFileName('order_shipping.html')
                ->setHtmlLayoutFileName('')
                ->setTextTemplateFileName('order_shipping.txt')
                ->setTextLayoutFileName('')
                ->setSecured(0)
                ->setLocale('fr_FR')
                ->setTitle('Commande à retirer en magasin')
                ->setSubject('Commande à récupérer en magasin')
                ->setLocale('en_US')
                ->setTitle('Order to pick up in store')
                ->setSubject('Order to pick up in store')
                ->setLocale('de_DE')
                ->setTitle('Bestellung im Geschäft abholen')
                ->setSubject('Bestellung im Geschäft abholen')
                ->save($con);
        }

        if (null === MessageQuery::create()->findOneByName(self::SMS_CUSTOM_LOCAL_PICKUP, $con)) {
            (new Message())
                ->setName(self::SMS_CUSTOM_LOCAL_PICKUP)
                ->setTextTemplateFileName('order_shipping_sms.txt')
                ->setSecured(0)
                ->setLocale('fr_FR')
                ->setTitle('SMS commande à retirer en magasin')
                ->setLocale('en_US')
                ->setTitle('Order to pick up in store text message')
                ->save($con);
        }
    }

    public function isValidDelivery(Country $country, ?State $state = null): bool
    {
        return true;
    }

    public function getDeliveryMode(): string
    {
        return 'localPickup';
    }

    public static function configureServices(ServicesConfigurator $servicesConfigurator): void
    {
        $servicesConfigurator->load(self::getModuleCode().'\\', __DIR__)
            ->exclude([__DIR__.'/I18n/*', __DIR__.'/Config/**/*.php', __DIR__.'/Tests/*', __DIR__.'/LocalPickup.php'])
            ->autowire(true)
            ->autoconfigure(true);
    }
}