php-translation / symfony-bundle

Controller/WebUIController.php

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <tobias.nyholm@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\Intl\Intl;
use Symfony\Component\Intl\Locales;
use Symfony\Component\Translation\MessageCatalogue;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use Translation\Bundle\Catalogue\CatalogueFetcher;
use Translation\Bundle\Catalogue\CatalogueManager;
use Translation\Bundle\Exception\MessageValidationException;
use Translation\Bundle\Model\CatalogueMessage;
use Translation\Bundle\Service\ConfigurationManager;
use Translation\Bundle\Service\StorageManager;
use Translation\Bundle\Service\StorageService;
use Translation\Common\Exception\StorageException;
use Translation\Common\Model\Message;
use Translation\Common\Model\MessageInterface;

/**
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
class WebUIController extends AbstractController
{
    private $configurationManager;
    private $catalogueFetcher;
    private $catalogueManager;
    private $storageManager;
    private $validator;
    private $locales;
    private $isWebUIEnabled;
    private $isWebUIAllowCreate;
    private $isWebUIAllowDelete;
    private $fileBasePath;

    public function __construct(
        ConfigurationManager $configurationManager,
        CatalogueFetcher $catalogueFetcher,
        CatalogueManager $catalogueManager,
        StorageManager $storageManager,
        ValidatorInterface $validator,
        array $locales,
        bool $isWebUIEnabled,
        bool $isWebUIAllowCreate,
        bool $isWebUIAllowDelete,
        string $fileBasePath
    ) {
        $this->configurationManager = $configurationManager;
        $this->catalogueFetcher = $catalogueFetcher;
        $this->catalogueManager = $catalogueManager;
        $this->storageManager = $storageManager;
        $this->validator = $validator;
        $this->locales = $locales;
        $this->isWebUIEnabled = $isWebUIEnabled;
        $this->isWebUIAllowCreate = $isWebUIAllowCreate;
        $this->isWebUIAllowDelete = $isWebUIAllowDelete;
        $this->fileBasePath = $fileBasePath;
    }

    /**
     * Show a dashboard for the configuration.
     */
    public function indexAction(?string $configName = null): Response
    {
        if (!$this->isWebUIEnabled) {
            return new Response('You are not allowed here. Check your config.', Response::HTTP_BAD_REQUEST);
        }

        $config = $this->configurationManager->getConfiguration($configName);
        $localeMap = $this->getLocale2LanguageMap();
        $catalogues = $this->catalogueFetcher->getCatalogues($config);

        $catalogueSize = [];
        $maxDomainSize = [];
        $maxCatalogueSize = 1;

        // For each catalogue (or locale)
        /** @var MessageCatalogue $catalogue */
        foreach ($catalogues as $catalogue) {
            $locale = $catalogue->getLocale();
            $domains = $catalogue->all();
            \ksort($domains);
            $catalogueSize[$locale] = 0;
            foreach ($domains as $domain => $messages) {
                $count = \count($messages);
                $catalogueSize[$locale] += $count;
                if (!isset($maxDomainSize[$domain]) || $count > $maxDomainSize[$domain]) {
                    $maxDomainSize[$domain] = $count;
                }
            }

            if ($catalogueSize[$locale] > $maxCatalogueSize) {
                $maxCatalogueSize = $catalogueSize[$locale];
            }
        }

        return $this->render('@Translation/WebUI/index.html.twig', [
            'catalogues' => $catalogues,
            'catalogueSize' => $catalogueSize,
            'maxDomainSize' => $maxDomainSize,
            'maxCatalogueSize' => $maxCatalogueSize,
            'localeMap' => $localeMap,
            'configName' => $config->getName(),
            'configNames' => $this->configurationManager->getNames(),
        ]);
    }

    /**
     * Show a catalogue.
     */
    public function showAction(string $configName, string $locale, string $domain): Response
    {
        if (!$this->isWebUIEnabled) {
            return new Response('You are not allowed here. Check your config.', Response::HTTP_BAD_REQUEST);
        }
        $config = $this->configurationManager->getConfiguration($configName);

        // Get a catalogue manager and load it with all the catalogues
        $this->catalogueManager->load($this->catalogueFetcher->getCatalogues($config));

        /** @var CatalogueMessage[] $messages */
        $messages = $this->catalogueManager->getMessages($locale, $domain);
        \usort($messages, function (CatalogueMessage $a, CatalogueMessage $b) {
            return \strcmp($a->getKey(), $b->getKey());
        });

        return $this->render('@Translation/WebUI/show.html.twig', [
            'messages' => $messages,
            'domains' => $this->catalogueManager->getDomains(),
            'currentDomain' => $domain,
            'locales' => $this->locales,
            'currentLocale' => $locale,
            'configName' => $config->getName(),
            'configNames' => $this->configurationManager->getNames(),
            'allow_create' => $this->isWebUIAllowCreate,
            'allow_delete' => $this->isWebUIAllowDelete,
            'file_base_path' => $this->fileBasePath,
        ]);
    }

    public function createAction(Request $request, string $configName, string $locale, string $domain): Response
    {
        if (!$this->isWebUIEnabled || !$this->isWebUIAllowCreate) {
            return new Response('You are not allowed to create. Check your config.', Response::HTTP_BAD_REQUEST);
        }

        /** @var StorageService $storage */
        $storage = $this->storageManager->getStorage($configName);

        try {
            $message = $this->getMessageFromRequest($request);
            $message = $message->withDomain($domain);
            $message = $message->withLocale($locale);
            $this->validateMessage($message, ['Create']);
        } catch (MessageValidationException $e) {
            return new Response($e->getMessage(), Response::HTTP_BAD_REQUEST);
        }

        try {
            $storage->create($message);
        } catch (StorageException $e) {
            throw new BadRequestHttpException(\sprintf('Key "%s" does already exist for "%s" on domain "%s".', $message->getKey(), $locale, $domain), $e);
        } catch (\Exception $e) {
            return new Response($e->getMessage(), Response::HTTP_BAD_REQUEST);
        }

        return $this->render('@Translation/WebUI/create.html.twig', [
            'message' => $message,
        ]);
    }

    public function editAction(Request $request, string $configName, string $locale, string $domain): Response
    {
        if (!$this->isWebUIEnabled) {
            return new Response('You are not allowed here. Check your config.', Response::HTTP_BAD_REQUEST);
        }

        try {
            $message = $this->getMessageFromRequest($request);
            $message = $message->withDomain($domain);
            $message = $message->withLocale($locale);
            $this->validateMessage($message, ['Edit']);
        } catch (MessageValidationException $e) {
            return new Response($e->getMessage(), Response::HTTP_BAD_REQUEST);
        }

        /** @var StorageService $storage */
        $storage = $this->storageManager->getStorage($configName);
        try {
            $storage->update($message);
        } catch (\Exception $e) {
            return new Response($e->getMessage(), Response::HTTP_BAD_REQUEST);
        }

        return new Response('Translation updated');
    }

    public function deleteAction(Request $request, string $configName, string $locale, string $domain): Response
    {
        if (!$this->isWebUIEnabled || !$this->isWebUIAllowDelete) {
            return new Response('You are not allowed to delete. Check your config.', Response::HTTP_BAD_REQUEST);
        }

        try {
            $message = $this->getMessageFromRequest($request);
            $message = $message->withLocale($locale);
            $message = $message->withDomain($domain);
            $this->validateMessage($message, ['Delete']);
        } catch (MessageValidationException $e) {
            return new Response($e->getMessage(), Response::HTTP_BAD_REQUEST);
        }

        /** @var StorageService $storage */
        $storage = $this->storageManager->getStorage($configName);
        try {
            $storage->delete($locale, $domain, $message->getKey());
        } catch (\Exception $e) {
            return new Response($e->getMessage(), Response::HTTP_BAD_REQUEST);
        }

        return new Response('Message was deleted');
    }

    private function getMessageFromRequest(Request $request): Message
    {
        $json = $request->getContent();
        $data = \json_decode($json, true);
        $message = new Message($data['key']);
        if (isset($data['message'])) {
            $message = $message->withTranslation($data['message']);
        }

        return $message;
    }

    /**
     * This will return a map of our configured locales and their language name.
     *
     * @return array locale => language
     */
    private function getLocale2LanguageMap(): array
    {
        $names = \class_exists(Locales::class)
            ? Locales::getNames('en')
            : Intl::getLocaleBundle()->getLocaleNames('en');

The method getLocaleBundle() does not exist on Symfony\Component\Intl\Intl.

        $map = [];
        foreach ($this->locales as $l) {
            $map[$l] = $names[$l] ?? $l;
        }

        return $map;
    }

    /**
     * @throws MessageValidationException
     */
    private function validateMessage(MessageInterface $message, array $validationGroups): void
    {
        $errors = $this->validator->validate($message, null, $validationGroups);
        if (\count($errors) > 0) {
            throw MessageValidationException::create();
        }
    }
}