File::write() - Code Metrics - Inspection of "Merge pull request #9293 from nextcloud/feature/91..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a56ec1...2aa108 )

by Morris

created 2018-05-02 14:16 UTC

File::write() F

↳ Parent: File

Complexity

Conditions	14
Paths	3072

Size

Total Lines	73
Code Lines	54

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	14
eloc	54
nc	3072
nop	3
dl	0
loc	73
rs	2.3293
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Andreas Fischer <[email protected]>
 * @author Bart Visscher <[email protected]>
 * @author duritong <[email protected]>
 * @author Georg Ehrke <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Juan Pablo Villafáñez <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Michael Gapczynski <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Phiber2000 <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Roger Szabo <[email protected]>
 * @author Thomas Müller <[email protected]>
 * @author Thomas Pulzer <[email protected]>
 * @author Vincent Petry <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\Log;
use OC\SystemConfig;
use OCP\Log\IFileBased;
use OCP\Log\IWriter;
use OCP\ILogger;

/**
 * logging utilities
 *
 * Log is saved at data/nextcloud.log (on default)
 */

class File implements IWriter, IFileBased {
	/** @var string */
	protected $logFile;
	/** @var SystemConfig */
	private $config;

	public function __construct(string $path, string $fallbackPath = '', SystemConfig $config) {
		$this->logFile = $path;
		if (!file_exists($this->logFile)) {
			if(
				(
					!is_writable(dirname($this->logFile))
					|| !touch($this->logFile)
				)
				&& $fallbackPath !== ''
			) {
				$this->logFile = $fallbackPath;
			}
		}
		$this->config = $config;
	}

	/**
	 * write a message in the log
	 * @param string $app
	 * @param string|array $message
	 * @param int $level
	 */
	public function write(string $app, $message, int $level) {
		// default to ISO8601
		$format = $this->config->getValue('logdateformat', \DateTime::ATOM);
		$logTimeZone = $this->config->getValue('logtimezone', 'UTC');
		try {
			$timezone = new \DateTimeZone($logTimeZone);
		} catch (\Exception $e) {
			$timezone = new \DateTimeZone('UTC');
		}
		$time = \DateTime::createFromFormat("U.u", number_format(microtime(true), 4, ".", ""));
		if ($time === false) {
			$time = new \DateTime(null, $timezone);
		} else {
			// apply timezone if $time is created from UNIX timestamp
			$time->setTimezone($timezone);
		}
		$request = \OC::$server->getRequest();
		$reqId = $request->getId();
		$remoteAddr = $request->getRemoteAddress();
		// remove username/passwords from URLs before writing the to the log file
		$time = $time->format($format);
		$url = ($request->getRequestUri() !== '') ? $request->getRequestUri() : '--';
		$method = is_string($request->getMethod()) ? $request->getMethod() : '--';
		if($this->config->getValue('installed', false)) {
			$user = \OC_User::getUser() ? \OC_User::getUser() : '--';
		} else {
			$user = '--';
		}
		$userAgent = $request->getHeader('User-Agent');
		if ($userAgent === '') {
			$userAgent = '--';
		}
		$version = $this->config->getValue('version', '');
		$entry = compact(
			'reqId',
			'level',
			'time',
			'remoteAddr',
			'user',
			'app',
			'method',
			'url',
			'message',
			'userAgent',
			'version'
		);
		// PHP's json_encode only accept proper UTF-8 strings, loop over all
		// elements to ensure that they are properly UTF-8 compliant or convert
		// them manually.
		foreach($entry as $key => $value) {
			if(is_string($value)) {
				$testEncode = json_encode($value);
				if($testEncode === false) {
					$entry[$key] = utf8_encode($value);
				}
			}
		}
		$entry = json_encode($entry, JSON_PARTIAL_OUTPUT_ON_ERROR);
		$handle = @fopen($this->logFile, 'a');
		if ((fileperms($this->logFile) & 0777) != 0640) {
			@chmod($this->logFile, 0640);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		}
		if ($handle) {
			fwrite($handle, $entry."\n");
			fclose($handle);
		} else {
			// Fall back to error_log
			error_log($entry);
		}
		if (php_sapi_name() === 'cli-server') {
			error_log($message, 4);
		}
	}

	/**
	 * get entries from the log in reverse chronological order
	 * @param int $limit
	 * @param int $offset
	 * @return array
	 */
	public function getEntries(int $limit=50, int $offset=0):array {
		$minLevel = $this->config->getValue("loglevel", ILogger::WARN);
		$entries = array();
		$handle = @fopen($this->logFile, 'rb');
		if ($handle) {
			fseek($handle, 0, SEEK_END);
			$pos = ftell($handle);
			$line = '';
			$entriesCount = 0;
			$lines = 0;
			// Loop through each character of the file looking for new lines
			while ($pos >= 0 && ($limit === null ||$entriesCount < $limit)) {
				fseek($handle, $pos);
				$ch = fgetc($handle);
				if ($ch == "\n" || $pos == 0) {
					if ($line != '') {
						// Add the first character if at the start of the file,
						// because it doesn't hit the else in the loop
						if ($pos == 0) {
							$line = $ch.$line;
						}
						$entry = json_decode($line);
						// Add the line as an entry if it is passed the offset and is equal or above the log level
						if ($entry->level >= $minLevel) {
							$lines++;
							if ($lines > $offset) {
								$entries[] = $entry;
								$entriesCount++;
							}
						}
						$line = '';
					}
				} else {
					$line = $ch.$line;
				}
				$pos--;
			}
			fclose($handle);
		}
		return $entries;
	}

	/**
	 * @return string
	 */
	public function getLogFilePath():string {
		return $this->logFile;
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			*
5			* @author Andreas Fischer <[email protected]>
6			* @author Bart Visscher <[email protected]>
7			* @author duritong <[email protected]>
8			* @author Georg Ehrke <[email protected]>
9			* @author Joas Schilling <[email protected]>
10			* @author Juan Pablo Villafáñez <[email protected]>
11			* @author Lukas Reschke <[email protected]>
12			* @author Michael Gapczynski <[email protected]>
13			* @author Morris Jobke <[email protected]>
14			* @author Phiber2000 <[email protected]>
15			* @author Robin Appelman <[email protected]>
16			* @author Roeland Jago Douma <[email protected]>
17			* @author Roger Szabo <[email protected]>
18			* @author Thomas Müller <[email protected]>
19			* @author Thomas Pulzer <[email protected]>
20			* @author Vincent Petry <[email protected]>
21			*
22			* @license AGPL-3.0
23			*
24			* This code is free software: you can redistribute it and/or modify
25			* it under the terms of the GNU Affero General Public License, version 3,
26			* as published by the Free Software Foundation.
27			*
28			* This program is distributed in the hope that it will be useful,
29			* but WITHOUT ANY WARRANTY; without even the implied warranty of
30			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31			* GNU Affero General Public License for more details.
32			*
33			* You should have received a copy of the GNU Affero General Public License, version 3,
34			* along with this program. If not, see <http://www.gnu.org/licenses/>
35			*
36			*/
37
38			namespace OC\Log;
39			use OC\SystemConfig;
40			use OCP\Log\IFileBased;
41			use OCP\Log\IWriter;
42			use OCP\ILogger;
43
44			/**
45			* logging utilities
46			*
47			* Log is saved at data/nextcloud.log (on default)
48			*/
49
50			class File implements IWriter, IFileBased {
51			/** @var string */
52			protected $logFile;
53			/** @var SystemConfig */
54			private $config;
55
56			public function __construct(string $path, string $fallbackPath = '', SystemConfig $config) {
57			$this->logFile = $path;
58			if (!file_exists($this->logFile)) {
59			if(
60			(
61			!is_writable(dirname($this->logFile))
62			\|\| !touch($this->logFile)
63			)
64			&& $fallbackPath !== ''
65			) {
66			$this->logFile = $fallbackPath;
67			}
68			}
69			$this->config = $config;
70			}
71
72			/**
73			* write a message in the log
74			* @param string $app
75			* @param string\|array $message
76			* @param int $level
77			*/
78			public function write(string $app, $message, int $level) {
79			// default to ISO8601
80			$format = $this->config->getValue('logdateformat', \DateTime::ATOM);
81			$logTimeZone = $this->config->getValue('logtimezone', 'UTC');
82			try {
83			$timezone = new \DateTimeZone($logTimeZone);
84			} catch (\Exception $e) {
85			$timezone = new \DateTimeZone('UTC');
86			}
87			$time = \DateTime::createFromFormat("U.u", number_format(microtime(true), 4, ".", ""));
88			if ($time === false) {
89			$time = new \DateTime(null, $timezone);
90			} else {
91			// apply timezone if $time is created from UNIX timestamp
92			$time->setTimezone($timezone);
93			}
94			$request = \OC::$server->getRequest();
95			$reqId = $request->getId();
96			$remoteAddr = $request->getRemoteAddress();
97			// remove username/passwords from URLs before writing the to the log file
98			$time = $time->format($format);
99			$url = ($request->getRequestUri() !== '') ? $request->getRequestUri() : '--';
100			$method = is_string($request->getMethod()) ? $request->getMethod() : '--';
101			if($this->config->getValue('installed', false)) {
102			$user = \OC_User::getUser() ? \OC_User::getUser() : '--';
103			} else {
104			$user = '--';
105			}
106			$userAgent = $request->getHeader('User-Agent');
107			if ($userAgent === '') {
108			$userAgent = '--';
109			}
110			$version = $this->config->getValue('version', '');
111			$entry = compact(
112			'reqId',
113			'level',
114			'time',
115			'remoteAddr',
116			'user',
117			'app',
118			'method',
119			'url',
120			'message',
121			'userAgent',
122			'version'
123			);
124			// PHP's json_encode only accept proper UTF-8 strings, loop over all
125			// elements to ensure that they are properly UTF-8 compliant or convert
126			// them manually.
127			foreach($entry as $key => $value) {
128			if(is_string($value)) {
129			$testEncode = json_encode($value);
130			if($testEncode === false) {
131			$entry[$key] = utf8_encode($value);
132			}
133			}
134			}
135			$entry = json_encode($entry, JSON_PARTIAL_OUTPUT_ON_ERROR);
136			$handle = @fopen($this->logFile, 'a');
137			if ((fileperms($this->logFile) & 0777) != 0640) {
138			@chmod($this->logFile, 0640);
			0 ignored issues – show Security Best Practice introduced 2016-06-09 12:21 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...
139			}
140			if ($handle) {
141			fwrite($handle, $entry."\n");
142			fclose($handle);
143			} else {
144			// Fall back to error_log
145			error_log($entry);
146			}
147			if (php_sapi_name() === 'cli-server') {
148			error_log($message, 4);
149			}
150			}
151
152			/**
153			* get entries from the log in reverse chronological order
154			* @param int $limit
155			* @param int $offset
156			* @return array
157			*/
158			public function getEntries(int $limit=50, int $offset=0):array {
159			$minLevel = $this->config->getValue("loglevel", ILogger::WARN);
160			$entries = array();
161			$handle = @fopen($this->logFile, 'rb');
162			if ($handle) {
163			fseek($handle, 0, SEEK_END);
164			$pos = ftell($handle);
165			$line = '';
166			$entriesCount = 0;
167			$lines = 0;
168			// Loop through each character of the file looking for new lines
169			while ($pos >= 0 && ($limit === null \|\|$entriesCount < $limit)) {
170			fseek($handle, $pos);
171			$ch = fgetc($handle);
172			if ($ch == "\n" \|\| $pos == 0) {
173			if ($line != '') {
174			// Add the first character if at the start of the file,
175			// because it doesn't hit the else in the loop
176			if ($pos == 0) {
177			$line = $ch.$line;
178			}
179			$entry = json_decode($line);
180			// Add the line as an entry if it is passed the offset and is equal or above the log level
181			if ($entry->level >= $minLevel) {
182			$lines++;
183			if ($lines > $offset) {
184			$entries[] = $entry;
185			$entriesCount++;
186			}
187			}
188			$line = '';
189			}
190			} else {
191			$line = $ch.$line;
192			}
193			$pos--;
194			}
195			fclose($handle);
196			}
197			return $entries;
198			}
199
200			/**
201			* @return string
202			*/
203			public function getLogFilePath():string {
204			return $this->logFile;
205			}
206			}
207

nextcloud / server

Push — master ( a56ec1...2aa108 )

File::write() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like