<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

namespace PrestaShopBundle\Cache;

use AdminAPIKernel;
use AdminKernel;
use FrontKernel;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;

/**
 * Since PrestaShop 9.0 we have multiple kernels with each their cache folders, the cache are split in this way:
 *  - var/cache/dev/admin
 *  - var/cache/dev/admin-api
 *  - var/cache/dev/front
 *  - var/cache/prod/admin
 *  - var/cache/prod/admin-api
 *  - var/cache/prod/front
 *  - var/cache/test/admin
 *  - var/cache/test/admin-api
 *  - var/cache/test/front
 *
 * Historically the cache was simply in:
 *  - var/cache/dev
 *  - var/cache/prod
 *  - var/cache/test
 *
 * These legacy cache folders are also used by legacy components (PrestaShop FO, autoload, modules, ...) but when we
 * use ./bin/console cache:clear is used it only clears the new cache folders and some elements stay present in the legacy
 * folder upper level, usually indicated in the _PS_CACHE_DIR_ legacy const.
 *
 * The purpose of this service is to clear the remaining elements that are still in the upper level so it will loop
 * through the elements present in the root environment folder and delete them (it filters out the cache related to
 * Symfony apps).
 *
 * This service implements the CacheClearerInterface and autoconfigure, this way it is called automatically by Somfony
 * when the cache:clear command is executed.
 */
class LegacyCacheClearer implements CacheClearerInterface
{
    public function __construct(
        protected readonly string $legacyCacheDir,
    ) {
    }

    public function clear(string $cacheDir)
    {
        if (!is_dir($this->legacyCacheDir)) {
            return;
        }

        // We do not use the $cacheDir because it points to the Symfony cache folder, we use the
        // legacy path of the cache instead
        $kernelAppIds = [AdminKernel::APP_ID, AdminAPIKernel::APP_ID, FrontKernel::APP_ID];
        $excludedDirectories = [];
        foreach ($kernelAppIds as $kernelAppId) {
            $excludedDirectories[] = $kernelAppId;
        }

        $fs = new Filesystem();

        // First remove all first level folders since it's fast to remove by folder
        $folderFinder = new Finder();
        $folderFinder
            ->in($this->legacyCacheDir)
            ->exclude($excludedDirectories)
            ->depth(0)
        ;
        $fs->remove($folderFinder->directories());

        // Then remove the remaining first level files
        $filesFinder = new Finder();
        $filesFinder
            ->in($this->legacyCacheDir)
            ->exclude($excludedDirectories)
            ->depth(0)
        ;
        $fs->remove($filesFinder->files());
    }
}