DirectoryChecker::getDirectoryStatus() - Code Metrics - Inspection of "Updates for XOOPS 2.5.12" - XoopsModules25x/news - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#41)

by Michael

created 2025-01-19 03:52 UTC

DirectoryChecker::getDirectoryStatus() B

↳ Parent: DirectoryChecker

Complexity

Conditions	6
Paths	9

Size

Total Lines	51
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	43
c	1
b	0
f	0
nc	9
nop	3
dl	0
loc	51
rs	8.6097

How to fix Long Method

<?php declare(strict_types=1);

namespace XoopsModules\News\Common;

/*
 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.
 */

/**
 *
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author          Xoops Development Team
 */
use Xmf\Module\Admin;
use Xmf\Request;
use XoopsModules\News;

//defined('XOOPS_ROOT_PATH') || die('XOOPS root path not defined');

require_once \dirname(__DIR__, 4) . '/mainfile.php';
$moduleDirName = \basename(\dirname(__DIR__, 2));
$moduleDirNameUpper = \mb_strtoupper($moduleDirName);
\xoops_loadLanguage('directorychecker', $moduleDirName);

/**
 * Class DirectoryChecker
 * check status of a directory
 */
class DirectoryChecker
{
    /**
     * @param string|null $path
     * @param int|null    $mode
     * @param string|null $redirectFile
     *
     * @return bool|string
     */
    public static function getDirectoryStatus(?string $path, ?int $mode = null, ?string $redirectFile = null)
    {
        $mode       ??= 0777;
        $pathIcon16 = Admin::iconUrl('', '16');

        if (empty($path)) {
            return false;
        }
        if (null === $redirectFile) {
            $redirectFile = $_SERVER['SCRIPT_NAME'];
        }
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
        if (!@\is_dir($path)) {
            $path_status = "<img src='$pathIcon16/0.png' >";
            $path_status .= "$path (" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_NOTAVAILABLE') . ') ';
            $path_status .= "<form action='" . $_SERVER['SCRIPT_NAME'] . "' method='post'>";
            $path_status .= "<input type='hidden' name='op' value='createdir'>";
            $path_status .= "<input type='hidden' name='path' value='$path'>";
            $path_status .= "<input type='hidden' name='redirect' value='$redirectFile'>";
            $path_status .= "<button class='submit' onClick='this.form.submit();'>" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_CREATETHEDIR') . '</button>';
            $path_status .= '</form>';
        } elseif (@\is_writable($path)) {
            $path_status = "<img src='$pathIcon16/1.png' >";
            $path_status .= "$path (" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_AVAILABLE') . ') ';
            $currentMode = \mb_substr(\decoct(\fileperms($path)), 2);
            if ($currentMode != \decoct($mode)) {
                $path_status = "<img src='$pathIcon16/0.png' >";
                $path_status .= $path . \sprintf(\constant('CO_' . $moduleDirNameUpper . '_' . 'DC_NOTWRITABLE'), \decoct($mode), $currentMode);
                $path_status .= "<form action='" . $_SERVER['SCRIPT_NAME'] . "' method='post'>";
                $path_status .= "<input type='hidden' name='op' value='setdirperm'>";
                $path_status .= "<input type='hidden' name='mode' value='$mode'>";
                $path_status .= "<input type='hidden' name='path' value='$path'>";
                $path_status .= "<input type='hidden' name='redirect' value='$redirectFile'>";
                $path_status .= "<button class='submit' onClick='this.form.submit();'>" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_SETMPERM') . '</button>';
                $path_status .= '</form>';
            }
        } else {
            $currentMode = \mb_substr(\decoct(\fileperms($path)), 2);
            $path_status = "<img src='$pathIcon16/0.png' >";
            $path_status .= $path . \sprintf(\constant('CO_' . $moduleDirNameUpper . '_' . 'DC_NOTWRITABLE'), \decoct($mode), $currentMode);
            $path_status .= "<form action='" . $_SERVER['SCRIPT_NAME'] . "' method='post'>";
            $path_status .= "<input type='hidden' name='op' value='setdirperm'>";
            $path_status .= "<input type='hidden' name='mode' value='$mode'>";
            $path_status .= "<input type='hidden' name='path' value='$path'>";
            $path_status .= "<input type='hidden' name='redirect' value='$redirectFile'>";
            $path_status .= "<button class='submit' onClick='this.form.submit();'>" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_SETMPERM') . '</button>';
            $path_status .= '</form>';
        }

        return $path_status;
    }

    /**
     * @param string $target
     * @param int    $mode
     *
     * @return bool
     */
    public static function createDirectory(string $target, int $mode = 0777): bool
    {
        $target = \str_replace('..', '', $target);

        // https://www.php.net/manual/en/function.mkdir.php
        return \is_dir($target) || (self::createDirectory(\dirname($target), $mode) && !\mkdir($target, $mode) && !\is_dir($target));
    }

    /**
     * @param string $target
     * @param int    $mode
     *
     * @return bool
     */
    public static function setDirectoryPermissions(string $target, int $mode = 0777): bool
    {
        $target = \str_replace('..', '', $target);

        return @\chmod($target, (int)$mode);
    }

    /**
     * @param string $dir_path
     *
     * @return bool
     */
    public static function dirExists(string $dir_path): bool
    {
        return \is_dir($dir_path);
    }
}

$op = Request::getString('op', '', 'POST');
switch ($op) {
    case 'createdir':
        if (Request::hasVar('path', 'POST')) {
            $path = $_POST['path'];
        }
        if (Request::hasVar('redirect', 'POST')) {
            $redirect = $_POST['redirect'];
        }
        $msg = DirectoryChecker::createDirectory($path) ? \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_DIRCREATED') : \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_DIRNOTCREATED');
        \redirect_header($redirect, 2, $msg . ': ' . $path);
        break;
    case 'setdirperm':
        if (Request::hasVar('path', 'POST')) {
            $path = $_POST['path'];
        }
        if (Request::hasVar('redirect', 'POST')) {
            $redirect = $_POST['redirect'];
        }
        if (Request::hasVar('mode', 'POST')) {
            $mode = $_POST['mode'];
        }
        $msg = DirectoryChecker::setDirectoryPermissions($path, $mode) ? \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_PERMSET') : \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_PERMNOTSET');
        \redirect_header($redirect, 2, $msg . ': ' . $path);
        break;
}


1			<?php declare(strict_types=1);
2
3			namespace XoopsModules\News\Common;
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
10			This program is distributed in the hope that it will be useful,
11			but WITHOUT ANY WARRANTY; without even the implied warranty of
12			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13			*/
14
15			/**
16			*
17			* @copyright XOOPS Project (https://xoops.org)
18			* @license GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
19			* @author Xoops Development Team
20			*/
21			use Xmf\Module\Admin;
22			use Xmf\Request;
23			use XoopsModules\News;
24
25			//defined('XOOPS_ROOT_PATH') \|\| die('XOOPS root path not defined');
26
27			require_once \dirname(__DIR__, 4) . '/mainfile.php';
28			$moduleDirName = \basename(\dirname(__DIR__, 2));
29			$moduleDirNameUpper = \mb_strtoupper($moduleDirName);
30			\xoops_loadLanguage('directorychecker', $moduleDirName);
31
32			/**
33			* Class DirectoryChecker
34			* check status of a directory
35			*/
36			class DirectoryChecker
37			{
38			/**
39			* @param string\|null $path
40			* @param int\|null $mode
41			* @param string\|null $redirectFile
42			*
43			* @return bool\|string
44			*/
45			public static function getDirectoryStatus(?string $path, ?int $mode = null, ?string $redirectFile = null)
46			{
47			$mode ??= 0777;
48			$pathIcon16 = Admin::iconUrl('', '16');
49
50			if (empty($path)) {
51			return false;
52			}
53			if (null === $redirectFile) {
54			$redirectFile = $_SERVER['SCRIPT_NAME'];
55			}
56			$moduleDirName = \basename(\dirname(__DIR__, 2));
57			$moduleDirNameUpper = \mb_strtoupper($moduleDirName);
58			if (!@\is_dir($path)) {
59			$path_status = "<img src='$pathIcon16/0.png' >";
60			$path_status .= "$path (" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_NOTAVAILABLE') . ') ';
61			$path_status .= "<form action='" . $_SERVER['SCRIPT_NAME'] . "' method='post'>";
62			$path_status .= "<input type='hidden' name='op' value='createdir'>";
63			$path_status .= "<input type='hidden' name='path' value='$path'>";
64			$path_status .= "<input type='hidden' name='redirect' value='$redirectFile'>";
65			$path_status .= "<button class='submit' onClick='this.form.submit();'>" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_CREATETHEDIR') . '</button>';
66			$path_status .= '</form>';
67			} elseif (@\is_writable($path)) {
68			$path_status = "<img src='$pathIcon16/1.png' >";
69			$path_status .= "$path (" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_AVAILABLE') . ') ';
70			$currentMode = \mb_substr(\decoct(\fileperms($path)), 2);
71			if ($currentMode != \decoct($mode)) {
72			$path_status = "<img src='$pathIcon16/0.png' >";
73			$path_status .= $path . \sprintf(\constant('CO_' . $moduleDirNameUpper . '_' . 'DC_NOTWRITABLE'), \decoct($mode), $currentMode);
74			$path_status .= "<form action='" . $_SERVER['SCRIPT_NAME'] . "' method='post'>";
75			$path_status .= "<input type='hidden' name='op' value='setdirperm'>";
76			$path_status .= "<input type='hidden' name='mode' value='$mode'>";
77			$path_status .= "<input type='hidden' name='path' value='$path'>";
78			$path_status .= "<input type='hidden' name='redirect' value='$redirectFile'>";
79			$path_status .= "<button class='submit' onClick='this.form.submit();'>" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_SETMPERM') . '</button>';
80			$path_status .= '</form>';
81			}
82			} else {
83			$currentMode = \mb_substr(\decoct(\fileperms($path)), 2);
84			$path_status = "<img src='$pathIcon16/0.png' >";
85			$path_status .= $path . \sprintf(\constant('CO_' . $moduleDirNameUpper . '_' . 'DC_NOTWRITABLE'), \decoct($mode), $currentMode);
86			$path_status .= "<form action='" . $_SERVER['SCRIPT_NAME'] . "' method='post'>";
87			$path_status .= "<input type='hidden' name='op' value='setdirperm'>";
88			$path_status .= "<input type='hidden' name='mode' value='$mode'>";
89			$path_status .= "<input type='hidden' name='path' value='$path'>";
90			$path_status .= "<input type='hidden' name='redirect' value='$redirectFile'>";
91			$path_status .= "<button class='submit' onClick='this.form.submit();'>" . \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_SETMPERM') . '</button>';
92			$path_status .= '</form>';
93			}
94
95			return $path_status;
96			}
97
98			/**
99			* @param string $target
100			* @param int $mode
101			*
102			* @return bool
103			*/
104			public static function createDirectory(string $target, int $mode = 0777): bool
105			{
106			$target = \str_replace('..', '', $target);
107
108			// https://www.php.net/manual/en/function.mkdir.php
109			return \is_dir($target) \|\| (self::createDirectory(\dirname($target), $mode) && !\mkdir($target, $mode) && !\is_dir($target));
110			}
111
112			/**
113			* @param string $target
114			* @param int $mode
115			*
116			* @return bool
117			*/
118			public static function setDirectoryPermissions(string $target, int $mode = 0777): bool
119			{
120			$target = \str_replace('..', '', $target);
121
122			return @\chmod($target, (int)$mode);
123			}
124
125			/**
126			* @param string $dir_path
127			*
128			* @return bool
129			*/
130			public static function dirExists(string $dir_path): bool
131			{
132			return \is_dir($dir_path);
133			}
134			}
135
136			$op = Request::getString('op', '', 'POST');
137			switch ($op) {
138			case 'createdir':
139			if (Request::hasVar('path', 'POST')) {
140			$path = $_POST['path'];
141			}
142			if (Request::hasVar('redirect', 'POST')) {
143			$redirect = $_POST['redirect'];
144			}
145			$msg = DirectoryChecker::createDirectory($path) ? \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_DIRCREATED') : \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_DIRNOTCREATED');
146			\redirect_header($redirect, 2, $msg . ': ' . $path);
147			break;
148			case 'setdirperm':
149			if (Request::hasVar('path', 'POST')) {
150			$path = $_POST['path'];
151			}
152			if (Request::hasVar('redirect', 'POST')) {
153			$redirect = $_POST['redirect'];
154			}
155			if (Request::hasVar('mode', 'POST')) {
156			$mode = $_POST['mode'];
157			}
158			$msg = DirectoryChecker::setDirectoryPermissions($path, $mode) ? \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_PERMSET') : \constant('CO_' . $moduleDirNameUpper . '_' . 'DC_PERMNOTSET');
159			\redirect_header($redirect, 2, $msg . ': ' . $path);
160			break;
161			}
162

XoopsModules25x / news

Pull Request — master (#41)

DirectoryChecker::getDirectoryStatus() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like