Passed
Pull Request — master (#1301)
by Michael
05:46
created

protector_onupdate_base()   F

Complexity

Conditions 18
Paths 288

Size

Total Lines 98
Code Lines 65

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 18
eloc 65
nc 288
nop 2
dl 0
loc 98
rs 2.9333
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
// start hack by Trabis
3
if (!class_exists('ProtectorRegistry')) {
4
    exit('Registry not found');
5
}
6
7
$registry  = ProtectorRegistry::getInstance();
8
$mydirname = $registry->getEntry('mydirname');
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $mydirname is correct as $registry->getEntry('mydirname') targeting ProtectorRegistry::getEntry() seems to always return null.

This check looks for function or method calls that always return null and whose return value is assigned to a variable.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

The method getObject() can return nothing but null, so it makes no sense to assign that value to a variable.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
9
$mydirpath = $registry->getEntry('mydirpath');
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $mydirpath is correct as $registry->getEntry('mydirpath') targeting ProtectorRegistry::getEntry() seems to always return null.

This check looks for function or method calls that always return null and whose return value is assigned to a variable.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

The method getObject() can return nothing but null, so it makes no sense to assign that value to a variable.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
10
$language  = $registry->getEntry('language');
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $language is correct as $registry->getEntry('language') targeting ProtectorRegistry::getEntry() seems to always return null.

This check looks for function or method calls that always return null and whose return value is assigned to a variable.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

The method getObject() can return nothing but null, so it makes no sense to assign that value to a variable.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
11
// end hack by Trabis
12
13
eval(' function xoops_module_update_' . $mydirname . '( $module ) { return protector_onupdate_base( $module , "' . $mydirname . '" ) ; } ');
0 ignored issues
show
introduced by
The use of eval() is discouraged.
Loading history...
14
15
if (!function_exists('protector_onupdate_base')) {
16
17
    /**
18
     * @param $module
19
     * @param $mydirname
20
     *
21
     * @return bool
22
     */
23
    function protector_onupdate_base($module, $mydirname)
24
    {
25
        // transations on module update
26
27
        global $msgs; // TODO :-D
28
29
        // for Cube 2.1
30
        if (defined('XOOPS_CUBE_LEGACY')) {
31
            $root =& XCube_Root::getSingleton();
0 ignored issues
show
Bug introduced by
The type XCube_Root was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
32
            $root->mDelegateManager->add('Legacy.Admin.Event.ModuleUpdate.' . ucfirst($mydirname) . '.Success', 'protector_message_append_onupdate');
33
            $msgs = array();
34
        } else {
35
            if (!is_array($msgs)) {
36
                $msgs = array();
37
            }
38
        }
39
40
        $db  = XoopsDatabaseFactory::getDatabaseConnection();
41
        $mid = $module->getVar('mid');
42
43
        // TABLES (write here ALTER TABLE etc. if necessary)
44
45
        // configs (Though I know it is not a recommended way...)
46
        $sql = 'SHOW COLUMNS FROM ' . $db->prefix('config') . " LIKE 'conf_title'";
47
        $result = $db->query($sql);
0 ignored issues
show
Bug introduced by
The method query() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

47
        /** @scrutinizer ignore-call */ 
48
        $result = $db->query($sql);
Loading history...
48
        if ($db->isResultSet($result) && ($myrow = $db->fetchArray($result)) && @$myrow['Type'] === 'varchar(30)') {
0 ignored issues
show
Bug introduced by
The method fetchArray() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

48
        if ($db->isResultSet($result) && ($myrow = $db->/** @scrutinizer ignore-call */ fetchArray($result)) && @$myrow['Type'] === 'varchar(30)') {
Loading history...
49
            $db->queryF('ALTER TABLE ' . $db->prefix('config') . " MODIFY `conf_title` varchar(255) NOT NULL default '', MODIFY `conf_desc` varchar(255) NOT NULL default ''");
0 ignored issues
show
Bug introduced by
The method queryF() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

49
            $db->/** @scrutinizer ignore-call */ 
50
                 queryF('ALTER TABLE ' . $db->prefix('config') . " MODIFY `conf_title` varchar(255) NOT NULL default '', MODIFY `conf_desc` varchar(255) NOT NULL default ''");
Loading history...
50
        }
51
52
        $sql = 'SHOW CREATE TABLE ' . $db->prefix('config');
53
        $result = $db->query($sql);
54
        if (!$db->isResultSet($result)) {
55
            \trigger_error("Query Failed! SQL: $sql- Error: " . $db->error(), E_USER_ERROR);
0 ignored issues
show
Bug introduced by
The method error() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

55
            \trigger_error("Query Failed! SQL: $sql- Error: " . $db->/** @scrutinizer ignore-call */ error(), E_USER_ERROR);
Loading history...
56
        }
57
        list(, $create_string) = $db->fetchRow($result);
0 ignored issues
show
Bug introduced by
The method fetchRow() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

57
        /** @scrutinizer ignore-call */ 
58
        list(, $create_string) = $db->fetchRow($result);
Loading history...
58
59
        foreach (explode('KEY', $create_string) as $line) {
60
            if (preg_match('/(\`conf\_title_\d+\`) \(\`conf\_title\`\)/', $line, $regs)) {
61
                $db->query('ALTER TABLE ' . $db->prefix('config') . ' DROP KEY ' . $regs[1]);
62
            }
63
        }
64
        $db->query('ALTER TABLE ' . $db->prefix('config') . ' ADD KEY `conf_title` (`conf_title`)');
65
66
        // 2.x -> 3.0
67
        $sql = 'SHOW CREATE TABLE ' . $db->prefix($mydirname . '_log');
68
        $result = $db->query($sql);
69
        if (!$db->isResultSet($result)) {
70
            \trigger_error("Query Failed! SQL: $sql- Error: " . $db->error(), E_USER_ERROR);
71
        }
72
        list(, $create_string) = $db->fetchRow($result);
73
        if (preg_match('/timestamp\(/i', $create_string)) {
74
            $db->query('ALTER TABLE ' . $db->prefix($mydirname . '_log') . ' MODIFY `timestamp` DATETIME');
75
        }
76
77
        // TEMPLATES (all templates have been already removed by modulesadmin)
78
        $tplfile_handler = xoops_getHandler('tplfile');
79
        $tpl_path        = __DIR__ . '/templates';
80
        if ($handler = @opendir($tpl_path . '/')) {
81
            while (($file = readdir($handler)) !== false) {
82
                if (substr($file, 0, 1) === '.') {
83
                    continue;
84
                }
85
                $file_path = $tpl_path . '/' . $file;
86
                if (is_file($file_path) && in_array(strrchr($file, '.'), array('.html', '.css', '.js'))) {
87
                    $mtime   = (int)(@filemtime($file_path));
88
                    $tplfile = $tplfile_handler->create();
89
                    $tplfile->setVar('tpl_source', file_get_contents($file_path), true);
90
                    $tplfile->setVar('tpl_refid', $mid);
91
                    $tplfile->setVar('tpl_tplset', 'default');
92
                    $tplfile->setVar('tpl_file', $mydirname . '_' . $file);
93
                    $tplfile->setVar('tpl_desc', '', true);
94
                    $tplfile->setVar('tpl_module', $mydirname);
95
                    $tplfile->setVar('tpl_lastmodified', $mtime);
96
                    $tplfile->setVar('tpl_lastimported', 0);
97
                    $tplfile->setVar('tpl_type', 'module');
98
                    if (!$tplfile_handler->insert($tplfile)) {
0 ignored issues
show
Bug introduced by
Are you sure the usage of $tplfile_handler->insert($tplfile) targeting XoopsObjectHandler::insert() seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
99
                        $msgs[] = '<span style="color:#ff0000;">ERROR: Could not insert template <b>' . htmlspecialchars($mydirname . '_' . $file) . '</b> to the database.</span>';
100
                    } else {
101
                        $tplid  = $tplfile->getVar('tpl_id');
102
                        $msgs[] = 'Template <b>' . htmlspecialchars($mydirname . '_' . $file) . '</b> added to the database. (ID: <b>' . $tplid . '</b>)';
103
                        // generate compiled file
104
                        include_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
105
                        include_once XOOPS_ROOT_PATH . '/class/template.php';
106
                        if (!xoops_template_touch($tplid)) {
0 ignored issues
show
Bug introduced by
It seems like $tplid can also be of type array and array; however, parameter $tpl_id of xoops_template_touch() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

106
                        if (!xoops_template_touch(/** @scrutinizer ignore-type */ $tplid)) {
Loading history...
107
                            $msgs[] = '<span style="color:#ff0000;">ERROR: Failed compiling template <b>' . htmlspecialchars($mydirname . '_' . $file) . '</b>.</span>';
108
                        } else {
109
                            $msgs[] = 'Template <b>' . htmlspecialchars($mydirname . '_' . $file) . '</b> compiled.</span>';
110
                        }
111
                    }
112
                }
113
            }
114
            closedir($handler);
115
        }
116
        include_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
117
        include_once XOOPS_ROOT_PATH . '/class/template.php';
118
        xoops_template_clear_module_cache($mid);
119
120
        return true;
121
    }
122
123
    /**
124
     * @param $module_obj
125
     * @param $log
126
     */
127
    function protector_message_append_onupdate(&$module_obj, &$log)
0 ignored issues
show
Unused Code introduced by
The parameter $module_obj is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

127
    function protector_message_append_onupdate(/** @scrutinizer ignore-unused */ &$module_obj, &$log)

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
128
    {
129
        if (is_array(@$GLOBALS['msgs'])) {
130
            foreach ($GLOBALS['msgs'] as $message) {
131
                $log->add(strip_tags($message));
132
            }
133
        }
134
135
        // use mLog->addWarning() or mLog->addError() if necessary
136
    }
137
}
138