xoops_module_update_xfguestbook()   D
last analyzed

Complexity

Conditions 18
Paths 33

Size

Total Lines 77
Code Lines 40

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 18
eloc 40
nc 33
nop 2
dl 0
loc 77
rs 4.8666
c 2
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 (https://www.gnu.org/licenses/gpl-2.0.html)
15
 * @package
16
 * @since
17
 * @author       XOOPS Development Team
18
 */
19
20
use XoopsModules\Xfguestbook;
21
use XoopsModules\Xfguestbook\Common;
22
use XoopsModules\Xfguestbook\Helper;
23
use XoopsModules\Xfguestbook\Utility;
24
25
if ((!defined('XOOPS_ROOT_PATH')) || !($GLOBALS['xoopsUser'] instanceof \XoopsUser)
26
    || !$GLOBALS['xoopsUser']->isAdmin()) {
27
    exit('Restricted access' . PHP_EOL);
28
}
29
30
/**
31
 * @param string $tablename
32
 *
33
 * @return bool
34
 */
35
function tableExists($tablename)
36
{
37
    $result = $GLOBALS['xoopsDB']->queryF("SHOW TABLES LIKE '$tablename'");
38
39
    return $GLOBALS['xoopsDB']->getRowsNum($result) > 0;
40
}
41
42
/**
43
 * Prepares system prior to attempting to install module
44
 * @param \XoopsModule $module {@link \XoopsModule}
45
 *
46
 * @return bool true if ready to install, false if not
47
 */
48
function xoops_module_pre_update_xfguestbook(\XoopsModule $module)
49
{
50
    /** @var Helper $helper */
51
    /** @var Utility $utility */
52
    $moduleDirName = basename(dirname(__DIR__));
0 ignored issues
show
Unused Code introduced by
The assignment to $moduleDirName is dead and can be removed.
Loading history...
53
    $helper        = Helper::getInstance();
0 ignored issues
show
Unused Code introduced by
The assignment to $helper is dead and can be removed.
Loading history...
54
    $utility       = new Utility();
55
56
    $xoopsSuccess = $utility::checkVerXoops($module);
57
    $phpSuccess   = $utility::checkVerPhp($module);
58
59
    return $xoopsSuccess && $phpSuccess;
60
}
61
62
/**
63
 * Performs tasks required during update of the module
64
 * @param \XoopsModule $module {@link \XoopsModule}
65
 * @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...
66
 */
67
function xoops_module_update_xfguestbook(\XoopsModule $module, $previousVersion = null)
68
{
69
    global $xoopsDB;
70
    $moduleDirName      = basename(dirname(__DIR__));
71
    $moduleDirNameUpper = mb_strtoupper($moduleDirName);
0 ignored issues
show
Unused Code introduced by
The assignment to $moduleDirNameUpper is dead and can be removed.
Loading history...
72
73
    /** @var Helper $helper */
74
    /** @var Utility $utility */
75
    /** @var Common\Configurator $configurator */
76
    $helper       = Helper::getInstance();
0 ignored issues
show
Unused Code introduced by
The assignment to $helper is dead and can be removed.
Loading history...
77
    $utility      = new Utility();
78
    $configurator = new Common\Configurator();
79
80
    if ($previousVersion < 230) {
81
        //delete old HTML templates
82
        if (count($configurator->templateFolders) > 0) {
83
            foreach ($configurator->templateFolders as $folder) {
84
                $templateFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $folder);
85
                if (is_dir($templateFolder)) {
86
                    $templateList = array_diff(scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
0 ignored issues
show
Bug introduced by
It seems like scandir($templateFolder, SCANDIR_SORT_NONE) can also be of type false; however, parameter $array1 of array_diff() does only seem to accept array, 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

86
                    $templateList = array_diff(/** @scrutinizer ignore-type */ scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
Loading history...
87
                    foreach ($templateList as $k => $v) {
88
                        $fileInfo = new \SplFileInfo($templateFolder . $v);
89
                        if ('html' === $fileInfo->getExtension() && 'index.html' !== $fileInfo->getFilename()) {
90
                            if (is_file($templateFolder . $v)) {
91
                                unlink($templateFolder . $v);
92
                            }
93
                        }
94
                    }
95
                }
96
            }
97
        }
98
99
        //  ---  DELETE OLD FILES ---------------
100
        if (count($configurator->oldFiles) > 0) {
101
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
102
            foreach (array_keys($configurator->oldFiles) as $i) {
103
                $tempFile = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFiles[$i]);
104
                if (is_file($tempFile)) {
105
                    unlink($tempFile);
106
                }
107
            }
108
        }
109
110
        //  ---  DELETE OLD FOLDERS ---------------
111
        xoops_load('XoopsFile');
112
        if (count($configurator->oldFolders) > 0) {
113
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
114
            foreach (array_keys($configurator->oldFolders) as $i) {
115
                $tempFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFolders[$i]);
116
                /** @var \XoopsObjectHandler $folderHandler */
117
                $folderHandler = XoopsFile::getHandler('folder', $tempFolder);
118
                $folderHandler->delete($tempFolder);
119
            }
120
        }
121
122
        //  ---  CREATE FOLDERS ---------------
123
        if (count($configurator->uploadFolders) > 0) {
124
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
125
            foreach (array_keys($configurator->uploadFolders) as $i) {
126
                $utility::createFolder($configurator->uploadFolders[$i]);
127
            }
128
        }
129
130
        //  ---  COPY blank.png FILES ---------------
131
        if (count($configurator->copyBlankFiles) > 0) {
132
            $file = dirname(__DIR__) . '/assets/images/blank.png';
133
            foreach (array_keys($configurator->copyBlankFiles) as $i) {
134
                $dest = $configurator->copyBlankFiles[$i] . '/blank.png';
135
                $utility::copyFile($file, $dest);
136
            }
137
        }
138
139
        //delete .html entries from the tpl table
140
        $sql = 'DELETE FROM ' . $xoopsDB->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . '\' AND `tpl_file` LIKE \'%.html%\'';
141
        $xoopsDB->queryF($sql);
142
        $sql = 'DELETE FROM ' . $xoopsDB->prefix('newblocks') . " WHERE `dirname` = '" . $module->getVar('dirname', 'n') . "' AND `template` LIKE '%.html%'";
143
        $xoopsDB->queryF($sql);
144
145
        /** @var \XoopsGroupPermHandler $grouppermHandler */ //        $grouppermHandler = xoops_getHandler('groupperm');
146
        //        return $grouppermHandler->deleteByModule($module->getVar('mid'), 'item_read');
147
    }
148
}
149