Passed
Branch master (1c832c)
by Michael
05:44 queued 44s
created

clearSampleData()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 12
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 8
c 1
b 0
f 0
nc 2
nop 0
dl 0
loc 12
rs 10
1
<?php
2
3
declare(strict_types=1);
4
5
/**
6
 * You may not change or alter any portion of this comment or credits
7
 * of supporting developers from this source code or any supporting source code
8
 * which is considered copyrighted (c) material of the original comment or credit authors.
9
 * This program is distributed in the hope that it will be useful,
10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
 *
13
 * @copyright       XOOPS Project (https://xoops.org)
14
 * @license         GNU GPL 2 (https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
15
 * @since           2.5.9
16
 * @author          Michael Beck (aka Mamba): https://github.com/mambax7
17
 */
18
19
use Xmf\Database\TableLoad;
20
use Xmf\Request;
21
use Xmf\Yaml;
22
use XoopsModules\Publisher\{Helper,
23
    Common\Configurator,
24
    Utility
25
};
26
/** @var Helper $helper */
27
/** @var Utility $utility */
28
/** @var Configurator $configurator */
29
30
require \dirname(__DIR__, 3) . '/include/cp_header.php';
31
require \dirname(__DIR__) . '/preloads/autoloader.php';
32
33
$op = Request::getCmd('op', '');
34
35
$moduleDirName      = \basename(\dirname(__DIR__));
36
$moduleDirNameUpper = mb_strtoupper($moduleDirName);
37
38
$helper = Helper::getInstance();
39
// Load language files
40
$helper->loadLanguage('common');
41
42
switch ($op) {
43
    case 'load':
44
        if (Request::hasVar('ok', 'REQUEST') && 1 === Request::getInt('ok', 0)) {
45
            if (!$GLOBALS['xoopsSecurity']->check()) {
46
                redirect_header($helper->url('admin/index.php'), 3, implode(',', $GLOBALS['xoopsSecurity']->getErrors()));
47
            }
48
            loadSampleData();
49
        } else {
50
            xoops_cp_header();
51
            xoops_confirm(['ok' => 1, 'op' => 'load'], 'index.php', sprintf(constant('CO_' . $moduleDirNameUpper . '_' . 'LOAD_SAMPLEDATA_CONFIRM')), constant('CO_' . $moduleDirNameUpper . '_' . 'CONFIRM'), true);
52
            xoops_cp_footer();
53
        }
54
        break;
55
    case 'save':
56
        saveSampleData();
57
        break;
58
    case 'clear':
59
        clearSampleData();
60
        break;
61
}
62
63
// XMF TableLoad for SAMPLE data
64
65
function loadSampleData()
66
{
67
    global $xoopsConfig;
68
    $moduleDirName      = \basename(\dirname(__DIR__));
69
    $moduleDirNameUpper = mb_strtoupper($moduleDirName);
70
71
    $utility      = new Utility();
72
    $configurator = new Configurator();
73
74
    $tables = \Xmf\Module\Helper::getHelper($moduleDirName)->getModule()->getInfo('tables');
75
76
    $language = 'english/';
77
    if (is_dir(__DIR__ . '/' . $xoopsConfig['language'])) {
78
        $language = $xoopsConfig['language'] . '/';
79
    }
80
81
    // load module tables
82
    foreach ($tables as $table) {
83
        $tabledata = Yaml::readWrapped($language . $table . '.yml');
84
        TableLoad::truncateTable($table);
85
        TableLoad::loadTableFromArray($table, $tabledata);
86
    }
87
88
    // load permissions
89
    $table     = 'group_permission';
90
    $tabledata = Yaml::readWrapped($language . $table . '.yml');
91
    $mid       = \Xmf\Module\Helper::getHelper($moduleDirName)->getModule()->getVar('mid');
92
    loadTableFromArrayWithReplace($table, $tabledata, 'gperm_modid', $mid);
93
94
    //  ---  COPY test folder files ---------------
95
    if (is_array($configurator->copyTestFolders) && count($configurator->copyTestFolders) > 0) {
96
        //        $file =  \dirname(__DIR__) . '/testdata/images/';
97
        foreach (array_keys($configurator->copyTestFolders) as $i) {
98
            $src  = $configurator->copyTestFolders[$i][0];
99
            $dest = $configurator->copyTestFolders[$i][1];
100
            $utility::rcopy($src, $dest);
101
        }
102
    }
103
    \redirect_header('../admin/index.php', 1, \constant('CO_' . $moduleDirNameUpper . '_' . 'LOAD_SAMPLEDATA_SUCCESS'));
104
}
105
106
function saveSampleData()
107
{
108
    global $xoopsConfig;
109
    $moduleDirName      = \basename(\dirname(__DIR__));
110
    $moduleDirNameUpper = mb_strtoupper($moduleDirName);
111
    $helper             = Helper::getInstance();
112
    $tables             = $helper->getModule()->getInfo('tables');
113
114
    $languageFolder = __DIR__ . '/' . $xoopsConfig['language'];
115
    if (!file_exists($languageFolder . '/')) {
116
        Utility::createFolder($languageFolder . '/');
117
    }
118
    $exportFolder = $languageFolder . '/Exports-' . date('Y-m-d-H-i-s') . '/';
119
    Utility::createFolder($exportFolder);
120
121
    // save module tables
122
    foreach ($tables as $table) {
123
        TableLoad::saveTableToYamlFile($table, $exportFolder . $table . '.yml');
124
    }
125
126
    // save permissions
127
    $criteria = new \CriteriaCompo();
128
    $criteria->add(new \Criteria('gperm_modid', $helper->getModule()->getVar('mid')));
0 ignored issues
show
Bug introduced by
It seems like $helper->getModule()->getVar('mid') can also be of type array and array; however, parameter $value of Criteria::__construct() 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

128
    $criteria->add(new \Criteria('gperm_modid', /** @scrutinizer ignore-type */ $helper->getModule()->getVar('mid')));
Loading history...
129
    $skipColumns[] = 'gperm_id';
0 ignored issues
show
Comprehensibility Best Practice introduced by
$skipColumns was never initialized. Although not strictly required by PHP, it is generally a good practice to add $skipColumns = array(); before regardless.
Loading history...
130
    TableLoad::saveTableToYamlFile('group_permission', $exportFolder . 'group_permission.yml', $criteria, $skipColumns);
131
    unset($criteria);
132
133
    \redirect_header('../admin/index.php', 1, \constant('CO_' . $moduleDirNameUpper . '_' . 'SAVE_SAMPLEDATA_SUCCESS'));
134
}
135
136
function exportSchema()
137
{
138
    $moduleDirName      = \basename(\dirname(__DIR__));
139
    $moduleDirNameUpper = mb_strtoupper($moduleDirName);
0 ignored issues
show
Unused Code introduced by
The assignment to $moduleDirNameUpper is dead and can be removed.
Loading history...
140
141
    try {
142
        // TODO set exportSchema
143
        //        $migrate = new Migrate($moduleDirName);
144
        //        $migrate->saveCurrentSchema();
145
        //
146
        //        redirect_header('../admin/index.php', 1, constant('CO_' . $moduleDirNameUpper . '_' . 'EXPORT_SCHEMA_SUCCESS'));
147
    } catch (\Throwable $e) {
0 ignored issues
show
Unused Code introduced by
catch (\Throwable $e) is not reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
148
        exit(constant('CO_' . $moduleDirNameUpper . '_' . 'EXPORT_SCHEMA_ERROR'));
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
149
    }
150
}
151
152
/**
153
 * loadTableFromArrayWithReplace
154
 *
155
 * @param string $table  value with should be used insead of original value of $search
156
 *
157
 * @param array  $data   array of rows to insert
158
 *                       Each element of the outer array represents a single table row.
159
 *                       Each row is an associative array in 'column' => 'value' format.
160
 * @param string $search name of column for which the value should be replaced
161
 * @param        $replace
162
 * @return int number of rows inserted
163
 */
164
function loadTableFromArrayWithReplace($table, $data, $search, $replace)
165
{
166
    /** @var \XoopsMySQLDatabase $db */
167
    $db = \XoopsDatabaseFactory::getDatabaseConnection();
168
169
    $prefixedTable = $db->prefix($table);
170
    $count         = 0;
171
172
    $sql = 'DELETE FROM ' . $prefixedTable . ' WHERE `' . $search . '`=' . $db->quote($replace);
173
174
    $result = $db->queryF($sql);
0 ignored issues
show
Unused Code introduced by
The assignment to $result is dead and can be removed.
Loading history...
175
176
    foreach ($data as $row) {
177
        $insertInto  = 'INSERT INTO ' . $prefixedTable . ' (';
178
        $valueClause = ' VALUES (';
179
        $first       = true;
180
        foreach ($row as $column => $value) {
181
            if ($first) {
182
                $first = false;
183
            } else {
184
                $insertInto  .= ', ';
185
                $valueClause .= ', ';
186
            }
187
188
            $insertInto .= $column;
189
            if ($search === $column) {
190
                $valueClause .= $db->quote($replace);
191
            } else {
192
                $valueClause .= $db->quote($value);
193
            }
194
        }
195
196
        $sql = $insertInto . ') ' . $valueClause . ')';
197
198
        $result = $db->queryF($sql);
199
        if (false !== $result) {
200
            ++$count;
201
        }
202
    }
203
204
    return $count;
205
}
206
207
function clearSampleData(){
208
    $moduleDirName      = \basename(\dirname(__DIR__));
209
    $moduleDirNameUpper = mb_strtoupper($moduleDirName);
210
    $helper             = Helper::getInstance();
211
    // Load language files
212
    $helper->loadLanguage('common');
213
    $tables = $helper->getModule()->getInfo('tables');
214
    // truncate module tables
215
    foreach ($tables as $table) {
216
        \Xmf\Database\TableLoad::truncateTable($table);
217
    }
218
    redirect_header($helper->url('admin/index.php'), 1, constant('CO_' . $moduleDirNameUpper . '_' . 'CLEAR_SAMPLEDATA_OK'));
219
}
220