getid3_handler Class Reference

Inheritance diagram for getid3_handler:

Collaboration diagram for getid3_handler:

Public Member Functions
	__construct (getID3 $getid3, $call_module=null)
	Analyze ()
	AnalyzeString ($string)
	setStringMode ($string)
	saveAttachment ($name, $offset, $length, $image_mime=null)

Protected Member Functions
	ftell ()
	fread ($bytes)
	fseek ($bytes, $whence=SEEK_SET)
	feof ()
	isDependencyFor ($module)
	error ($text)
	warning ($text)
	notice ($text)

Protected Attributes
	$getid3
	$data_string_flag = false
	$data_string = ''
	$data_string_position = 0
	$data_string_length = 0

Private Attributes
	$dependency_to = null

Detailed Description

Definition at line 1616 of file getid3.php.

Constructor & Destructor Documentation

__construct()

getid3_handler::__construct	(	getID3	$getid3,
			$call_module = null
	)

Definition at line 1631 of file getid3.php.

                                                                       {
                $this->getid3 = $getid3;

                if ($call_module) {
                        $this->dependency_to = str_replace('getid3_', '', $call_module);
                }
        }

Member Function Documentation

Analyze()

getid3_handler::Analyze ( )

abstract

AnalyzeString()

getid3_handler::AnalyzeString

(

$string

)

Definition at line 1645 of file getid3.php.

                                               {
                // Enter string mode
                $this->setStringMode($string);

                // Save info
                $saved_avdataoffset = $this->getid3->info['avdataoffset'];
                $saved_avdataend    = $this->getid3->info['avdataend'];
                $saved_filesize     = (isset($this->getid3->info['filesize']) ? $this->getid3->info['filesize'] : null); // may be not set if called as dependency without openfile() call

                // Reset some info
                $this->getid3->info['avdataoffset'] = 0;
                $this->getid3->info['avdataend']    = $this->getid3->info['filesize'] = $this->data_string_length;

                // Analyze
                $this->Analyze();

                // Restore some info
                $this->getid3->info['avdataoffset'] = $saved_avdataoffset;
                $this->getid3->info['avdataend']    = $saved_avdataend;
                $this->getid3->info['filesize']     = $saved_filesize;

                // Exit string mode
                $this->data_string_flag = false;
        }

error()

getid3_handler::error (   $text )

protected

Definition at line 1752 of file getid3.php.

References $text.

Referenced by getid3_bonk\Analyze(), getid3_vqf\Analyze(), getid3_zip\Analyze(), getid3_bink\Analyze(), getid3_dss\Analyze(), getid3_wavpack\Analyze(), getid3_efax\Analyze(), getid3_gif\Analyze(), getid3_tiff\Analyze(), getid3_exe\Analyze(), getid3_msoffice\Analyze(), getid3_par2\Analyze(), getid3_pdf\Analyze(), getid3_ts\Analyze(), getid3_mod\Analyze(), getid3_aa\Analyze(), getid3_monkey\Analyze(), getid3_amr\Analyze(), getid3_mpc\Analyze(), getid3_voc\Analyze(), getid3_szip\Analyze(), getid3_tta\Analyze(), getid3_avr\Analyze(), getid3_rkau\Analyze(), getid3_nsv\Analyze(), getid3_shorten\Analyze(), getid3_au\Analyze(), getid3_svg\Analyze(), getid3_apetag\Analyze(), getid3_lpac\Analyze(), getid3_png\Analyze(), getid3_pcd\Analyze(), getid3_real\Analyze(), getid3_la\Analyze(), getid3_swf\Analyze(), getid3_ogg\Analyze(), getid3_dsf\Analyze(), getid3_optimfrog\Analyze(), getid3_bmp\Analyze(), getid3_id3v2\Analyze(), getid3_rar\Analyze(), getid3_midi\Analyze(), getid3_ac3\Analyze(), getid3_quicktime\Analyze(), getid3_flac\Analyze(), getid3_gzip\Analyze(), getid3_mp3\Analyze(), getid3_asf\Analyze(), getid3_riff\Analyze(), getid3_dts\Analyze(), getid3_flv\Analyze(), getid3_matroska\Analyze(), getid3_mp3\decodeMPEGaudioHeader(), getid3_matroska\EnsureBufferHasEnoughData(), getid3_mp3\FreeFormatFrameLength(), getid3_aac\getAACADIFheaderFilepointer(), getid3_aac\getAACADTSheaderFilepointer(), getid3_mod\getITheaderFilepointer(), getid3_lyrics3\getLyrics3Data(), getid3_mod\getMODheaderFilepointer(), getid3_nsv\getNSVfHeaderFilepointer(), getid3_nsv\getNSVsHeaderFilepointer(), getid3_mp3\getOnlyMPEGaudioInfo(), getid3_mp3\getOnlyMPEGaudioInfoBruteForce(), getid3_mod\getS3MheaderFilepointer(), getid3_mod\getXMheaderFilepointer(), getid3_zip\getZIPentriesFilepointer(), getid3_zip\getZIPHeaderFilepointerTopDown(), getid3_bink\ParseBink(), getid3_flac\parseMETAdata(), getid3_mpc\ParseMPCsv7(), getid3_mpc\ParseMPCsv8(), getid3_ogg\ParseOpusPageHeader(), getid3_iso\ParsePathTable(), getid3_iso\ParsePrimaryVolumeDescriptor(), getid3_riff\ParseRIFF(), getid3_flac\parseSTREAMINFO(), getid3_iso\ParseSupplementaryVolumeDescriptor(), getid3_ogg\ParseVorbisPageHeader(), getid3_quicktime\QuicktimeParseAtom(), and getid3_mp3\RecursiveFrameScanning().

                                        {
                $this->getid3->info['error'][] = $text;

                return false;
        }

Here is the caller graph for this function:

feof()

getid3_handler::feof ( )

protected

Definition at line 1741 of file getid3.php.

Referenced by getid3_szip\Analyze(), getid3_amr\Analyze(), getid3_voc\Analyze(), getid3_wavpack\Analyze(), getid3_tar\Analyze(), getid3_matroska\EnsureBufferHasEnoughData(), getid3_mp3\getOnlyMPEGaudioInfo(), getid3_bonk\HandleBonkTags(), getid3_ogg\ParseOggPageHeader(), and getid3_optimfrog\ParseOptimFROGheader45().

                                  {
                if ($this->data_string_flag) {
                        return $this->data_string_position >= $this->data_string_length;
                }
                return feof($this->getid3->fp);
        }

Here is the caller graph for this function:

fread()

getid3_handler::fread (   $bytes )

protected

Definition at line 1683 of file getid3.php.

References $contents, and getid3_lib\intValueSupported().

Referenced by getid3_aac\Analyze(), getid3_vqf\Analyze(), getid3_bonk\Analyze(), getid3_zip\Analyze(), getid3_bink\Analyze(), getid3_dss\Analyze(), getid3_tta\Analyze(), getid3_shorten\Analyze(), getid3_voc\Analyze(), getid3_wavpack\Analyze(), getid3_efax\Analyze(), getid3_gif\Analyze(), getid3_tiff\Analyze(), getid3_exe\Analyze(), getid3_iso\Analyze(), getid3_ts\Analyze(), getid3_mod\Analyze(), getid3_msoffice\Analyze(), getid3_id3v1\Analyze(), getid3_lyrics3\Analyze(), getid3_aa\Analyze(), getid3_monkey\Analyze(), getid3_nsv\Analyze(), getid3_mpc\Analyze(), getid3_rkau\Analyze(), getid3_szip\Analyze(), getid3_au\Analyze(), getid3_amr\Analyze(), getid3_avr\Analyze(), getid3_dsf\Analyze(), getid3_apetag\Analyze(), getid3_real\Analyze(), getid3_svg\Analyze(), getid3_pcd\Analyze(), getid3_png\Analyze(), getid3_la\Analyze(), getid3_lpac\Analyze(), getid3_swf\Analyze(), getid3_ogg\Analyze(), getid3_optimfrog\Analyze(), getid3_bmp\Analyze(), getid3_id3v2\Analyze(), getid3_midi\Analyze(), getid3_ac3\Analyze(), getid3_tar\Analyze(), getid3_flac\Analyze(), getid3_quicktime\Analyze(), getid3_gzip\Analyze(), getid3_mp3\Analyze(), getid3_mpeg\Analyze(), getid3_asf\Analyze(), getid3_riff\Analyze(), getid3_dts\Analyze(), getid3_flv\Analyze(), getid3_mp3\decodeMPEGaudioHeader(), getid3_matroska\EnsureBufferHasEnoughData(), getid3_mp3\FreeFormatFrameLength(), getid3_aac\getAACADIFheaderFilepointer(), getid3_aac\getAACADTSheaderFilepointer(), getid3_mod\getITheaderFilepointer(), getid3_gif\GetLSBits(), getid3_lyrics3\getLyrics3Data(), getid3_mod\getMODheaderFilepointer(), getid3_nsv\getNSVfHeaderFilepointer(), getid3_nsv\getNSVsHeaderFilepointer(), getid3_mp3\getOnlyMPEGaudioInfo(), getid3_mp3\getOnlyMPEGaudioInfoBruteForce(), getid3_mod\getS3MheaderFilepointer(), getid3_mod\getXMheaderFilepointer(), getid3_bonk\HandleBonkTags(), getid3_iso\ParseDirectoryRecord(), getid3_flac\parseMETAdata(), getid3_mpc\ParseMPCsv6(), getid3_mpc\ParseMPCsv7(), getid3_mpc\ParseMPCsv8(), getid3_ogg\ParseOggPageHeader(), getid3_optimfrog\ParseOptimFROGheader42(), getid3_optimfrog\ParseOptimFROGheader45(), getid3_iso\ParsePathTable(), getid3_flac\parsePICTURE(), getid3_riff\ParseRIFF(), getid3_riff\ParseRIFFAMV(), getid3_ogg\ParseVorbisComments(), getid3_zip\ZIPparseCentralDirectory(), getid3_zip\ZIPparseEndOfCentralDirectory(), and getid3_zip\ZIPparseLocalFileHeader().

                                         {
                if ($this->data_string_flag) {
                        $this->data_string_position += $bytes;
                        return substr($this->data_string, $this->data_string_position - $bytes, $bytes);
                }
                $pos = $this->ftell() + $bytes;
                if (!getid3_lib::intValueSupported($pos)) {
                        throw new getid3_exception('cannot fread('.$bytes.' from '.$this->ftell().') because beyond PHP filesystem limit', 10);
                }

                //return fread($this->getid3->fp, $bytes);
                /*
                * http://www.getid3.org/phpBB3/viewtopic.php?t=1930
                * "I found out that the root cause for the problem was how getID3 uses the PHP system function fread().
                * It seems to assume that fread() would always return as many bytes as were requested.
                * However, according the PHP manual (http://php.net/manual/en/function.fread.php), this is the case only with regular local files, but not e.g. with Linux pipes.
                * The call may return only part of the requested data and a new call is needed to get more."
                */
                $contents = '';
                do {
                        $part = fread($this->getid3->fp, $bytes);
                        $partLength  = strlen($part);
                        $bytes      -= $partLength;
                        $contents   .= $part;
                } while (($bytes > 0) && ($partLength > 0));
                return $contents;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

fseek()

getid3_handler::fseek (   $bytes,   $whence = SEEK_SET  )

protected

Definition at line 1711 of file getid3.php.

References getid3_lib\intValueSupported().

Referenced by getid3_aac\Analyze(), getid3_vqf\Analyze(), getid3_bonk\Analyze(), getid3_zip\Analyze(), getid3_bink\Analyze(), getid3_dss\Analyze(), getid3_wavpack\Analyze(), getid3_efax\Analyze(), getid3_gif\Analyze(), getid3_tiff\Analyze(), getid3_exe\Analyze(), getid3_iso\Analyze(), getid3_msoffice\Analyze(), getid3_ts\Analyze(), getid3_mod\Analyze(), getid3_id3v1\Analyze(), getid3_lyrics3\Analyze(), getid3_aa\Analyze(), getid3_monkey\Analyze(), getid3_nsv\Analyze(), getid3_mpc\Analyze(), getid3_voc\Analyze(), getid3_tta\Analyze(), getid3_shorten\Analyze(), getid3_szip\Analyze(), getid3_au\Analyze(), getid3_amr\Analyze(), getid3_rkau\Analyze(), getid3_avr\Analyze(), getid3_dsf\Analyze(), getid3_apetag\Analyze(), getid3_real\Analyze(), getid3_pcd\Analyze(), getid3_svg\Analyze(), getid3_la\Analyze(), getid3_lpac\Analyze(), getid3_png\Analyze(), getid3_swf\Analyze(), getid3_ogg\Analyze(), getid3_optimfrog\Analyze(), getid3_bmp\Analyze(), getid3_jpg\Analyze(), getid3_id3v2\Analyze(), getid3_midi\Analyze(), getid3_ac3\Analyze(), getid3_tar\Analyze(), getid3_flac\Analyze(), getid3_quicktime\Analyze(), getid3_gzip\Analyze(), getid3_mp3\Analyze(), getid3_mpeg\Analyze(), getid3_asf\Analyze(), getid3_riff\Analyze(), getid3_dts\Analyze(), getid3_flv\Analyze(), getid3_mp3\decodeMPEGaudioHeader(), getid3_matroska\EnsureBufferHasEnoughData(), getid3_mp3\FreeFormatFrameLength(), getid3_aac\getAACADIFheaderFilepointer(), getid3_aac\getAACADTSheaderFilepointer(), getid3_mod\getITheaderFilepointer(), getid3_lyrics3\getLyrics3Data(), getid3_mod\getMODheaderFilepointer(), getid3_nsv\getNSVfHeaderFilepointer(), getid3_nsv\getNSVsHeaderFilepointer(), getid3_mp3\getOnlyMPEGaudioInfo(), getid3_mp3\getOnlyMPEGaudioInfoBruteForce(), getid3_mod\getS3MheaderFilepointer(), getid3_mod\getXMheaderFilepointer(), getid3_bonk\HandleBonkTags(), getid3_iso\ParseDirectoryRecord(), getid3_mpc\ParseMPCsv6(), getid3_mpc\ParseMPCsv8(), getid3_ogg\ParseOggPageHeader(), getid3_optimfrog\ParseOptimFROGheader42(), getid3_optimfrog\ParseOptimFROGheader45(), getid3_iso\ParsePathTable(), getid3_riff\ParseRIFF(), getid3_riff\ParseRIFFAMV(), getid3_ogg\ParseVorbisComments(), getid3_zip\ZIPparseCentralDirectory(), getid3_zip\ZIPparseEndOfCentralDirectory(), and getid3_zip\ZIPparseLocalFileHeader().

                                                           {
                if ($this->data_string_flag) {
                        switch ($whence) {
                                case SEEK_SET:
                                        $this->data_string_position = $bytes;
                                        break;

                                case SEEK_CUR:
                                        $this->data_string_position += $bytes;
                                        break;

                                case SEEK_END:
                                        $this->data_string_position = $this->data_string_length + $bytes;
                                        break;
                        }
                        return 0;
                } else {
                        $pos = $bytes;
                        if ($whence == SEEK_CUR) {
                                $pos = $this->ftell() + $bytes;
                        } elseif ($whence == SEEK_END) {
                                $pos = $this->getid3->info['filesize'] + $bytes;
                        }
                        if (!getid3_lib::intValueSupported($pos)) {
                                throw new getid3_exception('cannot fseek('.$pos.') because beyond PHP filesystem limit', 10);
                        }
                }
                return fseek($this->getid3->fp, $bytes, $whence);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ftell()

getid3_handler::ftell ( )

protected

Definition at line 1676 of file getid3.php.

Referenced by getid3_bonk\Analyze(), getid3_vqf\Analyze(), getid3_voc\Analyze(), getid3_wavpack\Analyze(), getid3_ogg\Analyze(), getid3_real\Analyze(), getid3_png\Analyze(), getid3_apetag\Analyze(), getid3_midi\Analyze(), getid3_asf\Analyze(), getid3_riff\Analyze(), getid3_flv\Analyze(), getid3_aac\getAACADTSheaderFilepointer(), getid3_lyrics3\getLyrics3Data(), getid3_mp3\getOnlyMPEGaudioInfo(), getid3_mp3\getOnlyMPEGaudioInfoBruteForce(), getid3_flac\parseMETAdata(), getid3_mpc\ParseMPCsv8(), getid3_ogg\ParseOggPageHeader(), getid3_optimfrog\ParseOptimFROGheader45(), getid3_flac\parsePICTURE(), getid3_riff\ParseRIFF(), getid3_ogg\ParseVorbisComments(), getid3_zip\ZIPparseCentralDirectory(), getid3_zip\ZIPparseEndOfCentralDirectory(), and getid3_zip\ZIPparseLocalFileHeader().

                                   {
                if ($this->data_string_flag) {
                        return $this->data_string_position;
                }
                return ftell($this->getid3->fp);
        }

Here is the caller graph for this function:

isDependencyFor()

getid3_handler::isDependencyFor (   $module )

finalprotected

Definition at line 1748 of file getid3.php.

References $module.

Referenced by getid3_ac3\Analyze(), getid3_dts\Analyze(), getid3_mp3\decodeMPEGaudioHeader(), getid3_flac\parseMETAdata(), getid3_flac\parseSTREAMINFO(), and getid3_flac\parseVORBIS_COMMENT().

                                                          {
                return $this->dependency_to == $module;
        }

Here is the caller graph for this function:

notice()

getid3_handler::notice (   $text )

protected

Definition at line 1762 of file getid3.php.

Referenced by getid3_ogg\ParseVorbisComments().

                                         {
                // does nothing for now
        }

Here is the caller graph for this function:

saveAttachment()

getid3_handler::saveAttachment	(		$name,
			$offset,
			$length,
			$image_mime = null
	)

Definition at line 1766 of file getid3.php.

References $name, array, getID3\ATTACHMENTS_INLINE, getID3\ATTACHMENTS_NONE, and getID3\warning().

Referenced by getid3_matroska\parseEBML(), and getid3_flac\parsePICTURE().

                                                                                  {
                try {

                        // do not extract at all
                        if ($this->getid3->option_save_attachments === getID3::ATTACHMENTS_NONE) {

                                $attachment = null; // do not set any

                        // extract to return array
                        } elseif ($this->getid3->option_save_attachments === getID3::ATTACHMENTS_INLINE) {

                                $this->fseek($offset);
                                $attachment = $this->fread($length); // get whole data in one pass, till it is anyway stored in memory
                                if ($attachment === false || strlen($attachment) != $length) {
                                        throw new Exception('failed to read attachment data');
                                }

                        // assume directory path is given
                        } else {

                                // set up destination path
                                $dir = rtrim(str_replace(array('/', '\\'), DIRECTORY_SEPARATOR, $this->getid3->option_save_attachments), DIRECTORY_SEPARATOR);
                                if (!is_dir($dir) || !is_writable($dir)) { // check supplied directory
                                        throw new Exception('supplied path ('.$dir.') does not exist, or is not writable');
                                }
                                $dest = $dir.DIRECTORY_SEPARATOR.$name.($image_mime ? '.'.getid3_lib::ImageExtFromMime($image_mime) : '');

                                // create dest file
                                if (($fp_dest = fopen($dest, 'wb')) == false) {
                                        throw new Exception('failed to create file '.$dest);
                                }

                                // copy data
                                $this->fseek($offset);
                                $buffersize = ($this->data_string_flag ? $length : $this->getid3->fread_buffer_size());
                                $bytesleft = $length;
                                while ($bytesleft > 0) {
                                        if (($buffer = $this->fread(min($buffersize, $bytesleft))) === false || ($byteswritten = fwrite($fp_dest, $buffer)) === false || ($byteswritten === 0)) {
                                                throw new Exception($buffer === false ? 'not enough data to read' : 'failed to write to destination file, may be not enough disk space');
                                        }
                                        $bytesleft -= $byteswritten;
                                }

                                fclose($fp_dest);
                                $attachment = $dest;

                        }

                } catch (Exception $e) {

                        // close and remove dest file if created
                        if (isset($fp_dest) && is_resource($fp_dest)) {
                                fclose($fp_dest);
                                unlink($dest);
                        }

                        // do not set any is case of error
                        $attachment = null;
                        $this->warning('Failed to extract attachment '.$name.': '.$e->getMessage());

                }

                // seek to the end of attachment
                $this->fseek($offset + $length);

                return $attachment;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setStringMode()

getid3_handler::setStringMode

(

$string

)

Definition at line 1670 of file getid3.php.

                                               {
                $this->data_string_flag   = true;
                $this->data_string        = $string;
                $this->data_string_length = strlen($string);
        }

warning()

getid3_handler::warning (   $text )

protected

Definition at line 1758 of file getid3.php.

References $text.

Referenced by getid3_bonk\Analyze(), getid3_vqf\Analyze(), getid3_aa\Analyze(), getid3_zip\Analyze(), getid3_nsv\Analyze(), getid3_id3v1\Analyze(), getid3_voc\Analyze(), getid3_wavpack\Analyze(), getid3_au\Analyze(), getid3_avr\Analyze(), getid3_lyrics3\Analyze(), getid3_ogg\Analyze(), getid3_png\Analyze(), getid3_apetag\Analyze(), getid3_real\Analyze(), getid3_la\Analyze(), getid3_lpac\Analyze(), getid3_id3v2\Analyze(), getid3_jpg\Analyze(), getid3_midi\Analyze(), getid3_ac3\Analyze(), getid3_quicktime\Analyze(), getid3_mp3\Analyze(), getid3_mpeg\Analyze(), getid3_asf\Analyze(), getid3_riff\Analyze(), getid3_matroska\Analyze(), getid3_mp3\decodeMPEGaudioHeader(), getid3_matroska\EnsureBufferHasEnoughData(), getid3_mp3\FreeFormatFrameLength(), getid3_aac\getAACADTSheaderFilepointer(), getid3_lyrics3\getLyrics3Data(), getid3_nsv\getNSVfHeaderFilepointer(), getid3_mp3\getOnlyMPEGaudioInfo(), getid3_mp3\getOnlyMPEGaudioInfoBruteForce(), getid3_bonk\HandleBonkTags(), getid3_asf\HeaderExtensionObjectDataParse(), getid3_matroska\parseEBML(), getid3_id3v2\ParseID3v2Frame(), getid3_flac\parseMETAdata(), getid3_mpc\ParseMPCsv6(), getid3_optimfrog\ParseOptimFROGheader45(), getid3_riff\ParseRIFF(), getid3_riff\ParseRIFFAMV(), getid3_flac\parseSTREAMINFO(), getid3_ogg\ParseVorbisComments(), getid3_quicktime\QuicktimeParseAtom(), getid3_mp3\RecursiveFrameScanning(), getid3_matroska\unhandledElement(), and getid3_zip\ZIPparseLocalFileHeader().

                                          {
                return $this->getid3->warning($text);
        }

Here is the caller graph for this function:

Field Documentation

$data_string

getid3_handler::$data_string = ''

protected

Definition at line 1624 of file getid3.php.

$data_string_flag

getid3_handler::$data_string_flag = false

protected

Definition at line 1623 of file getid3.php.

$data_string_length

getid3_handler::$data_string_length = 0

protected

Definition at line 1626 of file getid3.php.

$data_string_position

getid3_handler::$data_string_position = 0

protected

Definition at line 1625 of file getid3.php.

$dependency_to

getid3_handler::$dependency_to = null

private

Definition at line 1628 of file getid3.php.

$getid3

getid3_handler::$getid3

protected

Definition at line 1621 of file getid3.php.

Referenced by getid3_ogg\ParseVorbisComments().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/james-heinrich/getid3/getid3/getid3.php