agents/PRAY/GLSTBlock.php

Go to the documentation of this file.

<?php

require_once(dirname(__FILE__).'/../../support/StringReader.php');
require_once(dirname(__FILE__).'/../../support/Archiver.php');
require_once(dirname(__FILE__).'/CreaturesArchiveBlock.php');
require_once(dirname(__FILE__).'/../CreatureHistory/CreatureHistory.php');


define('GLST_FORMAT_UNKNOWN',0);
define('GLST_FORMAT_C3',1);
define('GLST_FORMAT_DS',2);

class GLSTBlock extends CreaturesArchiveBlock {

    
    private $history;
    private $format = GLST_FORMAT_UNKNOWN;



    public function GLSTBlock($object,$name,$content,$flags) {
        parent::CreaturesArchiveBlock($object,$name,$content,$flags,PRAY_BLOCK_GLST);
        if($object instanceof PRAYFile) {
            //Do nothing! Decoding is automated later now :)
        } else if($object instanceof CreatureHistory) {
            $this->history = $object;
        } else {
            throw new Exception('Couldn\'t create a GLST block. :(');
        }
    }

    private function GuessFormat() {
        //if I don't know
        if($this->format == GLST_FORMAT_UNKNOWN) {
            //ask $prayfile if it exists. (look for DSEX, otherwise C3)
            if($this->prayfile != null) {
                //prayfile should know
                if(sizeof($this->prayfile->GetBlocks(PRAY_BLOCK_DSEX)) > 0) {
                    $format = GLST_FORMAT_DS;
                } else {
                    $format = GLST_FORMAT_C3;
                }
            } else {
                //history will know. (Though it could be wrong)
                $format = $this->history->GuessFormat();
            }
            //cache so I don't need to ask again :)
            $this->format = $format;
        }
        return $this->format;
    }


    public function GetHistory() {
        $this->EnsureDecompiled();
        return $this->history;
    }


    public function GetPHOTBlockName(CreatureHistoryEvent $event) {
        $photoname = $event->GetPhotoGraph();
        if(empty($photoname)) {
            return null;
        }
        if($this->format == GLST_FORMAT_DS) {
            return $photoname.'.DSEX.photo';
        } else {
            return $photoname.'.photo';
        }
    }


    public function GetPhotoBlock(CreatureHistoryEvent $event) {
        if($this->GetPrayFile() instanceof PRAYFile) {
            return $block = $this->GetPrayFile()->GetBlockByName($this->GetPHOTBlockName());
        } else {
            throw new Exception("This GLSTBlock is not connected to a PRAYFile.");
        }
    }


    protected function DecompileBlockData() {   
        $reader = new StringReader($this->GetData());
        $firstchar = $reader->Read(1);
        if($firstchar == chr(0x27)) { //apostrophe thing
            //ds
            $this->format = GLST_FORMAT_DS;
        } else if($firstchar == chr(0x0C)) { //control character
            //c3
            $this->format = GLST_FORMAT_C3;
        } else {
            throw new Exception("Couldn't guess the format.");
        }
        //the first four bytes including $firstchar are probably one integer used to identify the game used.
        //We read the first one above and now we're skipping the next three.
        $reader->Skip(3); // 3 nulls.
        if($reader->ReadInt(4)!=1) { //Always 1, don't know why.
            throw new Exception('Either the GLST Block is corrupt or I don\'t understand what the 2nd set of 4 bytes mean.');
            return false;
        }
        $moniker        = $reader->Read($reader->ReadInt(4));
        $reader->Skip($reader->ReadInt(4)); //second moniker is always identical and never necessary.
        $name           = $reader->Read($reader->ReadInt(4));
        $gender         = $reader->ReadInt(4);
        $genus          = $reader->ReadInt(4); //0 for norn, 1 for grendel, 2 for ettin
        $species        = $reader->ReadInt(4);
        $eventslength   = $reader->ReadInt(4);

        $this->history = new CreatureHistory($moniker,$name,$gender,$genus,$species);
        if(!isset($eventslength)) {
            return false;
        }
        for($i=0;$i<$eventslength;$i++) {
            $this->DecodeEvent($reader);
        }

        //reading the footer
        $mutations = $reader->ReadInt(4);
        $crossovers = $reader->ReadInt(4);

        $this->history->SetMutationsAndCrossovers($mutations,$crossovers);

        if($this->format == GLST_FORMAT_DS) {
            $unknown1 = $reader->ReadInt(4);
            $warpveteran = (($reader->ReadInt(4)==1)?1:0);
            $unknown2 = $reader->Read($reader->ReadInt(4));
            $this->history->SetDSUnknowns($unknown1,$unknown2);
            $this->history->SetWarpVeteran($warpveteran);
        }
    }


    private function DecodeEvent($reader) {
        $eventNumber = $reader->ReadInt(4);
        //echo 'Event '.$eventNumber."\n";
        if($eventNumber < 18) {
            $eventnumber    = $eventNumber;
            $worldtime      = $reader->ReadInt(4);
            $creatureage    = $reader->ReadInt(4);
            $timestamp      = $reader->ReadInt(4);
            $lifestage      = $reader->ReadInt(4);
            $moniker        = $reader->Read($reader->ReadInt(4));
            $moniker2       = $reader->Read($reader->ReadInt(4));
            $usertext       = $reader->Read($reader->ReadInt(4));
            $photograph     = $reader->Read($reader->ReadInt(4));
            $worldname      = $reader->Read($reader->ReadInt(4));
            $worldUID       = $reader->Read($reader->ReadInt(4));
            $event = new CreatureHistoryEvent($eventnumber,$worldtime,$creatureage,
                $timestamp,$lifestage,$moniker,$moniker2,$usertext,$photograph,
                $worldname,$worldUID);
            if($this->format == GLST_FORMAT_DS) {
                $DSUser     = $reader->Read($reader->ReadInt(4));
                $unknown1   = $reader->ReadInt(4);
                $unknown2   = $reader->ReadInt(4);
                $event->AddDSInfo($DSUser,$unknown1,$unknown2);
            }
            $this->history->AddEvent($event);
            return true;
        }
        return false;       
    }



    protected function CompileBlockData($format=GLST_FORMAT_UNKNOWN) {
        //if you don't know
        if($format == GLST_FORMAT_UNKNOWN) {
            $format = $this->GuessFormat();
        }   
        $compiled = Archive($this->history->Compile($format));
        return $compiled;
    }

}
?>