PHPPgAdmin\Controller\ServersController

Complexity

Total Complexity

30

Size/Duplication

Total Lines	280
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	doLogout()	0	18	1
B	render()	0	39	4
C	doTree()	0	42	8
C	doDefault()	0	82	7
C	getServersGroups()	0	66	10

<?php

/**
 * PHPPgAdmin v6.0.0-beta.33
 */

namespace PHPPgAdmin\Controller;

use PHPPgAdmin\Decorators\Decorator;

/**
 * Base controller class.
 *
 * @package PHPPgAdmin
 */
class ServersController extends BaseController
{

    use ServersTrait;

The trait PHPPgAdmin\Controller\ServersTrait requires some properties which are not provided by PHPPgAdmin\Controller\ServersController: $EOF, $fields

    public $controller_name = 'ServersController';
    public $table_place     = 'servers-servers';
    public $section         = 'servers';
    public $query           = '';
    public $subject         = '';
    public $start_time;
    public $duration;

    /**
     * Default method to render the controller according to the action parameter.
     */
    public function render()
    {
        $lang = $this->lang;

The assignment to $lang is dead and can be removed.

        $action = $this->action;

        if ('tree' == $action) {
            return $this->doTree();
        }

        $msg = $this->msg;

        $server_html = $this->printHeader($this->lang['strservers'], null, false);
        $server_html .= $this->printBody(false);
        $server_html .= $this->printTrail('root', false);

        ob_start();
        switch ($action) {
            case 'logout':
                $this->doLogout();

                break;
            default:
                $this->doDefault($msg);

                break;
        }

        $server_html .= ob_get_clean();

        $server_html .= $this->printFooter(false);

        if (null === $this->container->requestobj->getAttribute('route')) {
            echo $server_html;
        } else {
            $body = $this->container->responseobj->getBody();
            $body->write($server_html);

            return $this->container->responseobj;
        }
    }

    public function doDefault($msg = '')
    {
        $lang = $this->lang;

        $this->printTabs('root', 'servers');
        $this->printMsg($msg);
        $group = isset($_GET['group']) ? $_GET['group'] : false;

        $groups  = $this->getServersGroups(true, $group);
        $columns = [
            'group' => [
                'title' => $lang['strgroup'],
                'field' => Decorator::field('desc'),
                'url'   => 'servers?',
                'vars'  => ['group' => 'id'],
            ],
        ];
        $actions = [];
        if (

First condition of a multi-line IF statement must directly follow the opening parenthesis

            (false !== $group) &&

Each line in a multi-line IF statement must begin with a boolean operator

            (isset($this->conf['srv_groups'][$group])) &&

Each line in a multi-line IF statement must begin with a boolean operator

            ($groups->recordCount() > 0)

Each line in a multi-line IF statement must begin with a boolean operator

        ) {
            $this->printTitle(sprintf($lang['strgroupgroups'], htmlentities($this->conf['srv_groups'][$group]['desc'], ENT_QUOTES, 'UTF-8')));
            echo $this->printTable($groups, $columns, $actions, $this->table_place);
        }

        $servers = $this->getServers(true, $group);

        $columns = [
            'server'   => [
                'title' => $lang['strserver'],
                'field' => Decorator::field('desc'),
                'url'   => \SUBFOLDER . '/redirect/server?',
                'vars'  => ['server' => 'sha'],
            ],
            'host'     => [
                'title' => $lang['strhost'],
                'field' => Decorator::field('host'),
            ],
            'port'     => [
                'title' => $lang['strport'],
                'field' => Decorator::field('port'),
            ],
            'username' => [
                'title' => $lang['strusername'],
                'field' => Decorator::field('username'),
            ],
            'actions'  => [
                'title' => $lang['stractions'],
            ],
        ];

        $actions = [
            'logout' => [
                'content' => $lang['strlogout'],
                'attr'    => [
                    'href' => [
                        'url'     => 'servers',
                        'urlvars' => [
                            'action'       => 'logout',
                            'logoutServer' => Decorator::field('id'),
                        ],
                    ],
                ],
            ],
        ];

        $svPre = function (&$rowdata) use ($actions) {
            $actions['logout']['disable'] = empty($rowdata->fields['username']);

            return $actions;
        };

        if (

First condition of a multi-line IF statement must directly follow the opening parenthesis

            (false !== $group) &&

Each line in a multi-line IF statement must begin with a boolean operator

            isset($this->conf['srv_groups'][$group])

Each line in a multi-line IF statement must begin with a boolean operator

        ) {
            $this->printTitle(sprintf($lang['strgroupservers'], htmlentities($this->conf['srv_groups'][$group]['desc'], ENT_QUOTES, 'UTF-8')), null);
            $actions['logout']['attr']['href']['urlvars']['group'] = $group;
        }
        echo $this->printTable($servers, $columns, $actions, $this->table_place, $lang['strnoobjects'], $svPre);
    }

    public function doTree()
    {
        $nodes    = [];
        $group_id = isset($_GET['group']) ? $_GET['group'] : false;

        // root with srv_groups
        if (isset($this->conf['srv_groups']) and count($this->conf['srv_groups']) > 0
            and false === $group_id) {

Closing parenthesis of a multi-line IF statement must be on a new line

            $nodes = $this->getServersGroups(true);
        } elseif (isset($this->conf['srv_groups']) and false !== $group_id) {
            // group subtree
            if ('all' !== $group_id) {
                $nodes = $this->getServersGroups(false, $group_id);
            }

            $nodes = array_merge($nodes, $this->getServers(false, $group_id));

It seems like $nodes can also be of type PHPPgAdmin\ArrayRecordSet; however, parameter $array1 of array_merge() does only seem to accept array, maybe add an additional type check?

It seems like $this->getServers(false, $group_id) can also be of type PHPPgAdmin\ArrayRecordSet; however, parameter $array2 of array_merge() does only seem to accept null|array, maybe add an additional type check?

            $nodes = new \PHPPgAdmin\ArrayRecordSet($nodes);
        } else {
            // no srv_group
            $nodes = $this->getServers(true, false);
        }

        $reqvars = $this->misc->getRequestVars('server');

The assignment to $reqvars is dead and can be removed.

        //$this->prtrace($reqvars);

        $attrs = [
            'text'    => Decorator::field('desc'),
            // Show different icons for logged in/out
            'icon'    => Decorator::field('icon'),
            'toolTip' => Decorator::field('id'),
            'action'  => Decorator::field('action'),
            // Only create a branch url if the user has
            // logged into the server.
            'branch'  => Decorator::field('branch'),
        ];
        /*$this->prtrace([
        'nodes'   => $nodes,
        'attrs'   => $attrs,
        'section' => $this->section,
        ]);*/
        return $this->printTree($nodes, $attrs, $this->section);
    }

    public function doLogout()
    {
        $plugin_manager = $this->plugin_manager;
        $lang           = $this->lang;
        $this->misc     = $this->misc;
        $conf           = $this->conf;

The assignment to $conf is dead and can be removed.

        $data           = $this->misc->getDatabaseAccessor();

The assignment to $data is dead and can be removed.

        $plugin_manager->do_hook('logout', $_REQUEST['logoutServer']);

        $server_info = $this->misc->getServerInfo($_REQUEST['logoutServer']);
        $this->misc->setServerInfo(null, null, $_REQUEST['logoutServer']);

        unset($_SESSION['sharedUsername'], $_SESSION['sharedPassword']);

        $this->misc->setReloadBrowser(true);

        echo sprintf($lang['strlogoutmsg'], $server_info['desc']);
    }

    /**
     * Get list of server groups.
     *
     * @param bool  $recordset return as RecordSet suitable for HTMLTableController::printTable if true, otherwise just return an array
     * @param mixed $group_id  a group name to filter the returned servers using $this->conf[srv_groups]
     *
     * @return array|\PHPPgAdmin\ArrayRecordSet either an array or a Recordset suitable for HTMLTableController::printTable
     */
    private function getServersGroups($recordset = false, $group_id = false)

Private method name "ServersController::getServersGroups" must be prefixed with an underscore

    {
        $lang = $this->lang;
        $grps = [];

        if (isset($this->conf['srv_groups'])) {
            foreach ($this->conf['srv_groups'] as $i => $group) {
                if (

First condition of a multi-line IF statement must directly follow the opening parenthesis

                    (($group_id === false) and (!isset($group['parents']))) /* root */

Each line in a multi-line IF statement must begin with a boolean operator

                    or (
                        ($group_id !== false)

Multi-line IF statement not indented correctly; expected 20 spaces but found 24

Each line in a multi-line IF statement must begin with a boolean operator

                        and isset($group['parents'])

Multi-line IF statement not indented correctly; expected 20 spaces but found 24

                        and in_array($group_id, explode(

Multi-line IF statement not indented correctly; expected 20 spaces but found 24

The opening parenthesis of a multi-line function call should be the last content on the line.

                            ',',
                            preg_replace('/\s/', '', $group['parents'])
                        ), true)

For multi-line function calls, the closing parenthesis should be on a new line.

                    ) /* nested group */

Each line in a multi-line IF statement must begin with a boolean operator

                ) {
                    $grps[$i] = [
                        'id'     => $i,
                        'desc'   => $group['desc'],
                        'icon'   => 'Servers',
                        'action' => Decorator::url(
                            'servers',
                            [
                                'group' => Decorator::field('id'),
                            ]
                        ),
                        'branch' => Decorator::url(
                            'servers',
                            [
                                'action' => 'tree',
                                'group'  => $i,
                            ]
                        ),
                    ];
                }
            }

            if ($group_id === false) {
                $grps['all'] = [
                    'id'     => 'all',
                    'desc'   => $lang['strallservers'],
                    'icon'   => 'Servers',
                    'action' => Decorator::url(
                        'servers',
                        [
                            'group' => Decorator::field('id'),
                        ]
                    ),
                    'branch' => Decorator::url(
                        'servers',
                        [
                            'action' => 'tree',
                            'group'  => 'all',
                        ]
                    ),
                ];
            }
        }

        if ($recordset) {
            return new \PHPPgAdmin\ArrayRecordSet($grps);
        }

        return $grps;
    }
}