xoops_module_pre_update_contact() - Code Metrics - mambax7/contact - Measure and Improve Code Quality continuously with Scrutinizer

xoops_module_pre_update_contact() A
last analyzed 2022-03-09 04:57 UTC

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	6
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	12
rs	10

<?php declare(strict_types=1);
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

/**
 * Contact module
 *
 * @copyright   XOOPS Project (https://xoops.org)
 * @license     https://www.fsf.org/copyleft/gpl.html GNU public license
 * @author      Kazumi Ono (aka Onokazu)
 * @author      Trabis <[email protected]>
 * @author      Hossein Azizabadi (AKA Voltan)
 * @param \XoopsModule $module
 * @param              $version
 */

use XoopsModules\Contact\{
    Common\Configurator,
    Helper,
    Utility
};

/** @var Helper $helper */
/** @var Utility $utility */
/** @var Configurator $configurator */
if ((!defined('XOOPS_ROOT_PATH')) || !($GLOBALS['xoopsUser'] instanceof \XoopsUser)
    || !$GLOBALS['xoopsUser']->isAdmin()) {
    exit('Restricted access' . PHP_EOL);
}

/**
 * Prepares system prior to attempting to install module
 * @param \XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if ready to install, false if not
 */
function xoops_module_pre_update_contact(\XoopsModule $module)
{
    /** @var Helper $helper */
    /** @var Utility $utility */
    $moduleDirName = \basename(\dirname(__DIR__));

    $helper        = Helper::getInstance();

    $utility       = new Utility();

    $xoopsSuccess = $utility::checkVerXoops($module);
    $phpSuccess   = $utility::checkVerPhp($module);

    return $xoopsSuccess && $phpSuccess;
}

/**
 * Performs tasks required during update of the module
 * @param \XoopsModule $module {@link XoopsModule}
 * @param null         $previousVersion

 *
 * @return bool true if update successful, false if not
 */
function xoops_module_update_contact(\XoopsModule $module, $previousVersion = null)
{
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);


    /** @var Helper $helper */
    /** @var Utility $utility */
    /** @var Configurator $configurator */
    $helper       = Helper::getInstance();

    $utility      = new Utility();

    $configurator = new Configurator();


    $xoopsDB = \XoopsDatabaseFactory::getDatabaseConnection();

    if ($previousVersion < 180) {
        $sql = 'CREATE TABLE ' . $xoopsDB->prefix('contact') . ' (
        contact_id int(10) unsigned NOT NULL auto_increment,
        contact_uid int(10) NOT NULL,
        contact_cid int(10) NOT NULL,
        contact_create int(10) NOT NULL,
        contact_subject varchar(255) NOT NULL,
        contact_name varchar(255) NOT NULL,
        contact_mail varchar(255) NOT NULL,
        contact_url varchar(255) NOT NULL,
        contact_icq varchar(255) NOT NULL,
        contact_company varchar(255) NOT NULL,
        contact_location varchar(255) NOT NULL,
        contact_department varchar(60) NOT NULL,
        contact_ip varchar(20) NOT NULL,
        contact_phone varchar(20) NOT NULL,
        contact_message text NOT NULL,
        contact_address text NOT NULL,
        contact_reply tinyint(1) NOT NULL,
        PRIMARY KEY  (contact_id)
        ) ENGINE=MyISAM;';
        $xoopsDB->query($sql);
    }

    if ($previousVersion < 181) {
        // Add contact_platform
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . "` ADD `contact_platform` ENUM('Android','Ios','Web') NOT NULL DEFAULT 'Web'";
        $xoopsDB->query($sql);
        // Add contact_type
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . "` ADD `contact_type` ENUM('Contact','Phone','Mail') NOT NULL DEFAULT 'Contact'";
        $xoopsDB->query($sql);
        // Add index contact_uid
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_uid` ( `contact_uid` )';
        $xoopsDB->query($sql);
        // Add index contact_cid
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_cid` ( `contact_cid` )';
        $xoopsDB->query($sql);
        // Add index contact_create
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_create` ( `contact_create` )';
        $xoopsDB->query($sql);
        // Add index contact_mail
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_mail` ( `contact_mail` )';
        $xoopsDB->query($sql);
        // Add index contact_phone
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_phone` ( `contact_phone` )';
        $xoopsDB->query($sql);
        // Add index contact_platform
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_platform` ( `contact_platform` )';
        $xoopsDB->query($sql);
        // Add index contact_type
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_type` ( `contact_type` )';
        $xoopsDB->query($sql);
    }

    if ($previousVersion < 227) {
        $configurator = new Configurator();
        $utility      = new Utility();

        //delete old HTML templates
        if (count($configurator->templateFolders) > 0) {
            foreach ($configurator->templateFolders as $folder) {
                $templateFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $folder);
                if (is_dir($templateFolder)) {
                    $templateList = array_diff(scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
                    foreach ($templateList as $k => $v) {
                        $fileInfo = new \SplFileInfo($templateFolder . $v);
                        if ('html' === $fileInfo->getExtension() && 'index.html' !== $fileInfo->getFilename()) {
                            if (is_file($templateFolder . $v)) {
                                unlink($templateFolder . $v);
                            }
                        }
                    }
                }
            }
        }

        //  ---  DELETE OLD FILES ---------------
        if (count($configurator->oldFiles) > 0) {
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
            foreach (array_keys($configurator->oldFiles) as $i) {
                $tempFile = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFiles[$i]);
                if (is_file($tempFile)) {
                    unlink($tempFile);
                }
            }
        }

        //  ---  DELETE OLD FOLDERS ---------------
        xoops_load('XoopsFile');
        if (count($configurator->oldFolders) > 0) {
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
            foreach (array_keys($configurator->oldFolders) as $i) {
                $tempFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFolders[$i]);
                /** @var XoopsObjectHandler $folderHandler */
                $folderHandler = XoopsFile::getHandler('folder', $tempFolder);
                $folderHandler->delete($tempFolder);
            }
        }

        //  ---  CREATE FOLDERS ---------------
        if (count($configurator->uploadFolders) > 0) {
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
            foreach (array_keys($configurator->uploadFolders) as $i) {
                $utility::createFolder($configurator->uploadFolders[$i]);
            }
        }

        //  ---  COPY blank.png FILES ---------------
        if (count($configurator->copyBlankFiles) > 0) {
            $file = \dirname(__DIR__) . '/assets/images/blank.png';
            foreach (array_keys($configurator->copyBlankFiles) as $i) {
                $dest = $configurator->copyBlankFiles[$i] . '/blank.png';
                $utility::copyFile($file, $dest);
            }
        }

        //delete .html entries from the tpl table
        $sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . '\' AND `tpl_file` LIKE \'%.html%\'';
        $GLOBALS['xoopsDB']->queryF($sql);

        /** @var \XoopsGroupPermHandler $grouppermHandler */
        $grouppermHandler = xoops_getHandler('groupperm');

        return $grouppermHandler->deleteByModule($module->getVar('mid'), 'item_read');
    }

    if ($previousVersion < 227) {
        // Add contact_skype
        $sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD `contact_skype` VARCHAR(255) NULL AFTER `contact_icq`';
        $xoopsDB->query($sql);
    }
}


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			* Contact module
14			*
15			* @copyright XOOPS Project (https://xoops.org)
16			* @license https://www.fsf.org/copyleft/gpl.html GNU public license
17			* @author Kazumi Ono (aka Onokazu)
18			* @author Trabis <[email protected]>
19			* @author Hossein Azizabadi (AKA Voltan)
20			* @param \XoopsModule $module
21			* @param $version
22			*/
23
24			use XoopsModules\Contact\{
25			Common\Configurator,
26			Helper,
27			Utility
28			};
29
30			/** @var Helper $helper */
31			/** @var Utility $utility */
32			/** @var Configurator $configurator */
33			if ((!defined('XOOPS_ROOT_PATH')) \|\| !($GLOBALS['xoopsUser'] instanceof \XoopsUser)
34			\|\| !$GLOBALS['xoopsUser']->isAdmin()) {
35			exit('Restricted access' . PHP_EOL);
36			}
37
38			/**
39			* Prepares system prior to attempting to install module
40			* @param \XoopsModule $module {@link XoopsModule}
41			*
42			* @return bool true if ready to install, false if not
43			*/
44			function xoops_module_pre_update_contact(\XoopsModule $module)
45			{
46			/** @var Helper $helper */
47			/** @var Utility $utility */
48			$moduleDirName = \basename(\dirname(__DIR__));
			0 ignored issues – show Unused Code introduced 2018-04-07 14:48 UTC by Report Bug Copy Issue Report The assignment to `$moduleDirName` is dead and can be removed. Loading history...
49			$helper = Helper::getInstance();
			0 ignored issues – show Unused Code introduced 2018-04-07 14:48 UTC by Report Bug Copy Issue Report The assignment to `$helper` is dead and can be removed. Loading history...
50			$utility = new Utility();
51
52			$xoopsSuccess = $utility::checkVerXoops($module);
53			$phpSuccess = $utility::checkVerPhp($module);
54
55			return $xoopsSuccess && $phpSuccess;
56			}
57
58			/**
59			* Performs tasks required during update of the module
60			* @param \XoopsModule $module {@link XoopsModule}
61			* @param null $previousVersion
			0 ignored issues – show Documentation Bug introduced 2018-04-07 14:48 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$previousVersion` is correct as it would always require `null` to be passed? Loading history...
62			*
63			* @return bool true if update successful, false if not
64			*/
65			function xoops_module_update_contact(\XoopsModule $module, $previousVersion = null)
66			{
67			$moduleDirName = \basename(\dirname(__DIR__));
68			$moduleDirNameUpper = \mb_strtoupper($moduleDirName);
			0 ignored issues – show Unused Code introduced 2021-03-11 15:27 UTC by Report Bug Copy Issue Report The assignment to `$moduleDirNameUpper` is dead and can be removed. Loading history...
69
70			/** @var Helper $helper */
71			/** @var Utility $utility */
72			/** @var Configurator $configurator */
73			$helper = Helper::getInstance();
			0 ignored issues – show Unused Code introduced 2018-04-07 14:48 UTC by Report Bug Copy Issue Report The assignment to `$helper` is dead and can be removed. Loading history...
74			$utility = new Utility();
			0 ignored issues – show Unused Code introduced 2018-04-07 14:48 UTC by Report Bug Copy Issue Report The assignment to `$utility` is dead and can be removed. Loading history...
75			$configurator = new Configurator();
			0 ignored issues – show Unused Code introduced 2018-04-07 14:48 UTC by Report Bug Copy Issue Report The assignment to `$configurator` is dead and can be removed. Loading history...
76
77			$xoopsDB = \XoopsDatabaseFactory::getDatabaseConnection();
78
79			if ($previousVersion < 180) {
80			$sql = 'CREATE TABLE ' . $xoopsDB->prefix('contact') . ' (
81			contact_id int(10) unsigned NOT NULL auto_increment,
82			contact_uid int(10) NOT NULL,
83			contact_cid int(10) NOT NULL,
84			contact_create int(10) NOT NULL,
85			contact_subject varchar(255) NOT NULL,
86			contact_name varchar(255) NOT NULL,
87			contact_mail varchar(255) NOT NULL,
88			contact_url varchar(255) NOT NULL,
89			contact_icq varchar(255) NOT NULL,
90			contact_company varchar(255) NOT NULL,
91			contact_location varchar(255) NOT NULL,
92			contact_department varchar(60) NOT NULL,
93			contact_ip varchar(20) NOT NULL,
94			contact_phone varchar(20) NOT NULL,
95			contact_message text NOT NULL,
96			contact_address text NOT NULL,
97			contact_reply tinyint(1) NOT NULL,
98			PRIMARY KEY (contact_id)
99			) ENGINE=MyISAM;';
100			$xoopsDB->query($sql);
101			}
102
103			if ($previousVersion < 181) {
104			// Add contact_platform
105			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . "` ADD `contact_platform` ENUM('Android','Ios','Web') NOT NULL DEFAULT 'Web'";
106			$xoopsDB->query($sql);
107			// Add contact_type
108			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . "` ADD `contact_type` ENUM('Contact','Phone','Mail') NOT NULL DEFAULT 'Contact'";
109			$xoopsDB->query($sql);
110			// Add index contact_uid
111			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_uid` ( `contact_uid` )';
112			$xoopsDB->query($sql);
113			// Add index contact_cid
114			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_cid` ( `contact_cid` )';
115			$xoopsDB->query($sql);
116			// Add index contact_create
117			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_create` ( `contact_create` )';
118			$xoopsDB->query($sql);
119			// Add index contact_mail
120			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_mail` ( `contact_mail` )';
121			$xoopsDB->query($sql);
122			// Add index contact_phone
123			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_phone` ( `contact_phone` )';
124			$xoopsDB->query($sql);
125			// Add index contact_platform
126			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_platform` ( `contact_platform` )';
127			$xoopsDB->query($sql);
128			// Add index contact_type
129			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD INDEX `contact_type` ( `contact_type` )';
130			$xoopsDB->query($sql);
131			}
132
133			if ($previousVersion < 227) {
134			$configurator = new Configurator();
135			$utility = new Utility();
136
137			//delete old HTML templates
138			if (count($configurator->templateFolders) > 0) {
139			foreach ($configurator->templateFolders as $folder) {
140			$templateFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $folder);
141			if (is_dir($templateFolder)) {
142			$templateList = array_diff(scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
143			foreach ($templateList as $k => $v) {
144			$fileInfo = new \SplFileInfo($templateFolder . $v);
145			if ('html' === $fileInfo->getExtension() && 'index.html' !== $fileInfo->getFilename()) {
146			if (is_file($templateFolder . $v)) {
147			unlink($templateFolder . $v);
148			}
149			}
150			}
151			}
152			}
153			}
154
155			// --- DELETE OLD FILES ---------------
156			if (count($configurator->oldFiles) > 0) {
157			// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
158			foreach (array_keys($configurator->oldFiles) as $i) {
159			$tempFile = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFiles[$i]);
160			if (is_file($tempFile)) {
161			unlink($tempFile);
162			}
163			}
164			}
165
166			// --- DELETE OLD FOLDERS ---------------
167			xoops_load('XoopsFile');
168			if (count($configurator->oldFolders) > 0) {
169			// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
170			foreach (array_keys($configurator->oldFolders) as $i) {
171			$tempFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFolders[$i]);
172			/** @var XoopsObjectHandler $folderHandler */
173			$folderHandler = XoopsFile::getHandler('folder', $tempFolder);
174			$folderHandler->delete($tempFolder);
175			}
176			}
177
178			// --- CREATE FOLDERS ---------------
179			if (count($configurator->uploadFolders) > 0) {
180			// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
181			foreach (array_keys($configurator->uploadFolders) as $i) {
182			$utility::createFolder($configurator->uploadFolders[$i]);
183			}
184			}
185
186			// --- COPY blank.png FILES ---------------
187			if (count($configurator->copyBlankFiles) > 0) {
188			$file = \dirname(__DIR__) . '/assets/images/blank.png';
189			foreach (array_keys($configurator->copyBlankFiles) as $i) {
190			$dest = $configurator->copyBlankFiles[$i] . '/blank.png';
191			$utility::copyFile($file, $dest);
192			}
193			}
194
195			//delete .html entries from the tpl table
196			$sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . '\' AND `tpl_file` LIKE \'%.html%\'';
197			$GLOBALS['xoopsDB']->queryF($sql);
198
199			/** @var \XoopsGroupPermHandler $grouppermHandler */
200			$grouppermHandler = xoops_getHandler('groupperm');
201
202			return $grouppermHandler->deleteByModule($module->getVar('mid'), 'item_read');
203			}
204
205			if ($previousVersion < 227) {
206			// Add contact_skype
207			$sql = 'ALTER TABLE `' . $xoopsDB->prefix('contact') . '` ADD `contact_skype` VARCHAR(255) NULL AFTER `contact_icq`';
208			$xoopsDB->query($sql);
209			}
210			}
211

mambax7 / contact

xoops_module_pre_update_contact() A last analyzed 2022-03-09 04:57 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

xoops_module_pre_update_contact() A
last analyzed 2022-03-09 04:57 UTC