System::denyWebAccess() - Code Metrics - puli/manager - Measure and Improve Code Quality continuously with Scrutinizer

System::denyWebAccess() A
last analyzed 2016-08-15 16:04 UTC

↳ Parent: System

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.2098

Importance

Changes

Metric	Value
dl	0
loc	11
c	0
b	0
f	0
ccs	5
cts	7
cp	0.7143
rs	9.4285
cc	3
eloc	6
nc	3
nop	1
crap	3.2098

<?php

/*
 * This file is part of the puli/manager package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Manager\Util;

use Puli\Manager\Api\FileNotFoundException;
use Puli\Manager\Api\InvalidConfigException;
use Puli\Manager\Api\NoDirectoryException;
use Symfony\Component\Filesystem\Filesystem;

/**
 * Provides system utilities.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class System

{
    /**
     * Parses context variables for Puli's home directory.
     *
     * This method scans the context variables "PULI_HOME", "HOME" and
     * "APPDATA" to determine Puli's home directory:
     *
     *  * If "PULI_HOME" is found, that directory is used.
     *  * If "HOME" is found, a directory ".puli" is created inside. This
     *    variable contains the path of the user's home directory by default
     *    on Unix based systems.
     *  * If "APPDATA" is found, a directory "Puli" is created inside. This
     *    variable contains the path of the application data by default on
     *    Windows.
     *
     * @return string The path to Puli's home directory.
     *
     * @throws InvalidConfigException If no context variable can be found to
     *                                determine the home directory.
     * @throws FileNotFoundException  If the home directory is not found.
     * @throws NoDirectoryException   If the home directory is not a directory.
     */
    public static function parseHomeDirectory()
    {
        if ($value = getenv('PULI_HOME')) {
            $homeDir = $value;
            $env = 'PULI_HOME';
        } elseif ($value = getenv('HOME')) {
            $homeDir = $value;
            $env = 'HOME';
        } elseif ($value = getenv('APPDATA')) {
            $homeDir = $value;
            $env = 'APPDATA';
        } else {
            throw new InvalidConfigException(sprintf(
                'Either the context variable PULI_HOME or %s must be set for '.
                'Puli to run.',
                defined('PHP_WINDOWS_VERSION_MAJOR') ? 'APPDATA' : 'HOME'
            ));
        }

        $homeDir = strtr($homeDir, array('\\' => '/'));

        if (!file_exists($homeDir)) {
            throw new FileNotFoundException(sprintf(
                'The home path %s defined in the context variable %s '.
                'does not exist.',
                $homeDir,
                $env
            ));
        }

        if (is_file($homeDir)) {
            throw new NoDirectoryException(sprintf(
                'The home path %s defined in the context variable %s '.
                'points to a file. Expected a directory path.',
                $homeDir,
                $env
            ));
        }

        switch ($env) {
            case 'PULI_HOME':
                return $homeDir; // user defined
            case 'HOME':
                return $homeDir.'/.puli'; // Linux/Mac
            default:
                return $homeDir.'/Puli'; // Windows
        }
    }

    /**
     * Denies web access to a directory path.
     *
     * A .htaccess file with the contents "Deny from all" is placed in the
     * directory, unless a .htaccess file exists already.
     *
     * @param string $directory The path to a directory.
     */
    public static function denyWebAccess($directory)
    {
        if (!file_exists($directory.'/.htaccess')) {
            if (!is_dir($directory)) {
                $filesystem = new Filesystem();
                $filesystem->mkdir($directory);
            }

            @file_put_contents($directory.'/.htaccess', 'Deny from all');
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
    }

    private function __construct()
    {
    }
}


1		<?php
2
3		/*
4		* This file is part of the puli/manager package.
5		*
6		* (c) Bernhard Schussek <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Puli\Manager\Util;
13
14		use Puli\Manager\Api\FileNotFoundException;
15		use Puli\Manager\Api\InvalidConfigException;
16		use Puli\Manager\Api\NoDirectoryException;
17		use Symfony\Component\Filesystem\Filesystem;
18
19		/**
20		* Provides system utilities.
21		*
22		* @since 1.0
23		*
24		* @author Bernhard Schussek <[email protected]>
25		*/
26		class System
		0 ignored issues – show Coding Style introduced 2015-12-06 22:18 UTC by Report Bug Copy Issue Report Since you have declared the constructor as private, maybe you should also declare the class as final. Loading history...
27		{
28		/**
29		* Parses context variables for Puli's home directory.
30		*
31		* This method scans the context variables "PULI_HOME", "HOME" and
32		* "APPDATA" to determine Puli's home directory:
33		*
34		* * If "PULI_HOME" is found, that directory is used.
35		* * If "HOME" is found, a directory ".puli" is created inside. This
36		* variable contains the path of the user's home directory by default
37		* on Unix based systems.
38		* * If "APPDATA" is found, a directory "Puli" is created inside. This
39		* variable contains the path of the application data by default on
40		* Windows.
41		*
42		* @return string The path to Puli's home directory.
43		*
44		* @throws InvalidConfigException If no context variable can be found to
45		* determine the home directory.
46		* @throws FileNotFoundException If the home directory is not found.
47		* @throws NoDirectoryException If the home directory is not a directory.
48		*/
49	65	public static function parseHomeDirectory()
50		{
51	65	if ($value = getenv('PULI_HOME')) {
52	54	$homeDir = $value;
53	54	$env = 'PULI_HOME';
54	11	} elseif ($value = getenv('HOME')) {
55	4	$homeDir = $value;
56	4	$env = 'HOME';
57	7	} elseif ($value = getenv('APPDATA')) {
58	4	$homeDir = $value;
59	4	$env = 'APPDATA';
60		} else {
61	3	throw new InvalidConfigException(sprintf(
62		'Either the context variable PULI_HOME or %s must be set for '.
63	3	'Puli to run.',
64	3	defined('PHP_WINDOWS_VERSION_MAJOR') ? 'APPDATA' : 'HOME'
65		));
66		}
67
68	62	$homeDir = strtr($homeDir, array('\\' => '/'));
69
70	62	if (!file_exists($homeDir)) {
71	3	throw new FileNotFoundException(sprintf(
72		'The home path %s defined in the context variable %s '.
73	3	'does not exist.',
74		$homeDir,
75		$env
76		));
77		}
78
79	59	if (is_file($homeDir)) {
80	4	throw new NoDirectoryException(sprintf(
81		'The home path %s defined in the context variable %s '.
82	4	'points to a file. Expected a directory path.',
83		$homeDir,
84		$env
85		));
86		}
87
88		switch ($env) {
89	55	case 'PULI_HOME':
90	51	return $homeDir; // user defined
91	4	case 'HOME':
92	2	return $homeDir.'/.puli'; // Linux/Mac
93		default:
94	2	return $homeDir.'/Puli'; // Windows
95		}
96		}
97
98		/**
99		* Denies web access to a directory path.
100		*
101		* A .htaccess file with the contents "Deny from all" is placed in the
102		* directory, unless a .htaccess file exists already.
103		*
104		* @param string $directory The path to a directory.
105		*/
106	48	public static function denyWebAccess($directory)
107		{
108	48	if (!file_exists($directory.'/.htaccess')) {
109	48	if (!is_dir($directory)) {
110		$filesystem = new Filesystem();
111		$filesystem->mkdir($directory);
112		}
113
114	48	@file_put_contents($directory.'/.htaccess', 'Deny from all');
		0 ignored issues – show Security Best Practice introduced 2015-12-06 22:18 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
115		}
116	48	}
117
118		private function __construct()
119		{
120		}
121		}
122

puli / manager

System::denyWebAccess() A last analyzed 2016-08-15 16:04 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

System::denyWebAccess() A
last analyzed 2016-08-15 16:04 UTC