App\Controller\TranslationsController

Complexity

Total Complexity

22

Size/Duplication

Total Lines	217
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	typeFromUrl()	0	8	2
A	add()	0	25	2
A	initialize()	0	5	1
A	setupJsonKeys()	0	9	1
A	delete()	0	30	5
B	edit()	0	36	7
A	save()	0	43	4

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2018 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */
namespace App\Controller;

use BEdita\I18n\Core\I18nTrait;
use BEdita\SDK\BEditaClientException;
use Cake\Http\Exception\BadRequestException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\Utility\Hash;
use Psr\Log\LogLevel;

/**
 * Translations controller: create, edit, remove translations
 *
 * @property \App\Controller\Component\HistoryComponent $History
 * @property \App\Controller\Component\ObjectsEditorsComponent $ObjectsEditors
 * @property \App\Controller\Component\PropertiesComponent $Properties
 * @property \App\Controller\Component\ProjectConfigurationComponent $ProjectConfiguration
 * @property \App\Controller\Component\QueryComponent $Query
 * @property \App\Controller\Component\ThumbsComponent $Thumbs
 * @property \BEdita\WebTools\Controller\Component\ApiFormatterComponent $ApiFormatter
 */
class TranslationsController extends ModulesController
{
    use I18nTrait;

    /**
     * @inheritDoc
     */
    public function initialize(): void
    {
        $this->setRequest($this->getRequest()->withParam('object_type', 'translations'));
        parent::initialize();
        $this->Query->setConfig('include', 'object');
    }

    /**
     * Display data to add a translation.
     *
     * @param string|int $id Object ID.
     * @return \Cake\Http\Response|null
     */
    public function add($id): ?Response
    {
        $this->getRequest()->allowMethod(['get']);
        $this->objectType = $this->typeFromUrl();

        try {
            $response = $this->apiClient->getObject($id, $this->objectType);
        } catch (BEditaClientException $e) {
            // Error! Back to index.
            $this->log($e->getMessage(), LogLevel::ERROR);
            $this->Flash->error($e->getMessage(), ['params' => $e]);

            return $this->redirect(['_name' => 'modules:view', 'object_type' => $this->objectType, 'id' => $id]);
        }
        $this->ProjectConfiguration->read();

        $this->set('schema', $this->Schema->getSchema($this->objectType));

        $object = Hash::extract($response, 'data');
        $this->set('translation', []);
        $this->set('object', $object);
        // Use first available language as default new language
        $this->set('newLang', array_key_first($this->getLanguages()));

        return null;
    }

    /**
     * View single translation.
     *
     * @param string|int $id Object ID.
     * @param string $lang The lang code.
     * @return \Cake\Http\Response|null
     */
    public function edit($id, $lang): ?Response
    {
        $this->getRequest()->allowMethod(['get']);
        $this->objectType = $this->typeFromUrl();

        $translation = [];
        try {
            $response = $this->apiClient->getObject($id, $this->objectType, compact('lang'));

            // verify that exists a translation in lang $lang inside include
            if (!empty($response['included'])) {
                foreach ($response['included'] as $included) {
                    if ($included['type'] === 'translations' && $included['attributes']['lang'] == $lang) {
                        $translation = $included;
                    }
                }
            }
            if (empty($translation)) {
                throw new NotFoundException(sprintf('Translation not found per %s %s and lang %s', $this->objectType, $id, $lang));
            }
        } catch (\Exception $e) {
            // Error! Back to index.
            $this->log($e->getMessage(), LogLevel::ERROR);
            $this->Flash->error($e->getMessage(), ['params' => $e]);

            return $this->redirect(['_name' => 'modules:view', 'object_type' => $this->objectType, 'id' => $id]);
        }
        $this->ProjectConfiguration->read();

        $this->set('schema', $this->Schema->getSchema($this->objectType));

        $object = Hash::extract($response, 'data');
        $this->set('translation', $translation);
        $this->set('object', $object);

        return null;
    }

    /**
     * Create or edit single translation.
     *
     * @return void
     */
    public function save(): void
    {
        $this->request->allowMethod(['post']);
        $this->objectType = $this->typeFromUrl();
        $this->setupJsonKeys();
        $requestData = $this->prepareRequest($this->objectType);
        $objectId = $requestData['object_id'];
        if (!empty($requestData['id'])) {
            unset($requestData['object_id']);
        }
        $lang = $requestData['lang'];
        try {
            $this->apiClient->save('translations', $requestData);
        } catch (BEditaClientException $e) {
            // Error! Back to object view or index.
            $this->log($e->getMessage(), LogLevel::ERROR);
            $this->Flash->error($e->getMessage(), ['params' => $e]);

            if ($this->getRequest()->getData('id')) {
                $this->redirect([
                    '_name' => 'translations:edit',
                    'object_type' => $this->objectType,
                    'id' => $objectId,
                    'lang' => $lang,
                ]);

                return;
            }

            $this->redirect([
                '_name' => 'translations:add',
                'object_type' => $this->objectType,
                'id' => $objectId,
            ]);

            return;
        }

        $this->redirect([
            '_name' => 'translations:edit',
            'object_type' => $this->objectType,
            'id' => $objectId,
            'lang' => $lang,
        ]);
    }

    /**
     * Setup internal `_jsonKeys`, add `translated_fields.` prefix
     * to create the correct path to the single translated field.
     *
     * @return void
     */
    protected function setupJsonKeys(): void
    {
        $jsonKeys = (array)array_map(
            function ($v) {
                return sprintf('translated_fields.%s', $v);
            },
            explode(',', (string)$this->request->getData('_jsonKeys'))
        );
        $this->request = $this->request->withData('_jsonKeys', implode(',', $jsonKeys));
    }

    /**
     * Delete single translation.
     * Expected request:
     *     data: [
     *         {
     *             id: <translation id>,
     *             object_id: <translated object id>,
     *         }
     *     ]
     *
     * @return \Cake\Http\Response
     */
    public function delete(): Response
    {
        $this->getRequest()->allowMethod(['post']);
        $this->objectType = $this->typeFromUrl();
        $requestData = $this->getRequest()->getData();
        $translation = [];
        try {
            if (empty($requestData[0])) {
                throw new BadRequestException(__('Empty request data'));
            }
            $translation = $requestData[0];
            if (empty($translation['id'])) {
                throw new BadRequestException(__('Empty translation "id"'));
            }
            if (empty($translation['object_id'])) {
                throw new BadRequestException(__('Empty translation "object_id"'));
            }
            // remove completely the translation
            $this->apiClient->delete(sprintf('/translations/%s', $translation['id']));
        } catch (BEditaClientException $e) {
            $this->log($e->getMessage(), LogLevel::ERROR);
            $this->Flash->error($e->getMessage(), ['params' => $e]);

            // redir to main object view
            return $this->redirect(['_name' => 'modules:view', 'object_type' => $this->objectType, 'id' => $translation['object_id']]);
        }
        $this->Flash->success(__('Translation(s) deleted'));

        // redir to main object view
        return $this->redirect(['_name' => 'modules:view', 'object_type' => $this->objectType, 'id' => $translation['object_id']]);
    }

    /**
     * Get type from url, if objectType is 'translations'
     *
     * @return string
     */
    protected function typeFromUrl(): string
    {
        if ($this->objectType !== 'translations') {
            return $this->objectType;
        }
        $here = (string)$this->getRequest()->getAttribute('here');

        return substr($here, 1, strpos(substr($here, 1), '/'));
    }
}