Passed
Push — master ( 757841...94ec22 )
by Goffy
06:13 queued 02:50
created

xoops_module_update_myiframe()   D

Complexity

Conditions 20
Paths 97

Size

Total Lines 94
Code Lines 49

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 20
eloc 49
c 2
b 0
f 0
nc 97
nop 2
dl 0
loc 94
rs 4.1666

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 declare(strict_types=1);
2
/*
3
 * You may not change or alter any portion of this comment or credits
4
 * of supporting developers from this source code or any supporting source code
5
 * which is considered copyrighted (c) material of the original comment or credit authors.
6
 *
7
 * This program is distributed in the hope that it will be useful,
8
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10
 */
11
12
/**
13
 * @copyright    XOOPS Project (https://xoops.org)
14
 * @license      GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
15
 * @author       XOOPS Development Team
16
 */
17
18
use Xmf\Database\Tables;
19
use XoopsModules\Myiframe;
20
21
if ((!defined('XOOPS_ROOT_PATH')) || !($GLOBALS['xoopsUser'] instanceof \XoopsUser)
22
    || !$GLOBALS['xoopsUser']->isAdmin()) {
23
    exit('Restricted access' . PHP_EOL);
24
}
25
26
/**
27
 * Prepares system prior to attempting to install module
28
 * @param \XoopsModule $module {@link XoopsModule}
29
 *
30
 * @return bool true if ready to install, false if not
31
 */
32
function xoops_module_pre_update_myiframe(\XoopsModule $module)
33
{
34
    $moduleDirName = \basename(\dirname(__DIR__));
0 ignored issues
show
Unused Code introduced by
The assignment to $moduleDirName is dead and can be removed.
Loading history...
35
    /** @var Myiframe\Helper $helper */
36
    /** @var Myiframe\Utility $utility */
37
    $helper  = Myiframe\Helper::getInstance();
0 ignored issues
show
Unused Code introduced by
The assignment to $helper is dead and can be removed.
Loading history...
38
    $utility = new Myiframe\Utility();
39
40
    $xoopsSuccess = $utility::checkVerXoops($module);
41
    $phpSuccess   = $utility::checkVerPhp($module);
42
43
    return $xoopsSuccess && $phpSuccess;
44
}
45
46
/**
47
 * Performs tasks required during update of the module
48
 * @param \XoopsModule $module {@link XoopsModule}
49
 * @param null         $previousVersion
0 ignored issues
show
Documentation Bug introduced by
Are you sure the doc-type for parameter $previousVersion is correct as it would always require null to be passed?
Loading history...
50
 *
51
 * @return bool true if update successful, false if not
52
 */
53
function xoops_module_update_myiframe(\XoopsModule $module, $previousVersion = null)
54
{
55
    $moduleDirName      = \basename(\dirname(__DIR__));
56
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
0 ignored issues
show
Unused Code introduced by
The assignment to $moduleDirNameUpper is dead and can be removed.
Loading history...
57
58
    /** @var Myiframe\Helper $helper */ /** @var Myiframe\Utility $utility */
59
    /** @var Myiframe\Common\Configurator $configurator */
60
    $helper       = Myiframe\Helper::getInstance();
0 ignored issues
show
Unused Code introduced by
The assignment to $helper is dead and can be removed.
Loading history...
61
    $utility      = new Myiframe\Utility();
62
    $configurator = new Myiframe\Common\Configurator();
63
64
    if ($previousVersion < 240) {
65
        //rename column EXAMPLE
66
        $tables     = new Tables();
67
        $table      = 'myiframex_categories';
68
        $column     = 'ordre';
69
        $newName    = 'order';
70
        $attributes = "INT(5) NOT NULL DEFAULT '0'";
71
        if ($tables->useTable($table)) {
72
            $tables->alterColumn($table, $column, $attributes, $newName);
73
            if (!$tables->executeQueue()) {
74
                echo '<br>' . _AM_MYIFRAME_UPGRADEFAILED0 . ' ' . $tables->getLastError();
0 ignored issues
show
Bug introduced by
The constant _AM_MYIFRAME_UPGRADEFAILED0 was not found. Maybe you did not declare it correctly or list all dependencies?
Loading history...
75
            }
76
        }
77
78
        //delete old HTML templates
79
        if (count($configurator->templateFolders) > 0) {
80
            foreach ($configurator->templateFolders as $folder) {
81
                $templateFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $folder);
82
                if (is_dir($templateFolder)) {
83
                    $templateList = array_diff(scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
84
                    foreach ($templateList as $k => $v) {
85
                        $fileInfo = new \SplFileInfo($templateFolder . $v);
86
                        if ('html' === $fileInfo->getExtension() && 'index.html' !== $fileInfo->getFilename()) {
87
                            if (is_file($templateFolder . $v)) {
88
                                unlink($templateFolder . $v);
89
                            }
90
                        }
91
                    }
92
                }
93
            }
94
        }
95
96
        //  ---  DELETE OLD FILES ---------------
97
        if (count($configurator->oldFiles) > 0) {
98
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
99
            foreach (array_keys($configurator->oldFiles) as $i) {
100
                $tempFile = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFiles[$i]);
101
                if (is_file($tempFile)) {
102
                    unlink($tempFile);
103
                }
104
            }
105
        }
106
107
        //  ---  DELETE OLD FOLDERS ---------------
108
        xoops_load('XoopsFile');
109
        if (count($configurator->oldFolders) > 0) {
110
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
111
            foreach (array_keys($configurator->oldFolders) as $i) {
112
                $tempFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFolders[$i]);
113
                /** @var XoopsObjectHandler $folderHandler */
114
                $folderHandler = XoopsFile::getHandler('folder', $tempFolder);
115
                $folderHandler->delete($tempFolder);
116
            }
117
        }
118
119
        //  ---  CREATE FOLDERS ---------------
120
        if (count($configurator->uploadFolders) > 0) {
121
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
122
            foreach (array_keys($configurator->uploadFolders) as $i) {
123
                $utility::createFolder($configurator->uploadFolders[$i]);
124
            }
125
        }
126
127
        //  ---  COPY blank.png FILES ---------------
128
        if (count($configurator->copyBlankFiles) > 0) {
129
            $file = \dirname(__DIR__) . '/assets/images/blank.png';
130
            foreach (array_keys($configurator->copyBlankFiles) as $i) {
131
                $dest = $configurator->copyBlankFiles[$i] . '/blank.png';
132
                $utility::copyFile($file, $dest);
133
            }
134
        }
135
136
        //delete .html entries from the tpl table
137
        $sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . '\' AND `tpl_file` LIKE \'%.html%\'';
138
        $GLOBALS['xoopsDB']->queryF($sql);
139
140
        /** @var \XoopsGroupPermHandler $grouppermHandler */
141
        $grouppermHandler = xoops_getHandler('groupperm');
142
143
        return $grouppermHandler->deleteByModule($module->getVar('mid'), 'item_read');
144
    }
145
146
    return true;
147
}
148