Passed
Push — master ( 37a2f2...290aa0 )
by Michael
02:35
created

onupdate.php ➔ xoops_module_update_xfguestbook()   D

Complexity

Conditions 19
Paths 65

Size

Total Lines 85
Code Lines 43

Duplication

Lines 13
Ratio 15.29 %

Importance

Changes 0
Metric Value
cc 19
eloc 43
nc 65
nop 2
dl 13
loc 85
rs 4.7869
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
/*
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 or later (http://www.gnu.org/licenses/gpl-2.0.html)
15
 * @package
16
 * @since
17
 * @author       XOOPS Development Team
18
 */
19
20
use XoopsModules\Xfguestbook;
21
22
if ((!defined('XOOPS_ROOT_PATH')) || !($GLOBALS['xoopsUser'] instanceof \XoopsUser)
23
    || !$GLOBALS['xoopsUser']->IsAdmin()) {
24
    exit('Restricted access' . PHP_EOL);
25
}
26
27
/**
28
 * @param string $tablename
29
 *
30
 * @return bool
31
 */
32
function tableExists($tablename)
33
{
34
    $result = $GLOBALS['xoopsDB']->queryF("SHOW TABLES LIKE '$tablename'");
35
36
    return $GLOBALS['xoopsDB']->getRowsNum($result) > 0;
37
}
38
39
/**
40
 *
41
 * Prepares system prior to attempting to install module
42
 * @param XoopsModule $module {@link XoopsModule}
43
 *
44
 * @return bool true if ready to install, false if not
45
 */
46
function xoops_module_pre_update_xfguestbook(\XoopsModule $module)
47
{
48
    /** @var Xfguestbook\Helper $helper */
49
    /** @var Xfguestbook\Utility $utility */
50
    $moduleDirName = basename(dirname(__DIR__));
0 ignored issues
show
Unused Code introduced by
The assignment to $moduleDirName is dead and can be removed.
Loading history...
51
    $helper       = Xfguestbook\Helper::getInstance();
0 ignored issues
show
Unused Code introduced by
The assignment to $helper is dead and can be removed.
Loading history...
52
    $utility      = new Xfguestbook\Utility();
53
54
    $xoopsSuccess = $utility::checkVerXoops($module);
55
    $phpSuccess   = $utility::checkVerPhp($module);
56
    return $xoopsSuccess && $phpSuccess;
57
}
58
59
/**
60
 *
61
 * Performs tasks required during update of the module
62
 * @param XoopsModule $module {@link XoopsModule}
63
 * @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...
64
 *
65
 * @return void true if update successful, false if not
66
 */
67
68
function xoops_module_update_xfguestbook(\XoopsModule $module, $previousVersion = null)
69
{
70
    global $xoopsDB;
71
    $moduleDirName = basename(dirname(__DIR__));
72
    $moduleDirNameUpper   = strtoupper($moduleDirName);
0 ignored issues
show
Unused Code introduced by
The assignment to $moduleDirNameUpper is dead and can be removed.
Loading history...
73
74
    /** @var Xfguestbook\Helper $helper */
75
    /** @var Xfguestbook\Utility $utility */
76
    /** @var Xfguestbook\Common\Configurator $configurator */
77
    $helper  = Xfguestbook\Helper::getInstance();
0 ignored issues
show
Unused Code introduced by
The assignment to $helper is dead and can be removed.
Loading history...
78
    $utility = new Xfguestbook\Utility();
79
    $configurator = new Xfguestbook\Common\Configurator();
80
81
    if ($previousVersion < 230) {
82
83
        //delete old HTML templates
84
        if (count($configurator->templateFolders) > 0) {
85
            foreach ($configurator->templateFolders as $folder) {
86
                $templateFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $folder);
87
                if (is_dir($templateFolder)) {
88
                    $templateList = array_diff(scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
89
                    foreach ($templateList as $k => $v) {
90
                        $fileInfo = new \SplFileInfo($templateFolder . $v);
91
                        if ('html' === $fileInfo->getExtension() && 'index.html' !== $fileInfo->getFilename()) {
92
                            if (file_exists($templateFolder . $v)) {
93
                                unlink($templateFolder . $v);
94
                            }
95
                        }
96
                    }
97
                }
98
            }
99
        }
100
101
        //  ---  DELETE OLD FILES ---------------
102
        if (count($configurator->oldFiles) > 0) {
103
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
104
            foreach (array_keys($configurator->oldFiles) as $i) {
105
                $tempFile = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFiles[$i]);
106
                if (is_file($tempFile)) {
107
                    unlink($tempFile);
108
                }
109
            }
110
        }
111
112
        //  ---  DELETE OLD FOLDERS ---------------
113
        xoops_load('XoopsFile');
114
        if (count($configurator->oldFolders) > 0) {
115
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
116
            foreach (array_keys($configurator->oldFolders) as $i) {
117
                $tempFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFolders[$i]);
118
                /** @var \XoopsObjectHandler $folderHandler */
119
                $folderHandler = XoopsFile::getHandler('folder', $tempFolder);
120
                $folderHandler->delete($tempFolder);
121
            }
122
        }
123
124
        //  ---  CREATE FOLDERS ---------------
125
        if (count($configurator->uploadFolders) > 0) {
126
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
127
            foreach (array_keys($configurator->uploadFolders) as $i) {
128
                $utility::createFolder($configurator->uploadFolders[$i]);
129
            }
130
        }
131
132
        //  ---  COPY blank.png FILES ---------------
133
        if (count($configurator->copyBlankFiles) > 0) {
134
            $file =  dirname(__DIR__) . '/assets/images/blank.png';
135
            foreach (array_keys($configurator->copyBlankFiles) as $i) {
136
                $dest = $configurator->copyBlankFiles[$i] . '/blank.png';
137
                $utility::copyFile($file, $dest);
138
            }
139
        }
140
141
        //delete .html entries from the tpl table
142
        $sql = 'DELETE FROM ' . $xoopsDB->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . '\' AND `tpl_file` LIKE \'%.html%\'';
143
        $xoopsDB->queryF($sql);
144
        $sql = 'DELETE FROM ' . $xoopsDB->prefix('newblocks') . " WHERE `dirname` = '" . $module->getVar('dirname', 'n') . "' AND `template` LIKE '%.html%'";
145
        $xoopsDB->queryF($sql);
146
147
        /** @var XoopsGroupPermHandler $grouppermHandler */
148
        //        $grouppermHandler = xoops_getHandler('groupperm');
149
        //        return $grouppermHandler->deleteByModule($module->getVar('mid'), 'item_read');
150
    }
151
}
152