Icewind\SMB\Native\NativeReadStream

Complexity

Total Complexity

15

Size/Duplication

Total Lines	89
Duplicated Lines	13.48 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

90%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	stream_open()	0	3	1
A	wrap()	0	13	1
A	stream_read()	0	19	4
A	stream_seek()	12	12	3
A	stream_eof()	0	3	2
A	stream_tell()	0	3	1
A	stream_write()	0	3	1
A	stream_truncate()	0	3	1

<?php
/**
 * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
 * This file is licensed under the Licensed under the MIT license:
 * http://opensource.org/licenses/MIT
 */

namespace Icewind\SMB\Native;

use Icewind\SMB\StringBuffer;

/**
 * Stream optimized for read only usage
 */
class NativeReadStream extends NativeStream {
	const CHUNK_SIZE = 1048576; // 1MB chunks

	/** @var StringBuffer */
	private $readBuffer;

	public function __construct() {
		$this->readBuffer = new StringBuffer();
	}

	/** @var int */
	private $pos = 0;

	public function stream_open($path, $mode, $options, &$opened_path) {
		return parent::stream_open($path, $mode, $options, $opened_path);
	}

	/**
	 * Wrap a stream from libsmbclient-php into a regular php stream
	 *
	 * @param 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', NativeReadStream::class);
		$context = stream_context_create([
			'nativesmb' => [
				'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->readBuffer->remaining() < $count) {

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().

			$chunk = parent::stream_read(self::CHUNK_SIZE);
			if ($chunk === false) {
				return false;
			}
			$this->readBuffer->push($chunk);
		}

		$result = $this->readBuffer->read($count);

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

		return $result;
	}

	public function stream_seek($offset, $whence = SEEK_SET) {

This method seems to be duplicated in your project.

		$result = parent::stream_seek($offset, $whence);
		if ($result) {
			$this->readBuffer->clear();
			$pos = parent::stream_tell();

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().

			if ($pos === false) {
				return false;
			}
			$this->pos = $pos;
		}
		return $result;
	}

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

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

	public function stream_write($data) {
		return false;
	}

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