Source for file Common.php
Documentation is available at Common.php
* PEAR_Common, the base class for the PEAR Installer
* @author Stig Bakken <ssb@php.net>
* @author Tomas V. V. Cox <cox@idecnet.com>
* @author Greg Beaver <cellog@php.net>
* @copyright 1997-2009 The Authors
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @version CVS: $Id: Common.php 313023 2011-07-06 19:17:11Z dufuz $
* @link http://pear.php.net/package/PEAR
* @since File available since Release 0.1.0
* @deprecated File deprecated since Release 1.4.0a1
* PEAR_Common error when an invalid PHP file is passed to PEAR_Common::analyzeSourceCode()
define('PEAR_COMMON_ERROR_INVALIDPHP', 1 );
define('_PEAR_COMMON_PACKAGE_NAME_PREG', '[A-Za-z][a-zA-Z0-9_]+');
define('PEAR_COMMON_PACKAGE_NAME_PREG', '/^' . _PEAR_COMMON_PACKAGE_NAME_PREG . '\\z/');
// this should allow: 1, 1.0, 1.0RC1, 1.0dev, 1.0dev123234234234, 1.0a1, 1.0b1, 1.0pl1
define('_PEAR_COMMON_PACKAGE_VERSION_PREG', '\d+(?:\.\d+)*(?:[a-zA-Z]+\d*)?');
define('PEAR_COMMON_PACKAGE_VERSION_PREG', '/^' . _PEAR_COMMON_PACKAGE_VERSION_PREG . '\\z/i');
// XXX far from perfect :-)
define('_PEAR_COMMON_PACKAGE_DOWNLOAD_PREG', '(' . _PEAR_COMMON_PACKAGE_NAME_PREG .
define('PEAR_COMMON_PACKAGE_DOWNLOAD_PREG', '/^' . _PEAR_COMMON_PACKAGE_DOWNLOAD_PREG .
define('_PEAR_CHANNELS_NAME_PREG', '[A-Za-z][a-zA-Z0-9\.]+');
define('PEAR_CHANNELS_NAME_PREG', '/^' . _PEAR_CHANNELS_NAME_PREG . '\\z/');
// this should allow any dns or IP address, plus a path - NO UNDERSCORES ALLOWED
define('_PEAR_CHANNELS_SERVER_PREG', '[a-zA-Z0-9\-]+(?:\.[a-zA-Z0-9\-]+)*(\/[a-zA-Z0-9\-]+)*');
define('PEAR_CHANNELS_SERVER_PREG', '/^' . _PEAR_CHANNELS_SERVER_PREG . '\\z/i');
define('_PEAR_CHANNELS_PACKAGE_PREG', '(' ._PEAR_CHANNELS_SERVER_PREG . ')\/('
. _PEAR_COMMON_PACKAGE_NAME_PREG . ')');
define('PEAR_CHANNELS_PACKAGE_PREG', '/^' . _PEAR_CHANNELS_PACKAGE_PREG . '\\z/i');
define('_PEAR_COMMON_CHANNEL_DOWNLOAD_PREG', '(' . _PEAR_CHANNELS_NAME_PREG . ')::('
. _PEAR_COMMON_PACKAGE_NAME_PREG . ')(-([.0-9a-zA-Z]+))?');
define('PEAR_COMMON_CHANNEL_DOWNLOAD_PREG', '/^' . _PEAR_COMMON_CHANNEL_DOWNLOAD_PREG . '\\z/');
* List of temporary files and directories registered by
* PEAR_Common::addTempFile().
$GLOBALS['_PEAR_Common_tempfiles'] = array ();
$GLOBALS['_PEAR_Common_maintainer_roles'] = array ('lead','developer','contributor','helper');
$GLOBALS['_PEAR_Common_release_states'] = array ('alpha','beta','stable','snapshot','devel');
$GLOBALS['_PEAR_Common_dependency_types'] = array ('pkg','ext','php','prog','ldlib','rtlib','os','websrv','sapi');
* Valid dependency relations
$GLOBALS['_PEAR_Common_dependency_relations'] = array ('has','eq','lt','le','gt','ge','not', 'ne');
$GLOBALS['_PEAR_Common_file_roles'] = array ('php','ext','test','doc','data','src','script');
* Valid replacement types
$GLOBALS['_PEAR_Common_replacement_types'] = array ('php-const', 'pear-config', 'package-info');
$GLOBALS['_PEAR_Common_provide_types'] = array ('ext', 'prog', 'class', 'function', 'feature', 'api');
$GLOBALS['_PEAR_Common_script_phases'] = array ('pre-install', 'post-install', 'pre-uninstall', 'post-uninstall', 'pre-build', 'post-build', 'pre-configure', 'post-configure', 'pre-setup', 'post-setup');
* Class providing common functionality for PEAR administration classes.
* @author Stig Bakken <ssb@php.net>
* @author Tomas V. V. Cox <cox@idecnet.com>
* @author Greg Beaver <cellog@php.net>
* @copyright 1997-2009 The Authors
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @version Release: 1.9.4
* @link http://pear.php.net/package/PEAR
* @since Class available since Release 1.4.0a1
* @deprecated This class will disappear, and its components will be spread
* into smaller classes, like the AT&T breakup, as of Release 1.4.0a1
* User Interface object (PEAR_Frontend_* class). If null,
* the log() method uses print.
* Configuration object (PEAR_Config).
/** stack of elements, gives some sort of XML context */
/** name of currently parsed XML element */
/** array of attributes of the currently parsed XML element */
/** assoc with information about a package */
* Flag variable used to mark a valid package file
* PEAR_Common constructor
$this->debug = $this->config->get('verbose');
// doesn't work due to bug #14744
//$tempfiles = $this->_tempfiles;
$tempfiles = & $GLOBALS['_PEAR_Common_tempfiles'];
require_once 'System.php';
* Register a temporary file or directory. When the destructor is
* executed, all registered temporary files and directories are
* @param string $file name of file or directory
require_once 'PEAR/Frontend.php';
* Wrapper to System::mkDir(), creates a directory as well as
* any necessary parent directories.
* @param string $dir directory name
* @return bool TRUE on success, or a PEAR error
// Only used in Installer - move it there ?
$this->log(2 , " + create dir $dir" );
require_once 'System.php';
* @param int $level log level (0 is quiet, higher is noisier)
* @param string $msg message to write to the log
function log($level, $msg, $append_crlf = true )
if ($this->debug >= $level) {
require_once 'PEAR/Frontend.php';
if (is_a($ui, 'PEAR_Frontend')) {
$ui->log ($msg, $append_crlf);
* Create and register a temporary directory.
* @param string $tmpdir (optional) Directory to use as tmpdir.
* Will use system defaults (for example
* /tmp or c:\windows\temp) if not specified
* @return string name of created directory
$topt = $tmpdir ? array ('-t', $tmpdir) : array ();
require_once 'System.php';
* Set object that represents the frontend to be used.
* @param object Reference of the frontend object
* Return an array containing all of the states that are more stable than
* or equal to the passed in state
* @param string Release state
* @param boolean Determines whether to include $state in the list
* @return false|arrayFalse if $state is not a valid release state
static $states = array ('snapshot', 'devel', 'alpha', 'beta', 'stable');
$i = array_search ($state, $states);
* Get the valid roles for a PEAR package maintainer
return $GLOBALS['_PEAR_Common_maintainer_roles'];
* Get the valid package release states of packages
return $GLOBALS['_PEAR_Common_release_states'];
* Get the implemented dependency types (php, ext, pkg etc.)
return $GLOBALS['_PEAR_Common_dependency_types'];
* Get the implemented dependency relations (has, lt, ge etc.)
return $GLOBALS['_PEAR_Common_dependency_relations'];
* Get the implemented file roles
return $GLOBALS['_PEAR_Common_file_roles'];
* Get the implemented file replacement types in
return $GLOBALS['_PEAR_Common_replacement_types'];
* Get the implemented file replacement types in
return $GLOBALS['_PEAR_Common_provide_types'];
* Get the implemented file replacement types in
return $GLOBALS['_PEAR_Common_script_phases'];
* Test whether a string contains a valid package name.
* @param string $name the package name to test
* Test whether a string contains a valid package version.
* @param string $ver the package version to test
* @param string $path relative or absolute include path
foreach ($ipath as $include) {
$test = realpath($include . DIRECTORY_SEPARATOR . $path);
function _postProcessChecks ($pf)
return $this->_postProcessValidPackagexml ($pf);
$errs = $pf->getUserinfo ();
foreach ($errs as $error) {
$e = $this->raiseError($error['message'], $error['code'], null , null , $error);
* Returns information about a package file. Expects the name of
* a gzipped tar file as input.
* @param string $file name of .tgz file
* @return array array with package information
* @deprecated use PEAR_PackageFile->fromTgzFile() instead
return $this->_postProcessChecks ($pf);
* Returns information about a package file. Expects the name of
* a package xml file as input.
* @param string $descfile name of package xml file
* @return array array with package information
* @deprecated use PEAR_PackageFile->fromPackageFile() instead
return $this->_postProcessChecks ($pf);
* Returns information about a package file. Expects the contents
* of a package xml file as input.
* @param string $data contents of package.xml file
* @return array array with package information
* @deprecated use PEAR_PackageFile->fromXmlstring() instead
return $this->_postProcessChecks ($pf);
* @param PEAR_PackageFile_v1|PEAR_PackageFile_v2
function _postProcessValidPackagexml (&$pf)
if (!is_a($pf, 'PEAR_PackageFile_v2')) {
// sort of make this into a package.xml 1.0-style array
// changelog is not converted to old format.
$arr = $pf->toArray (true );
unset ($arr['old'], $arr['xsdversion'], $arr['contents'], $arr['compatible'],
$arr['channel'], $arr['uri'], $arr['dependencies'], $arr['phprelease'],
$arr['extsrcrelease'], $arr['zendextsrcrelease'], $arr['extbinrelease'],
$arr['zendextbinrelease'], $arr['bundle'], $arr['lead'], $arr['developer'],
$arr['helper'], $arr['contributor']);
$arr['filelist'] = $pf->getFilelist ();
* Returns package information from different sources
* This method is able to extract information about a package
* from a .tgz archive or from a XML package definition file.
* @param string Filename of the source ('package.xml', '<package>.tgz')
* @deprecated use PEAR_PackageFile->fromAnyFile() instead
$errs = $pf->getUserinfo ();
foreach ($errs as $error) {
$e = $this->raiseError($error['message'], $error['code'], null , null , $error);
return $this->_postProcessValidPackagexml ($pf);
* Return an XML document based on the package info (as returned
* by the PEAR_Common::infoFrom* methods).
* @param array $pkginfo package info
* @return string XML data
* @deprecated use a PEAR_PackageFile_v* object's generator instead
$pf = &$packagefile->fromArray ($pkginfo);
$gen = &$pf->getDefaultGenerator ();
* Validate XML package definition file.
* @param string $info Filename of the package archive or of the
* package definition file
* @param array $errors Array that will contain the errors
* @param array $warnings Array that will contain the warnings
* @param string $dir_prefix (optional) directory where source files
* may be found, or empty if they are not available
* @deprecated use the validation of PEAR_PackageFile objects
if (strpos($info, '<?xml') !== false ) {
$errs = $pf->getUserinfo ();
foreach ($errs as $error) {
if ($error['level'] == 'error') {
$errors[] = $error['message'];
$warnings[] = $error['message'];
* Build a "provides" array from data returned by
* analyzeSourceCode(). The format of the built array is like
* 'class;MyClass' => 'array('type' => 'class', 'name' => 'MyClass'),
* @param array $srcinfo array with information about a source file
* as returned by the analyzeSourceCode() method.
$file = basename($srcinfo['source_file']);
if (isset ($this->_packageName)) {
$pn = $this->_packageName;
foreach ($srcinfo['declared_classes'] as $class) {
if (isset ($this->pkginfo['provides'][$key])) {
array ('file'=> $file, 'type' => 'class', 'name' => $class);
if (isset ($srcinfo['inheritance'][$class])) {
$this->pkginfo['provides'][$key]['extends'] =
$srcinfo['inheritance'][$class];
foreach ($srcinfo['declared_methods'] as $class => $methods) {
foreach ($methods as $method) {
$function = " $class::$method";
$key = " function;$function";
if ($method{0 } == '_' || !strcasecmp($method, $class) ||
isset ($this->pkginfo['provides'][$key])) {
array ('file'=> $file, 'type' => 'function', 'name' => $function);
foreach ($srcinfo['declared_functions'] as $function) {
$key = " function;$function";
if ($function{0 } == '_' || isset ($this->pkginfo['provides'][$key])) {
$warnings[] = "in1 " . $file . " : function \"$function\" not prefixed with package name \"$pn\"";
array ('file'=> $file, 'type' => 'function', 'name' => $function);
* Analyze the source code of the given PHP file
* @param string Filename of the PHP file
require_once 'PEAR/PackageFile/v2/Validator.php';
$a = new PEAR_PackageFile_v2_Validator;
return $a->analyzeSourceCode ($file);
$used_c = $decl_c = $decl_f = $decl_m = array ();
foreach ($info['filelist'] as $file => $fa) {
$decl_c = @array_merge($decl_c, $tmp['declared_classes']);
$decl_f = @array_merge($decl_f, $tmp['declared_functions']);
$decl_m = @array_merge($decl_m, $tmp['declared_methods']);
return array ('used_classes' => $used_c,
'declared_classes' => $decl_c,
'declared_methods' => $decl_m,
'declared_functions' => $decl_f,
'undeclared_classes' => $undecl_c,
'inheritance' => $inheri,
* Download a file through HTTP. Considers suggested file name in
* Content-disposition: header and can run a callback function for
* different events. The callback will be called with two
* parameters: the callback type, and parameters. The implemented
* 'setup' called at the very beginning, parameter is a UI object
* that should be used for all output
* 'message' the parameter is a string with an informational message
* 'saveas' may be used to save with a different file name, the
* parameter is the filename that is about to be used.
* If a 'saveas' callback returns a non-empty string,
* that file name will be used as the filename instead.
* Note that $save_dir will not be affected by this, only
* the basename of the file.
* 'start' download is starting, parameter is number of bytes
* that are expected, or -1 if unknown
* 'bytesread' parameter is the number of bytes read so far
* 'done' download is complete, parameter is the total number
* 'connfailed' if the TCP connection fails, this callback is called
* with array(host,port,errno,errmsg)
* 'writefailed' if writing to disk fails, this callback is called
* with array(destfile,errmsg)
* If an HTTP proxy has been configured (http_proxy PEAR_Config
* setting), the proxy will be used.
* @param string $url the URL to download
* @param object $ui PEAR_Frontend_* instance
* @param object $config PEAR_Config instance
* @param string $save_dir (optional) directory to save file in
* @param mixed $callback (optional) function/method to call for status
* @return string Returns the full path of the downloaded file or a PEAR
* error on failure. If the error is caused by
* socket-related errors, the error object will
* have the fsockopen error code available through
* @deprecated in favor of PEAR_Downloader::downloadHttp()
function downloadHttp($url, &$ui, $save_dir = '.', $callback = null )
require_once 'PEAR/Downloader.php';
require_once 'PEAR/Config.php';
require_once 'PEAR/PackageFile.php';
Documentation generated on Wed, 06 Jul 2011 23:30:34 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.
|