<?
/**
* PEAR, the PHP Extension and Application Repository
*
* PEAR class and PEAR_Error class
*
* PHP versions 4 and 5
*
* @category pear
* @package PEAR
* @author Sterling Hughes <[email protected]>
* @author Stig Bakken <[email protected]>
* @Authors: Sandy McArthur Jr. <[email protected]>
* @author Tomas V.V.Cox <[email protected]>
* @author Greg Beaver <[email protected]>
* @copyright 1997-2010 The Authors
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @version CVS: $Id: PEAR.php 313023 2011-07-06 19:17:11Z dufuz $
* @link http://pear.php.net/package/PEAR
* @since File available since Release 0.1
*/
/**#@+
* ERROR constants
*/
define('PEAR_ERROR_RETURN', 1);
define('PEAR_ERROR_PRINT', 2);
define('PEAR_ERROR_TRIGGER', 4);
define('PEAR_ERROR_DIE', 8);
define('PEAR_ERROR_CALLBACK', 16);
/**
* WARNING: obsolete
* @deprecated
*/
define('PEAR_ERROR_EXCEPTION', 32);
/**#@-*/
define('PEAR_ZE2', (function_exists('version_compare') &&
version_compare(zend_version(), "2-dev", "ge")));
if (substr(PHP_OS, 0, 3) == 'WIN') {
define('OS_WINDOWS', true);
define('OS_UNIX', false);
define('PEAR_OS', 'Windows');
} else {
define('OS_WINDOWS', false);
define('OS_UNIX', true);
define('PEAR_OS', 'Unix'); // blatant assumption
}
$GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_RETURN;
$GLOBALS['_PEAR_default_error_options'] = E_USER_NOTICE;
$GLOBALS['_PEAR_destructor_object_list'] = array();
$GLOBALS['_PEAR_shutdown_funcs'] = array();
$GLOBALS['_PEAR_error_handler_stack'] = array();
@ini_set('track_errors', true);
/**
* Base class for other PEAR classes. Provides rudimentary
* emulation of destructors.
*
* If you want a destructor in your class, inherit PEAR and make a
* destructor method called _yourclassname (same name as the
* constructor, but with a "_" prefix). Also, in your constructor you
* have to call the PEAR constructor: $this->PEAR();.
* The destructor method will be called without parameters. Note that
* at in some SAPI implementations (such as Apache), any output during
* the request shutdown (in which destructors are called) seems to be
* discarded. If you need to get any debug information from your
* destructor, use error_log(), syslog() or something similar.
*
* IMPORTANT! To use the emulated destructors you need to create the
* objects by reference: $obj =& new PEAR_child;
*
* @category pear
* @package PEAR
* @author Stig Bakken <[email protected]>
* @author Tomas V.V. Cox <[email protected]>
* @author Greg Beaver <[email protected]>
* @copyright 1997-2006 The PHP Group
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @version Release: 1.9.4
* @link http://pear.php.net/package/PEAR
* @see PEAR_Error
* @since Class available since PHP 4.0.2
* @link http://pear.php.net/manual/en/core.pear.php#core.pear.pear
*/
class PEAR
{
/**
* Whether to enable internal debug messages.
*
* @var bool
* @access private
*/
var $_debug = false;
/**
* Default error mode for this object.
*
* @var int
* @access private
*/
var $_default_error_mode = null;
/**
* Default error options used for this object when error mode
* is PEAR_ERROR_TRIGGER.
*
* @var int
* @access private
*/
var $_default_error_options = null;
/**
* Default error handler (callback) for this object, if error mode is
* PEAR_ERROR_CALLBACK.
*
* @var string
* @access private
*/
var $_default_error_handler = '';
/**
* Which class to use for error objects.
*
* @var string
* @access private
*/
var $_error_class = 'PEAR_Error';
/**
* An array of expected errors.
*
* @var array
* @access private
*/
var $_expected_errors = array();
/**
* Constructor. Registers this object in
* $_PEAR_destructor_object_list for destructor emulation if a
* destructor object exists.
*
* @param string $error_class (optional) which class to use for
* error objects, defaults to PEAR_Error.
* @access public
* @return void
*/
function PEAR($error_class = null)
{
$classname = strtolower(get_class($this));
if ($this->_debug) {
print "PEAR constructor called, class=$classname\n";
}
if ($error_class !== null) {
$this->_error_class = $error_class;
}
while ($classname && strcasecmp($classname, "pear")) {
$destructor = "_$classname";
if (method_exists($this, $destructor)) {
global $_PEAR_destructor_object_list;
$_PEAR_destructor_object_list[] = &$this;
if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
register_shutdown_function("_PEAR_call_destructors");
$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
}
break;
} else {
$classname = get_parent_class($classname);
}
}
}
/**
* Destructor (the emulated type of...). Does nothing right now,
* but is included for forward compatibility, so subclass
* destructors should always call it.
*
* See the note in the class desciption about output from
* destructors.
*
* @access public
* @return void
*/
function _PEAR() {
if ($this->_debug) {
printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
}
}
/**
* If you have a class that's mostly/entirely static, and you need static
* properties, you can use this method to simulate them. Eg. in your method(s)
* do this: $myVar = &PEAR::getStaticProperty('myclass', 'myVar');
* You MUST use a reference, or they will not persist!
*
* @access public
* @param string $class The calling classname, to prevent clashes
* @param string $var The variable to retrieve.
* @return mixed A reference to the variable. If not set it will be
* auto initialised to NULL.
*/
function &getStaticProperty($class, $var)
{
static $properties;
if (!isset($properties[$class])) {
$properties[$class] = array();
}
if (!array_key_exists($var, $properties[$class])) {
$properties[$class][$var] = null;
}
return $properties[$class][$var];
}
/**
* Use this function to register a shutdown method for static
* classes.
*
* @access public
* @param mixed $func The function name (or array of class/method) to call
* @param mixed $args The arguments to pass to the function
* @return void
*/
function registerShutdownFunc($func, $args = array())
{
// if we are called statically, there is a potential
// that no shutdown func is registered. Bug #6445
if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
register_shutdown_function("_PEAR_call_destructors");
$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
}
$GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);
}
/**
* Tell whether a value is a PEAR error.
*
* @param mixed $data the value to test
* @param int $code if $data is an error object, return true
* only if $code is a string and
* $obj->getMessage() == $code or
* $code is an integer and $obj->getCode() == $code
* @access public
* @return bool true if parameter is an error
*/
function isError($data, $code = null)
{
if (!is_a($data, 'PEAR_Error')) {
return false;
}
if (is_null($code)) {
return true;
} elseif (is_string($code)) {
return $data->getMessage() == $code;
}
return $data->getCode() == $code;
}
/**
* Sets how errors generated by this object should be handled.
* Can be invoked both in objects and statically. If called
* statically, setErrorHandling sets the default behaviour for all
* PEAR objects. If called in an object, setErrorHandling sets
* the default behaviour for that object.
*
* @param int $mode
* One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
* PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION.
*
* @param mixed $options
* When $mode is PEAR_ERROR_TRIGGER, this is the error level (one
* of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
*
* When $mode is PEAR_ERROR_CALLBACK, this parameter is expected
* to be the callback function or method. A callback
* function is a string with the name of the function, a
* callback method is an array of two elements: the element
* at index 0 is the object, and the element at index 1 is
* the name of the method to call in the object.
*
* When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is
* a printf format string used when printing the error
* message.
*
* @access public
* @return void
* @see PEAR_ERROR_RETURN
* @see PEAR_ERROR_PRINT
* @see PEAR_ERROR_TRIGGER
* @see PEAR_ERROR_DIE
* @see PEAR_ERROR_CALLBACK
* @see PEAR_ERROR_EXCEPTION
*
* @since PHP 4.0.5
*/
function setErrorHandling($mode = null, $options = null)
{
if (isset($this) && is_a($this, 'PEAR')) {
$setmode = &$this->_default_error_mode;
$setoptions = &$this->_default_error_options;
} else {
$setmode = &$GLOBALS['_PEAR_default_error_mode'];
$setoptions = &$GLOBALS['_PEAR_default_error_options'];
}
switch ($mode) {
case PEAR_ERROR_EXCEPTION:
case PEAR_ERROR_RETURN:
case PEAR_ERROR_PRINT:
case PEAR_ERROR_TRIGGER:
case PEAR_ERROR_DIE:
case null:
$setmode = $mode;
$setoptions = $options;
break;
case PEAR_ERROR_CALLBACK:
$setmode = $mode;
// class/object method callback
if (is_callable($options)) {
$setoptions = $options;
} else {
trigger_error("invalid error callback", E_USER_WARNING);
}
break;
default:
trigger_error("invalid error mode", E_USER_WARNING);
break;
}
}
/**
* This method is used to tell which errors you expect to get.
* Expected errors are always returned with error mode
* PEAR_ERROR_RETURN. Expected error codes are stored in a stack,
* and this method pushes a new element onto it. The list of
* expected errors are in effect until they are popped off the
* stack with the popExpect() method.
*
* Note that this method can not be called statically
*
* @param mixed $code a single error code or an array of error codes to expect
*
* @return int the new depth of the "expected errors" stack
* @access public
*/
function expectError($code = '*')
{
if (is_array($code)) {
array_push($this->_expected_errors, $code);
} else {
array_push($this->_expected_errors, array($code));
}
return count($this->_expected_errors);
}
/**
* This method pops one element off the expected error codes
* stack.
*
* @return array the list of error codes that were popped
*/
function popExpect()
{
return array_pop($this->_expected_errors);
}
/**
* This method checks unsets an error code if available
*
* @param mixed error code
* @return bool true if the error code was unset, false otherwise
* @access private
* @since PHP 4.3.0
*/
function _checkDelExpect($error_code)
{
$deleted = false;
foreach ($this->_expected_errors as $key => $error_array) {
if (in_array($error_code, $error_array)) {
unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);
$deleted = true;
}
// clean up empty arrays
if (0 == count($this->_expected_errors[$key])) {
unset($this->_expected_errors[$key]);
}
}
return $deleted;
}
/**
* This method deletes all occurences of the specified element from
* the expected error codes stack.
*
* @param mixed $error_code error code that should be deleted
* @return mixed list of error codes that were deleted or error
* @access public
* @since PHP 4.3.0
*/
function delExpect($error_code)
{
$deleted = false;
if ((is_array($error_code) && (0 != count($error_code)))) {
// $error_code is a non-empty array here; we walk through it trying
// to unset all values
foreach ($error_code as $key => $error) {
$deleted = $this->_checkDelExpect($error) ? true : false;
}
return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME
} elseif (!empty($error_code)) {
// $error_code comes alone, trying to unset it
if ($this->_checkDelExpect($error_code)) {
return true;
}
return PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME
}
// $error_code is empty
return PEAR::raiseError("The expected error you submitted is empty"); // IMPROVE ME
}
/**
* This method is a wrapper that returns an instance of the
* configured error class with this object's default error
* handling applied. If the $mode and $options parameters are not
* specified, the object's defaults are used.
*
* @param mixed $message a text error message or a PEAR error object
*
* @param int $code a numeric error code (it is up to your class
* to define these if you want to use codes)
*
* @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
* PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.
*
* @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter
* specifies the PHP-internal error level (one of
* E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
* If $mode is PEAR_ERROR_CALLBACK, this
* parameter specifies the callback function or
* method. In other error modes this parameter
* is ignored.
*
* @param string $userinfo If you need to pass along for example debug
* information, this parameter is meant for that.
*
* @param string $error_class The returned error object will be
* instantiated from this class, if specified.
*
* @param bool $skipmsg If true, raiseError will only pass error codes,
* the error message parameter will be dropped.
*
* @access public
* @return object a PEAR error object
* @see PEAR::setErrorHandling
* @since PHP 4.0.5
*/
function &raiseError($message = null,
$code = null,
$mode = null,
$options = null,
$userinfo = null,
$error_class = null,
$skipmsg = false)
{
// The error is yet a PEAR error object
if (is_object($message)) {
$code = $message->getCode();
$userinfo = $message->getUserInfo();
$error_class = $message->getType();
$message->error_message_prefix = '';
$message = $message->getMessage();
}
if (
isset($this) &&
isset($this->_expected_errors) &&
count($this->_expected_errors) > 0 &&
count($exp = end($this->_expected_errors))
) {
if ($exp[0] == "*" ||
(is_int(reset($exp)) && in_array($code, $exp)) ||
(is_string(reset($exp)) && in_array($message, $exp))
) {
$mode = PEAR_ERROR_RETURN;
}
}
// No mode given, try global ones
if ($mode === null) {
// Class error handler
if (isset($this) && isset($this->_default_error_mode)) {
$mode = $this->_default_error_mode;
$options = $this->_default_error_options;
// Global error handler
} elseif (isset($GLOBALS['_PEAR_default_error_mode'])) {
$mode = $GLOBALS['_PEAR_default_error_mode'];
$options = $GLOBALS['_PEAR_default_error_options'];
}
}
if ($error_class !== null) {
$ec = $error_class;
} elseif (isset($this) && isset($this->_error_class)) {
$ec = $this->_error_class;
} else {
$ec = 'PEAR_Error';
}
if (intval(PHP_VERSION) < 5) {
// little non-eval hack to fix bug #12147
include 'PEAR/FixPHP5PEARWarnings.php';
return $a;
}
if ($skipmsg) {
$a = new $ec($code, $mode, $options, $userinfo);
} else {
$a = new $ec($message, $code, $mode, $options, $userinfo);
}
return $a;
}
/**
* Simpler form of raiseError with fewer options. In most cases
* message, code and userinfo are enough.
*
* @param mixed $message a text error message or a PEAR error object
*
* @param int $code a numeric error code (it is up to your class
* to define these if you want to use codes)
*
* @param string $userinfo If you need to pass along for example debug
* information, this parameter is meant for that.
*
* @access public
* @return object a PEAR error object
* @see PEAR::raiseError
*/
function &throwError($message = null, $code = null, $userinfo = null)
{
if (isset($this) && is_a($this, 'PEAR')) {
$a = &$this->raiseError($message, $code, null, null, $userinfo);
return $a;
}
$a = &PEAR::raiseError($message, $code, null, null, $userinfo);
return $a;
}
function staticPushErrorHandling($mode, $options = null)
{
$stack = &$GLOBALS['_PEAR_error_handler_stack'];
$def_mode = &$GLOBALS['_PEAR_default_error_mode'];
$def_options = &$GLOBALS['_PEAR_default_error_options'];
$stack[] = array($def_mode, $def_options);
switch ($mode) {
case PEAR_ERROR_EXCEPTION:
case PEAR_ERROR_RETURN:
case PEAR_ERROR_PRINT:
case PEAR_ERROR_TRIGGER:
case PEAR_ERROR_DIE:
case null:
$def_mode = $mode;
$def_options = $options;
break;
case PEAR_ERROR_CALLBACK:
$def_mode = $mode;
// class/object method callback
if (is_callable($options)) {
$def_options = $options;
} else {
trigger_error("invalid error callback", E_USER_WARNING);
}
break;
default:
trigger_error("invalid error mode", E_USER_WARNING);
break;
}
$stack[] = array($mode, $options);
return true;
}
function staticPopErrorHandling()
{
$stack = &$GLOBALS['_PEAR_error_handler_stack'];
$setmode = &$GLOBALS['_PEAR_default_error_mode'];
$setoptions = &$GLOBALS['_PEAR_default_error_options'];
array_pop($stack);
list($mode, $options) = $stack[sizeof($stack) - 1];
array_pop($stack);
switch ($mode) {
case PEAR_ERROR_EXCEPTION:
case PEAR_ERROR_RETURN:
case PEAR_ERROR_PRINT:
case PEAR_ERROR_TRIGGER:
case PEAR_ERROR_DIE:
case null:
$setmode = $mode;
$setoptions = $options;
break;
case PEAR_ERROR_CALLBACK:
$setmode = $mode;
// class/object method callback
if (is_callable($options)) {
$setoptions = $options;
} else {
trigger_error("invalid error callback", E_USER_WARNING);
}
break;
default:
trigger_error("invalid error mode", E_USER_WARNING);
break;
}
return true;
}
/**
* Push a new error handler on top of the error handler options stack. With this
* you can easily override the actual error handler for some code and restore
* it later with popErrorHandling.
*
* @param mixed $mode (same as setErrorHandling)
* @param mixed $options (same as setErrorHandling)
*
* @return bool Always true
*
* @see PEAR::setErrorHandling
*/
function pushErrorHandling($mode, $options = null)
{
$stack = &$GLOBALS['_PEAR_error_handler_stack'];
if (isset($this) && is_a($this, 'PEAR')) {
$def_mode = &$this->_default_error_mode;
$def_options = &$this->_default_error_options;
} else {
$def_mode = &$GLOBALS['_PEAR_default_error_mode'];
$def_options = &$GLOBALS['_PEAR_default_error_options'];
}
$stack[] = array($def_mode, $def_options);
if (isset($this) && is_a($this, 'PEAR')) {
$this->setErrorHandling($mode, $options);
} else {
PEAR::setErrorHandling($mode, $options);
}
$stack[] = array($mode, $options);
return true;
}
/**
* Pop the last error handler used
*
* @return bool Always true
*
* @see PEAR::pushErrorHandling
*/
function popErrorHandling()
{
$stack = &$GLOBALS['_PEAR_error_handler_stack'];
array_pop($stack);
list($mode, $options) = $stack[sizeof($stack) - 1];
array_pop($stack);
if (isset($this) && is_a($this, 'PEAR')) {
$this->setErrorHandling($mode, $options);
} else {
PEAR::setErrorHandling($mode, $options);
}
return true;
}
/**
* OS independant PHP extension load. Remember to take care
* on the correct extension name for case sensitive OSes.
*
* @param string $ext The extension name
* @return bool Success or not on the dl() call
*/
function loadExtension($ext)
{
if (extension_loaded($ext)) {
return true;
}
// if either returns true dl() will produce a FATAL error, stop that
if (
function_exists('dl') === false ||
ini_get('enable_dl') != 1 ||
ini_get('safe_mode') == 1
) {
return false;
}
if (OS_WINDOWS) {
$suffix = '.dll';
} elseif (PHP_OS == 'HP-UX') {
$suffix = '.sl';
} elseif (PHP_OS == 'AIX') {
$suffix = '.a';
} elseif (PHP_OS == 'OSX') {
$suffix = '.bundle';
} else {
$suffix = '.so';
}
return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix);
}
}
if (PEAR_ZE2) {
include_once 'PEAR5.php';
}
function _PEAR_call_destructors()
{
global $_PEAR_destructor_object_list;
if (is_array($_PEAR_destructor_object_list) &&
sizeof($_PEAR_destructor_object_list))
{
reset($_PEAR_destructor_object_list);
if (PEAR_ZE2) {
$destructLifoExists = PEAR5::getStaticProperty('PEAR', 'destructlifo');
} else {
$destructLifoExists = PEAR::getStaticProperty('PEAR', 'destructlifo');
}
if ($destructLifoExists) {
$_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list);
}
while (list($k, $objref) = each($_PEAR_destructor_object_list)) {
$classname = get_class($objref);
while ($classname) {
$destructor = "_$classname";
if (method_exists($objref, $destructor)) {
$objref->$destructor();
break;
} else {
$classname = get_parent_class($classname);
}
}
}
// Empty the object list to ensure that destructors are
// not called more than once.
$_PEAR_destructor_object_list = array();
}
// Now call the shutdown functions
if (
isset($GLOBALS['_PEAR_shutdown_funcs']) &&
is_array($GLOBALS['_PEAR_shutdown_funcs']) &&
!empty($GLOBALS['_PEAR_shutdown_funcs'])
) {
foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) {
call_user_func_array($value[0], $value[1]);
}
}
}
/**
* Standard PEAR error class for PHP 4
*
* This class is supserseded by {@link PEAR_Exception} in PHP 5
*
* @category pear
* @package PEAR
* @author Stig Bakken <[email protected]>
* @author Tomas V.V. Cox <[email protected]>
* @author Gregory Beaver <[email protected]>
* @copyright 1997-2006 The PHP Group
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @version Release: 1.9.4
* @link http://pear.php.net/manual/en/core.pear.pear-error.php
* @see PEAR::raiseError(), PEAR::throwError()
* @since Class available since PHP 4.0.2
*/
class PEAR_Error
{
var $error_message_prefix = '';
var $mode = PEAR_ERROR_RETURN;
var $level = E_USER_NOTICE;
var $code = -1;
var $message = '';
var $userinfo = '';
var $backtrace = null;
/**
* PEAR_Error constructor
*
* @param string $message message
*
* @param int $code (optional) error code
*
* @param int $mode (optional) error mode, one of: PEAR_ERROR_RETURN,
* PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER,
* PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION
*
* @param mixed $options (optional) error level, _OR_ in the case of
* PEAR_ERROR_CALLBACK, the callback function or object/method
* tuple.
*
* @param string $userinfo (optional) additional user/debug info
*
* @access public
*
*/
function PEAR_Error($message = 'unknown error', $code = null,
$mode = null, $options = null, $userinfo = null)
{
if ($mode === null) {
$mode = PEAR_ERROR_RETURN;
}
$this->message = $message;
$this->code = $code;
$this->mode = $mode;
$this->userinfo = $userinfo;
if (PEAR_ZE2) {
$skiptrace = PEAR5::getStaticProperty('PEAR_Error', 'skiptrace');
} else {
$skiptrace = PEAR::getStaticProperty('PEAR_Error', 'skiptrace');
}
if (!$skiptrace) {
$this->backtrace = debug_backtrace();
if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) {
unset($this->backtrace[0]['object']);
}
}
if ($mode & PEAR_ERROR_CALLBACK) {
$this->level = E_USER_NOTICE;
$this->callback = $options;
} else {
if ($options === null) {
$options = E_USER_NOTICE;
}
$this->level = $options;
$this->callback = null;
}
if ($this->mode & PEAR_ERROR_PRINT) {
if (is_null($options) || is_int($options)) {
$format = "%s";
} else {
$format = $options;
}
printf($format, $this->getMessage());
}
if ($this->mode & PEAR_ERROR_TRIGGER) {
trigger_error($this->getMessage(), $this->level);
}
if ($this->mode & PEAR_ERROR_DIE) {
$msg = $this->getMessage();
if (is_null($options) || is_int($options)) {
$format = "%s";
if (substr($msg, -1) != "\n") {
$msg .= "\n";
}
} else {
$format = $options;
}
die(sprintf($format, $msg));
}
if ($this->mode & PEAR_ERROR_CALLBACK && is_callable($this->callback)) {
call_user_func($this->callback, $this);
}
if ($this->mode & PEAR_ERROR_EXCEPTION) {
trigger_error("PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions", E_USER_WARNING);
eval('$e = new Exception($this->message, $this->code);throw($e);');
}
}
/**
* Get the error mode from an error object.
*
* @return int error mode
* @access public
*/
function getMode()
{
return $this->mode;
}
/**
* Get the callback function/method from an error object.
*
* @return mixed callback function or object/method array
* @access public
*/
function getCallback()
{
return $this->callback;
}
/**
* Get the error message from an error object.
*
* @return string full error message
* @access public
*/
function getMessage()
{
return ($this->error_message_prefix . $this->message);
}
/**
* Get error code from an error object
*
* @return int error code
* @access public
*/
function getCode()
{
return $this->code;
}
/**
* Get the name of this error/exception.
*
* @return string error/exception name (type)
* @access public
*/
function getType()
{
return get_class($this);
}
/**
* Get additional user-supplied information.
*
* @return string user-supplied information
* @access public
*/
function getUserInfo()
{
return $this->userinfo;
}
/**
* Get additional debug information supplied by the application.
*
* @return string debug information
* @access public
*/
function getDebugInfo()
{
return $this->getUserInfo();
}
/**
* Get the call backtrace from where the error was generated.
* Supported with PHP 4.3.0 or newer.
*
* @param int $frame (optional) what frame to fetch
* @return array Backtrace, or NULL if not available.
* @access public
*/
function getBacktrace($frame = null)
{
if (defined('PEAR_IGNORE_BACKTRACE')) {
return null;
}
if ($frame === null) {
return $this->backtrace;
}
return $this->backtrace[$frame];
}
function addUserInfo($info)
{
if (empty($this->userinfo)) {
$this->userinfo = $info;
} else {
$this->userinfo .= " ** $info";
}
}
function __toString()
{
return $this->getMessage();
}
/**
* Make a string representation of this object.
*
* @return string a string with an object summary
* @access public
*/
function toString()
{
$modes = array();
$levels = array(E_USER_NOTICE => 'notice',
E_USER_WARNING => 'warning',
E_USER_ERROR => 'error');
if ($this->mode & PEAR_ERROR_CALLBACK) {
if (is_array($this->callback)) {
$callback = (is_object($this->callback[0]) ?
strtolower(get_class($this->callback[0])) :
$this->callback[0]) . '::' .
$this->callback[1];
} else {
$callback = $this->callback;
}
return sprintf('[%s: message="%s" code=%d mode=callback '.
'callback=%s prefix="%s" info="%s"]',
strtolower(get_class($this)), $this->message, $this->code,
$callback, $this->error_message_prefix,
$this->userinfo);
}
if ($this->mode & PEAR_ERROR_PRINT) {
$modes[] = 'print';
}
if ($this->mode & PEAR_ERROR_TRIGGER) {
$modes[] = 'trigger';
}
if ($this->mode & PEAR_ERROR_DIE) {
$modes[] = 'die';
}
if ($this->mode & PEAR_ERROR_RETURN) {
$modes[] = 'return';
}
return sprintf('[%s: message="%s" code=%d mode=%s level=%s '.
'prefix="%s" info="%s"]',
strtolower(get_class($this)), $this->message, $this->code,
implode("|", $modes), $levels[$this->level],
$this->error_message_prefix,
$this->userinfo);
}
}
// Uncomment the folling define if you want the class to automatically
// read the MPEG frame info to get bitrate, mpeg version, layer, etc.
//
// NOTE: This is needed to maintain pre-version 1.0 behavior which maybe
// needed if you are using info that is from the mpeg frame. This includes
// the length of the song.
//
// This is discouraged because it will siginfincantly lengthen script
// execution time if all you need is the ID3 tag info.
// define('ID3_AUTO_STUDY', true);
// Uncomment the following define if you want tons of debgging info.
// Tip: make sure you use a <PRE> block so the print_r's are readable.
// define('ID3_SHOW_DEBUG', true);
/**
* File not opened
* @const PEAR_MP3_ID_FNO
*/
define('PEAR_MP3_ID_FNO', 1);
/**
* Read error
* @const PEAR_MP3_ID_RE
*/
define('PEAR_MP3_ID_RE', 2);
/**
* Tag not found
* @const PEAR_MP3_ID_TNF
*/
define('PEAR_MP3_ID_TNF', 3);
/**
* File is not a MP3 file (corrupted?)
* @const PEAR_MP3_ID_NOMP3
*/
define('PEAR_MP3_ID_NOMP3', 4);
/**
* A Class for reading/writing MP3 ID3 tags
*
* Note: This code doesn't try to deal with corrupt mp3s. So if you get
* incorrect length times or something else it may be your mp3. To fix just
* re-enocde from the CD. :~)
*
* eg:
* require_once("MP3/Id.php");
* $file = "Some Song.mp3";
*
* $id3 = &new MP3_Id();
* $id3->read($file);
* print_r($id3);
*
* echo $id3->getTag('artists');
*
* $id3->comment = "Be gentle with that file.";
* $id3->write();
* $id3->read($file);
* print_r($id3 );
*
* @package MP3_Id
* @author Sandy McArthur Jr. <[email protected]>
* @version $Id: Id.php 315617 2011-08-27 14:36:36Z alexmerz $
*/
class MP3_Id {
/**
* mp3/mpeg file name
* @var boolean
*/
var $file = false;
/**
* ID3 v1 tag found? (also true if v1.1 found)
* @var boolean
*/
var $id3v1 = false;
/**
* ID3 v1.1 tag found?
* @var boolean
*/
var $id3v11 = false;
/**
* ID3 v2 tag found? (not used yet)
* @var boolean
*/
var $id3v2 = false;
// ID3v1.1 Fields:
/**
* trackname
* @var string
*/
var $name = '';
/**
* artists
* @var string
*/
var $artists = '';
/**
* album
* @var string
*/
var $album = '';
/**
* year
* @var string
*/
var $year = '';
/**
* comment
* @var string
*/
var $comment = '';
/**
* track number
* @var integer
*/
var $track = 0;
/**
* genre name
* @var string
*/
var $genre = '';
/**
* genre number
* @var integer
*/
var $genreno = 255;
// MP3 Frame Stuff
/**
* Was the file studied to learn more info?
* @var boolean
*/
var $studied = false;
/**
* version of mpeg
* @var integer
*/
var $mpeg_ver = 0;
/**
* version of layer
* @var integer
*/
var $layer = 0;
/**
* version of bitrate
* @var integer
*/
var $bitrate = 0;
/**
* Frames are crc protected?
* @var boolean
*/
var $crc = false;
/**
* frequency
* @var integer
*/
var $frequency = 0;
/**
* encoding type (CBR or VBR)
* @var string
*/
var $encoding_type = 0;
/**
* number of samples per MPEG audio frame
* @var integer
*/
var $samples_per_frame = 0;
/**
* samples in file
* @var integer
*/
var $samples = 0;
/**
* Bytes in file without tag overhead
* @var integer
*/
var $musicsize = -1;
/**
* number of MPEG audio frames
* @var integer
*/
var $frames = 0;
/**
* quality indicator (0% - 100%)
* @var integer
*/
var $quality = 0;
/**
* Frames padded
* @var boolean
*/
var $padding = false;
/**
* private bit set
* @var boolean
*/
var $private = false;
/**
* Mode (Stero etc)
* @var string
*/
var $mode = '';
/**
* Copyrighted
* @var string
*/
var $copyright = false;
/**
* On Original Media? (never used)
* @var boolean
*/
var $original = false;
/**
* Emphasis (also never used)
* @var boolean
*/
var $emphasis = '';
/**
* Bytes in file
* @var integer
*/
var $filesize = -1;
/**
* Byte at which the first mpeg header was found
* @var integer
*/
var $frameoffset = -1;
/**
* length of mp3 format hh:mm:ss
* @var string
*/
var $lengthh = false;
/**
* length of mp3 format mm:ss
* @var string
*/
var $length = false;
/**
* length of mp3 in seconds
* @var string
*/
var $lengths = false;
/**
* if any errors they will be here
* @var string
*/
var $error = false;
/**
* print debugging info?
* @var boolean
*/
var $debug = false;
/**
* print debugg
* @var string
*/
var $debugbeg = '<DIV STYLE="margin: 0.5 em; padding: 0.5 em; border-width: thin; border-color: black; border-style: solid">';
/**
* print debugg
* @var string
*/
var $debugend = '</DIV>';
/*
* creates a new id3 object
* and loads a tag from a file.
*
* @param string $study study the mpeg frame to get extra info like bitrate and frequency
* You should advoid studing alot of files as it will siginficantly
* slow this down.
* @access public
*/
function MP3_Id($study = false) {
if(defined('ID3_SHOW_DEBUG')) $this->debug = true;
$this->study=($study || defined('ID3_AUTO_STUDY'));
} // id3()
/**
* reads the given file and parse it
*
* @param string $file the name of the file to parse
* @return mixed PEAR_Error on error
* @access public
*/
function read( $file="") {
if ($this->debug) print($this->debugbeg . "id3('$file')<HR>\n");
if(!empty($file))$this->file = $file;
if ($this->debug) print($this->debugend);
return $this->_read_v1();
}
/**
* sets a field
*
* possible names of tags are:
* artists - Name of band or artist
* album - Name of the album
* year - publishing year of the album or song
* comment - song comment
* track - the number of the track
* genre - genre of the song
* genreno - Number of the genre
*
* @param mixed $name Name of the tag to set or hash with the key as fieldname
* @param mixed $value the value to set
*
* @access public
*/
function setTag($name, $value) {
if( is_array($name)) {
foreach( $name as $n => $v) {
$this -> $n = $v ;
}
} else {
$this -> $name = $value ;
}
}
/**
* get the value of a tag
*
* @param string $name the name of the field to get
* @param mixed $default returned if the field not exists
*
* @return mixed The value of the field
* @access public
* @see setTag
*/
function getTag($name, $default = 0) {
if(empty($this -> $name)) {
return $default ;
} else {
return $this -> $name ;
}
}
/**
* update the id3v1 tags on the file.
* Note: If/when ID3v2 is implemented this method will probably get another
* parameters.
*
* @param boolean $v1 if true update/create an id3v1 tag on the file. (defaults to true)
*
* @access public
*/
function write($v1 = true) {
if ($this->debug) print($this->debugbeg . "write()<HR>\n");
if ($v1) {
$this->_write_v1();
}
if ($this->debug) print($this->debugend);
} // write()
/**
* study() - does extra work to get the MPEG frame info.
*
* @access public
*/
function study() {
$this->studied = true;
$this->_readframe();
} // study()
/**
* copy($from) - set's the ID3 fields to the same as the fields in $from
*
* @param string $from fields to copy
* @access public
*/
function copy($from) {
if ($this->debug) print($this->debugbeg . "copy(\$from)<HR>\n");
$this->name = $from->name;
$this->artists = $from->artists;
$this->album = $from->album;
$this->year = $from->year;
$this->comment = $from->comment;
$this->track = $from->track;
$this->genre = $from->genre;
$this->genreno = $from->genreno;
if ($this->debug) print($this->debugend);
} // copy($from)
/**
* remove - removes the id3 tag(s) from a file.
*
* @param boolean $id3v1 true to remove the tag
* @param boolean $id3v2 true to remove the tag (Not yet implemented)
*
* @access public
*/
function remove($id3v1 = true, $id3v2 = true) {
if ($this->debug) print($this->debugbeg . "remove()<HR>\n");
if ($id3v1) {
$this->_remove_v1();
}
if ($id3v2) {
// TODO: write ID3v2 code
}
if ($this->debug) print($this->debugend);
} // remove
/**
* read a ID3 v1 or v1.1 tag from a file
*
* $file should be the path to the mp3 to look for a tag.
* When in doubt use the full path.
*
* @return mixed PEAR_Error if fails
* @access private
*/
function _read_v1() {
if ($this->debug) print($this->debugbeg . "_read_v1()<HR>\n");
if (! ($f = @fopen($this->file, 'rb')) ) {
return PEAR::raiseError( "Unable to open " . $this->file, PEAR_MP3_ID_FNO);
}
if (fseek($f, -128, SEEK_END) == -1) {
return PEAR::raiseError( 'Unable to see to end - 128 of ' . $this->file, PEAR_MP3_ID_RE);
}
$r = fread($f, 128);
fclose($f);
if ($this->debug) {
$unp = unpack('H*raw', $r);
print_r($unp);
}
$id3tag = $this->_decode_v1($r);
if(!PEAR::isError( $id3tag)) {
$this->id3v1 = true;
$tmp = explode(Chr(0), $id3tag['NAME']);
$this->name = $tmp[0];
$tmp = explode(Chr(0), $id3tag['ARTISTS']);
$this->artists = $tmp[0];
$tmp = explode(Chr(0), $id3tag['ALBUM']);
$this->album = $tmp[0];
$tmp = explode(Chr(0), $id3tag['YEAR']);
$this->year = $tmp[0];
$tmp = explode(Chr(0), $id3tag['COMMENT']);
$this->comment = $tmp[0];
if (isset($id3tag['TRACK'])) {
$this->id3v11 = true;
$this->track = $id3tag['TRACK'];
}
$this->genreno = $id3tag['GENRENO'];
$this->genre = $id3tag['GENRE'];
} else {
return $id3tag ;
}
if ($this->debug) print($this->debugend);
} // _read_v1()
/**
* decodes that ID3v1 or ID3v1.1 tag
*
* false will be returned if there was an error decoding the tag
* else an array will be returned
*
* @param string $rawtag tag to decode
* @return string decoded tag
* @access private
*/
function _decode_v1($rawtag) {
if ($this->debug) print($this->debugbeg . "_decode_v1(\$rawtag)<HR>\n");
if ($rawtag[125] == Chr(0) and $rawtag[126] != Chr(0)) {
// ID3 v1.1
$format = 'a3TAG/a30NAME/a30ARTISTS/a30ALBUM/a4YEAR/a28COMMENT/x1/C1TRACK/C1GENRENO';
} else {
// ID3 v1
$format = 'a3TAG/a30NAME/a30ARTISTS/a30ALBUM/a4YEAR/a30COMMENT/C1GENRENO';
}
$id3tag = unpack($format, $rawtag);
if ($this->debug) print_r($id3tag);
if ($id3tag['TAG'] == 'TAG') {
$id3tag['GENRE'] = $this->getgenre($id3tag['GENRENO']);
} else {
$id3tag = PEAR::raiseError( 'TAG not found', PEAR_MP3_ID_TNF);
}
if ($this->debug) print($this->debugend);
return $id3tag;
} // _decode_v1()
/**
* writes a ID3 v1 or v1.1 tag to a file
*
* @return mixed returns PEAR_Error when fails
* @access private
*/
function _write_v1() {
if ($this->debug) print($this->debugbeg . "_write_v1()<HR>\n");
$file = $this->file;
if (! ($f = @fopen($file, 'r+b')) ) {
return PEAR::raiseError( "Unable to open " . $file, PEAR_MP3_ID_FNO);
}
if (fseek($f, -128, SEEK_END) == -1) {
// $this->error = 'Unable to see to end - 128 of ' . $file;
return PEAR::raiseError( "Unable to see to end - 128 of " . $file, PEAR_MP3_ID_RE);
}
$this->genreno = $this->getgenreno($this->genre, $this->genreno);
$newtag = $this->_encode_v1();
$r = fread($f, 128);
if ( !PEAR::isError( $this->_decode_v1($r))) {
if (fseek($f, -128, SEEK_END) == -1) {
// $this->error = 'Unable to see to end - 128 of ' . $file;
return PEAR::raiseError( "Unable to see to end - 128 of " . $file, PEAR_MP3_ID_RE);
}
fwrite($f, $newtag);
} else {
if (fseek($f, 0, SEEK_END) == -1) {
// $this->error = 'Unable to see to end of ' . $file;
return PEAR::raiseError( "Unable to see to end of " . $file, PEAR_MP3_ID_RE);
}
fwrite($f, $newtag);
}
fclose($f);
if ($this->debug) print($this->debugend);
} // _write_v1()
/*
* encode the ID3 tag
*
* the newly built tag will be returned
*
* @return string the new tag
* @access private
*/
function _encode_v1() {
if ($this->debug) print($this->debugbeg . "_encode_v1()<HR>\n");
if ($this->track) {
// ID3 v1.1
$id3pack = 'a3a30a30a30a4a28x1C1C1';
$newtag = pack($id3pack,
'TAG',
$this->name,
$this->artists,
$this->album,
$this->year,
$this->comment,
$this->track,
$this->genreno
);
} else {
// ID3 v1
$id3pack = 'a3a30a30a30a4a30C1';
$newtag = pack($id3pack,
'TAG',
$this->name,
$this->artists,
$this->album,
$this->year,
$this->comment,
$this->genreno
);
}
if ($this->debug) {
print('id3pack: ' . $id3pack . "\n");
$unp = unpack('H*new', $newtag);
print_r($unp);
}
if ($this->debug) print($this->debugend);
return $newtag;
} // _encode_v1()
/**
* if exists it removes an ID3v1 or v1.1 tag
*
* returns true if the tag was removed or none was found
* else false if there was an error
*
* @return boolean true, if the tag was removed
* @access private
*/
function _remove_v1() {
if ($this->debug) print($this->debugbeg . "_remove_v1()<HR>\n");
$file = $this->file;
if (! ($f = fopen($file, 'r+b')) ) {
return PEAR::raiseError( "Unable to open " . $file, PEAR_MP3_ID_FNO);
}
if (fseek($f, -128, SEEK_END) == -1) {
return PEAR::raiseError( 'Unable to see to end - 128 of ' . $file, PEAR_MP3_ID_RE);
}
$r = fread($f, 128);
$success = false;
if ( !PEAR::isError( $this->_decode_v1($r))) {
$size = filesize($this->file) - 128;
if ($this->debug) print('size: old: ' . filesize($this->file));
$success = ftruncate($f, $size);
clearstatcache();
if ($this->debug) print(' new: ' . filesize($this->file));
}
fclose($f);
if ($this->debug) print($this->debugend);
return $success;
} // _remove_v1()
/**
* reads a frame from the file
*
* @return mixed PEAR_Error when fails
* @access private
*/
function _readframe() {
if ($this->debug) print($this->debugbeg . "_readframe()<HR>\n");
$file = $this->file;
if (! ($f = fopen($file, 'rb')) ) {
if ($this->debug) print($this->debugend);
return PEAR::raiseError( "Unable to open " . $file, PEAR_MP3_ID_FNO) ;
}
$this->filesize = filesize($file);
do {
while (fread($f,1) != Chr(255)) { // Find the first frame
if ($this->debug) echo "Find...\n";
if (feof($f)) {
if ($this->debug) print($this->debugend);
return PEAR::raiseError( "No mpeg frame found", PEAR_MP3_ID_NOMP3) ;
}
}
fseek($f, ftell($f) - 1); // back up one byte
$frameoffset = ftell($f);
$r = fread($f, 4);
// Binary to Hex to a binary sting. ugly but best I can think of.
// $bits = unpack('H*bits', $r);
// $bits = base_convert($bits['bits'],16,2);
$bits = sprintf("%'08b%'08b%'08b%'08b", ord($r{0}), ord($r{1}), ord($r{2}), ord($r{3}));
} while (!$bits[8] and !$bits[9] and !$bits[10]); // 1st 8 bits true from the while
if ($this->debug) print('Bits: ' . $bits . "\n");
$this->frameoffset = $frameoffset;
// Detect VBR header
if ($bits[11] == 0) {
if (($bits[24] == 1) && ($bits[25] == 1)) {
$vbroffset = 9; // MPEG 2.5 Mono
} else {
$vbroffset = 17; // MPEG 2.5 Stereo
}
} else if ($bits[12] == 0) {
if (($bits[24] == 1) && ($bits[25] == 1)) {
$vbroffset = 9; // MPEG 2 Mono
} else {
$vbroffset = 17; // MPEG 2 Stereo
}
} else {
if (($bits[24] == 1) && ($bits[25] == 1)) {
$vbroffset = 17; // MPEG 1 Mono
} else {
$vbroffset = 32; // MPEG 1 Stereo
}
}
fseek($f, ftell($f) + $vbroffset);
$r = fread($f, 4);
switch ($r) {
case 'Xing':
$this->encoding_type = 'VBR';
case 'Info':
// Extract info from Xing header
if ($this->debug) print('Encoding Header: ' . $r . "\n");
$r = fread($f, 4);
$vbrbits = sprintf("%'08b", ord($r{3}));
if ($this->debug) print('XING Header Bits: ' . $vbrbits . "\n");
if ($vbrbits[7] == 1) {
// Next 4 bytes contain number of frames
$r = fread($f, 4);
$this->frames = unpack('N', $r);
$this->frames = $this->frames[1];
}
if ($vbrbits[6] == 1) {
// Next 4 bytes contain number of bytes
$r = fread($f, 4);
$this->musicsize = unpack('N', $r);
$this->musicsize = $this->musicsize[1];
}
if ($vbrbits[5] == 1) {
// Next 100 bytes contain TOC entries, skip
fseek($f, ftell($f) + 100);
}
if ($vbrbits[4] == 1) {
// Next 4 bytes contain Quality Indicator
$r = fread($f, 4);
$this->quality = unpack('N', $r);
$this->quality = $this->quality[1];
}
break;
case 'VBRI':
default:
if ($vbroffset != 32) {
// VBRI Header is fixed after 32 bytes, so maybe we are looking at the wrong place.
fseek($f, ftell($f) + 32 - $vbroffset);
$r = fread($f, 4);
if ($r != 'VBRI') {
$this->encoding_type = 'CBR';
break;
}
} else {
$this->encoding_type = 'CBR';
break;
}
if ($this->debug) print('Encoding Header: ' . $r . "\n");
$this->encoding_type = 'VBR';
// Next 2 bytes contain Version ID, skip
fseek($f, ftell($f) + 2);
// Next 2 bytes contain Delay, skip
fseek($f, ftell($f) + 2);
// Next 2 bytes contain Quality Indicator
$r = fread($f, 2);
$this->quality = unpack('n', $r);
$this->quality = $this->quality[1];
// Next 4 bytes contain number of bytes
$r = fread($f, 4);
$this->musicsize = unpack('N', $r);
$this->musicsize = $this->musicsize[1];
// Next 4 bytes contain number of frames
$r = fread($f, 4);
$this->frames = unpack('N', $r);
$this->frames = $this->frames[1];
}
fclose($f);
if ($bits[11] == 0) {
$this->mpeg_ver = "2.5";
$bitrates = array(
'1' => array(0, 32, 48, 56, 64, 80, 96, 112, 128, 144, 160, 176, 192, 224, 256, 0),
'2' => array(0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0),
'3' => array(0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0),
);
} else if ($bits[12] == 0) {
$this->mpeg_ver = "2";
$bitrates = array(
'1' => array(0, 32, 48, 56, 64, 80, 96, 112, 128, 144, 160, 176, 192, 224, 256, 0),
'2' => array(0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0),
'3' => array(0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0),
);
} else {
$this->mpeg_ver = "1";
$bitrates = array(
'1' => array(0, 32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 448, 0),
'2' => array(0, 32, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 384, 0),
'3' => array(0, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 0),
);
}
if ($this->debug) print('MPEG' . $this->mpeg_ver . "\n");
$layer = array(
array(0,3),
array(2,1),
);
$this->layer = $layer[$bits[13]][$bits[14]];
if ($this->debug) print('layer: ' . $this->layer . "\n");
if ($bits[15] == 0) {
// It's backwards, if the bit is not set then it is protected.
if ($this->debug) print("protected (crc)\n");
$this->crc = true;
}
$bitrate = 0;
if ($bits[16] == 1) $bitrate += 8;
if ($bits[17] == 1) $bitrate += 4;
if ($bits[18] == 1) $bitrate += 2;
if ($bits[19] == 1) $bitrate += 1;
$this->bitrate = $bitrates[$this->layer][$bitrate];
$frequency = array(
'1' => array(
'0' => array(44100, 48000),
'1' => array(32000, 0),
),
'2' => array(
'0' => array(22050, 24000),
'1' => array(16000, 0),
),
'2.5' => array(
'0' => array(11025, 12000),
'1' => array(8000, 0),
),
);
$this->frequency = $frequency[$this->mpeg_ver][$bits[20]][$bits[21]];
$this->padding = $bits[22];
$this->private = $bits[23];
$mode = array(
array('Stereo', 'Joint Stereo'),
array('Dual Channel', 'Mono'),
);
$this->mode = $mode[$bits[24]][$bits[25]];
// XXX: I dunno what the mode extension is for bits 26,27
$this->copyright = $bits[28];
$this->original = $bits[29];
$emphasis = array(
array('none', '50/15ms'),
array('', 'CCITT j.17'),
);
$this->emphasis = $emphasis[$bits[30]][$bits[31]];
$samplesperframe = array(
'1' => array(
'1' => 384,
'2' => 1152,
'3' => 1152
),
'2' => array(
'1' => 384,
'2' => 1152,
'3' => 576
),
'2.5' => array(
'1' => 384,
'2' => 1152,
'3' => 576
),
);
$this->samples_per_frame = $samplesperframe[$this->mpeg_ver][$this->layer];
if ($this->encoding_type != 'VBR') {
if ($this->bitrate == 0) {
$s = -1;
} else {
$s = ((8*filesize($this->file))/1000) / $this->bitrate;
}
$this->length = sprintf('%02d:%02d',floor($s/60),floor($s-(floor($s/60)*60)));
$this->lengthh = sprintf('%02d:%02d:%02d',floor($s/3600),floor($s/60),floor($s-(floor($s/60)*60)));
$this->lengths = (int)$s;
$this->samples = ceil($this->lengths * $this->frequency);
if(0 != $this->samples_per_frame) {
$this->frames = ceil($this->samples / $this->samples_per_frame);
} else {
$this->frames = 0;
}
$this->musicsize = ceil($this->lengths * $this->bitrate * 1000 / 8);
} else {
$this->samples = $this->samples_per_frame * $this->frames;
$s = $this->samples / $this->frequency;
$this->length = sprintf('%02d:%02d',floor($s/60),floor($s-(floor($s/60)*60)));
$this->lengthh = sprintf('%02d:%02d:%02d',floor($s/3600),floor($s/60),floor($s-(floor($s/60)*60)));
$this->lengths = (int)$s;
$this->bitrate = (int)(($this->musicsize / $s) * 8 / 1000);
}
if ($this->debug) print($this->debugend);
} // _readframe()
/**
* getGenre - return the name of a genre number
*
* if no genre number is specified the genre number from
* $this->genreno will be used.
*
* the genre is returned or false if an error or not found
* no error message is ever returned
*
* @param integer $genreno Number of the genre
* @return mixed false, if no genre found, else string
*
* @access public
*/
function getGenre($genreno) {
if ($this->debug) print($this->debugbeg . "getgenre($genreno)<HR>\n");
$genres = $this->genres();
if (isset($genres[$genreno])) {
$genre = $genres[$genreno];
if ($this->debug) print($genre . "\n");
} else {
$genre = '';
}
if ($this->debug) print($this->debugend);
return $genre;
} // getGenre($genreno)
/*
* getGenreNo - return the number of the genre name
*
* the genre number is returned or 0xff (255) if a match is not found
* you can specify the default genreno to use if one is not found
* no error message is ever returned
*
* @param string $genre Name of the genre
* @param integer $default Genre number in case of genre not found
*
* @access public
*/
function getGenreNo($genre, $default = 0xff) {
if ($this->debug) print($this->debugbeg . "getgenreno('$genre',$default)<HR>\n");
$genres = $this->genres();
$genreno = false;
if ($genre) {
foreach ($genres as $no => $name) {
if (strtolower($genre) == strtolower($name)) {
if ($this->debug) print("$no:'$name' == '$genre'");
$genreno = $no;
}
}
}
if ($genreno === false) $genreno = $default;
if ($this->debug) print($this->debugend);
return $genreno;
} // getGenreNo($genre, $default = 0xff)
/*
* genres - returns an array of the ID3v1 genres
*
* @return array
*
* @access public
*/
function genres() {
return array(
0 => 'Blues',
1 => 'Classic Rock',
2 => 'Country',
3 => 'Dance',
4 => 'Disco',
5 => 'Funk',
6 => 'Grunge',
7 => 'Hip-Hop',
8 => 'Jazz',
9 => 'Metal',
10 => 'New Age',
11 => 'Oldies',
12 => 'Other',
13 => 'Pop',
14 => 'R&B',
15 => 'Rap',
16 => 'Reggae',
17 => 'Rock',
18 => 'Techno',
19 => 'Industrial',
20 => 'Alternative',
21 => 'Ska',
22 => 'Death Metal',
23 => 'Pranks',
24 => 'Soundtrack',
25 => 'Euro-Techno',
26 => 'Ambient',
27 => 'Trip-Hop',
28 => 'Vocal',
29 => 'Jazz+Funk',
30 => 'Fusion',
31 => 'Trance',
32 => 'Classical',
33 => 'Instrumental',
34 => 'Acid',
35 => 'House',
36 => 'Game',
37 => 'Sound Clip',
38 => 'Gospel',
39 => 'Noise',
40 => 'Alternative Rock',
41 => 'Bass',
42 => 'Soul',
43 => 'Punk',
44 => 'Space',
45 => 'Meditative',
46 => 'Instrumental Pop',
47 => 'Instrumental Rock',
48 => 'Ethnic',
49 => 'Gothic',
50 => 'Darkwave',
51 => 'Techno-Industrial',
52 => 'Electronic',
53 => 'Pop-Folk',
54 => 'Eurodance',
55 => 'Dream',
56 => 'Southern Rock',
57 => 'Comedy',
58 => 'Cult',
59 => 'Gangsta',
60 => 'Top 40',
61 => 'Christian Rap',
62 => 'Pop/Funk',
63 => 'Jungle',
64 => 'Native US',
65 => 'Cabaret',
66 => 'New Wave',
67 => 'Psychadelic',
68 => 'Rave',
69 => 'Showtunes',
70 => 'Trailer',
71 => 'Lo-Fi',
72 => 'Tribal',
73 => 'Acid Punk',
74 => 'Acid Jazz',
75 => 'Polka',
76 => 'Retro',
77 => 'Musical',
78 => 'Rock & Roll',
79 => 'Hard Rock',
80 => 'Folk',
81 => 'Folk-Rock',
82 => 'National Folk',
83 => 'Swing',
84 => 'Fast Fusion',
85 => 'Bebob',
86 => 'Latin',
87 => 'Revival',
88 => 'Celtic',
89 => 'Bluegrass',
90 => 'Avantgarde',
91 => 'Gothic Rock',
92 => 'Progressive Rock',
93 => 'Psychedelic Rock',
94 => 'Symphonic Rock',
95 => 'Slow Rock',
96 => 'Big Band',
97 => 'Chorus',
98 => 'Easy Listening',
99 => 'Acoustic',
100 => 'Humour',
101 => 'Speech',
102 => 'Chanson',
103 => 'Opera',
104 => 'Chamber Music',
105 => 'Sonata',
106 => 'Symphony',
107 => 'Booty Bass',
108 => 'Primus',
109 => 'Porn Groove',
110 => 'Satire',
111 => 'Slow Jam',
112 => 'Club',
113 => 'Tango',
114 => 'Samba',
115 => 'Folklore',
116 => 'Ballad',
117 => 'Power Ballad',
118 => 'Rhytmic Soul',
119 => 'Freestyle',
120 => 'Duet',
121 => 'Punk Rock',
122 => 'Drum Solo',
123 => 'Acapella',
124 => 'Euro-House',
125 => 'Dance Hall',
126 => 'Goa',
127 => 'Drum & Bass',
128 => 'Club-House',
129 => 'Hardcore',
130 => 'Terror',
131 => 'Indie',
132 => 'BritPop',
133 => 'Negerpunk',
134 => 'Polsk Punk',
135 => 'Beat',
136 => 'Christian Gangsta Rap',
137 => 'Heavy Metal',
138 => 'Black Metal',
139 => 'Crossover',
140 => 'Contemporary Christian',
141 => 'Christian Rock',
142 => 'Merengue',
143 => 'Salsa',
144 => 'Trash Metal',
145 => 'Anime',
146 => 'Jpop',
147 => 'Synthpop'
);
}
}
?>