Merge pull request #3 from WebReborn/patch-1

Update README.md

LICENSE.md

@@ -0,0 +1,25 @@
+# BSD 2-Clause License
+
+Copyright (c) 2020, Rogiel Sulzbach
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -13,6 +13,7 @@ The recommended way of installing this library is using Composer.
     use Rogiel\MPQ\MPQFile;
     
     $file = MPQFile::parseFile(__DIR__.'/test.SC2Replay');
+    $file->parse();
     $stream = $file->openStream('replay.details');
     while($data = $stream->readBytes(100)) {
     	echo $data;

src/Compression/DeflateCompression.php

@@ -49,7 +49,7 @@ class DeflateCompression implements Compression {
 	 */
 	public function decompress($data, $length) {
 		$output = @gzinflate(substr($data, 0, $length), $length);
-		if(!is_string($output)) {
+		if($output === false) {
 			throw new InvalidInputDataException('The decompression input data is invalid.', $output);
 		}
 		return $output;

src/Hashing/BaseHashing.php

@@ -42,19 +42,18 @@ abstract class BaseHashing implements Hashing {
 
 	public function hash($string) {
 		$seed1 = 0x7FED7FED;
-		$seed2 = ((0xEEEE << 16) | 0xEEEE);
+		$seed2 = 0xEEEEEEEE;
 		$strLen = strlen($string);
 
 		for ($i = 0;$i < $strLen;$i++) {
 			$next = ord(strtoupper(substr($string, $i, 1)));
 
-			$seed1 = CryptoUtils::$cryptTable[($this->hashType << 8) + $next] ^ (CryptoUtils::uPlus($seed1,$seed2));
-			$seed2 = CryptoUtils::uPlus(CryptoUtils::uPlus(CryptoUtils::uPlus(CryptoUtils::uPlus($next,$seed1),$seed2),$seed2 << 5),3);
+			$seed1 = CryptoUtils::$cryptTable[($this->hashType << 8) + $next] ^ (CryptoUtils::uPlus($seed1,$seed2)) & 0xFFFFFFFF;
+			$seed2 = CryptoUtils::uPlus(CryptoUtils::uPlus(CryptoUtils::uPlus(CryptoUtils::uPlus($next,$seed1),$seed2),$seed2 << 5),3) & 0xFFFFFFFF;
 		}
 		return $seed1;
 	}
 
-
 // function that adds up two integers without allowing them to overflow to floats
 	private function uPlus($o1, $o2) {
 		$o1h = ($o1 >> 16) & 0xFFFF;

src/MPQFile.php

@@ -52,6 +52,11 @@ class MPQFile {
 	 */
 	private $stream;
 
+	/**
+	 * @var boolean
+	 */
+	private $parsed;
+
 	/**
 	 * @var UserData
 	 */
@@ -74,36 +79,50 @@ class MPQFile {
 
 	public function __construct(Stream $stream) {
 		$this->stream = $stream;
-		$this->parse();
 	}
 
+    function __destruct() {
+        $this->stream->close();
+    }
+
 	// -----------------------------------------------------------------------------------------------------------------
 
-	private function parse() {
+	public function isParsed() {
+		return $this->parsed;
+	}
+
+	public function parse() {
+		if($this->isParsed()) {
+			return;
+		}
+
 		$parser = new BinaryStreamParser($this->stream);
 
 		$signature = $this->parseSignature($parser);
 		if($signature == "MPQ27") {
 			$this->userData = UserData::parse($parser);
-			$this->stream->seek($this->userData->getHeaderOffset());
+			$this->stream->seek($this->getUserDataOffset());
+
+            $signature = $this->parseSignature($parser);
 		}
 
-		$signature = $this->parseSignature($parser);
 		if($signature == "MPQ26") {
 			$this->header = Header::parse($parser);
 		}
 
 		$this->hashTable = $this->parseHashTable();
 		$this->blockTable = $this->parseBlockTable();
+
+		$this->parsed = true;
 	}
 
 	private function parseHashTable() {
 		$hashing = new FileKeyHashing();
 		$encryptedStream = new EncryptedStream($this->stream, new DefaultEncryption($hashing->hash('(hash table)')));
 		$parser = new BinaryStreamParser($encryptedStream);
-		$parser->seek($this->userData->getHeaderOffset() + $this->header->getHashTablePos());
+		$parser->seek($this->getUserDataOffset() + $this->getHeader()->getHashTablePos());
 		$hashes = array();
-		for($i = 0; $i<$this->header->getHashTableSize(); $i++) {
+		for($i = 0; $i<$this->getHeader()->getHashTableSize(); $i++) {
 			$hashes[$i] = Hash::parse($parser);
 		}
 		return new HashTable($hashes);
@@ -113,11 +132,17 @@ class MPQFile {
 		$hashing = new FileKeyHashing();
 		$encryptedStream = new EncryptedStream($this->stream, new DefaultEncryption($hashing->hash('(block table)')));
 		$parser = new BinaryStreamParser($encryptedStream);
-		$parser->seek($this->userData->getHeaderOffset() + $this->header->getBlockTablePos());
+		$parser->seek($this->getUserDataOffset() + $this->getHeader()->getBlockTablePos());
 		$blocks = array();
-		for($i = 0; $i<$this->header->getBlockTableSize(); $i++) {
-			$blocks[$i] = Block::parse($parser);
+
+//		$offsetFix = 0;
+		for($i = 0; $i<$this->getHeader()->getBlockTableSize(); $i++) {
+			$block = $blocks[$i] = Block::parse($parser);
+//			if($block->getSize() == 0) {
+//				$offsetFix++;
+//			}
 		}
+
 		return new BlockTable($blocks);
 	}
 
@@ -132,6 +157,16 @@ class MPQFile {
 
 	// -----------------------------------------------------------------------------------------------------------------
 
+	public function getUserDataOffset() {
+		$userData = $this->getUserData();
+		if($userData === null) {
+			return 0;
+		}
+		return $userData->getHeaderOffset();
+	}
+
+	// -----------------------------------------------------------------------------------------------------------------
+
 	/**
 	 * @param $fileName
 	 * @return null|Hash
@@ -143,7 +178,7 @@ class MPQFile {
 		$hashA = $hashingA->hash($fileName);
 		$hashB = $hashingB->hash($fileName);
 
-		return $this->hashTable->findHashByHash($hashA, $hashB);
+		return $this->getHashTable()->findHashByHash($hashA, $hashB);
 	}
 
 	/**
@@ -155,6 +190,7 @@ class MPQFile {
 		if($hash == NULL) {
 			return NULL;
 		}
+
 		return $this->getBlockTable()->getBlock($hash->getBlockIndex());
 	}
 
@@ -165,15 +201,15 @@ class MPQFile {
 		}
 
 		$stream = clone $this->stream;
-		$stream->seek($this->userData->getHeaderOffset() + $block->getFilePos());
+		$stream->seek($this->getUserDataOffset() + $block->getFilePos());
 		$parser = new BinaryStreamParser($stream);
 
 		$sectors = array();
 		if($block->isChecksumed() || !$block->isSingleUnit()) {
-			$blockSize = $block->getCompressedSize();
+			$blockSize = 512 * (1 << $this->getHeader()->getBlockSize());
 			$fileSize  = $block->getSize();
 
-			for ($i = $fileSize;$i > 0;$i -= $this->header->getBlockSize()) {
+			for ($i = $fileSize; $i > 0; $i -= $blockSize) {
 				$sectors[] = $parser->readUInt32();
 				$blockSize -= 4;
 			}

src/Stream/Block/BlockStream.php

@@ -30,9 +30,12 @@ namespace Rogiel\MPQ\Stream\Block;
 
 
 use Rogiel\MPQ\Compression\BZIPCompression;
+use Rogiel\MPQ\Compression\DeflateCompression;
+use Rogiel\MPQ\Exception\Compression\CompressionException;
 use Rogiel\MPQ\Metadata\Block;
 use Rogiel\MPQ\MPQFile;
 use Rogiel\MPQ\Stream\CompressedStream;
+use Rogiel\MPQ\Stream\MemoryStream;
 use Rogiel\MPQ\Stream\Parser\BinaryStreamParser;
 use Rogiel\MPQ\Stream\Stream;
 
@@ -93,6 +96,7 @@ class BlockStream implements Stream {
 		$this->position = 0;
 		$this->buffer = NULL;
 		$this->currentSector = $this->sectors[0];
+		$this->positionInSector = 0;
 	}
 
 	// -----------------------------------------------------------------------------------------------------------------
@@ -106,16 +110,21 @@ class BlockStream implements Stream {
 	}
 
 	public function readBytes($bytes) {
-		if($this->eof()) {
+	    if($this->eof()) {
 			return false;
 		}
 		if(($this->position + $bytes) > $this->block->getSize()) {
 			$bytes = $this->block->getSize() - $this->position;
 		}
 
-		if($this->buffer == NULL) {
+		if($this->buffer === NULL) {
 			$this->buffer = $this->readSector($this->currentSector);
-		} else if($this->positionInSector >= strlen($this->buffer)) {
+			$this->positionInSector = 0;
+        } else if($this->positionInSector >= strlen($this->buffer)) {
+            if(!isset($this->sectors[$this->currentSector->getIndex() + 1])) {
+		        return false;
+            }
+
 			$this->currentSector = $this->sectors[$this->currentSector->getIndex() + 1];
 			$this->buffer = $this->readSector($this->currentSector);
 			$this->positionInSector = 0;
@@ -153,37 +162,34 @@ class BlockStream implements Stream {
 	// -----------------------------------------------------------------------------------------------------------------
 
 	private function readSector(Sector $sector) {
-		$this->stream->seek($this->file->getUserData()->getHeaderOffset()
+		$this->stream->seek($this->file->getUserDataOffset()
 			+ $this->block->getFilePos()
 			+ $sector->getStart());
 
-		$compressedStream = $this->createCompressedStream();
-		return $compressedStream->readBytes($sector->getLength());
+		$compressedStream = $this->createCompressedStream($sector);
+		return $compressedStream->readBytes($this->block->getSize());
 	}
 
-	private function createCompressedStream() {
+	private function createCompressedStream(Sector $sector) {
 		$stream = $this->stream;
-		if($this->block->isCompressed()) {
+
+        if($this->block->isCompressed() && $this->block->getSize() > $this->block->getCompressedSize()) {
 			$parser = new BinaryStreamParser($this->stream);
 			$compressionType = $parser->readByte();
 			switch ($compressionType) {
-				case 0x10:
-					return new CompressedStream($stream, new BZIPCompression());
-					break;
+				case 0x00: return $stream;
+                case 0x02: {
+                    $len = $parser->readUInt16();
+                    $blockData = $stream->readBytes($len);
+                    return new MemoryStream(gzinflate($blockData));
+                }
+//				case 0x02: return new CompressedStream($stream, new DeflateCompression());
+				case 0x10: return new CompressedStream($stream, new BZIPCompression());
+				default:
+					throw new CompressionException(sprintf('Invalid compression format: %s', $compressionType));
 			}
 		}
 		return $stream;
 	}
 
-	private function computeSectors($start, $length) {
-		$sectors = array();
-		foreach($this->sectors as $sector) {
-			/** @var $sector Sector */
-			if($sector->contains($start, $length)) {
-				$sectors[] = $sector;
-			}
-		}
-		return $sectors;
-	}
-
 }

src/Stream/FileStream.php

@@ -40,14 +40,22 @@ class FileStream implements Stream {
 		$this->handle = fopen($file, 'r');
 	}
 
+    public function __clone() {
+        $this->handle = fopen($this->file, 'r');
+    }
+
+    function __destruct() {
+        $this->close();
+    }
+
 	// -----------------------------------------------------------------------------------------------------------------
 
 	/**
 	 * {@inheritdoc}
 	 */
 	public function close() {
-		fclose($this->handle);
-	}
+		@fclose($this->handle);
+    }
 
 	/**
 	 * {@inheritdoc}
@@ -84,10 +92,4 @@ class FileStream implements Stream {
 		return feof($this->handle);
 	}
 
-	// -----------------------------------------------------------------------------------------------------------------
-
-	public function __clone() {
-		return new FileStream($this->file);
-	}
-
 }

src/Stream/Parser/BinaryStreamParser.php

@@ -69,6 +69,17 @@ class BinaryStreamParser {
 		return $this->stream->readBytes($size);
 	}
 
+	public function readCString($debug=false) {
+	    $str = '';
+	    while(true) {
+	        $c = $this->stream->readBytes(1);
+            if($c == "\0") {
+                return $str;
+            }
+            $str .= (string) $c;
+        }
+    }
+
 	public function eof() {
 		return $this->stream->eof();
 	}