AlldbController - Code Metrics - Inspection of "Apply fixes from StyleCI" - HuasoFoundries/phpPgAdmin6 - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — develop (#209)

by Felipe
created 2018-06-19 15:37 UTC
AlldbController C

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	565
Duplicated Lines	6.73 %
Coupling/Cohesion

Components	1
Dependencies	3
Importance

Changes
Metric	Value
dl	38
loc	565
rs	6.0975
c	0
b	0
f	0
wmc	60
lcom	1
cbo	3
8 Methods

Rating	Name	Duplication	Size	Complexity
C	render()	0	64	13
B	doDefault()	0	138	6
A	doTree()	18	18	1
C	doAlter()	0	61	10
C	doDrop()	0	60	10
D	doCreate()	20	116	16
B	doSaveCreate()	0	37	3
B	doExport()	0	24	1
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like AlldbController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AlldbController, and based on these observations, apply Extract Interface, too.
<?php

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

namespace PHPPgAdmin\Controller;

use PHPPgAdmin\Decorators\Decorator;

/**
 * Base controller class.
 *
 * @package PHPPgAdmin
 */
class AlldbController extends BaseController

{
    use \PHPPgAdmin\Traits\ExportTrait;
    public $table_place      = 'alldb-databases';
    public $controller_title = 'strdatabases';

    /**
     * Default method to render the controller according to the action parameter.
     */
    public function render()

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

        $header_template = 'header.twig';

        ob_start();
        switch ($this->action) {
            case 'export':
                $this->doExport();

                break;
            case 'save_create':
                if (isset($_POST['cancel'])) {
                    $this->doDefault();
                } else {
                    $this->doSaveCreate();
                }

                break;
            case 'create':
                $this->doCreate();

                break;
            case 'drop':
                if (isset($_REQUEST['drop'])) {
                    $this->doDrop(false);
                } else {
                    $this->doDefault();
                }

                break;
            case 'confirm_drop':
                $this->doDrop(true);

                break;
            case 'alter':
                if (isset($_POST['oldname'], $_POST['newname']) && !isset($_POST['cancel'])) {
                    $this->doAlter(false);
                } else {
                    $this->doDefault();
                }

                break;
            case 'confirm_alter':
                $this->doAlter(true);

                break;
            default:
                $header_template = 'header_datatables.twig';
                $this->doDefault();

                break;
        }
        $output = ob_get_clean();

        $this->printHeader($this->headerTitle(), null, true, $header_template);
        $this->printBody();
        echo $output;

        return $this->printFooter();
    }

    /**
     * Show default list of databases in the server.
     *
     * @param mixed $msg
     */
    public function doDefault($msg = '')
    {
        $this->printTrail('server');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->printTabs('server', 'databases');
        $this->printMsg($msg);
        $data = $this->misc->getDatabaseAccessor();

        $databases = $data->getDatabases();

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

        $href = $this->misc->getHREF();

        $columns = [
            'database'   => [
                'title' => $this->lang['strdatabase'],
                'field' => Decorator::field('datname'),
                'url'   => \SUBFOLDER."/redirect/database?{$href}&amp;",
                'vars'  => ['database' => 'datname'],
            ],
            'owner'      => [
                'title' => $this->lang['strowner'],
                'field' => Decorator::field('datowner'),
            ],
            'encoding'   => [
                'title' => $this->lang['strencoding'],
                'field' => Decorator::field('datencoding'),
            ],

            'tablespace' => [
                'title' => $this->lang['strtablespace'],
                'field' => Decorator::field('tablespace'),
            ],
            'dbsize'     => [
                'title' => $this->lang['strsize'],
                'field' => Decorator::field('dbsize'),
                'type'  => 'prettysize',
            ],
            'lc_collate' => [
                'title' => $this->lang['strcollation'],
                'field' => Decorator::field('datcollate'),
            ],
            'lc_ctype'   => [
                'title' => $this->lang['strctype'],
                'field' => Decorator::field('datctype'),
            ],
            'actions'    => [
                'title' => $this->lang['stractions'],
            ],
            'comment'    => [
                'title' => $this->lang['strcomment'],
                'field' => Decorator::field('datcomment'),
            ],
        ];

        $actions = [
            'multiactions' => [
                'keycols' => ['database' => 'datname'],
                'url'     => 'alldb',
                'default' => null,
            ],
            'drop'         => [
                'content'     => $this->lang['strdrop'],
                'attr'        => [
                    'href' => [
                        'url'     => 'alldb',
                        'urlvars' => [
                            'subject'      => 'database',
                            'action'       => 'confirm_drop',
                            'dropdatabase' => Decorator::field('datname'),
                        ],
                    ],
                ],
                'multiaction' => 'confirm_drop',
            ],
            'privileges'   => [
                'content' => $this->lang['strprivileges'],
                'attr'    => [
                    'href' => [
                        'url'     => 'privileges',
                        'urlvars' => [
                            'subject'  => 'database',
                            'database' => Decorator::field('datname'),
                        ],
                    ],
                ],
            ],
        ];
        if ($data->hasAlterDatabase()) {
            $actions['alter'] = [
                'content' => $this->lang['stralter'],
                'attr'    => [
                    'href' => [
                        'url'     => 'alldb',
                        'urlvars' => [
                            'subject'       => 'database',
                            'action'        => 'confirm_alter',
                            'alterdatabase' => Decorator::field('datname'),
                        ],
                    ],
                ],
            ];
        }

        if (!$data->hasTablespaces()) {
            unset($columns['tablespace']);
        }

        if (!$data->hasServerAdminFuncs()) {
            unset($columns['dbsize']);
        }

        if (!$data->hasDatabaseCollation()) {
            unset($columns['lc_collate'], $columns['lc_ctype']);
        }

        if (!isset($data->privlist['database'])) {
            unset($actions['privileges']);
        }

        echo $this->printTable($databases, $columns, $actions, $this->table_place, $this->lang['strnodatabases']);

        $navlinks = [
            'create' => [
                'attr'    => [
                    'href' => [
                        'url'     => 'alldb',
                        'urlvars' => [
                            'action' => 'create',
                            'server' => $_REQUEST['server'],
                        ],
                    ],
                ],
                'content' => $this->lang['strcreatedatabase'],
            ],
        ];
        $this->printNavLinks($navlinks, $this->table_place, get_defined_vars());
    }

    public function doTree()

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

        $databases = $data->getDatabases();

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

        $attrs = [
            'text'    => Decorator::field('datname'),
            'icon'    => 'Database',
            'toolTip' => Decorator::field('datcomment'),
            'action'  => Decorator::redirecturl('redirect', $reqvars, ['subject' => 'database', 'database' => Decorator::field('datname')]),
            'branch'  => Decorator::url('/src/views/database', $reqvars, ['action' => 'tree', 'database' => Decorator::field('datname')]),
        ];

        return $this->printTree($databases, $attrs, 'databases');
    }

    /**
     * Display a form for alter and perform actual alter.
     *
     * @param mixed $confirm
     */
    public function doAlter($confirm)
    {
        $data = $this->misc->getDatabaseAccessor();

        if ($confirm) {
            $this->printTrail('database');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->printTitle($this->lang['stralter'], 'pg.database.alter');

            echo '<form action="'.\SUBFOLDER.'/src/views/alldb" method="post">'.PHP_EOL;
            echo '<table>'.PHP_EOL;
            echo "<tr><th class=\"data left required\">{$this->lang['strname']}</th>".PHP_EOL;
            echo '<td class="data1">';
            echo "<input name=\"newname\" size=\"32\" maxlength=\"{$data->_maxNameLen}\" value=\"",
            htmlspecialchars($_REQUEST['alterdatabase']), '" /></td></tr>'.PHP_EOL;

            if ($data->hasAlterDatabaseOwner() && $data->isSuperUser()) {
                // Fetch all users

                $rs    = $data->getDatabaseOwner($_REQUEST['alterdatabase']);
                $owner = isset($rs->fields['usename']) ? $rs->fields['usename'] : '';
                $users = $data->getUsers();

                echo "<tr><th class=\"data left required\">{$this->lang['strowner']}</th>".PHP_EOL;
                echo '<td class="data1"><select name="owner">';
                while (!$users->EOF) {
                    $uname = $users->fields['usename'];
                    echo '<option value="', htmlspecialchars($uname), '"',
                    ($uname == $owner) ? ' selected="selected"' : '', '>', htmlspecialchars($uname), '</option>'.PHP_EOL;
                    $users->moveNext();
                }
                echo '</select></td></tr>'.PHP_EOL;
            }
            if ($data->hasSharedComments()) {
                $rs      = $data->getDatabaseComment($_REQUEST['alterdatabase']);
                $comment = isset($rs->fields['description']) ? $rs->fields['description'] : '';
                echo "<tr><th class=\"data left\">{$this->lang['strcomment']}</th>".PHP_EOL;
                echo '<td class="data1">';
                echo '<textarea rows="3" cols="32" name="dbcomment">',
                htmlspecialchars($comment), '</textarea></td></tr>'.PHP_EOL;
            }
            echo '</table>'.PHP_EOL;
            echo '<input type="hidden" name="action" value="alter" />'.PHP_EOL;
            echo $this->misc->form;
            echo '<input type="hidden" name="oldname" value="',
            htmlspecialchars($_REQUEST['alterdatabase']), '" />'.PHP_EOL;
            echo "<input type=\"submit\" name=\"alter\" value=\"{$this->lang['stralter']}\" />".PHP_EOL;
            echo "<input type=\"submit\" name=\"cancel\" value=\"{$this->lang['strcancel']}\" />".PHP_EOL;
            echo '</form>'.PHP_EOL;
        } else {
            $this->coalesceArr($_POST, 'owner', '');

            $this->coalesceArr($_POST, 'dbcomment', '');

            if (0 == $data->alterDatabase($_POST['oldname'], $_POST['newname'], $_POST['owner'], $_POST['dbcomment'])) {
                $this->misc->setReloadBrowser(true);
                $this->doDefault($this->lang['strdatabasealtered']);
            } else {
                $this->doDefault($this->lang['strdatabasealteredbad']);
            }
        }
    }

    /**
     * Show confirmation of drop and perform actual drop.
     *
     * @param mixed $confirm
     */
    public function doDrop($confirm)
    {
        $data = $this->misc->getDatabaseAccessor();

        if (empty($_REQUEST['dropdatabase']) && empty($_REQUEST['ma'])) {
            return $this->doDefault($this->lang['strspecifydatabasetodrop']);
        }

        if ($confirm) {
            $this->printTrail('database');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->printTitle($this->lang['strdrop'], 'pg.database.drop');

            echo '<form action="'.\SUBFOLDER.'/src/views/alldb" method="post">'.PHP_EOL;
            //If multi drop
            if (isset($_REQUEST['ma'])) {
                foreach ($_REQUEST['ma'] as $v) {
                    $a = unserialize(htmlspecialchars_decode($v, ENT_QUOTES));
                    echo '<p>', sprintf($this->lang['strconfdropdatabase'], $this->misc->printVal($a['database'])), '</p>'.PHP_EOL;
                    printf('<input type="hidden" name="dropdatabase[]" value="%s" />', htmlspecialchars($a['database']));
                }
            } else {
                echo '<p>', sprintf($this->lang['strconfdropdatabase'], $this->misc->printVal($_REQUEST['dropdatabase'])), '</p>'.PHP_EOL;
                echo '<input type="hidden" name="dropdatabase" value="', htmlspecialchars($_REQUEST['dropdatabase']), '" />'.PHP_EOL;
                // END if multi drop
            }

            echo '<input type="hidden" name="action" value="drop" />'.PHP_EOL;
            echo $this->misc->form;
            echo "<input type=\"submit\" name=\"drop\" value=\"{$this->lang['strdrop']}\" />".PHP_EOL;
            echo "<input type=\"submit\" name=\"cancel\" value=\"{$this->lang['strcancel']}\" />".PHP_EOL;
            echo "</form>\n"; //  END confirm
        } else {
            //If multi drop
            if (is_array($_REQUEST['dropdatabase'])) {
                $msg = '';
                foreach ($_REQUEST['dropdatabase'] as $d) {
                    $status = $data->dropDatabase($d);
                    if (0 == $status) {
                        $msg .= sprintf('%s: %s<br />', htmlentities($d, ENT_QUOTES, 'UTF-8'), $this->lang['strdatabasedropped']);
                    } else {
                        $this->doDefault(sprintf('%s%s: %s<br />', $msg, htmlentities($d, ENT_QUOTES, 'UTF-8'), $this->lang['strdatabasedroppedbad']));

                        return;
                    }
                    // Everything went fine, back to Default page...
                }
                $this->setReloadDropDatabase(true);
                $this->doDefault($msg);
            } else {
                $status = $data->dropDatabase($_POST['dropdatabase']);
                if (0 == $status) {
                    $this->setReloadDropDatabase(true);
                    $this->doDefault($this->lang['strdatabasedropped']);
                } else {
                    $this->doDefault($this->lang['strdatabasedroppedbad']);
                }
            }
            //END DROP
        }
    }

    // END FUNCTION

    /**
     * Displays a screen where they can enter a new database.
     *
     * @param mixed $msg
     */
    public function doCreate($msg = '')
    {
        $data = $this->misc->getDatabaseAccessor();

        $this->printTrail('server');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->printTitle($this->lang['strcreatedatabase'], 'pg.database.create');
        $this->printMsg($msg);

        $this->coalesceArr($_POST, 'formName', '');

        // Default encoding is that in language file
        $this->coalesceArr($_POST, 'formEncoding', '');
        $this->coalesceArr($_POST, 'formTemplate', 'template1');

        $this->coalesceArr($_POST, 'formSpc', '');

        $this->coalesceArr($_POST, 'formComment', '');

        // Fetch a list of databases in the cluster
        $templatedbs = $data->getDatabases(false);

        $tablespaces = null;
        // Fetch all tablespaces from the database
        if ($data->hasTablespaces()) {
            $tablespaces = $data->getTablespaces();
        }

        echo '<form action="'.\SUBFOLDER.'/src/views/alldb" method="post">'.PHP_EOL;
        echo '<table>'.PHP_EOL;
        echo "\t<tr>\n\t\t<th class=\"data left required\">{$this->lang['strname']}</th>".PHP_EOL;
        echo "\t\t<td class=\"data1\"><input name=\"formName\" size=\"32\" maxlength=\"{$data->_maxNameLen}\" value=\"",
        htmlspecialchars($_POST['formName']), "\" /></td>\n\t</tr>".PHP_EOL;

        echo "\t<tr>\n\t\t<th class=\"data left required\">{$this->lang['strtemplatedb']}</th>".PHP_EOL;
        echo "\t\t<td class=\"data1\">".PHP_EOL;
        echo "\t\t\t<select name=\"formTemplate\">".PHP_EOL;
        // Always offer template0 and template1
        echo "\t\t\t\t<option value=\"template0\"",
        ('template0' == $_POST['formTemplate']) ? ' selected="selected"' : '', '>template0</option>'.PHP_EOL;
        echo "\t\t\t\t<option value=\"template1\"",
        ('template1' == $_POST['formTemplate']) ? ' selected="selected"' : '', '>template1</option>'.PHP_EOL;
        while (!$templatedbs->EOF) {
            $dbname = htmlspecialchars($templatedbs->fields['datname']);
            if ('template1' != $dbname) {
                // filter out for $this->conf[show_system] users so we dont get duplicates
                echo "\t\t\t\t<option value=\"{$dbname}\"",
                ($dbname == $_POST['formTemplate']) ? ' selected="selected"' : '', ">{$dbname}</option>".PHP_EOL;
            }
            $templatedbs->moveNext();
        }
        echo "\t\t\t</select>".PHP_EOL;
        echo "\t\t</td>\n\t</tr>".PHP_EOL;

        // ENCODING
        echo "\t<tr>\n\t\t<th class=\"data left required\">{$this->lang['strencoding']}</th>".PHP_EOL;
        echo "\t\t<td class=\"data1\">".PHP_EOL;
        echo "\t\t\t<select name=\"formEncoding\">".PHP_EOL;
        echo "\t\t\t\t<option value=\"\"></option>".PHP_EOL;

        foreach ($data->codemap as $key) {
            echo "\t\t\t\t<option value=\"", htmlspecialchars($key), '"',
            ($key == $_POST['formEncoding']) ? ' selected="selected"' : '', '>',
            $this->misc->printVal($key), '</option>'.PHP_EOL;
        }
        echo "\t\t\t</select>".PHP_EOL;
        echo "\t\t</td>\n\t</tr>".PHP_EOL;

        if ($data->hasDatabaseCollation()) {
            $this->coalesceArr($_POST, 'formCollate', '');

            $this->coalesceArr($_POST, 'formCType', '');

            // LC_COLLATE
            echo "\t<tr>\n\t\t<th class=\"data left\">{$this->lang['strcollation']}</th>".PHP_EOL;
            echo "\t\t<td class=\"data1\">".PHP_EOL;
            echo "\t\t\t<input name=\"formCollate\" value=\"", htmlspecialchars($_POST['formCollate']), '" />'.PHP_EOL;
            echo "\t\t</td>\n\t</tr>".PHP_EOL;

            // LC_CTYPE
            echo "\t<tr>\n\t\t<th class=\"data left\">{$this->lang['strctype']}</th>".PHP_EOL;
            echo "\t\t<td class=\"data1\">".PHP_EOL;
            echo "\t\t\t<input name=\"formCType\" value=\"", htmlspecialchars($_POST['formCType']), '" />'.PHP_EOL;
            echo "\t\t</td>\n\t</tr>".PHP_EOL;
        }

        // Tablespace (if there are any)
        if ($data->hasTablespaces() && $tablespaces->recordCount() > 0) {

            echo "\t<tr>\n\t\t<th class=\"data left\">{$this->lang['strtablespace']}</th>".PHP_EOL;
            echo "\t\t<td class=\"data1\">\n\t\t\t<select name=\"formSpc\">".PHP_EOL;
            // Always offer the default (empty) option
            echo "\t\t\t\t<option value=\"\"",
            ('' == $_POST['formSpc']) ? ' selected="selected"' : '', '></option>'.PHP_EOL;
            // Display all other tablespaces
            while (!$tablespaces->EOF) {
                $spcname = htmlspecialchars($tablespaces->fields['spcname']);
                echo "\t\t\t\t<option value=\"{$spcname}\"",
                ($spcname == $_POST['formSpc']) ? ' selected="selected"' : '', ">{$spcname}</option>".PHP_EOL;
                $tablespaces->moveNext();
            }
            echo "\t\t\t</select>\n\t\t</td>\n\t</tr>".PHP_EOL;
        }

        // Comments (if available)
        if ($data->hasSharedComments()) {

            echo "\t<tr>\n\t\t<th class=\"data left\">{$this->lang['strcomment']}</th>".PHP_EOL;
            echo "\t\t<td><textarea name=\"formComment\" rows=\"3\" cols=\"32\">",
            htmlspecialchars($_POST['formComment']), "</textarea></td>\n\t</tr>".PHP_EOL;
        }

        echo '</table>'.PHP_EOL;
        echo '<p><input type="hidden" name="action" value="save_create" />'.PHP_EOL;
        echo $this->misc->form;
        echo "<input type=\"submit\" value=\"{$this->lang['strcreate']}\" />".PHP_EOL;
        echo "<input type=\"submit\" name=\"cancel\" value=\"{$this->lang['strcancel']}\" /></p>".PHP_EOL;
        echo '</form>'.PHP_EOL;
    }

    /**
     * Actually creates the new view in the database.
     */
    public function doSaveCreate()
    {
        $data = $this->misc->getDatabaseAccessor();

        // Default tablespace to null if it isn't set
        $this->coalesceArr($_POST, 'formSpc', null);

        // Default comment to blank if it isn't set
        $this->coalesceArr($_POST, 'formComment', null);

        // Default collate to blank if it isn't set
        $this->coalesceArr($_POST, 'formCollate', null);

        // Default ctype to blank if it isn't set
        $this->coalesceArr($_POST, 'formCType', null);

        // Check that they've given a name and a definition
        if ('' == $_POST['formName']) {
            $this->doCreate($this->lang['strdatabaseneedsname']);
        } else {
            $status = $data->createDatabase(
                $_POST['formName'],
                $_POST['formEncoding'],
                $_POST['formSpc'],
                $_POST['formComment'],
                $_POST['formTemplate'],
                $_POST['formCollate'],
                $_POST['formCType']
            );
            if (0 == $status) {
                $this->misc->setReloadBrowser(true);
                $this->doDefault($this->lang['strdatabasecreated']);
            } else {
                $this->doCreate($this->lang['strdatabasecreatedbad']);
            }
        }
    }

    /**
     * Displays options for cluster download.
     *
     * @param mixed $msg
     */
    public function doExport($msg = '')
    {
        $this->printTrail('server');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->printTabs('server', 'export');
        $this->printMsg($msg);

        $subject = 'server';
        $object  = $_REQUEST['server'];

        $this->prtrace($this->misc->getServerInfo());

        echo $this->formHeader('dbexport');

        echo $this->dataOnly(true, true);

        echo $this->structureOnly();

        echo $this->structureAndData(true);

        // dumpall doesn't support gzip
        echo $this->displayOrDownload(false);

        echo $this->formFooter($subject, $object);
    }
}

HuasoFoundries / phpPgAdmin6
