nextcloud / server

apps/dav/lib/Upload/AssemblyStream.php

Doc Comments +5 added lines, -2 removed lines

@@ -146,7 +146,7 @@ 
 
 	/**
 	 * @param string $data
-	 * @return int
+	 * @return boolean
 	 */
 	public function stream_write($data) {
 		return false;
@@ -252,7 +252,7 @@ 
 	}
 
 	/**
-	 * @param $pos
+	 * @param integer $pos
 	 * @return IFile | null
 	 */
 	private function getNodeForPosition($pos) {
@@ -280,6 +280,9 @@ 
 		}
 	}
 
+	/**
+	 * @param resource $handle
+	 */
 	private function seekStream($handle, $position) {
 		if (stream_get_meta_data($handle)['seekable']) {
 			fseek($this->currentStream, $position);

Indentation +255 added lines, -255 removed lines

@@ -36,260 +36,260 @@
  */
 class AssemblyStream implements \Icewind\Streams\File {
 
-	/** @var resource */
-	private $context;
-
-	/** @var IFile[] */
-	private $nodes;
-
-	/** @var int */
-	private $pos = 0;
-
-	/** @var array */
-	private $sortedNodes;
-
-	/** @var int */
-	private $size;
-
-	/** @var resource */
-	private $currentStream = null;
-
-	/**
-	 * @param string $path
-	 * @param string $mode
-	 * @param int $options
-	 * @param string &$opened_path
-	 * @return bool
-	 */
-	public function stream_open($path, $mode, $options, &$opened_path) {
-		$this->loadContext('assembly');
-
-		// sort the nodes
-		$nodes = $this->nodes;
-		// http://stackoverflow.com/a/10985500
-		@usort($nodes, function (IFile $a, IFile $b) {
-			return strnatcmp($a->getName(), $b->getName());
-		});
-		$this->nodes = $nodes;
-
-		// build additional information
-		$this->sortedNodes = [];
-		$start = 0;
-		foreach ($this->nodes as $node) {
-			$size = $node->getSize();
-			$name = $node->getName();
-			$this->sortedNodes[$name] = ['node' => $node, 'start' => $start, 'end' => $start + $size];
-			$start += $size;
-			$this->size = $start;
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $offset
-	 * @param int $whence
-	 * @return bool
-	 */
-	public function stream_seek($offset, $whence = SEEK_SET) {
-		return false;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function stream_tell() {
-		return $this->pos;
-	}
-
-	/**
-	 * @param int $count
-	 * @return string
-	 */
-	public function stream_read($count) {
-		do {
-			if ($this->currentStream === null) {
-				list($node, $posInNode) = $this->getNodeForPosition($this->pos);
-				if (is_null($node)) {
-					// reached last node, no more data
-					return '';
-				}
-				$this->currentStream = $this->getStream($node);
-				if ($posInNode > 0) {
-					$this->seekStream($this->currentStream, $posInNode);
-				}
-			}
-
-			$data = fread($this->currentStream, $count);
-			// isset is faster than strlen
-			if (isset($data[$count - 1])) {
-				// we read the full count
-				$read = $count;
-			} else {
-				// reaching end of stream, which happens less often so strlen is ok
-				$read = strlen($data);
-			}
-
-			if (feof($this->currentStream)) {
-				fclose($this->currentStream);
-				$this->currentNode = null;
-				$this->currentStream = null;
-			}
-			// if no data read, try again with the next node because
-			// returning empty data can make the caller think there is no more
-			// data left to read
-		} while ($read === 0);
-
-		// update position
-		$this->pos += $read;
-		return $data;
-	}
-
-	/**
-	 * @param string $data
-	 * @return int
-	 */
-	public function stream_write($data) {
-		return false;
-	}
-
-	/**
-	 * @param int $option
-	 * @param int $arg1
-	 * @param int $arg2
-	 * @return bool
-	 */
-	public function stream_set_option($option, $arg1, $arg2) {
-		return false;
-	}
-
-	/**
-	 * @param int $size
-	 * @return bool
-	 */
-	public function stream_truncate($size) {
-		return false;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function stream_stat() {
-		return [];
-	}
-
-	/**
-	 * @param int $operation
-	 * @return bool
-	 */
-	public function stream_lock($operation) {
-		return false;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function stream_flush() {
-		return false;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function stream_eof() {
-		return $this->pos >= $this->size;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function stream_close() {
-		return true;
-	}
-
-
-	/**
-	 * Load the source from the stream context and return the context options
-	 *
-	 * @param string $name
-	 * @return array
-	 * @throws \Exception
-	 */
-	protected function loadContext($name) {
-		$context = stream_context_get_options($this->context);
-		if (isset($context[$name])) {
-			$context = $context[$name];
-		} else {
-			throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
-		}
-		if (isset($context['nodes']) and is_array($context['nodes'])) {
-			$this->nodes = $context['nodes'];
-		} else {
-			throw new \BadMethodCallException('Invalid context, nodes not set');
-		}
-		return $context;
-	}
-
-	/**
-	 * @param IFile[] $nodes
-	 * @return resource
-	 *
-	 * @throws \BadMethodCallException
-	 */
-	public static function wrap(array $nodes) {
-		$context = stream_context_create([
-			'assembly' => [
-				'nodes' => $nodes]
-		]);
-		stream_wrapper_register('assembly', '\OCA\DAV\Upload\AssemblyStream');
-		try {
-			$wrapped = fopen('assembly://', 'r', null, $context);
-		} catch (\BadMethodCallException $e) {
-			stream_wrapper_unregister('assembly');
-			throw $e;
-		}
-		stream_wrapper_unregister('assembly');
-		return $wrapped;
-	}
-
-	/**
-	 * @param $pos
-	 * @return IFile | null
-	 */
-	private function getNodeForPosition($pos) {
-		foreach ($this->sortedNodes as $node) {
-			if ($pos >= $node['start'] && $pos < $node['end']) {
-				return [$node['node'], $pos - $node['start']];
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * @param IFile $node
-	 * @return resource
-	 */
-	private function getStream(IFile $node) {
-		$data = $node->get();
-		if (is_resource($data)) {
-			return $data;
-		} else {
-			$tmp = fopen('php://temp', 'w+');
-			fwrite($tmp, $data);
-			rewind($tmp);
-			return $tmp;
-		}
-	}
-
-	private function seekStream($handle, $position) {
-		if (stream_get_meta_data($handle)['seekable']) {
-			fseek($this->currentStream, $position);
-		} else {
-			$offset = $position - $this->stream_tell($handle);
-			if ($offset < 0) {
-				throw new \InvalidArgumentException('Can\'t rewind stream');
-			}
-			fread($handle, $offset);
-		}
-	}
+    /** @var resource */
+    private $context;
+
+    /** @var IFile[] */
+    private $nodes;
+
+    /** @var int */
+    private $pos = 0;
+
+    /** @var array */
+    private $sortedNodes;
+
+    /** @var int */
+    private $size;
+
+    /** @var resource */
+    private $currentStream = null;
+
+    /**
+     * @param string $path
+     * @param string $mode
+     * @param int $options
+     * @param string &$opened_path
+     * @return bool
+     */
+    public function stream_open($path, $mode, $options, &$opened_path) {
+        $this->loadContext('assembly');
+
+        // sort the nodes
+        $nodes = $this->nodes;
+        // http://stackoverflow.com/a/10985500
+        @usort($nodes, function (IFile $a, IFile $b) {
+            return strnatcmp($a->getName(), $b->getName());
+        });
+        $this->nodes = $nodes;
+
+        // build additional information
+        $this->sortedNodes = [];
+        $start = 0;
+        foreach ($this->nodes as $node) {
+            $size = $node->getSize();
+            $name = $node->getName();
+            $this->sortedNodes[$name] = ['node' => $node, 'start' => $start, 'end' => $start + $size];
+            $start += $size;
+            $this->size = $start;
+        }
+        return true;
+    }
+
+    /**
+     * @param string $offset
+     * @param int $whence
+     * @return bool
+     */
+    public function stream_seek($offset, $whence = SEEK_SET) {
+        return false;
+    }
+
+    /**
+     * @return int
+     */
+    public function stream_tell() {
+        return $this->pos;
+    }
+
+    /**
+     * @param int $count
+     * @return string
+     */
+    public function stream_read($count) {
+        do {
+            if ($this->currentStream === null) {
+                list($node, $posInNode) = $this->getNodeForPosition($this->pos);
+                if (is_null($node)) {
+                    // reached last node, no more data
+                    return '';
+                }
+                $this->currentStream = $this->getStream($node);
+                if ($posInNode > 0) {
+                    $this->seekStream($this->currentStream, $posInNode);
+                }
+            }
+
+            $data = fread($this->currentStream, $count);
+            // isset is faster than strlen
+            if (isset($data[$count - 1])) {
+                // we read the full count
+                $read = $count;
+            } else {
+                // reaching end of stream, which happens less often so strlen is ok
+                $read = strlen($data);
+            }
+
+            if (feof($this->currentStream)) {
+                fclose($this->currentStream);
+                $this->currentNode = null;
+                $this->currentStream = null;
+            }
+            // if no data read, try again with the next node because
+            // returning empty data can make the caller think there is no more
+            // data left to read
+        } while ($read === 0);
+
+        // update position
+        $this->pos += $read;
+        return $data;
+    }
+
+    /**
+     * @param string $data
+     * @return int
+     */
+    public function stream_write($data) {
+        return false;
+    }
+
+    /**
+     * @param int $option
+     * @param int $arg1
+     * @param int $arg2
+     * @return bool
+     */
+    public function stream_set_option($option, $arg1, $arg2) {
+        return false;
+    }
+
+    /**
+     * @param int $size
+     * @return bool
+     */
+    public function stream_truncate($size) {
+        return false;
+    }
+
+    /**
+     * @return array
+     */
+    public function stream_stat() {
+        return [];
+    }
+
+    /**
+     * @param int $operation
+     * @return bool
+     */
+    public function stream_lock($operation) {
+        return false;
+    }
+
+    /**
+     * @return bool
+     */
+    public function stream_flush() {
+        return false;
+    }
+
+    /**
+     * @return bool
+     */
+    public function stream_eof() {
+        return $this->pos >= $this->size;
+    }
+
+    /**
+     * @return bool
+     */
+    public function stream_close() {
+        return true;
+    }
+
+
+    /**
+     * Load the source from the stream context and return the context options
+     *
+     * @param string $name
+     * @return array
+     * @throws \Exception
+     */
+    protected function loadContext($name) {
+        $context = stream_context_get_options($this->context);
+        if (isset($context[$name])) {
+            $context = $context[$name];
+        } else {
+            throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
+        }
+        if (isset($context['nodes']) and is_array($context['nodes'])) {
+            $this->nodes = $context['nodes'];
+        } else {
+            throw new \BadMethodCallException('Invalid context, nodes not set');
+        }
+        return $context;
+    }
+
+    /**
+     * @param IFile[] $nodes
+     * @return resource
+     *
+     * @throws \BadMethodCallException
+     */
+    public static function wrap(array $nodes) {
+        $context = stream_context_create([
+            'assembly' => [
+                'nodes' => $nodes]
+        ]);
+        stream_wrapper_register('assembly', '\OCA\DAV\Upload\AssemblyStream');
+        try {
+            $wrapped = fopen('assembly://', 'r', null, $context);
+        } catch (\BadMethodCallException $e) {
+            stream_wrapper_unregister('assembly');
+            throw $e;
+        }
+        stream_wrapper_unregister('assembly');
+        return $wrapped;
+    }
+
+    /**
+     * @param $pos
+     * @return IFile | null
+     */
+    private function getNodeForPosition($pos) {
+        foreach ($this->sortedNodes as $node) {
+            if ($pos >= $node['start'] && $pos < $node['end']) {
+                return [$node['node'], $pos - $node['start']];
+            }
+        }
+        return null;
+    }
+
+    /**
+     * @param IFile $node
+     * @return resource
+     */
+    private function getStream(IFile $node) {
+        $data = $node->get();
+        if (is_resource($data)) {
+            return $data;
+        } else {
+            $tmp = fopen('php://temp', 'w+');
+            fwrite($tmp, $data);
+            rewind($tmp);
+            return $tmp;
+        }
+    }
+
+    private function seekStream($handle, $position) {
+        if (stream_get_meta_data($handle)['seekable']) {
+            fseek($this->currentStream, $position);
+        } else {
+            $offset = $position - $this->stream_tell($handle);
+            if ($offset < 0) {
+                throw new \InvalidArgumentException('Can\'t rewind stream');
+            }
+            fread($handle, $offset);
+        }
+    }
 
 }

Spacing +2 added lines, -2 removed lines

@@ -67,7 +67,7 @@ 
 		// sort the nodes
 		$nodes = $this->nodes;
 		// http://stackoverflow.com/a/10985500
-		@usort($nodes, function (IFile $a, IFile $b) {
+		@usort($nodes, function(IFile $a, IFile $b) {
 			return strnatcmp($a->getName(), $b->getName());
 		});
 		$this->nodes = $nodes;
@@ -219,7 +219,7 @@ 
 		if (isset($context[$name])) {
 			$context = $context[$name];
 		} else {
-			throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
+			throw new \BadMethodCallException('Invalid context, "'.$name.'" options not set');
 		}
 		if (isset($context['nodes']) and is_array($context['nodes'])) {
 			$this->nodes = $context['nodes'];