codemasher / wildstar-database

src/Archive/AIDXReader.php

<?php
/**
 * Class AIDXReader
 *
 * @link         https://github.com/Narthorn/Halon/blob/master/halon.py
 *
 * @filesource   AIDXReader.php
 * @created      06.01.2019
 * @package      codemasher\WildstarDB\Archive
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2019 smiley
 * @license      MIT
 */

namespace codemasher\WildstarDB\Archive;

use codemasher\WildstarDB\WSDBException;

use function array_fill, array_merge, fread, fseek, ftell, strpos, substr, unpack;

/**
 * @property array $dirs
 */
final class AIDXReader extends PACKReaderAbstract{

	private const AIDX_ROOT = 'a4ArchiveType/LVersion/LBuildnumber/LIndex';
	private const AIDX_DATA = 'LNameOffset/LFlags/QFiletime/QSizeUncompressed/QSizeCompressed/a20Hash/x4';

	/** @var array */
	protected $dirs;

	/**
	 * @inheritDoc
	 */
	protected function readData():void{

		// get the root info block of the AIDX file (4+4+4+4 = 16 bytes)
		$rootInfo = unpack($this::AIDX_ROOT, fread($this->fh, 16));

		if($rootInfo['ArchiveType'] !== "\x58\x44\x49\x41"){ // XDIA
			throw new WSDBException('invalid AIDX');
		}

		$this->dirs = [];
		$this->data = $this->getBlock($this->blocktable[$rootInfo['Index']]);
	}

	/**
	 * @param array  $blockInfo
	 * @param string $parent
	 *
	 * @return array
	 */
	private function getBlock(array $blockInfo, string $parent = ''):array{

		// add the current path to the collection
		$this->dirs[] = $parent;

		// find the info block
		fseek($this->fh, $blockInfo['Offset']);

		// get the count of directories and files in that block (4+4 = 8 bytes)
		$n = unpack('Ldirs/Lfiles', fread($this->fh, 8));

		$dirs  = array_fill(0, $n['dirs'], null);
		$files = array_fill(0, $n['files'], null);

		// create a directory object for each dir (4+4 = 8 bytes)
		foreach($dirs as $i => $_){
			$dirs[$i] = new Directory(unpack('LNameOffset/LBlockIndex', fread($this->fh, 8)), $parent);

It seems like unpack('LNameOffset/LBlockIndex', fread($this->fh, 8)) can also be of type false; however, parameter $data of codemasher\WildstarDB\Archive\Directory::__construct() does only seem to accept array, maybe add an additional type check?

		}

		// create a file object for each file (4+4+8+8+8+20+4 = 56 bytes)
		foreach($files as $i => $_){
			$files[$i] = new File(unpack($this::AIDX_DATA, fread($this->fh, 56)), $parent);

It seems like unpack($this::AIDX_DATA, fread($this->fh, 56)) can also be of type false; however, parameter $data of codemasher\WildstarDB\Archive\File::__construct() does only seem to accept array, maybe add an additional type check?

		}

		// read the list of names from the remaining data
		$names = fread($this->fh, $blockInfo['Size'] - (ftell($this->fh) - $blockInfo['Offset']));

		$getname = function(ItemAbstract $e) use ($names){
			return '/'.substr($names, $e->NameOffset, strpos($names, "\x00", $e->NameOffset) - $e->NameOffset);
		};

		// apply the names to each object in the block
		foreach($dirs as $i => $e){
			$dirs[$i]->Name = $getname($e);
		}

		foreach($files as $i => $e){
			$files[$i]->Name = $getname($e);
		}

		// loop through the directory stucture recursively and add the block data
		foreach($dirs as $i => $info){
			if(isset($this->blocktable[$info->BlockIndex])){
				$dirs[$i]->Content = $this->getBlock($this->blocktable[$info->BlockIndex], $parent.$info->Name);
			}
		}

		return array_merge($dirs, $files);
	}

}