getid3_apetag::Analyze(): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

Performance profile

How much work a call to getid3_apetag::Analyze() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

811

Executed per call on PHP 8.5. The body compiles to 811.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

Uses · 11

• getid3_lib::intValueSupported()
• getid3_apetag::warning()
• getid3_apetag::fseek()
• getid3_apetag::fread()
• getid3_apetag::parseAPEheaderFooter()
• getid3_apetag::error()
• getid3_apetag::ftell()
• getid3_lib::LittleEndian2Int()
• getid3_apetag::parseAPEtagFlags()
• getid3_lib::GetDataImageSize()
• getID3::is_writable()

Source code

View on Trac ↗View on GitHub ↗

38	public function Analyze() {39		$info = &$this->getid3->info;40 41		if (!getid3_lib::intValueSupported($info['filesize'])) {42			$this->warning('Unable to check for APEtags because file is larger than '.round(PHP_INT_MAX / 1073741824).'GB');43			return false;44		}45		if (PHP_INT_MAX == 2147483647) {46			// https://github.com/JamesHeinrich/getID3/issues/43947			$this->warning('APEtag flags may not be parsed correctly on 32-bit PHP');48		}49 50		$id3v1tagsize     = 128;51		$apetagheadersize = 32;52		$lyrics3tagsize   = 10;53 54		if ($this->overrideendoffset == 0) {55 56			$this->fseek(0 - $id3v1tagsize - $apetagheadersize - $lyrics3tagsize, SEEK_END);57			$APEfooterID3v1 = $this->fread($id3v1tagsize + $apetagheadersize + $lyrics3tagsize);58 59			//if (preg_match('/APETAGEX.{24}TAG.{125}$/i', $APEfooterID3v1)) {60			if (substr($APEfooterID3v1, strlen($APEfooterID3v1) - $id3v1tagsize - $apetagheadersize, 8) == 'APETAGEX') {61 62				// APE tag found before ID3v163				$info['ape']['tag_offset_end'] = $info['filesize'] - $id3v1tagsize;64 65			//} elseif (preg_match('/APETAGEX.{24}$/i', $APEfooterID3v1)) {66			} elseif (substr($APEfooterID3v1, strlen($APEfooterID3v1) - $apetagheadersize, 8) == 'APETAGEX') {67 68				// APE tag found, no ID3v169				$info['ape']['tag_offset_end'] = $info['filesize'];70 71			}72 73		} else {74 75			$this->fseek($this->overrideendoffset - $apetagheadersize);76			if ($this->fread(8) == 'APETAGEX') {77				$info['ape']['tag_offset_end'] = $this->overrideendoffset;78			}79 80		}81		if (!isset($info['ape']['tag_offset_end'])) {82 83			// APE tag not found84			unset($info['ape']);85			return false;86 87		}88 89		// shortcut90		$thisfile_ape = &$info['ape'];91 92		$this->fseek($thisfile_ape['tag_offset_end'] - $apetagheadersize);93		$APEfooterData = $this->fread(32);94		if (!($thisfile_ape['footer'] = $this->parseAPEheaderFooter($APEfooterData))) {95			$this->error('Error parsing APE footer at offset '.$thisfile_ape['tag_offset_end']);96			return false;97		}98 99		if (isset($thisfile_ape['footer']['flags']['header']) && $thisfile_ape['footer']['flags']['header']) {100			$this->fseek($thisfile_ape['tag_offset_end'] - $thisfile_ape['footer']['raw']['tagsize'] - $apetagheadersize);101			$thisfile_ape['tag_offset_start'] = $this->ftell();102			$APEtagData = $this->fread($thisfile_ape['footer']['raw']['tagsize'] + $apetagheadersize);103		} else {104			$thisfile_ape['tag_offset_start'] = $thisfile_ape['tag_offset_end'] - $thisfile_ape['footer']['raw']['tagsize'];105			$this->fseek($thisfile_ape['tag_offset_start']);106			$APEtagData = $this->fread($thisfile_ape['footer']['raw']['tagsize']);107		}108		$info['avdataend'] = $thisfile_ape['tag_offset_start'];109 110		if (isset($info['id3v1']['tag_offset_start']) && ($info['id3v1']['tag_offset_start'] < $thisfile_ape['tag_offset_end'])) {111			$this->warning('ID3v1 tag information ignored since it appears to be a false synch in APEtag data');112			unset($info['id3v1']);113			foreach ($info['warning'] as $key => $value) {114				if ($value == 'Some ID3v1 fields do not use NULL characters for padding') {115					unset($info['warning'][$key]);116					sort($info['warning']);117					break;

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ID3/module.tag.apetag.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.