midgard_admin_asgard_handler_welcome::_populate_toolbar() - Code Metrics - Inspection of "More robust handling of DB incosistencies" - flack/openpsa - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( daf040...4ffbc4 )

by Andreas
created 2021-12-01 16:00 UTC
_populate_toolbar() A

↳ Parent: midgard_admin_asgard_handler_welcome
Complexity

Conditions	2
Paths	2
Size

Total Lines	41
Code Lines	27
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	20
CRAP Score	2.0932
Importance

Changes
Metric	Value
cc	2
eloc	27
nc	2
nop	0
dl	0
loc	41
ccs	20
cts	28
cp	0.7143
crap	2.0932
rs	9.488
c	0
b	0
f	0
<?php
/**
 * @package midgard.admin.asgard
 * @author The Midgard Project, http://www.midgard-project.org
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */

use midcom\grid\provider;
use Symfony\Component\HttpFoundation\Request;

/**
 * Welcome interface
 *
 * @package midgard.admin.asgard
 */
class midgard_admin_asgard_handler_welcome extends midcom_baseclasses_components_handler
{
    use midgard_admin_asgard_handler;

    private function _list_revised(string $since, ?string $type = null, bool $only_mine = false) : array
    {
        $types = ($type !== null) ? [$type] : $this->_request_data['schema_types'];
        $revised = [];

        // List installed MgdSchema types and convert to DBA classes
        foreach ($types as $schema_type) {
            $midcom_dba_classname = midcom::get()->dbclassloader->get_midcom_class_name_for_mgdschema_object(new $schema_type);
            if (!empty($midcom_dba_classname)) {
                // List all revised objects
                $qb = new midcom_core_querybuilder($midcom_dba_classname);
                $qb->add_constraint('metadata.revised', '>=', $since);

                if (   $only_mine
                    && midcom::get()->auth->user) {
                    $qb->add_constraint('metadata.authors', 'LIKE', '|' . midcom::get()->auth->user->guid . '|');
                }

                foreach ($qb->execute() as $object) {
                    $revised["{$object->metadata->revised}_{$object->guid}_{$object->metadata->revision}"] = [
                        'object' => $object,
                        'revisor' => midcom::get()->auth->get_user($object->metadata->revisor)
                    ];
                }
            }
        }

        krsort($revised);
        return $revised;
    }

    /**
     * Object editing view
     */
    public function _handler_welcome(Request $request, array &$data)
    {
        $data['schema_types'] = array_diff(midcom_connection::get_schema_types(), $this->_config->get_array('skip_in_filter'));

        $data['view_title'] = $this->_l10n->get('asgard');

        if ($request->request->has('action') && $request->request->has('entries')) {
            $method_name = '_mass_' . $request->request->get('action');
            $this->$method_name($request->request->get('entries'));
        }

        if ($request->query->has('revised_after')) {
            $data['revised_after'] = date('Y-m-d', $request->query->get('revised_after'));

            $data['type_filter'] = null;
            if ($request->query->get('type_filter', 'any') != 'any') {
                $data['type_filter'] = $request->query->get('type_filter');
            }

            $data['only_mine'] = $request->query->getBoolean('only_mine');

            $objects = $this->_list_revised($data['revised_after'], $data['type_filter'], $data['only_mine']);
        } else {
            $data['revised_after'] = date('Y-m-d', strtotime('yesterday'));
            $objects = $this->_list_revised($data['revised_after']);
        }

        $this->_prepare_tabledata($objects);

        $data['action_options'] = [
            'none' => ['label' => $this->_l10n->get('apply to selected')],
            'delete' => [
                'label' => $this->_l10n_midcom->get('delete'),
            ],
            'approve' => [
                'label' => $this->_l10n_midcom->get('approve'),
            ]
        ];

        $this->_populate_toolbar();
        return $this->get_response();
    }

    private function _prepare_tabledata(array $objects)
    {
        $rows = [];
        foreach ($objects as $data) {
            $object = $data['object'];
            $reflector = midcom_helper_reflector::get($object);

            $row = [
                'revision' => $object->metadata->revision,
                'revised' => $object->metadata->revised,
                'id' => $object->guid,
                'class' => get_class($object),
            ];

            $row['approved'] = ($object->is_approved()) ? strftime('%x %X', $object->metadata->approved) : $this->_l10n->get('not approved');
            try {
                $row['index_title'] = $reflector->get_object_label($object) ?: '[' . $this->_l10n->get('no title') . ']';
            } catch (Exception $e) {
                $row['index_title'] = 'ERROR: ' . $e->getMessage();
            }
            $link = $this->router->generate('object_' . $this->_request_data['default_mode'], ['guid' => $object->guid]);
            $row['title'] = '<a href="' . $link . '" title="' . $row['class'] . '">' . $reflector->get_object_icon($object) . ' ' . $row['index_title'] . '</a>';

            if (empty($data['revisor'])) {
                $row['revisor'] = $this->_l10n_midcom->get('unknown');
            } else {
                $row['revisor'] = $data['revisor']->name;
            }
            $rows[] = $row;
        }
        $provider = new provider($rows, 'local');
        $this->_request_data['grid'] = $provider->get_grid('revised');
    }

    private function _populate_toolbar()
    {
        $buttons = [];
        $buttons[] = [
            MIDCOM_TOOLBAR_URL => $this->router->generate('preferences'),
            MIDCOM_TOOLBAR_LABEL => $this->_l10n->get('user preferences'),
            MIDCOM_TOOLBAR_GLYPHICON => 'sliders',
        ];

        if (midcom::get()->auth->admin) {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => $this->router->generate('shell'),
                MIDCOM_TOOLBAR_LABEL => $this->_l10n->get('shell'),
                MIDCOM_TOOLBAR_GLYPHICON => 'terminal',
            ];
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => $this->router->generate('trash'),
                MIDCOM_TOOLBAR_LABEL => $this->_l10n->get('trash'),
                MIDCOM_TOOLBAR_GLYPHICON => 'trash',
            ];
        }

        $buttons[] = [
            MIDCOM_TOOLBAR_URL => $this->router->generate('components'),
            MIDCOM_TOOLBAR_LABEL => $this->_l10n->get('components'),
            MIDCOM_TOOLBAR_GLYPHICON => 'puzzle-piece',
        ];

        // Add link to site
        $buttons[] = [
            MIDCOM_TOOLBAR_URL => midcom_core_context::get()->get_key(MIDCOM_CONTEXT_ANCHORPREFIX),
            MIDCOM_TOOLBAR_LABEL => $this->_l10n->get('back to site'),
            MIDCOM_TOOLBAR_GLYPHICON => 'home',
        ];

        $buttons[] = [
            MIDCOM_TOOLBAR_URL => midcom_core_context::get()->get_key(MIDCOM_CONTEXT_ANCHORPREFIX) . "midcom-logout-",
            MIDCOM_TOOLBAR_URL => /** @scrutinizer ignore-type */ midcom_core_context::get()->get_key(MIDCOM_CONTEXT_ANCHORPREFIX) . "midcom-logout-",
            MIDCOM_TOOLBAR_LABEL => $this->_l10n_midcom->get('logout'),
            MIDCOM_TOOLBAR_GLYPHICON => 'sign-out',
        ];
        $this->_request_data['asgard_toolbar']->add_items($buttons);
    }

    private function _mass_delete(array $guids)
    {
        foreach ($guids as $guid) {
            try {
                $object = midcom::get()->dbfactory->get_object_by_guid($guid);
            } catch (midcom_error $e) {
                continue;
            }

            if ($object->delete()) {
                midcom::get()->uimessages->add($this->_l10n->get('midgard.admin.asgard'), sprintf($this->_l10n->get('object %s removed'), $object->guid));
            }
        }
    }

    private function _mass_approve(array $guids)
    {
        foreach ($guids as $guid) {
            try {
                $object = midcom::get()->dbfactory->get_object_by_guid($guid);
            } catch (midcom_error $e) {
                continue;
            }

            if (   $object->can_do('midgard:update')
                && $object->can_do('midcom:approve')) {
                $object->metadata->approve();
                midcom::get()->uimessages->add($this->_l10n->get('midgard.admin.asgard'), sprintf($this->_l10n->get('object %s approved'), $object->guid));
            }
        }
    }

    /**
     * Shows the loaded object in editor.
     */
    public function _show_welcome(string $handler_id, array &$data)
    {
        if (midcom::get()->auth->can_user_do('midgard.admin.asgard:manage_objects', null, 'midgard_admin_asgard_plugin')) {
            midcom_show_style('midgard_admin_asgard_welcome');
        }
    }
}

flack / openpsa

Push — master ( daf040...4ffbc4 )

_populate_toolbar() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
