Writer::save() - Code Metrics - Inspection of "adjusted basic loading saving in admin" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — psr2-config ( 8ea568...077c27 )

by Andreas

created 2018-05-11 22:21 UTC

Writer::save() C

↳ Parent: Writer

Complexity

Conditions	8
Paths	18

Size

Total Lines	25
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	8
eloc	16
nc	18
nop	1
dl	0
loc	25
rs	5.3846
c	1
b	0
f	1

<?php

namespace dokuwiki\plugin\config\core;

/**
 * Writes the settings to the correct local file
 */
class Writer {
    /** @var string header info */
    protected $header = 'Dokuwiki\'s Main Configuration File - Local Settings';

    /** @var string the file where the config will be saved to */
    protected $savefile;

    /**
     * Writer constructor.
     */
    public function __construct() {
        global $config_cascade;
        $this->savefile = end($config_cascade['main']['local']);
    }

    /**
     * Save the given settings
     *
     * @param Setting[] $settings
     * @throws \Exception
     */
    public function save($settings) {
        global $conf;
        if($this->isLocked()) throw new \Exception('no save');

        // backup current file (remove any existing backup)
        if(file_exists($this->savefile)) {
            if(file_exists($this->savefile . '.bak')) @unlink($this->savefile . '.bak');
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            if(!io_rename($this->savefile, $this->savefile . '.bak')) throw new \Exception('no backup');
        }

        if(!$fh = @fopen($this->savefile, 'wb')) {
            io_rename($this->savefile . '.bak', $this->savefile); // problem opening, restore the backup
            throw new \Exception('no save');
        }

        $out = $this->getHeader();
        foreach($settings as $setting) {
            $out .= $setting->out('conf', 'php');
        }

        fwrite($fh, $out);
        fclose($fh);
        if($conf['fperm']) chmod($this->savefile, $conf['fperm']);
        @opcache_invalidate($this->savefile);
// For example instead of
@mkdir($dir);

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

    /**
     * Update last modified time stamp of the config file
     *
     * Will invalidate all DokuWiki caches
     *
     * @throws \Exception when the config isn't writable
     */
    public function touch() {
        if($this->isLocked()) throw new \Exception('no save');
        @touch($this->savefile);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        @opcache_invalidate($this->savefile);
// For example instead of
@mkdir($dir);

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

    /**
     * Configuration is considered locked if there is no local settings filename
     * or the directory its in is not writable or the file exists and is not writable
     *
     * @return bool true: locked, false: writable
     */
    public function isLocked() {
        if(!$this->savefile) return true;
        if(!is_writable(dirname($this->savefile))) return true;
        if(file_exists($this->savefile) && !is_writable($this->savefile)) return true;
        return false;
    }

    /**
     * Returns the PHP intro header for the config file
     *
     * @return string
     */
    protected function getHeader() {
        return join(
            "\n",
            array(
                '<?php',
                '/*',
                ' * ' . $this->header,
                ' * Auto-generated by config plugin',
                ' * Run for user: ' . $_SERVER['REMOTE_USER'],
                ' * Date: ' . date('r'),
                ' */',
                '',
                ''
            )
        );
    }
}


1			<?php
2
3			namespace dokuwiki\plugin\config\core;
4
5			/**
6			* Writes the settings to the correct local file
7			*/
8			class Writer {
9			/** @var string header info */
10			protected $header = 'Dokuwiki\'s Main Configuration File - Local Settings';
11
12			/** @var string the file where the config will be saved to */
13			protected $savefile;
14
15			/**
16			* Writer constructor.
17			*/
18			public function __construct() {
19			global $config_cascade;
20			$this->savefile = end($config_cascade['main']['local']);
21			}
22
23			/**
24			* Save the given settings
25			*
26			* @param Setting[] $settings
27			* @throws \Exception
28			*/
29			public function save($settings) {
30			global $conf;
31			if($this->isLocked()) throw new \Exception('no save');
32
33			// backup current file (remove any existing backup)
34			if(file_exists($this->savefile)) {
35			if(file_exists($this->savefile . '.bak')) @unlink($this->savefile . '.bak');
			1 ignored issue – show Security Best Practice introduced 2018-05-11 22:24 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...
36			if(!io_rename($this->savefile, $this->savefile . '.bak')) throw new \Exception('no backup');
37			}
38
39			if(!$fh = @fopen($this->savefile, 'wb')) {
40			io_rename($this->savefile . '.bak', $this->savefile); // problem opening, restore the backup
41			throw new \Exception('no save');
42			}
43
44			$out = $this->getHeader();
45			foreach($settings as $setting) {
46			$out .= $setting->out('conf', 'php');
47			}
48
49			fwrite($fh, $out);
50			fclose($fh);
51			if($conf['fperm']) chmod($this->savefile, $conf['fperm']);
52			@opcache_invalidate($this->savefile);
			1 ignored issue – show Security Best Practice introduced 2018-05-11 22:24 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...
53			}
54
55			/**
56			* Update last modified time stamp of the config file
57			*
58			* Will invalidate all DokuWiki caches
59			*
60			* @throws \Exception when the config isn't writable
61			*/
62			public function touch() {
63			if($this->isLocked()) throw new \Exception('no save');
64			@touch($this->savefile);
			1 ignored issue – show Security Best Practice introduced 2018-05-11 22:24 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...
65			@opcache_invalidate($this->savefile);
			1 ignored issue – show Security Best Practice introduced 2018-05-11 22:24 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...
66			}
67
68			/**
69			* Configuration is considered locked if there is no local settings filename
70			* or the directory its in is not writable or the file exists and is not writable
71			*
72			* @return bool true: locked, false: writable
73			*/
74			public function isLocked() {
75			if(!$this->savefile) return true;
76			if(!is_writable(dirname($this->savefile))) return true;
77			if(file_exists($this->savefile) && !is_writable($this->savefile)) return true;
78			return false;
79			}
80
81			/**
82			* Returns the PHP intro header for the config file
83			*
84			* @return string
85			*/
86			protected function getHeader() {
87			return join(
88			"\n",
89			array(
90			'<?php',
91			'/*',
92			' * ' . $this->header,
93			' * Auto-generated by config plugin',
94			' * Run for user: ' . $_SERVER['REMOTE_USER'],
95			' * Date: ' . date('r'),
96			' */',
97			'',
98			''
99			)
100			);
101			}
102			}
103

splitbrain / dokuwiki

Push — psr2-config ( 8ea568...077c27 )

Writer::save() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like