gplcart\modules\editor\controllers\Editor

Complexity

Total Complexity

47

Size/Duplication

Total Lines	432
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	outputListEditor()	0	4	1
A	__construct()	0	7	1
A	themeEditor()	0	9	1
A	setTitleThemeEditor()	0	4	1
A	setBreadcrumbThemeEditor()	0	16	1
A	outputThemeEditor()	0	4	1
A	listEditor()	0	12	1
A	setModuleEditor()	0	14	3
A	getFilesEditor()	0	5	1
B	prepareFilesEditor()	0	28	4
A	setTitleListEditor()	0	5	1
A	setBreadcrumbListEditor()	0	16	1
A	editEditor()	0	19	1
A	setMessageEditEditor()	0	10	4
A	setJsSettingsEditor()	0	9	1
A	submitEditor()	0	6	3
A	validateEditor()	0	12	1
B	validateSyntaxEditor()	0	17	6
A	saveEditor()	0	14	2
A	canSaveEditor()	0	5	2
A	controlAccessSaveEditor()	0	6	2
A	setTitleEditEditor()	0	6	1
B	setBreadcrumbEditEditor()	0	26	1
A	outputEditEditor()	0	4	1
A	setFilePathEditor()	0	12	3
A	getFileContentEditor()	0	4	1
A	getFileTotalLinesEditor()	0	4	1

<?php

/**
 * @package Theme editor
 * @author Iurii Makukh <gplcart.software@gmail.com>
 * @copyright Copyright (c) 2015, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
 */

namespace gplcart\modules\editor\controllers;

use gplcart\core\models\Module as ModuleModel,
    gplcart\modules\editor\models\Editor as EditorModuleModel;
use gplcart\core\controllers\backend\Controller as BackendController;

/**
 * Handles incoming requests and outputs data related to Theme editor module
 */
class Editor extends BackendController
{

    /**
     * Editor model instance
     * @var \gplcart\modules\editor\models\Editor $editor
     */
    protected $editor;

    /**
     * Module model instance
     * @var \gplcart\core\models\Module $module
     */
    protected $module;

    /**
     * The current module
     * @var array
     */
    protected $data_module = array();

    /**
     * The current module file
     * @var string
     */
    protected $data_file;

    /**
     * The current file extension
     * @var string
     */
    protected $data_extension;

    /**
     * @param EditorModuleModel $editor
     * @param ModuleModel $module
     */
    public function __construct(EditorModuleModel $editor, ModuleModel $module)
    {
        parent::__construct();

        $this->editor = $editor;
        $this->module = $module;
    }

    /**
     * Route callback to display the select theme page
     */
    public function themeEditor()
    {
        $this->setTitleThemeEditor();
        $this->setBreadcrumbThemeEditor();

        $this->setData('themes', $this->module->getByType('theme'));

        $this->outputThemeEditor();
    }

    /**
     * Set title on the select theme page
     */
    protected function setTitleThemeEditor()
    {
        $this->setTitle($this->text('Themes'));
    }

    /**
     * Set breadcrumbs on the select theme page
     */
    protected function setBreadcrumbThemeEditor()
    {
        $breadcrumbs = array();

        $breadcrumbs[] = array(
            'url' => $this->url('admin'),
            'text' => $this->text('Dashboard')
        );

        $breadcrumbs[] = array(
            'url' => $this->url('admin/module/list'),
            'text' => $this->text('Modules')
        );

        $this->setBreadcrumbs($breadcrumbs);
    }

    /**
     * Output rendered templates on the select theme page
     */
    protected function outputThemeEditor()
    {
        $this->output('editor|themes');
    }

    /**
     * Displays the module file overview page
     * @param integer $module_id
     */
    public function listEditor($module_id)
    {
        $this->setModuleEditor($module_id);

        $this->setTitleListEditor();
        $this->setBreadcrumbListEditor();

        $this->setData('module', $this->data_module);
        $this->setData('files', $this->getFilesEditor());

        $this->outputListEditor();
    }

    /**
     * Returns an array of module data
     * @param string $module_id
     */
    protected function setModuleEditor($module_id)
    {
        $module = $this->module->get($module_id);

        if (empty($module)) {
            $this->outputHttpStatus(404);
        }

        if ($module['type'] !== 'theme') {
            $this->outputHttpStatus(403);
        }

        $this->data_module = $module;
    }

    /**
     * Returns an array of files to edit
     * @return array
     */
    protected function getFilesEditor()
    {
        $data = $this->editor->getList($this->data_module);
        return $this->prepareFilesEditor($data);
    }

    /**
     * Prepares an array of files to be edited
     * @param array $data
     * @return array
     */
    protected function prepareFilesEditor(array $data)
    {
        $prepared = array();
        foreach ($data as $folder => $files) {
            foreach ($files as $file) {

                $path = trim(str_replace($this->data_module['directory'], '', $file), '/');
                $depth = substr_count(str_replace('\\', '/', $path), '/'); // WIN compatibility

                $pathinfo = pathinfo($path);
                $directory = is_dir($file);
                $parent = $directory ? $path : $pathinfo['dirname'];

                $prepared[$folder][$parent][] = array(
                    'file' => $file,
                    'path' => $path,
                    'depth' => $depth,
                    'directory' => $directory,
                    'name' => $pathinfo['basename'],
                    'id' => gplcart_string_encode($path),
                    'indentation' => str_repeat('<span class="indentation"></span>', $depth)
                );
            }

            ksort($prepared[$folder]);
        }
        return $prepared;
    }

    /**
     * Sets title on theme files overview page
     */
    protected function setTitleListEditor()
    {
        $text = $this->text('Edit theme %name', array('%name' => $this->data_module['name']));
        $this->setTitle($text);
    }

    /**
     * Sets breadcrumbs on theme files overview page
     */
    protected function setBreadcrumbListEditor()
    {
        $breadcrumbs = array();

        $breadcrumbs[] = array(
            'url' => $this->url('admin'),
            'text' => $this->text('Dashboard')
        );

        $breadcrumbs[] = array(
            'url' => $this->url('admin/module/list'),
            'text' => $this->text('Modules')
        );

        $this->setBreadcrumbs($breadcrumbs);
    }

    /**
     * Renders templates of theme files overview page
     */
    protected function outputListEditor()
    {
        $this->output('editor|list');
    }

    /**
     * Displays the file edit page
     * @param string $module_id
     * @param string $file_id
     */
    public function editEditor($module_id, $file_id)
    {
        $this->setModuleEditor($module_id);
        $this->setFilePathEditor($file_id);

        $this->setTitleEditEditor();
        $this->setBreadcrumbEditEditor();
        $this->setMessageEditEditor();

        $this->setData('module', $this->data_module);
        $this->setData('can_save', $this->canSaveEditor());
        $this->setData('lines', $this->getFileTotalLinesEditor());
        $this->setData('editor.content', $this->getFileContentEditor());

        $this->submitEditor();

        $this->setJsSettingsEditor();
        $this->outputEditEditor();
    }

    /**
     * Sets messages on the file edit page
     */
    protected function setMessageEditEditor()
    {
        if ($this->canSaveEditor() && $this->data_extension === 'php') {
            $this->setMessage($this->text('Be careful! Invalid PHP code can break down all your site!'), 'danger');
            if (!$this->editor->canValidatePhpCode()) {
                $message = $this->text('PHP syntax validation is disabled due to your environment settings');
                $this->setMessage($message, 'warning');
            }
        }
    }

    /**
     * Sets JavaScript settings on the file edit page
     */
    protected function setJsSettingsEditor()
    {
        $settings = array(
            'readonly' => !$this->canSaveEditor(),
            'file_extension' => $this->data_extension
        );

        $this->setJsSettings('editor', $settings);
    }

    /**
     * Saves an array of submitted data
     */
    protected function submitEditor()
    {
        if ($this->isPosted('save') && $this->validateEditor()) {
            $this->saveEditor();
        }
    }

    /**
     * Validates a submitted data when editing a theme file
     * @return bool
     */
    protected function validateEditor()
    {
        $this->setSubmitted('editor', null, false);

        $this->setSubmitted('user_id', $this->uid);
        $this->setSubmitted('path', $this->data_file);
        $this->setSubmitted('module', $this->data_module);

        $this->validateSyntaxEditor();

        return !$this->hasErrors();
    }

    /**
     * Validate syntax of a submitted file
     */
    protected function validateSyntaxEditor()
    {
        $code = $this->getSubmitted('content');

        if (empty($code) || $this->data_extension !== 'php') {
            return null;
        }

        $result = $this->editor->validatePhpCode($code);

        if (!isset($result) || $result === true) {
            return null;
        }

        $error = empty($result) ? $this->text('There is a syntax error in your file') : $result;
        $this->setError('content', $error);
    }

    /**
     * Writes a submitted content to a theme file
     */
    protected function saveEditor()
    {
        $this->controlAccessSaveEditor();

        $submitted = $this->getSubmitted();
        $result = $this->editor->save($submitted);

        if ($result === true) {
            $message = $this->text('Theme file has been saved');
            $this->redirect("admin/tool/editor/{$submitted['module']['id']}", $message, 'success');
        }

        $this->redirect('', $this->text('An error occurred'), 'warning');
    }

    /**
     * Whether the current user can save the file
     */
    protected function canSaveEditor()
    {
        return $this->access('editor_edit')//
                && $this->current_theme['id'] != $this->data_module['id'];
    }

    /**
     * Controls permissions to save a theme file for the current user
     */
    protected function controlAccessSaveEditor()
    {
        if (!$this->canSaveEditor()) {
            $this->outputHttpStatus(403);
        }
    }

    /**
     * Sets titles on the file edit page
     */
    protected function setTitleEditEditor()
    {
        $vars = array('%name' => str_replace('\\', '/', gplcart_relative_path($this->data_file)));
        $text = $this->text('Edit file %name', $vars);
        $this->setTitle($text);
    }

    /**
     * Sets breadcrumbs on the file edit page
     */
    protected function setBreadcrumbEditEditor()
    {
        $breadcrumbs = array();

        $breadcrumbs[] = array(
            'url' => $this->url('admin'),
            'text' => $this->text('Dashboard')
        );

        $breadcrumbs[] = array(
            'url' => $this->url('admin/module/list'),
            'text' => $this->text('Modules')
        );

        $breadcrumbs[] = array(
            'url' => $this->url('admin/tool/editor'),
            'text' => $this->text('Themes')
        );

        $breadcrumbs[] = array(
            'url' => $this->url("admin/tool/editor/{$this->data_module['id']}"),
            'text' => $this->text('Edit theme %name', array('%name' => $this->data_module['name']))
        );

        $this->setBreadcrumbs($breadcrumbs);
    }

    /**
     * Renders the file edit page
     */
    protected function outputEditEditor()
    {
        $this->output('editor|edit');
    }

    /**
     * Returns a path to the file to be edited
     * @param string $encoded_filename URL encoded base64 hash
     */
    protected function setFilePathEditor($encoded_filename)
    {
        $filepath = gplcart_string_decode($encoded_filename);
        $file = "{$this->data_module['directory']}/$filepath";

        if (!is_file($file) || !is_readable($file)) {
            $this->outputHttpStatus(404);
        }

        $this->data_file = $file;
        $this->data_extension = pathinfo($file, PATHINFO_EXTENSION);
    }

    /**
     * Returns a content of the file
     * @return string
     */
    protected function getFileContentEditor()
    {
        return file_get_contents($this->data_file);
    }

    /**
     * Returns the total number of lines in the file
     * @return integer
     */
    protected function getFileTotalLinesEditor()
    {
        return count(file($this->data_file));
    }

}