midcom_services_rcs_handler

Complexity

Total Complexity

41

Size/Duplication

Total Lines	285
Duplicated Lines	0 %

Test Coverage

Coverage

91.22%

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	load_object()	0	10	3
A	resolve_object_title()	0	3	1
A	rcs_toolbar()	0	25	2
B	populate_rcs_toolbar()	0	34	8
A	add_diff_button()	0	7	1
A	add_preview_button()	0	7	1
A	_show_preview()	0	3	1
A	prepare_request_data()	0	10	2
A	translate()	0	14	4
A	_handler_diff()	0	33	5
A	_handler_preview()	0	24	4
A	_handler_history()	0	14	4
A	_handler_restore()	0	13	3
A	_show_diff()	0	3	1
A	_show_history()	0	5	1

<?php
/**
 * @package midcom.services.rcs
 * @author CONTENT CONTROL http://www.contentcontrol-berlin.de/
 * @copyright CONTENT CONTROL http://www.contentcontrol-berlin.de/
 */

use Symfony\Component\HttpFoundation\Request;

/**
 * @package midcom.services.rcs
 */
abstract class midcom_services_rcs_handler extends midcom_baseclasses_components_handler
{
    /**
     * RCS backend
     *
     * @var midcom_services_rcs_backend
     */
    private $backend;

    /**
     * Pointer to midgard object
     *
     * @var midcom_core_dbaobject
     */
    protected $object;

    protected $style_prefix = '';

    protected $url_prefix = '';

    abstract protected function get_object_url() : string;

    abstract protected function handler_callback(string $handler_id);

    abstract protected function get_breadcrumbs() : array;

    protected function resolve_object_title()
    {
        return midcom_helper_reflector::get($this->object)->get_object_label($this->object);
    }

    /**
     * Load the object and the rcs backend
     */
    private function load_object(string $guid)
    {
        $this->object = midcom::get()->dbfactory->get_object_by_guid($guid);

        if (   !midcom::get()->config->get('midcom_services_rcs_enable')
            || !$this->object->_use_rcs) {
            throw new midcom_error_notfound("Revision control not supported for " . get_class($this->object) . ".");
        }

        $this->backend = midcom::get()->rcs->load_backend($this->object);
    }

    /**
     * Prepare version control toolbar
     */
    private function rcs_toolbar(array $revision, array $revision2 = null)
    {
        $this->add_stylesheet(MIDCOM_STATIC_URL . "/midcom.services.rcs/rcs.css");
        $prefix = midcom_core_context::get()->get_key(MIDCOM_CONTEXT_ANCHORPREFIX) . $this->url_prefix;

Are you sure midcom_core_context::get()->get_key(MIDCOM_CONTEXT_ANCHORPREFIX) of type false|mixed can be used in concatenation?

        $history = $this->backend->get_history();
        $this->_request_data['rcs_toolbar'] = new midcom_helper_toolbar();
        $this->populate_rcs_toolbar($history, $prefix, $revision, $revision2);

        // RCS functional toolbar
        $this->_request_data['rcs_toolbar_2'] = new midcom_helper_toolbar();
        $restore = $revision2 ?: $revision;

        $buttons = [
            [
                MIDCOM_TOOLBAR_URL => "{$prefix}{$this->object->guid}/",
                MIDCOM_TOOLBAR_LABEL => $this->_l10n->get('show history'),
                MIDCOM_TOOLBAR_GLYPHICON => 'history',
            ], [
                MIDCOM_TOOLBAR_URL => "{$prefix}restore/{$this->object->guid}/{$restore['revision']}/",
                MIDCOM_TOOLBAR_LABEL => sprintf($this->_l10n->get('restore version %s'), $restore['version']),
                MIDCOM_TOOLBAR_GLYPHICON => 'recycle',
                MIDCOM_TOOLBAR_ENABLED => ($restore['revision'] !== $history->get_last()['revision']),
            ]
        ];
        $this->_request_data['rcs_toolbar_2']->add_items($buttons);
    }

    private function populate_rcs_toolbar(midcom_services_rcs_history $history, string $prefix, array $revision, ?array $revision2)
    {
        $first = $history->get_first();
        $last = $history->get_last();

        $diff_view = !empty($revision2);
        $revision2 = $revision2 ?? $revision;

        if ($previous = $history->get_previous($revision['revision'])) {
            $enabled = true;
        } else {
            $enabled = false;
            $previous = $first;
        }
        $this->add_preview_button($prefix, $first, 'fast-backward', $enabled || $diff_view);

It seems like $first can also be of type null; however, parameter $entry of midcom_services_rcs_handler::add_preview_button() does only seem to accept array, maybe add an additional type check?

        $this->add_preview_button($prefix, $diff_view ? $revision : $previous, 'backward', $enabled || $diff_view);
        $this->add_diff_button($prefix, $previous, $revision, 'step-backward', $enabled);

It seems like $previous can also be of type null; however, parameter $first of midcom_services_rcs_handler::add_diff_button() does only seem to accept array, maybe add an additional type check?

        $this->_request_data['rcs_toolbar']->add_item([
            MIDCOM_TOOLBAR_URL => "{$prefix}preview/{$this->object->guid}/{$revision2['revision']}/",
            MIDCOM_TOOLBAR_LABEL => sprintf($this->_l10n->get('version %s'), $revision2['version']),
            MIDCOM_TOOLBAR_GLYPHICON => 'file-o',
            MIDCOM_TOOLBAR_ENABLED => $diff_view,
        ]);

        if ($next = $history->get_next($revision2['revision'])) {
            $enabled = true;
        } else {
            $enabled = false;
            $next = $last;
        }
        $this->add_diff_button($prefix, $revision2, $next, 'step-forward', $enabled);

It seems like $next can also be of type null; however, parameter $second of midcom_services_rcs_handler::add_diff_button() does only seem to accept array, maybe add an additional type check?

        $this->add_preview_button($prefix, $next, 'forward', $enabled || $diff_view);
        $this->add_preview_button($prefix, $last, 'fast-forward', $enabled || $diff_view);
    }

    private function add_preview_button(string $prefix, array $entry, string $icon, bool $enabled)
    {
        $this->_request_data['rcs_toolbar']->add_item([
            MIDCOM_TOOLBAR_URL => "{$prefix}preview/{$this->object->guid}/{$entry['revision']}/",
            MIDCOM_TOOLBAR_LABEL => $entry['version'],
            MIDCOM_TOOLBAR_GLYPHICON => $icon,
            MIDCOM_TOOLBAR_ENABLED => $enabled,
        ]);
    }

    private function add_diff_button(string $prefix, array $first, array $second, string $icon, bool $enabled)
    {
        $this->_request_data['rcs_toolbar']->add_item([
            MIDCOM_TOOLBAR_URL => "{$prefix}diff/{$this->object->guid}/{$first['revision']}/{$second['revision']}/",
            MIDCOM_TOOLBAR_LABEL => $this->_l10n->get('show differences'),
            MIDCOM_TOOLBAR_GLYPHICON => $icon,
            MIDCOM_TOOLBAR_ENABLED => $enabled,
        ]);
    }

    private function prepare_request_data(string $view_title)
    {
        foreach ($this->get_breadcrumbs() as $item) {
            $this->add_breadcrumb($item[MIDCOM_NAV_URL], $item[MIDCOM_NAV_NAME]);
        }
        $this->add_breadcrumb($this->url_prefix . "{$this->object->guid}/", $this->_l10n->get('show history'));

        $this->_request_data['handler'] = $this;
        $this->_request_data['view_title'] = $view_title;
        midcom::get()->head->set_pagetitle($view_title);
    }

    public function translate(string $string) : string
    {
        $translated = $string;
        $component = midcom::get()->dbclassloader->get_component_for_class($this->object->__midcom_class_name__);
        if (midcom::get()->componentloader->is_installed($component)) {

It seems like $component can also be of type null; however, parameter $path of midcom_helper__componentloader::is_installed() does only seem to accept string, maybe add an additional type check?

            $translated = midcom::get()->i18n->get_l10n($component)->get($string);

It seems like $component can also be of type null; however, parameter $component of midcom_services_i18n::get_l10n() does only seem to accept string, maybe add an additional type check?

        }
        if ($translated === $string) {
            $translated = $this->_l10n->get($string);
            if ($translated === $string) {
                $translated = $this->_l10n_midcom->get($string);
            }
        }
        return $translated;
    }

    /**
     * Show the changes done to the object
     */
    public function _handler_history(Request $request, string $handler_id, array $args)
    {
        // Check if the comparison request is valid
        $first = $request->query->get('first');
        $last = $request->query->get('last');
        if ($first && $last && $first != $last) {
            return new midcom_response_relocate($this->url_prefix . "diff/{$args[0]}/{$first}/{$last}/");
        }

        $this->load_object($args[0]);
        $view_title = sprintf($this->_l10n->get('revision history of %s'), $this->resolve_object_title());

        $this->prepare_request_data($view_title);
        return $this->handler_callback($handler_id);
    }

    /**
     * @param array $data The local request data.
     */
    public function _show_history(string $handler_id, array &$data)
    {
        $data['history'] = $this->backend->get_history();
        $data['guid'] = $this->object->guid;
        midcom_show_style($this->style_prefix . 'history');
    }

    /**
     * Show a diff between two versions
     */
    public function _handler_diff(string $handler_id, array $args, array &$data)
    {
        $this->load_object($args[0]);
        $history = $this->backend->get_history();

        $compare_revision = $history->get($args[1]);
        $latest_revision = $history->get($args[2]);

        if (!$compare_revision || !$latest_revision) {
            throw new midcom_error_notfound("One of the revisions {$args[1]} or {$args[2]} does not exist.");
        }

        $data['diff'] = array_filter($this->backend->get_diff($args[1], $args[2]), function($value, $key) {
            return array_key_exists('diff', $value)
                && !is_array($value['diff'])
                && midcom_services_rcs::is_field_showable($key);
        }, ARRAY_FILTER_USE_BOTH);
        $data['comment'] = $latest_revision;

        // Set the version numbers
        $data['guid'] = $args[0];

        $view_title = sprintf($this->_l10n->get('changes between revisions %s and %s'), $compare_revision['version'], $latest_revision['version']);

        // Load the toolbars
        $this->rcs_toolbar($compare_revision, $latest_revision);
        $this->prepare_request_data($view_title);
        $this->add_breadcrumb(
            $this->url_prefix . "diff/{$this->object->guid}/{$compare_revision['revision']}/{$latest_revision['revision']}/",
            sprintf($this->_l10n->get('differences between %s and %s'), $compare_revision['version'], $latest_revision['version'])
        );

        return $this->handler_callback($handler_id);
    }

    /**
     * Show the differences between the versions
     */
    public function _show_diff()
    {
        midcom_show_style($this->style_prefix . 'diff');
    }

    /**
     * View previews
     */
    public function _handler_preview(string $handler_id, array $args, array &$data)
    {
        $revision = $args[1];
        $data['latest_revision'] = $revision;
        $data['guid'] = $args[0];
        $this->load_object($args[0]);
        $metadata = $this->backend->get_history()->get($args[1]);
        if (!$metadata) {
            throw new midcom_error_notfound("Revision {$args[1]} does not exist.");
        }

        $data['preview'] = array_filter($this->backend->get_revision($revision), function ($value, $key) {
            return !is_array($value)
                && !in_array($value, ['', '0000-00-00'])
                && midcom_services_rcs::is_field_showable($key);
        }, ARRAY_FILTER_USE_BOTH);

        $this->_view_toolbar->hide_item($this->url_prefix . "preview/{$this->object->guid}/{$revision}/");

        $view_title = sprintf($this->_l10n->get('viewing version %s from %s'), $metadata['version'], $this->_l10n->get_formatter()->datetime($metadata['date']));
        // Load the toolbars
        $this->rcs_toolbar($metadata);
        $this->prepare_request_data($view_title);
        return $this->handler_callback($handler_id);
    }

    public function _show_preview()
    {
        midcom_show_style($this->style_prefix . 'preview');
    }

    /**
     * Restore to diff
     */
    public function _handler_restore(array $args)
    {
        $this->load_object($args[0]);

        $this->object->require_do('midgard:update');
        // TODO: set another privilege for restoring?

        if (   $this->backend->get_history()->version_exists($args[1])
            && $this->backend->restore_to_revision($args[1])) {
            midcom::get()->uimessages->add($this->_l10n->get('midcom.admin.rcs'), sprintf($this->_l10n->get('restore to version %s successful'), $args[1]));
            return new midcom_response_relocate($this->get_object_url());
        }
        throw new midcom_error(sprintf($this->_l10n->get('restore to version %s failed, reason %s'), $args[1], midcom_connection::get_error_string()));
    }
}