agents/PRAY/PrayBlock.php

Go to the documentation of this file.

<?php
require_once(dirname(__FILE__).'/AGNTBlock.php');
require_once(dirname(__FILE__).'/CREABlock.php');
require_once(dirname(__FILE__).'/DFAMBlock.php');
require_once(dirname(__FILE__).'/DSAGBlock.php');
require_once(dirname(__FILE__).'/DSEXBlock.php');
require_once(dirname(__FILE__).'/EGGSBlock.php');
require_once(dirname(__FILE__).'/EXPCBlock.php');
require_once(dirname(__FILE__).'/FILEBlock.php');
require_once(dirname(__FILE__).'/GENEBlock.php');
require_once(dirname(__FILE__).'/GLSTBlock.php');
require_once(dirname(__FILE__).'/LIVEBlock.php');
require_once(dirname(__FILE__).'/PHOTBlock.php');
require_once(dirname(__FILE__).'/SFAMBlock.php');


define('PRAY_BLOCK_AGNT','AGNT'); 
define('PRAY_BLOCK_CREA','CREA');
define('PRAY_BLOCK_DFAM','DFAM');
define('PRAY_BLOCK_DSAG','DSAG');
define('PRAY_BLOCK_DSEX','DSEX');
define('PRAY_BLOCK_EGGS' ,'EGGS' );
define('PRAY_BLOCK_EXPC','EXPC');
define('PRAY_BLOCK_FILE','FILE');
define('PRAY_BLOCK_GENE','GENE');
define('PRAY_BLOCK_GLST','GLST');
define('PRAY_BLOCK_LIVE','LIVE');
define('PRAY_BLOCK_PHOT','PHOT');
define('PRAY_BLOCK_SFAM','SFAM');




define('PRAY_FLAG_ZLIB_COMPRESSED',1);

abstract class PrayBlock {

    private $prayfile;
    private $content;
    private $name;
    private $type;
    private $decompiled;

    //


    public function PrayBlock($prayfile,$name,$content,$flags,$type) {
        if(strlen($type) != 4) {
            throw new Exception('Invalid PRAY block type: '.$type);
        }
        if($prayfile instanceof PRAYFile) {
            $this->prayfile = $prayfile;
            $this->decompiled = false;
        } else {
            $this->prayfile = null;
            $this->decompiled = true;
        }
        $this->name = $name;
        $this->content = $content;
        $this->flags = $flags;
        $this->type = $type;
    }


    protected function EncodeBlockHeader($length,$uncompressedlength=false) {
        $compiled = $this->GetType();
        $compiled .= substr($this->GetName(),0,128);
        $len = 128 - strlen($this->GetName());
        
        for($i=0;$i<$len;$i++) {
            $compiled .= pack('x');
        }
        if($uncompressedlength === false) {
            $uncompressedlength = $length;
        }
        $compiled .= pack('VVV',$length,$uncompressedlength,$this->flags);
        return $compiled;
    }



    protected function PerformFlagOperations($data) {
        if($this->IsFlagSet(PRAY_FLAG_ZLIB_COMPRESSED)) {
            $data = gzcompress($data);
        }
        return $data;
    }



    public function GetName() {
        return $this->name;
    }

    public function GetData() {
        if($this->decompiled) {
            throw new Exception('Can\'t get data on a decompiled PRAYBlock. It must be compiled first');
            return;
        }
        if($this->IsFlagSet(PRAY_FLAG_ZLIB_COMPRESSED)) {
            $this->content = gzuncompress($this->content);
            $this->SetFlagsOff(PRAY_FLAG_ZLIB_COMPRESSED);
        }
        return $this->content;
    }

    public function GetType() {
        return $this->type;
    }

    public function GetFlags() {
        return $this->flags;
    }

    public function IsFlagSet($flag) {
        return (($this->flags & $flag) === $flag);
    }



    protected function GetLength() {
        return strlen($this->content);
    }

    protected function SetData($data) {
        $this->content = $data;
    }

    protected function GetPrayFile() {
        return $this->prayfile;
    }

    protected function SetFlagsOn($flags) {
        $this->flags = $this->flags | $flags;
    }

    protected function SetFlagsOff($flags) {
        $this->flags = $this->flags & ~$flags;

    }

    protected function EnsureDecompiled() {
        if($this->decompiled) {
            return;
        } else {
            $this->DecompileBlockData();
            $this->decompiled = true;
        }
    }

    // Started above GetLength.


    public function Compile() {
        if($this->decompiled) { 
            $data = $this->CompileBlockData();
            $uclength = strlen($data);
            $data = $this->PerformFlagOperations($data);
            $compiled = $this->EncodeBlockHeader(strlen($data),$uclength);
            $compiled .= $data;
            $this->content = $data;
            $this->decompiled = false;
            return $compiled; 
        } else {
            $data = $this->PerformFlagOperations($this->content);
            $compiled  = $this->EncodeBlockHeader(strlen($this->content),strlen($data));
            $compiled .= $this->content;
            return $compiled;
        }
    }



    protected abstract function CompileBlockData();

    protected abstract function DecompileBlockData();


    public static function MakePrayBlock($blocktype,PRAYFile $prayfile,$name,$content,$flags) {
        switch($blocktype) {
            //agents
        case PRAY_BLOCK_AGNT:
            return new AGNTBlock($prayfile,$name,$content,$flags);
        case PRAY_BLOCK_DSAG:
            return new DSAGBlock($prayfile,$name,$content,$flags);
        case PRAY_BLOCK_LIVE:
            return new LIVEBlock($prayfile,$name,$content,$flags); //sea monkeys agent files.

            //egg
        case PRAY_BLOCK_EGGS:
            return new EGGSBlock($prayfile,$name,$content,$flags);

            //starter families
        case PRAY_BLOCK_DFAM:
            return new DFAMBlock($prayfile,$name,$content,$flags);
        case PRAY_BLOCK_SFAM:
            return new SFAMBlock($prayfile,$name,$content,$flags);

            //exported creatures
        case PRAY_BLOCK_EXPC:
            return new EXPCBlock($prayfile,$name,$content,$flags);
        case PRAY_BLOCK_DSEX:
            return new DSEXBlock($prayfile,$name,$content,$flags);

        case PRAY_BLOCK_CREA:
            return new CREABlock($prayfile,$name,$content,$flags);

            //creature photos
        case PRAY_BLOCK_PHOT:
            return new PHOTBlock($prayfile,$name,$content,$flags);

            //creature history
        case PRAY_BLOCK_GLST:
            return new GLSTBlock($prayfile,$name,$content,$flags);

            //creature genetics
        case PRAY_BLOCK_GENE:
            return new GENEBlock($prayfile,$name,$content,$flags);

            //files
        case PRAY_BLOCK_FILE:
            return new FILEBlock($prayfile,$name,$content,$flags);

        default:
            return null;
        }
    }
}
?>