getid3_torrent::ReadSequentialDigits() - Code Metrics - Inspection of "getID3 development version 1.9.20-202010031049" - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — vendor/getid3 ( d7a1ee...1697a0 )

by Pauli

created 2020-10-03 18:00 UTC

getid3_torrent::ReadSequentialDigits() B

↳ Parent: getid3_torrent

Complexity

Conditions	8
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	8
nop	3
dl	0
loc	20
rs	8.4444
c	0
b	0
f	0

<?php

/////////////////////////////////////////////////////////////////
/// getID3() by James Heinrich <[email protected]>               //
//  available at https://github.com/JamesHeinrich/getID3       //
//            or https://www.getid3.org                        //
//            or http://getid3.sourceforge.net                 //
//  see readme.txt for more details                            //
/////////////////////////////////////////////////////////////////
//                                                             //
// module.misc.torrent.php                                     //
// module for analyzing .torrent files                         //
// dependencies: NONE                                          //
//                                                            ///
/////////////////////////////////////////////////////////////////

if (!defined('GETID3_INCLUDEPATH')) { // prevent path-exposing attacks that access modules directly on public webservers
	exit;
}

class getid3_torrent extends getid3_handler
{
	/**
	 * Assume all .torrent files are less than 1MB and just read entire thing into memory for easy processing.
	 * Override this value if you need to process files larger than 1MB
	 *
	 * @var int
	 */
	public $max_torrent_filesize = 1048576;

	/**
	 * calculated InfoHash (SHA1 of the entire "info" Dictionary)
	 *
	 * @var string
	 */
	private $infohash = '';

	const PIECE_HASHLENGTH = 20; // number of bytes the SHA1 hash is for each piece

	/**
	 * @return bool
	 */
	public function Analyze() {
		$info = &$this->getid3->info;
		$filesize = $info['avdataend'] - $info['avdataoffset'];
		if ($filesize > $this->max_torrent_filesize) {  //
			$this->error('File larger ('.number_format($filesize).' bytes) than $max_torrent_filesize ('.number_format($this->max_torrent_filesize).' bytes), increase getid3_torrent->max_torrent_filesize if needed');
			return false;
		}
		$this->fseek($info['avdataoffset']);
		$TORRENT = $this->fread($filesize);
		$offset = 0;
		if (!preg_match('#^(d8\\:announce|d7\\:comment)#', $TORRENT)) {

			$this->error('Expecting "d8:announce" or "d7:comment" at '.$info['avdataoffset'].', found "'.substr($TORRENT, $offset, 12).'" instead.');
			return false;
		}
		$info['fileformat'] = 'torrent';

		$info['torrent'] = $this->NextEntity($TORRENT, $offset);
		if ($this->infohash) {
			$info['torrent']['infohash'] = $this->infohash;
		}

		if (empty($info['torrent']['info']['length']) && !empty($info['torrent']['info']['files'][0]['length'])) {
			$info['torrent']['info']['length'] = 0;
			foreach ($info['torrent']['info']['files'] as $key => $filedetails) {

				$info['torrent']['info']['length'] += $filedetails['length'];
			}
		}
		if (!empty($info['torrent']['info']['length']) && !empty($info['torrent']['info']['piece length']) && !empty($info['torrent']['info']['pieces'])) {
			$num_pieces_size = ceil($info['torrent']['info']['length'] / $info['torrent']['info']['piece length']);
			$num_pieces_hash = strlen($info['torrent']['info']['pieces']) / getid3_torrent::PIECE_HASHLENGTH; // should be concatenated 20-byte SHA1 hashes
			if ($num_pieces_hash == $num_pieces_size) {
				$info['torrent']['info']['piece_hash'] = array();
				for ($i = 0; $i < $num_pieces_size; $i++) {
					$info['torrent']['info']['piece_hash'][$i] = '';
					for ($j = 0; $j < getid3_torrent::PIECE_HASHLENGTH; $j++) {
						$info['torrent']['info']['piece_hash'][$i] .= sprintf('%02x', ord($info['torrent']['info']['pieces'][(($i * getid3_torrent::PIECE_HASHLENGTH) + $j)]));
					}
				}
				unset($info['torrent']['info']['pieces']);
			} else {
				$this->warning('found '.$num_pieces_size.' pieces based on file/chunk size; found '.$num_pieces_hash.' pieces in hash table');
			}
		}
		if (!empty($info['torrent']['info']['name']) && !empty($info['torrent']['info']['length']) && !isset($info['torrent']['info']['files'])) {
			// single-file torrent
			$info['torrent']['files'] = array($info['torrent']['info']['name'] => $info['torrent']['info']['length']);
		} elseif (!empty($info['torrent']['info']['files'])) {
			// multi-file torrent
			$info['torrent']['files'] = array();
			foreach ($info['torrent']['info']['files'] as $key => $filedetails) {

				$info['torrent']['files'][implode('/', $filedetails['path'])] = $filedetails['length'];
			}
		} else {
			$this->warning('no files found');
		}

		return true;
	}

	/**
	 * @return string|array|int|bool
	 */
	public function NextEntity(&$TORRENT, &$offset) {
		// https://fileformats.fandom.com/wiki/Torrent_file
		// https://en.wikipedia.org/wiki/Torrent_file
		// https://en.wikipedia.org/wiki/Bencode

		if ($offset >= strlen($TORRENT)) {
			$this->error('cannot read beyond end of file '.$offset);
			return false;
		}
		$type = $TORRENT[$offset++];
		if ($type == 'i') {

			// Integers are stored as i<integer>e:
			//   i90e
			$value = $this->ReadSequentialDigits($TORRENT, $offset, true);
			if ($TORRENT[$offset++] == 'e') {
//echo '<li>int: '.$value.'</li>';
				return (int) $value;
			}
			$this->error('unexpected('.__LINE__.') input "'.$value.'" at offset '.($offset - 1));
			return false;

		} elseif ($type == 'd') {

			// Dictionaries are stored as d[key1][value1][key2][value2][...]e. Keys and values appear alternately.
			// Keys must be strings and must be ordered alphabetically.
			// For example, {apple-red, lemon-yellow, violet-blue, banana-yellow} is stored as:
			//   d5:apple3:red6:banana6:yellow5:lemon6:yellow6:violet4:bluee
			$values = array();
//echo 'DICTIONARY @ '.$offset.'<ul>';
			$info_dictionary_start = null; // dummy declaration to prevent "Variable might not be defined" warnings
			while (true) {
				if ($TORRENT[$offset] === 'e') {
					break;
				}
				$thisentry = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				$key = $this->NextEntity($TORRENT, $offset);
				if ($key == 'info') {
					$info_dictionary_start = $offset;
				}
				if ($key === false) {
					$this->error('unexpected('.__LINE__.') input at offset '.$offset);
					return false;
				}
				$value = $this->NextEntity($TORRENT, $offset);
				if ($key == 'info') {
					$info_dictionary_end = $offset;
					$this->infohash = sha1(substr($TORRENT, $info_dictionary_start, $info_dictionary_end - $info_dictionary_start));
				}
				if ($value === false) {
					$this->error('unexpected('.__LINE__.') input at offset '.$offset);
					return false;
				}
				$values[$key] = $value;
			}
			if ($TORRENT[$offset++] == 'e') {
//echo '</ul>';
				return $values;
			}
			$this->error('unexpected('.__LINE__.') input "'.$TORRENT[($offset - 1)].'" at offset '.($offset - 1));
			return false;

		} elseif ($type == 'l') {

//echo 'LIST @ '.$offset.'<ul>';
			// Lists are stored as l[value 1][value2][value3][...]e. For example, {spam, eggs, cheeseburger} is stored as:
			//	l4:spam4:eggs12:cheeseburgere
			$values = array();
			while (true) {
				if ($TORRENT[$offset] === 'e') {
					break;
				}
				$NextEntity = $this->NextEntity($TORRENT, $offset);
				if ($NextEntity === false) {
					$this->error('unexpected('.__LINE__.') input at offset '.($offset - 1));
					return false;
				}
				$values[] = $NextEntity;
			}
			if ($TORRENT[$offset++] == 'e') {
//echo '</ul>';
				return $values;
			}
			$this->error('unexpected('.__LINE__.') input "'.$TORRENT[($offset - 1)].'" at offset '.($offset - 1));
			return false;

		} elseif (ctype_digit($type)) {

			// Strings are stored as <length of string>:<string>:
			//   4:wiki
			$length = $type;
			while (true) {
				$char = $TORRENT[$offset++];
				if ($char == ':') {
					break;
				} elseif (!ctype_digit($char)) {
					$this->error('unexpected('.__LINE__.') input "'.$char.'" at offset '.($offset - 1));
					return false;
				}
				$length .= $char;
			}
			if (($offset + $length) > strlen($TORRENT)) {
				$this->error('string at offset '.$offset.' claims to be '.$length.' bytes long but only '.(strlen($TORRENT) - $offset).' bytes of data left in file');
				return false;
			}
			$string = substr($TORRENT, $offset, $length);
			$offset += $length;
//echo '<li>string: '.$string.'</li>';
			return (string) $string;

		} else {

			$this->error('unexpected('.__LINE__.') input "'.$type.'" at offset '.($offset - 1));
			return false;

		}
	}

	/**
	 * @return string
	 */
	public function ReadSequentialDigits(&$TORRENT, &$offset, $allow_negative=false) {
		$start_offset = $offset;
		$value = '';
		while (true) {
			$char = $TORRENT[$offset++];
			if (!ctype_digit($char)) {
				if ($allow_negative && ($char == '-') && (strlen($value) == 0)) {
					// allow negative-sign if first character and $allow_negative enabled
				} else {
					$offset--;
					break;
				}
			}
			$value .= $char;
		}
		if (($value[0] === '0') && ($value !== '0')) {
			$this->warning('illegal zero-padded number "'.$value.'" at offset '.$start_offset);
		}
		return $value;
	}

}


1		<?php
2
3		/////////////////////////////////////////////////////////////////
4		/// getID3() by James Heinrich <[email protected]> //
5		// available at https://github.com/JamesHeinrich/getID3 //
6		// or https://www.getid3.org //
7		// or http://getid3.sourceforge.net //
8		// see readme.txt for more details //
9		/////////////////////////////////////////////////////////////////
10		// //
11		// module.misc.torrent.php //
12		// module for analyzing .torrent files //
13		// dependencies: NONE //
14		// ///
15		/////////////////////////////////////////////////////////////////
16
17		if (!defined('GETID3_INCLUDEPATH')) { // prevent path-exposing attacks that access modules directly on public webservers
18		exit;
19		}
20
21		class getid3_torrent extends getid3_handler
22		{
23		/**
24		* Assume all .torrent files are less than 1MB and just read entire thing into memory for easy processing.
25		* Override this value if you need to process files larger than 1MB
26		*
27		* @var int
28		*/
29		public $max_torrent_filesize = 1048576;
30
31		/**
32		* calculated InfoHash (SHA1 of the entire "info" Dictionary)
33		*
34		* @var string
35		*/
36		private $infohash = '';
37
38		const PIECE_HASHLENGTH = 20; // number of bytes the SHA1 hash is for each piece
39
40		/**
41		* @return bool
42		*/
43		public function Analyze() {
44		$info = &$this->getid3->info;
45		$filesize = $info['avdataend'] - $info['avdataoffset'];
46		if ($filesize > $this->max_torrent_filesize) { //
47		$this->error('File larger ('.number_format($filesize).' bytes) than $max_torrent_filesize ('.number_format($this->max_torrent_filesize).' bytes), increase getid3_torrent->max_torrent_filesize if needed');
48		return false;
49		}
50		$this->fseek($info['avdataoffset']);
51		$TORRENT = $this->fread($filesize);
52		$offset = 0;
53	View Code Duplication	if (!preg_match('#^(d8\\:announce\|d7\\:comment)#', $TORRENT)) {
		0 ignored issues – show Duplication introduced 2020-10-03 18:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
54		$this->error('Expecting "d8:announce" or "d7:comment" at '.$info['avdataoffset'].', found "'.substr($TORRENT, $offset, 12).'" instead.');
55		return false;
56		}
57		$info['fileformat'] = 'torrent';
58
59		$info['torrent'] = $this->NextEntity($TORRENT, $offset);
60		if ($this->infohash) {
61		$info['torrent']['infohash'] = $this->infohash;
62		}
63
64		if (empty($info['torrent']['info']['length']) && !empty($info['torrent']['info']['files'][0]['length'])) {
65		$info['torrent']['info']['length'] = 0;
66	View Code Duplication	foreach ($info['torrent']['info']['files'] as $key => $filedetails) {
		0 ignored issues – show Duplication introduced 2020-10-03 18:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
67		$info['torrent']['info']['length'] += $filedetails['length'];
68		}
69		}
70		if (!empty($info['torrent']['info']['length']) && !empty($info['torrent']['info']['piece length']) && !empty($info['torrent']['info']['pieces'])) {
71		$num_pieces_size = ceil($info['torrent']['info']['length'] / $info['torrent']['info']['piece length']);
72		$num_pieces_hash = strlen($info['torrent']['info']['pieces']) / getid3_torrent::PIECE_HASHLENGTH; // should be concatenated 20-byte SHA1 hashes
73		if ($num_pieces_hash == $num_pieces_size) {
74		$info['torrent']['info']['piece_hash'] = array();
75		for ($i = 0; $i < $num_pieces_size; $i++) {
76		$info['torrent']['info']['piece_hash'][$i] = '';
77		for ($j = 0; $j < getid3_torrent::PIECE_HASHLENGTH; $j++) {
78		$info['torrent']['info']['piece_hash'][$i] .= sprintf('%02x', ord($info['torrent']['info']['pieces'][(($i * getid3_torrent::PIECE_HASHLENGTH) + $j)]));
79		}
80		}
81		unset($info['torrent']['info']['pieces']);
82		} else {
83		$this->warning('found '.$num_pieces_size.' pieces based on file/chunk size; found '.$num_pieces_hash.' pieces in hash table');
84		}
85		}
86		if (!empty($info['torrent']['info']['name']) && !empty($info['torrent']['info']['length']) && !isset($info['torrent']['info']['files'])) {
87		// single-file torrent
88		$info['torrent']['files'] = array($info['torrent']['info']['name'] => $info['torrent']['info']['length']);
89		} elseif (!empty($info['torrent']['info']['files'])) {
90		// multi-file torrent
91		$info['torrent']['files'] = array();
92	View Code Duplication	foreach ($info['torrent']['info']['files'] as $key => $filedetails) {
		0 ignored issues – show Duplication introduced 2020-10-03 18:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
93		$info['torrent']['files'][implode('/', $filedetails['path'])] = $filedetails['length'];
94		}
95		} else {
96		$this->warning('no files found');
97		}
98
99		return true;
100		}
101
102		/**
103		* @return string\|array\|int\|bool
104		*/
105		public function NextEntity(&$TORRENT, &$offset) {
106		// https://fileformats.fandom.com/wiki/Torrent_file
107		// https://en.wikipedia.org/wiki/Torrent_file
108		// https://en.wikipedia.org/wiki/Bencode
109
110		if ($offset >= strlen($TORRENT)) {
111		$this->error('cannot read beyond end of file '.$offset);
112		return false;
113		}
114		$type = $TORRENT[$offset++];
115		if ($type == 'i') {
116
117		// Integers are stored as i<integer>e:
118		// i90e
119		$value = $this->ReadSequentialDigits($TORRENT, $offset, true);
120		if ($TORRENT[$offset++] == 'e') {
121		//echo '<li>int: '.$value.'</li>';
122		return (int) $value;
123		}
124		$this->error('unexpected('.__LINE__.') input "'.$value.'" at offset '.($offset - 1));
125		return false;
126
127		} elseif ($type == 'd') {
128
129		// Dictionaries are stored as d[key1][value1][key2][value2][...]e. Keys and values appear alternately.
130		// Keys must be strings and must be ordered alphabetically.
131		// For example, {apple-red, lemon-yellow, violet-blue, banana-yellow} is stored as:
132		// d5:apple3:red6:banana6:yellow5:lemon6:yellow6:violet4:bluee
133		$values = array();
134		//echo 'DICTIONARY @ '.$offset.'<ul>';
135		$info_dictionary_start = null; // dummy declaration to prevent "Variable might not be defined" warnings
136		while (true) {
137		if ($TORRENT[$offset] === 'e') {
138		break;
139		}
140		$thisentry = array();
		0 ignored issues – show Unused Code introduced 2020-10-03 18:03 UTC by Report Bug Copy Issue Report `$thisentry` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
141		$key = $this->NextEntity($TORRENT, $offset);
142		if ($key == 'info') {
143		$info_dictionary_start = $offset;
144		}
145		if ($key === false) {
146		$this->error('unexpected('.__LINE__.') input at offset '.$offset);
147		return false;
148		}
149		$value = $this->NextEntity($TORRENT, $offset);
150		if ($key == 'info') {
151		$info_dictionary_end = $offset;
152		$this->infohash = sha1(substr($TORRENT, $info_dictionary_start, $info_dictionary_end - $info_dictionary_start));
153		}
154		if ($value === false) {
155		$this->error('unexpected('.__LINE__.') input at offset '.$offset);
156		return false;
157		}
158		$values[$key] = $value;
159		}
160		if ($TORRENT[$offset++] == 'e') {
161		//echo '</ul>';
162		return $values;
163		}
164		$this->error('unexpected('.__LINE__.') input "'.$TORRENT[($offset - 1)].'" at offset '.($offset - 1));
165		return false;
166
167		} elseif ($type == 'l') {
168
169		//echo 'LIST @ '.$offset.'<ul>';
170		// Lists are stored as l[value 1][value2][value3][...]e. For example, {spam, eggs, cheeseburger} is stored as:
171		// l4:spam4:eggs12:cheeseburgere
172		$values = array();
173		while (true) {
174		if ($TORRENT[$offset] === 'e') {
175		break;
176		}
177		$NextEntity = $this->NextEntity($TORRENT, $offset);
178		if ($NextEntity === false) {
179		$this->error('unexpected('.__LINE__.') input at offset '.($offset - 1));
180		return false;
181		}
182		$values[] = $NextEntity;
183		}
184		if ($TORRENT[$offset++] == 'e') {
185		//echo '</ul>';
186		return $values;
187		}
188		$this->error('unexpected('.__LINE__.') input "'.$TORRENT[($offset - 1)].'" at offset '.($offset - 1));
189		return false;
190
191		} elseif (ctype_digit($type)) {
192
193		// Strings are stored as <length of string>:<string>:
194		// 4:wiki
195		$length = $type;
196		while (true) {
197		$char = $TORRENT[$offset++];
198		if ($char == ':') {
199		break;
200		} elseif (!ctype_digit($char)) {
201		$this->error('unexpected('.__LINE__.') input "'.$char.'" at offset '.($offset - 1));
202		return false;
203		}
204		$length .= $char;
205		}
206		if (($offset + $length) > strlen($TORRENT)) {
207		$this->error('string at offset '.$offset.' claims to be '.$length.' bytes long but only '.(strlen($TORRENT) - $offset).' bytes of data left in file');
208		return false;
209		}
210		$string = substr($TORRENT, $offset, $length);
211		$offset += $length;
212		//echo '<li>string: '.$string.'</li>';
213		return (string) $string;
214
215		} else {
216
217		$this->error('unexpected('.__LINE__.') input "'.$type.'" at offset '.($offset - 1));
218		return false;
219
220		}
221		}
222
223		/**
224		* @return string
225		*/
226		public function ReadSequentialDigits(&$TORRENT, &$offset, $allow_negative=false) {
227		$start_offset = $offset;
228		$value = '';
229		while (true) {
230		$char = $TORRENT[$offset++];
231		if (!ctype_digit($char)) {
232		if ($allow_negative && ($char == '-') && (strlen($value) == 0)) {
233		// allow negative-sign if first character and $allow_negative enabled
234		} else {
235		$offset--;
236		break;
237		}
238		}
239		$value .= $char;
240		}
241		if (($value[0] === '0') && ($value !== '0')) {
242		$this->warning('illegal zero-padded number "'.$value.'" at offset '.$start_offset);
243		}
244		return $value;
245		}
246
247		}
248

owncloud / music

Push — vendor/getid3 ( d7a1ee...1697a0 )

getid3_torrent::ReadSequentialDigits() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like