COB::GetBlocks() - Code Metrics - Inspection of "fix a couple syntax errors and add unimplemented C..." - telyn/c2ephp - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c33da0...2cb87f )

by Telyn

created 2018-01-28 11:01 UTC

COB::GetBlocks() A

↳ Parent: COB

Complexity

Conditions	4
Paths	3

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	6
nc	3
nop	1
dl	0
loc	9
rs	9.2
c	0
b	0
f	0

<?php
require_once(dirname(__FILE__).'/../support/IReader.php');
require_once(dirname(__FILE__).'/../support/StringReader.php');
require_once(dirname(__FILE__).'/COB/AgentBlock.php');
require_once(dirname(__FILE__).'/COB/FileBlock.php');
require_once(dirname(__FILE__).'/COB/AuthorBlock.php');
require_once(dirname(__FILE__).'/COB/UnknownBlock.php');

///@{
/**
 * @name C1 format cob
 * Value: C1
 */
define('COB_FORMAT_C1', 'C1');
/**
 * @name C2 format COB
 * Value: C2
 */
define('COB_FORMAT_C2', 'C2');
///@}

/// @brief Class that interacts with COB files (c1 and c2 formats)
class COB {

    /// @cond INTERNAL_DOCS

    private $format;
    private $blocks;

    /// @endcond

    /// @brief Creates a new COB file
    /**
     * If you want to create a COB file from scratch, simply don't
     * pass anything to the constructor. \n\n
     * Alternatively, if you know which kind of COB file you are
     * reading, or only want to deal with a specific kind of COB
     * file, you can call the LoadC1COB and LoadC2COB functions
     * after creating a blank cob file. E.g. ($reader is a IReader) \n\n
     * $cob = new COB; \n
     * $cob->LoadC1COB($reader); \n
     * This code will only parse C1 cobs.
     * @param $reader The reader which contains the cob to read from. Can be null.
     */
    public function COB(IReader $reader = null) {
        if ($reader != null) {
            $this->LoadCOB($reader);
        }
    }

    /// @cond INTERNAL_DOCS

    /// @brief Loads the COB from the IReader.
    /**
     * Used internally, this function is not for the general public! \n
     * This function first identifies which type of COB is in the IReader
     * Then decompresses if necessary, then calls LoadC1COB or LoadC2COB.
     * @param $reader The reader to read from
     */
    private function LoadCOB(IReader $reader) {
        if ($reader->Read(4) == 'cob2') {
            $reader->Seek(0);
            $this->LoadC2COB($reader);
        } else {
            $string = $reader->GetSubString(0);
            $data = @gzuncompress($string);
            if ($data === false) {
                $reader->Seek(0);
                $this->LoadC1COB($reader);
            } else {
                $this->LoadC2COB(new StringReader($data));
            }
        }
    }

    /// @endcond

    /// @brief Loads a C2 COB from the IReader given
    /**
     * C2 COBs have multiple blocks, which are accessible via the
     * COB::GetBlocks function.
     * @param $reader The IReader to load from
     */
    public function LoadC2COB(IReader $reader) {
        $this->format = COB_FORMAT_C2;
        if ($reader->Read(4) == 'cob2') {
            while ($block = $this->ReadBlock($reader)) {
                $this->blocks[] = $block;
            }
        } else {
            throw new Exception('Not a valid C2 COB file!');
        }
    }

    /// @brief Loads a C1 COB from the specified reader
    /** 
     * C1 COBs have just one block, which is a COBAgentBlock.
     * This is accessible by calling COB::GetBlocks
     * @param $reader the reader to load from
     */
    public function LoadC1COB(IReader $reader) {
        $this->format = COB_FORMAT_C1;
        $version = $reader->ReadInt(2);
        if ($version > 4) {
            throw new Exception('Invalid cob file.');
        } else {
            $this->blocks[] = COBAgentBlock::CreateFromReaderC1($reader);
        }
    }
    /// @brief Adds a COBBlock to this COB
    /**
     * @param $block the block to add.
     */
    public function AddBlock(COBBlock $block) {
        //TODO: Check that this block works for this COB type?
        $this->blocks[] = $block;
    }

    /// @cond INTERNAL_DOCS

    /// @brief Underlying block reader used by C2 COBs
    /**
     * Reads a block from the specified reader, then instanitates
     * a representative COBBlock, and returns it.
     */
    private function ReadBlock(IReader $reader) {
        if (!($type = $reader->Read(4))) {
            return false;
        }
        $size = $reader->ReadInt(4);
        switch ($type) {
        case 'agnt':
            //we read the entire thing so that if there are errors we can still go on with the other blocks.
            return COBAgentBlock::CreateFromReaderC2($reader);
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'auth':
            return COBAuthorBlock::CreateFromReader(new StringReader($reader->Read($size)));
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'file':
            return COBFileBlock::CreateFromReader(new StringReader($reader->Read($size)));
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        default:
            //throw new Exception('Invalid block type: Probably a bug or an invalid COB file: '.$type);

            //simply ignore unknown block types, in case people add their own
            return new COBUnknownBlock($type, $reader->Read($size));
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
    }

    /// @endcond
    
    /// @brief Accessor method to get blocks of the given type
    /**
     * If $type is false, will return all blocks in this agent. \n
     * In a C1 COB, there is only one block and it is of the agnt
     * type.
     * @param $type The type of block to get (agnt, auth, file). False by default.
     * @return An array of COBBlocks.
     */
    public function GetBlocks($type = false) {
        $blocks = array();
        foreach ($this->blocks as $block) {
            if ($type === false || $type == $block->GetType()) {
                $blocks[] = $block;
            }
        }
        return $blocks;
    }

    /// @brief Compiles the COB in the given format
    /**
     *  @param $format The format of the COB. If null, assumed it's a creatures 2 COB
     *  @return A binary string containing the COB.
     */
    public function Compile($format = null) {
        if ($format == null) {
            $format = $this->GetType();

        }
        if ($format != FORMAT_C1) {
            $format = FORMAT_C2;
        }
        switch ($format) {
        case FORMAT_C1:
            $this->CompileC1();
        case FORMAT_C2:
            $this->CompileC2();
        default:
            throw new Exception('Non-understood COB format - sorry!');
        }
    }

    /// @brief Compiles to a C1 COB. <b>Unimplemented</b>
    // TODO: implement this.
    public function CompileC1() {
        throw new Exception('C1 COB Compilation not yet ready.');
    }
    /// @brief Compiles a C2 COB. <b>May not actually work.</b>
    // TODO: Check accuracy
    public function CompileC2() {
        $data = 'cob2'; 
        foreach ($this->blocks as $block) {
            $data .= $block->Compile();
        }    
    }
}
?>



1			<?php
2			require_once(dirname(__FILE__).'/../support/IReader.php');
3			require_once(dirname(__FILE__).'/../support/StringReader.php');
4			require_once(dirname(__FILE__).'/COB/AgentBlock.php');
5			require_once(dirname(__FILE__).'/COB/FileBlock.php');
6			require_once(dirname(__FILE__).'/COB/AuthorBlock.php');
7			require_once(dirname(__FILE__).'/COB/UnknownBlock.php');
8
9			///@{
10			/**
11			* @name C1 format cob
12			* Value: C1
13			*/
14			define('COB_FORMAT_C1', 'C1');
15			/**
16			* @name C2 format COB
17			* Value: C2
18			*/
19			define('COB_FORMAT_C2', 'C2');
20			///@}
21
22			/// @brief Class that interacts with COB files (c1 and c2 formats)
23			class COB {
24
25			/// @cond INTERNAL_DOCS
26
27			private $format;
28			private $blocks;
29
30			/// @endcond
31
32			/// @brief Creates a new COB file
33			/**
34			* If you want to create a COB file from scratch, simply don't
35			* pass anything to the constructor. \n\n
36			* Alternatively, if you know which kind of COB file you are
37			* reading, or only want to deal with a specific kind of COB
38			* file, you can call the LoadC1COB and LoadC2COB functions
39			* after creating a blank cob file. E.g. ($reader is a IReader) \n\n
40			* $cob = new COB; \n
41			* $cob->LoadC1COB($reader); \n
42			* This code will only parse C1 cobs.
43			* @param $reader The reader which contains the cob to read from. Can be null.
44			*/
45			public function COB(IReader $reader = null) {
46			if ($reader != null) {
47			$this->LoadCOB($reader);
48			}
49			}
50
51			/// @cond INTERNAL_DOCS
52
53			/// @brief Loads the COB from the IReader.
54			/**
55			* Used internally, this function is not for the general public! \n
56			* This function first identifies which type of COB is in the IReader
57			* Then decompresses if necessary, then calls LoadC1COB or LoadC2COB.
58			* @param $reader The reader to read from
59			*/
60			private function LoadCOB(IReader $reader) {
61			if ($reader->Read(4) == 'cob2') {
62			$reader->Seek(0);
63			$this->LoadC2COB($reader);
64			} else {
65			$string = $reader->GetSubString(0);
66			$data = @gzuncompress($string);
67			if ($data === false) {
68			$reader->Seek(0);
69			$this->LoadC1COB($reader);
70			} else {
71			$this->LoadC2COB(new StringReader($data));
72			}
73			}
74			}
75
76			/// @endcond
77
78			/// @brief Loads a C2 COB from the IReader given
79			/**
80			* C2 COBs have multiple blocks, which are accessible via the
81			* COB::GetBlocks function.
82			* @param $reader The IReader to load from
83			*/
84			public function LoadC2COB(IReader $reader) {
85			$this->format = COB_FORMAT_C2;
86			if ($reader->Read(4) == 'cob2') {
87			while ($block = $this->ReadBlock($reader)) {
88			$this->blocks[] = $block;
89			}
90			} else {
91			throw new Exception('Not a valid C2 COB file!');
92			}
93			}
94
95			/// @brief Loads a C1 COB from the specified reader
96			/**
97			* C1 COBs have just one block, which is a COBAgentBlock.
98			* This is accessible by calling COB::GetBlocks
99			* @param $reader the reader to load from
100			*/
101			public function LoadC1COB(IReader $reader) {
102			$this->format = COB_FORMAT_C1;
103			$version = $reader->ReadInt(2);
104			if ($version > 4) {
105			throw new Exception('Invalid cob file.');
106			} else {
107			$this->blocks[] = COBAgentBlock::CreateFromReaderC1($reader);
108			}
109			}
110			/// @brief Adds a COBBlock to this COB
111			/**
112			* @param $block the block to add.
113			*/
114			public function AddBlock(COBBlock $block) {
115			//TODO: Check that this block works for this COB type?
116			$this->blocks[] = $block;
117			}
118
119			/// @cond INTERNAL_DOCS
120
121			/// @brief Underlying block reader used by C2 COBs
122			/**
123			* Reads a block from the specified reader, then instanitates
124			* a representative COBBlock, and returns it.
125			*/
126			private function ReadBlock(IReader $reader) {
127			if (!($type = $reader->Read(4))) {
128			return false;
129			}
130			$size = $reader->ReadInt(4);
131			switch ($type) {
132			case 'agnt':
133			//we read the entire thing so that if there are errors we can still go on with the other blocks.
134			return COBAgentBlock::CreateFromReaderC2($reader);
135			break;
			0 ignored issues – show Unused Code introduced 2018-01-28 11:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
136			case 'auth':
137			return COBAuthorBlock::CreateFromReader(new StringReader($reader->Read($size)));
138			break;
			0 ignored issues – show Unused Code introduced 2018-01-28 11:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
139			case 'file':
140			return COBFileBlock::CreateFromReader(new StringReader($reader->Read($size)));
141			break;
			0 ignored issues – show Unused Code introduced 2018-01-28 11:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
142			default:
143			//throw new Exception('Invalid block type: Probably a bug or an invalid COB file: '.$type);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-10-26 17:17 UTC by Report Bug Copy Issue Report `64%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
144			//simply ignore unknown block types, in case people add their own
145			return new COBUnknownBlock($type, $reader->Read($size));
146			break;
			0 ignored issues – show Unused Code introduced 2018-01-28 11:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
147			}
148			}
149
150			/// @endcond
151
152			/// @brief Accessor method to get blocks of the given type
153			/**
154			* If $type is false, will return all blocks in this agent. \n
155			* In a C1 COB, there is only one block and it is of the agnt
156			* type.
157			* @param $type The type of block to get (agnt, auth, file). False by default.
158			* @return An array of COBBlocks.
159			*/
160			public function GetBlocks($type = false) {
161			$blocks = array();
162			foreach ($this->blocks as $block) {
163			if ($type === false \|\| $type == $block->GetType()) {
164			$blocks[] = $block;
165			}
166			}
167			return $blocks;
168			}
169
170			/// @brief Compiles the COB in the given format
171			/**
172			* @param $format The format of the COB. If null, assumed it's a creatures 2 COB
173			* @return A binary string containing the COB.
174			*/
175			public function Compile($format = null) {
176			if ($format == null) {
177			$format = $this->GetType();
			0 ignored issues – show Bug introduced 2018-01-28 11:03 UTC by Report Bug Copy Issue Report The method `GetType()` does not seem to exist on `object<COB>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
178			}
179			if ($format != FORMAT_C1) {
180			$format = FORMAT_C2;
181			}
182			switch ($format) {
183			case FORMAT_C1:
184			$this->CompileC1();
185			case FORMAT_C2:
186			$this->CompileC2();
187			default:
188			throw new Exception('Non-understood COB format - sorry!');
189			}
190			}
191
192			/// @brief Compiles to a C1 COB. <b>Unimplemented</b>
193			// TODO: implement this.
194			public function CompileC1() {
195			throw new Exception('C1 COB Compilation not yet ready.');
196			}
197			/// @brief Compiles a C2 COB. <b>May not actually work.</b>
198			// TODO: Check accuracy
199			public function CompileC2() {
200			$data = 'cob2';
201			foreach ($this->blocks as $block) {
202			$data .= $block->Compile();
203			}
204			}
205			}
206			?>
			0 ignored issues – show Best Practice introduced 2016-10-26 17:17 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...
207

telyn / c2ephp

GitHub Access Token became invalid

Push — master ( c33da0...2cb87f )

COB::GetBlocks() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like