NativeReadStream - Code Metrics - Inspection of "Optimize reading of large files when using php-smb..." - icewind1991/SMB - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0861d2...a71dc8 )

by Robin

created 2017-08-16 14:48 UTC

NativeReadStream A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

90.7%

Importance

Changes

Metric	Value
wmc	12
lcom	1
cbo	1
dl	0
loc	89
ccs	39
cts	43
cp	0.907
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	stream_open()	6	1
A	wrap()	13	1
A	stream_read()	21	3
A	stream_seek()	9	2
A	stream_eof()	3	2
A	stream_tell()	3	1
A	stream_write()	3	1
A	stream_truncate()	3	1

<?php
/**
 * Copyright (c) 2014 Robin Appelman <[email protected]>
 * This file is licensed under the Licensed under the MIT license:
 * http://opensource.org/licenses/MIT
 */

namespace Icewind\SMB;

/**
 * Stream optimized for read only usage
 */
class NativeReadStream extends NativeStream {
	const CHUNK_SIZE = 1048576; // 1MB chunks
	/**
	 * @var resource
	 */
	private $readBuffer = null;

	private $bufferSize = 0;

	private $pos = 0;

	public function stream_open($path, $mode, $options, &$opened_path) {
		$this->readBuffer = fopen('php://memory', 'r+');

		return parent::stream_open($path, $mode, $options, $opened_path);

	}

	/**
	 * Wrap a stream from libsmbclient-php into a regular php stream
	 *
	 * @param \Icewind\SMB\NativeState $state
	 * @param resource $smbStream
	 * @param string $mode
	 * @param string $url
	 * @return resource
	 */
	public static function wrap($state, $smbStream, $mode, $url) {
		stream_wrapper_register('nativesmb', '\Icewind\SMB\NativeReadStream');
		$context = stream_context_create(array(
			'nativesmb' => array(
				'state'  => $state,
				'handle' => $smbStream,
				'url'    => $url
			)
		));
		$fh = fopen('nativesmb://', $mode, false, $context);
		stream_wrapper_unregister('nativesmb');
		return $fh;
	}

	public function stream_read($count) {
		// php reads 8192 bytes at once
		// however due to network latency etc, it's faster to read in larger chunks
		// and buffer the result
		if (!parent::stream_eof() && $this->bufferSize < $count) {
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
			$remaining = $this->readBuffer;
			$this->readBuffer = fopen('php://memory', 'r+');
			$this->bufferSize = 0;
			stream_copy_to_stream($remaining, $this->readBuffer);
			$this->bufferSize += fwrite($this->readBuffer, parent::stream_read(self::CHUNK_SIZE));
			fseek($this->readBuffer, 0);
		}

		$result = fread($this->readBuffer, $count);
		$this->bufferSize -= $count;

		$read = strlen($result);
		$this->pos += $read;

		return $result;
	}

	public function stream_seek($offset, $whence = SEEK_SET) {
		$result = parent::stream_seek($offset, $whence);
		if ($result) {
			$this->readBuffer = fopen('php://memory', 'r+');
			$this->bufferSize = 0;
			$this->pos = parent::stream_tell();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		}
		return $result;
	}

	public function stream_eof() {
		return $this->bufferSize <= 0 && parent::stream_eof();
	}

	public function stream_tell() {
		return $this->pos;
	}

	public function stream_write($data) {
		return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	public function stream_truncate($size) {
		return false;
	}
}


1		<?php
2		/**
3		* Copyright (c) 2014 Robin Appelman <[email protected]>
4		* This file is licensed under the Licensed under the MIT license:
5		* http://opensource.org/licenses/MIT
6		*/
7
8		namespace Icewind\SMB;
9
10		/**
11		* Stream optimized for read only usage
12		*/
13		class NativeReadStream extends NativeStream {
14		const CHUNK_SIZE = 1048576; // 1MB chunks
15		/**
16		* @var resource
17		*/
18		private $readBuffer = null;
19
20		private $bufferSize = 0;
21
22		private $pos = 0;
23
24	40	public function stream_open($path, $mode, $options, &$opened_path) {
25	40	$this->readBuffer = fopen('php://memory', 'r+');
26
27	40	return parent::stream_open($path, $mode, $options, $opened_path);
28
29		}
30
31		/**
32		* Wrap a stream from libsmbclient-php into a regular php stream
33		*
34		* @param \Icewind\SMB\NativeState $state
35		* @param resource $smbStream
36		* @param string $mode
37		* @param string $url
38		* @return resource
39		*/
40	40	public static function wrap($state, $smbStream, $mode, $url) {
41	40	stream_wrapper_register('nativesmb', '\Icewind\SMB\NativeReadStream');
42	40	$context = stream_context_create(array(
43		'nativesmb' => array(
44	40	'state' => $state,
45	40	'handle' => $smbStream,
46		'url' => $url
47	40	)
48	40	));
49	40	$fh = fopen('nativesmb://', $mode, false, $context);
50	40	stream_wrapper_unregister('nativesmb');
51	40	return $fh;
52		}
53
54	38	public function stream_read($count) {
55		// php reads 8192 bytes at once
56		// however due to network latency etc, it's faster to read in larger chunks
57		// and buffer the result
58	38	if (!parent::stream_eof() && $this->bufferSize < $count) {
		0 ignored issues – show Comprehensibility Bug introduced 2017-08-16 14:47 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`stream_eof()` instead of `stream_read()`). Are you sure this is correct? If so, you might want to change this to `$this->stream_eof()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
59	38	$remaining = $this->readBuffer;
60	38	$this->readBuffer = fopen('php://memory', 'r+');
61	38	$this->bufferSize = 0;
62	38	stream_copy_to_stream($remaining, $this->readBuffer);
63	38	$this->bufferSize += fwrite($this->readBuffer, parent::stream_read(self::CHUNK_SIZE));
64	38	fseek($this->readBuffer, 0);
65	38	}
66
67	38	$result = fread($this->readBuffer, $count);
68	38	$this->bufferSize -= $count;
69
70	38	$read = strlen($result);
71	38	$this->pos += $read;
72
73	38	return $result;
74		}
75
76	2	public function stream_seek($offset, $whence = SEEK_SET) {
77	2	$result = parent::stream_seek($offset, $whence);
78	2	if ($result) {
79	2	$this->readBuffer = fopen('php://memory', 'r+');
80	2	$this->bufferSize = 0;
81	2	$this->pos = parent::stream_tell();
		0 ignored issues – show Documentation Bug introduced 2017-08-16 14:47 UTC by Report Bug Copy Issue Report It seems like `parent::stream_tell()` can also be of type `boolean`. However, the property `$pos` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history... Comprehensibility Bug introduced 2017-08-16 14:47 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`stream_tell()` instead of `stream_seek()`). Are you sure this is correct? If so, you might want to change this to `$this->stream_tell()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
82	2	}
83	2	return $result;
84		}
85
86	38	public function stream_eof() {
87	38	return $this->bufferSize <= 0 && parent::stream_eof();
88		}
89
90	2	public function stream_tell() {
91	2	return $this->pos;
92		}
93
94		public function stream_write($data) {
95		return false;
		0 ignored issues – show Bug Best Practice introduced 2017-08-16 14:47 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Icewind\Streams\File::stream_write` of type `integer`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
96		}
97
98		public function stream_truncate($size) {
99		return false;
100		}
101		}
102

icewind1991 / SMB

Push — master ( 0861d2...a71dc8 )

NativeReadStream A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Duplication Side-by-Side

Filter issues like