lengow.php

<?php
/**
 * Copyright 2017 Lengow SAS.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * @author    Team Connector <team-connector@lengow.com>
 * @copyright 2017 Lengow SAS
 * @license   http://www.apache.org/licenses/LICENSE-2.0
 */
require_once _PS_MODULE_DIR_ . 'lengow' . DIRECTORY_SEPARATOR . 'loader.php';

if (!defined('_PS_VERSION_')) {
    exit;
}

use PrestaShop\PrestaShop\Adapter\SymfonyContainer;

/**
 * Lengow
 */
class Lengow extends Module
{
    /**
     * Lengow Install Class
     */
    /** @var LengowInstall */
    private LengowInstall $installClass;

    /**
     * Lengow Hook Class
     */
    /** @var LengowHook */
    private LengowHook $hookClass;

    /**
     * Construct
     */
    public function __construct()
    {
        $this->name = 'lengow';
        $this->tab = 'export';
        $this->version = '4.2.2'; // x-release-please-version
        $this->author = 'Lengow';
        $this->module_key = '__LENGOW_PRESTASHOP_PRODUCT_KEY__';
        $this->ps_versions_compliancy = [
            'min' => '8.0.0',
            'max' => '9.99.99',
        ];

        $this->bootstrap = true;

        parent::__construct();

        LengowContext::setContext($this->context);

        $this->displayName = 'Lengow';
        $this->description = $this->l('Lengow allows you to easily export your product catalogue from your PrestaShop store and sell on Amazon, Cdiscount, Google Shopping, Criteo, LeGuide.com, Ebay, Rakuten, Priceminister. Choose from our 1,800 available marketing channels!');
        $this->confirmUninstall = $this->l('Are you sure you want to uninstall the Lengow module?');

        $this->installClass = new LengowInstall($this, $this->context);
        $this->hookClass = new LengowHook($this, $this->context);

        if (self::isInstalled($this->name)) {
            $oldVersion = LengowConfiguration::getGlobalValue(
                LengowConfiguration::PLUGIN_VERSION
            );
            if ($oldVersion !== $this->version) {
                $this->installClass->clearCaches();
                LengowInstall::setInstallationStatus(false);
                $this->installClass->update($oldVersion);
                LengowConfiguration::updateGlobalValue(
                    LengowConfiguration::PLUGIN_VERSION,
                    $this->version
                );
                $this->installClass->clearCaches();
            }
        }

        $this->context->smarty->assign('lengow_link', new LengowLink());
    }

    /**
     * Configure Link
     * Redirect on lengow configure page
     *
     * @return void
     */
    public function getContent(): void
    {
        $sfContainer = SymfonyContainer::getInstance();
        if ($sfContainer === null) {
            return;
        }
        $router = $sfContainer->get('router');
        try {
            Tools::redirectAdmin($router->generate('lengow_home'));
        } catch (Symfony\Component\Routing\Exception\RouteNotFoundException $e) {
            $this->clearCompiledCache();
            Tools::redirectAdmin(
                $this->context->link->getAdminLink('AdminModules', true, [], ['configure' => $this->name])
            );
        }
    }

    /**
     * Deletes Symfony routing and container cache files for all environments so they are
     * rebuilt fresh on the next request with this module's routes and services included.
     *
     * Both the routing cache (UrlGenerator/UrlMatcher) and the compiled DI container entry-point
     * are deleted because both are built during $kernel->handle() which runs before parent::install()
     * registers the module in the database.
     *
     * @return void
     */
    private function clearCompiledCache(): void
    {
        $routingFiles = ['UrlGenerator.php', 'UrlGenerator.php.meta', 'UrlMatcher.php', 'UrlMatcher.php.meta'];
        foreach (['dev', 'prod'] as $env) {
            $cacheDir = _PS_ROOT_DIR_ . '/var/cache/' . $env . '/';
            foreach ($routingFiles as $file) {
                @unlink($cacheDir . $file);
            }
            // Remove the compiled container entry-point so the DI container is recompiled
            // on the next request and module services (controllers) are properly registered.
            foreach (glob($cacheDir . 'app*Container.php') ?: [] as $containerFile) {
                @unlink($containerFile);
            }
        }
    }

    /**
     * Install process
     *
     * @return bool
     */
    public function install(): bool
    {
        $this->installClass->clearCaches();
        if (!parent::install()) {
            return false;
        }
        // Routing/container cache was built by the current request's kernel before this module was
        // registered in the DB, so it lacks lengow routes and services. Delete it now so the next
        // request rebuilds it fresh.
        $this->clearCompiledCache();
        $isInstalled = $this->installClass->install();
        $this->installClass->clearCaches();

        return $isInstalled;
    }

    /**
     * Uninstall process
     *
     * @return bool
     */
    public function uninstall(): bool
    {
        $this->installClass->clearCaches();
        if (!parent::uninstall()) {
            return false;
        }
        $isUninstalled = $this->installClass->uninstall();
        $this->installClass->clearCaches();

        return $isUninstalled;
    }

    /**
     * Reset process
     *
     * @return bool
     */
    public function reset(): bool
    {
        $this->installClass->clearCaches();
        $isReset = $this->installClass->reset();
        $this->installClass->clearCaches();

        return $isReset;
    }

    /**
     * Register legacy webservice URLs as PS-native routes pointing to the FO controllers.
     *
     * Old URLs (modules/lengow/webservice/*.php) still work because:
     * - The physical PHP files no longer exist, so Apache forwards to index.php
     * - PS Dispatcher picks up these routes and dispatches to the FO controllers
     *
     * @return array<string, array<string, mixed>>
     */
    public function hookModuleRoutes(): array
    {
        return [
            'lengow-cron' => [
                'controller' => 'cron',
                'rule' => 'modules/lengow/webservice/cron.php',
                'keywords' => [],
                'params' => [
                    'fc' => 'module',
                    'module' => 'lengow',
                ],
            ],
            'lengow-export' => [
                'controller' => 'export',
                'rule' => 'modules/lengow/webservice/export.php',
                'keywords' => [],
                'params' => [
                    'fc' => 'module',
                    'module' => 'lengow',
                ],
            ],
            'lengow-toolbox' => [
                'controller' => 'toolbox',
                'rule' => 'modules/lengow/webservice/toolbox.php',
                'keywords' => [],
                'params' => [
                    'fc' => 'module',
                    'module' => 'lengow',
                ],
            ],
        ];
    }

    /**
     * Hook to display the icon
     *
     * @return void
     */
    public function hookDisplayBackOfficeHeader(): void
    {
        $this->hookClass->hookDisplayBackOfficeHeader();
    }

    /**
     * Hook on Home page
     *
     * @return void
     */
    public function hookDisplayHome(): void
    {
        $this->hookClass->hookDisplayHome();
    }

    /**
     * Hook on Payment page
     *
     * @return void
     */
    public function hookDisplayPaymentTop(): void
    {
        $this->hookClass->hookPaymentTop();
    }

    /**
     * Hook for generate tracker on front footer page
     *
     * @return mixed
     */
    public function hookDisplayFooter(): mixed
    {
        return $this->hookClass->hookFooter();
    }

    /**
     * Hook on order confirmation page to init order's product list
     *
     * @param array<string, mixed> $args Arguments of hook
     *
     * @return void
     */
    public function hookDisplayOrderConfirmation(array $args): void
    {
        $this->hookClass->hookOrderConfirmation($args);
    }

    /**
     * Order status update
     * Event This hook launches modules when the status of an order changes
     *
     * @param array<string, mixed> $args
     *
     * @return void
     */
    public function hookActionOrderStatusUpdate(array $args): void
    {
        $this->hookClass->hookUpdateOrderStatus($args);
    }

    /**
     * Order status post update
     *
     * @param array<string, mixed> $args Arguments of hook
     *
     * @return void
     */
    public function hookActionOrderStatusPostUpdate(array $args): void
    {
        $this->hookClass->hookActionOrderStatusPostUpdate($args);
    }

    /**
     * Hook for update order if isset tracking number
     *
     * @param array<string, mixed> $args Arguments of hook
     *
     * @return void
     */
    public function hookActionObjectUpdateAfter(array $args): void
    {
        $this->hookClass->hookActionObjectUpdateAfter($args);
    }

    /**
     * Hook on admin page's order
     *
     * @param array<string, mixed> $args Arguments of hook
     *
     * @return mixed
     */
    public function hookDisplayAdminOrder(array $args): mixed
    {
        return $this->hookClass->hookAdminOrder($args);
    }

    /**
     * Hook on admin page's order side
     *
     * @param array<string, mixed> $args Arguments of hook
     *
     * @return mixed
     */
    public function hookDisplayAdminOrderSide(array $args): mixed
    {
        return $this->hookClass->hookAdminOrderSide($args);
    }

    /**
     * Hook to add a Lengow tab link in the order detail tabs
     *
     * @param array<string, mixed> $params
     *
     * @return string
     */
    public function hookDisplayAdminOrderTabLink(array $params): string
    {
        return $this->hookClass->hookDisplayAdminOrderTabLink($params);
    }

    /**
     * Hook to add Lengow tab content in the order detail tabs
     *
     * @param array<string, mixed> $params
     *
     * @return string
     */
    public function hookDisplayAdminOrderTabContent(array $params): string
    {
        return $this->hookClass->hookDisplayAdminOrderTabContent($params);
    }

    /**
     * Hook when a product line is refunded
     *
     * @param array<string, mixed> $args
     *
     * @return void
     */
    public function hookActionProductCancel(array $args): void
    {
        $this->hookClass->hookActionProductCancel($args);
    }
}