Inheritance diagram for PEAR_Builder:

Collaboration diagram for PEAR_Builder:

Public Member Functions
	__construct ($configureoptions, &$ui)
	_build_win32 ($descfile, $callback=null)
	_harvestInstDir ($dest_prefix, $dirname, &$built_files)
	_parseConfigureOptions ($options)
	_parseConfigureOptionsEndElement ($parser, $element)
	_parseConfigureOptionsStartElement ($parser, $tagName, $attribs)
	_runCommand ($command, $callback=null)
	build ($descfile, $callback=null)
	log ($level, $msg, $append_crlf=true)
	msdevCallback ($what, $data)
	phpizeCallback ($what, $data)
Public Member Functions inherited from PEAR_Common
	__construct ()
	_PEAR_Common ()
	_postProcessChecks ($pf)
	_postProcessValidPackagexml (&$pf)
	buildProvidesArray ($srcinfo)
	detectDependencies ($any, $status_callback=null)
	downloadHttp ( $url, &$ui, $save_dir='.', $callback=null, $lastmodified=null, $accept=false, $channel=false)
	infoFromAny ($info)
	infoFromDescriptionFile ($descfile)
	infoFromString ($data)
	infoFromTgzFile ($file)
	mkDirHier ($dir)
	mkTempDir ($tmpdir='')
	setFrontendObject (&$ui)
	validatePackageInfo ($info, &$errors, &$warnings, $dir_prefix='')
	validPackageName ($name)
	validPackageVersion ($ver)
	xmlFromInfo ($pkginfo)
Public Member Functions inherited from PEAR
	__call ($method, $arguments)
	__construct ($error_class=null)
	_checkDelExpect ($error_code)
	_PEAR ()
	delExpect ($error_code)
	expectError ($code=' *')
	PEAR ($error_class=null)
	popExpect ()

Data Fields
	$_firstline = null
	$_lastline = null
	$_parsed_configure_options
	$current_callback = null
	$extensions_built = array()
	$php_api_version = 0
	$zend_extension_api_no = 0
	$zend_module_api_no = 0
Data Fields inherited from PEAR_Common
	$_validPackageFile
	$config = null
	$current_attributes = array()
	$current_element
	$current_path = null
	$element_stack = array()
	$pkginfo = array()
	$ui = null
Data Fields inherited from PEAR
	$_debug = false
	$_default_error_handler = ''
	$_default_error_mode = null
	$_default_error_options = null
	$_error_class = 'PEAR_Error'
	$_expected_errors = array()

Additional Inherited Members
Static Public Member Functions inherited from PEAR_Common
static	addTempFile ($file)
static	analyzeSourceCode ($file)
static	betterStates ($state, $include=false)
static	getDependencyRelations ()
static	getDependencyTypes ()
static	getFileRoles ()
static	getProvideTypes ()
static	getReleaseStates ()
static	getReplacementTypes ()
static	getScriptPhases ()
static	getUserRoles ()
static	isIncludeable ($path)
Static Public Member Functions inherited from PEAR
static	__callStatic ($method, $arguments)
static	getSourceDateEpoch ()
static &	getStaticProperty ($class, $var)
static	isError ($data, $code=null)
static	loadExtension ($ext)
static	registerShutdownFunc ($func, $args=array())
static	staticPopErrorHandling ()
static	staticPushErrorHandling ($mode, $options=null)
Static Protected Member Functions inherited from PEAR
static	_popErrorHandling ($object)
static	_pushErrorHandling ($object, $mode, $options=null)
static	_raiseError ($object, $message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
static	_setErrorHandling ( $object, $mode=null, $options=null)
static	_throwError ($object, $message=null, $code=null, $userinfo=null)
Static Protected Attributes inherited from PEAR
static	$bivalentMethods

Detailed Description

Definition at line 41 of file Builder.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(		$configureoptions,
		&	$ui )

PEAR_Builder constructor.

Parameters

mixed[]	$configureoptions
object	$ui	user interface object (instance of PEAR_Frontend_*)

@access public

Definition at line 74 of file Builder.php.

    {
        parent::__construct();
        $this->setFrontendObject($ui);
        $this->_parseConfigureOptions($configureoptions);
    }

References PEAR_Common\$ui, _parseConfigureOptions(), and PEAR_Common\setFrontendObject().

Here is the call graph for this function:

Member Function Documentation

◆ _build_win32()

_build_win32	(		$descfile,
			$callback = null )

Build an extension from source on windows. requires msdev

Definition at line 131 of file Builder.php.

    {
        if (is_object($descfile)) {
            $pkg = $descfile;
            $descfile = $pkg->getPackageFile();
        } else {
            $pf = new PEAR_PackageFile($this->config, $this->debug);
            $pkg = &$pf->fromPackageFile($descfile, PEAR_VALIDATE_NORMAL);
            if (PEAR::isError($pkg)) {
                return $pkg;
            }
        }
        $dir = dirname($descfile);
        $old_cwd = getcwd();
 
        if (!file_exists($dir) || !is_dir($dir) || !chdir($dir)) {
            return $this->raiseError("could not chdir to $dir");
        }
 
        // packages that were in a .tar have the packagefile in this directory
        $vdir = $pkg->getPackage() . '-' . $pkg->getVersion();
        if (file_exists($dir) && is_dir($vdir)) {
            if (!chdir($vdir)) {
                return $this->raiseError("could not chdir to " . realpath($vdir));
            }
 
            $dir = getcwd();
        }
 
        $this->log(2, "building in $dir");
 
        $dsp = $pkg->getPackage().'.dsp';
        if (!file_exists("$dir/$dsp")) {
            return $this->raiseError("The DSP $dsp does not exist.");
        }
        // XXX TODO: make release build type configurable
        $command = 'msdev '.$dsp.' /MAKE "'.$pkg->getPackage(). ' - Release"';
 
        $err = $this->_runCommand($command, array(&$this, 'msdevCallback'));
        if (PEAR::isError($err)) {
            return $err;
        }
 
        // figure out the build platform and type
        $platform = 'Win32';
        $buildtype = 'Release';
        if (preg_match('/.*?'.$pkg->getPackage().'\s-\s(\w+)\s(.*?)-+/i',$this->_firstline,$matches)) {
            $platform = $matches[1];
            $buildtype = $matches[2];
        }
 
        if (preg_match('/(.*)?\s-\s(\d+).*?(\d+)/', $this->_lastline, $matches)) {
            if ($matches[2]) {
                // there were errors in the build
                return $this->raiseError("There were errors during compilation.");
            }
            $out = $matches[1];
        } else {
            return $this->raiseError("Did not understand the completion status returned from msdev.exe.");
        }
 
        // msdev doesn't tell us the output directory :/
        // open the dsp, find /out and use that directory
        $dsptext = join('', file($dsp));
 
        // this regex depends on the build platform and type having been
        // correctly identified above.
        $regex ='/.*?!IF\s+"\$\‍(CFG\‍)"\s+==\s+("'.
                    $pkg->getPackage().'\s-\s'.
                    $platform.'\s'.
                    $buildtype.'").*?'.
                    '\/out:"(.*?)"/is';
 
        if ($dsptext && preg_match($regex, $dsptext, $matches)) {
            // what we get back is a relative path to the output file itself.
            $outfile = realpath($matches[2]);
        } else {
            return $this->raiseError("Could not retrieve output information from $dsp.");
        }
        // realpath returns false if the file doesn't exist
        if ($outfile && copy($outfile, "$dir/$out")) {
            $outfile = "$dir/$out";
        }
 
        $built_files[] = array(
            'file' => "$outfile",
            'php_api' => $this->php_api_version,
            'zend_mod_api' => $this->zend_module_api_no,
            'zend_ext_api' => $this->zend_extension_api_no,
            );
 
        return $built_files;
    }

References $command, _runCommand(), PEAR\isError(), log(), and PEAR_VALIDATE_NORMAL.

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _harvestInstDir()

_harvestInstDir	(		$dest_prefix,
			$dirname,
		&	$built_files )

Parameters

string
string
array	@access private

Definition at line 241 of file Builder.php.

    {
        $d = opendir($dirname);
        if (!$d)
            return false;
 
        $ret = true;
        while (($ent = readdir($d)) !== false) {
            if ($ent[0] == '.')
                continue;
 
            $full = $dirname . DIRECTORY_SEPARATOR . $ent;
            if (is_dir($full)) {
                if (!$this->_harvestInstDir(
                        $dest_prefix . DIRECTORY_SEPARATOR . $ent,
                        $full, $built_files)) {
                    $ret = false;
                    break;
                }
            } else {
                $dest = $dest_prefix . DIRECTORY_SEPARATOR . $ent;
                $built_files[] = array(
                        'file' => $full,
                        'dest' => $dest,
                        'php_api' => $this->php_api_version,
                        'zend_mod_api' => $this->zend_module_api_no,
                        'zend_ext_api' => $this->zend_extension_api_no,
                        );
            }
        }
        closedir($d);
        return $ret;
    }

References _harvestInstDir().

Referenced by _harvestInstDir(), and build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _parseConfigureOptions()

_parseConfigureOptions ( $options )

Parse –configureoptions string.

Parameters

string Options, in the form "X=1 Y=2 Z='there\'s always one'"

Definition at line 86 of file Builder.php.

    {
        $data = '<XML><PROPERTIES ' . $options . ' /></XML>';
        $parser = xml_parser_create('ISO-8859-1');
        xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
        xml_set_element_handler(
            $parser, array($this, '_parseConfigureOptionsStartElement'),
            array($this, '_parseConfigureOptionsEndElement'));
        xml_parse($parser, $data, true);
        xml_parser_free($parser);
    }

References $options.

Referenced by __construct().

Here is the caller graph for this function:

◆ _parseConfigureOptionsEndElement()

_parseConfigureOptionsEndElement	(		$parser,
			$element )

Handle element end.

See also: PEAR_Builder\_parseConfigureOptions()

Parameters

	resource
string	$element

Definition at line 123 of file Builder.php.

124 {

125 }

◆ _parseConfigureOptionsStartElement()

_parseConfigureOptionsStartElement	(	$parser,
		$tagName,
		$attribs )

Handle element start.

See also: PEAR_Builder\_parseConfigureOptions()

Parameters

resource	$parser
string	$tagName
mixed[]	$attribs

Definition at line 107 of file Builder.php.

    {
        if ($tagName !== 'PROPERTIES') {
            return;
        }
        $this->_parsed_configure_options = $attribs;
    }

◆ _runCommand()

_runCommand	(		$command,
			$callback = null )

Run an external command, using a message callback to report output. The command will be run through popen and output is reported for every line with a "cmdoutput" message with the line string, including newlines, as payload.

Parameters

string	$command	the command to run
mixed	$callback	(optional) function to use as message callback

Returns: bool whether the command was successful (exit code 0 means success, any other means failure)

@access private

Definition at line 522 of file Builder.php.

    {
        $this->log(1, "running: $command");
        $pp = popen("$command 2>&1", "r");
        if (!$pp) {
            return $this->raiseError("failed to run `$command'");
        }
        if ($callback && $callback[0]->debug == 1) {
            $olddbg = $callback[0]->debug;
            $callback[0]->debug = 2;
        }
 
        while ($line = fgets($pp, 1024)) {
            if ($callback) {
                call_user_func($callback, 'cmdoutput', $line);
            } else {
                $this->log(2, rtrim($line));
            }
        }
        if ($callback && isset($olddbg)) {
            $callback[0]->debug = $olddbg;
        }
 
        $exitcode = is_resource($pp) ? pclose($pp) : -1;
        return ($exitcode == 0);
    }

References $command, and log().

Referenced by _build_win32(), and build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build()

build	(		$descfile,
			$callback = null )

Build an extension from source. Runs "phpize" in the source directory, but compiles in a temporary directory (TMPDIR/pear-build-USER/PACKAGE-VERSION).

Parameters

	string\|PEAR_PackageFile_v*	$descfile path to XML package description file, or a PEAR_PackageFile object
mixed	$callback	callback function used to report output, see PEAR_Builder\_runCommand for details

Returns: array an array of associative arrays with built files, format: array( array( 'file' => '/path/to/ext.so', 'php_api' => YYYYMMDD, 'zend_mod_api' => YYYYMMDD, 'zend_ext_api' => YYYYMMDD ), ... )

@access public

See also: PEAR_Builder\_runCommand

Definition at line 298 of file Builder.php.

    {
        if (preg_match('/(\\/|\\\\|^)([^\\/\\\\]+)?php([^\\/\\\\]+)?$/',
                       $this->config->get('php_bin'), $matches)) {
            if (isset($matches[2]) && strlen($matches[2]) &&
                trim($matches[2]) != trim($this->config->get('php_prefix'))) {
                $this->log(0, 'WARNING: php_bin ' . $this->config->get('php_bin') .
                           ' appears to have a prefix ' . $matches[2] . ', but' .
                           ' config variable php_prefix does not match');
            }
 
            if (isset($matches[3]) && strlen($matches[3]) &&
                trim($matches[3]) != trim($this->config->get('php_suffix'))) {
                $this->log(0, 'WARNING: php_bin ' . $this->config->get('php_bin') .
                           ' appears to have a suffix ' . $matches[3] . ', but' .
                           ' config variable php_suffix does not match');
            }
        }
 
        $this->current_callback = $callback;
        if (PEAR_OS == "Windows") {
            return $this->_build_win32($descfile, $callback);
        }
 
        if (PEAR_OS != 'Unix') {
            return $this->raiseError("building extensions not supported on this platform");
        }
 
        if (is_object($descfile)) {
            $pkg = $descfile;
            $descfile = $pkg->getPackageFile();
            if (is_a($pkg, 'PEAR_PackageFile_v1')) {
                $dir = dirname($descfile);
            } else {
                $dir = $pkg->_config->get('temp_dir') . '/' . $pkg->getName();
                // automatically delete at session end
                self::addTempFile($dir);
            }
        } else {
            $pf = new PEAR_PackageFile($this->config);
            $pkg = &$pf->fromPackageFile($descfile, PEAR_VALIDATE_NORMAL);
            if (PEAR::isError($pkg)) {
                return $pkg;
            }
            $dir = dirname($descfile);
        }
 
        // Find config. outside of normal path - e.g. config.m4
        foreach (array_keys($pkg->getInstallationFileList()) as $item) {
          if (stristr(basename($item), 'config.m4') && dirname($item) != '.') {
            $dir .= DIRECTORY_SEPARATOR . dirname($item);
            break;
          }
        }
 
        $old_cwd = getcwd();
        if (!file_exists($dir) || !is_dir($dir) || !chdir($dir)) {
            return $this->raiseError("could not chdir to $dir");
        }
 
        $vdir = $pkg->getPackage() . '-' . $pkg->getVersion();
        if (is_dir($vdir)) {
            chdir($vdir);
        }
 
        $dir = getcwd();
        $this->log(2, "building in $dir");
        $binDir = $this->config->get('bin_dir');
        if (!preg_match('@(^|:)' . preg_quote($binDir, '@') . '(:|$)@', getenv('PATH'))) {
            putenv('PATH=' . $binDir . ':' . getenv('PATH'));
        }
        $err = $this->_runCommand($this->config->get('php_prefix')
                                . "phpize" .
                                $this->config->get('php_suffix'),
                                array(&$this, 'phpizeCallback'));
        if (PEAR::isError($err)) {
            return $err;
        }
 
        if (!$err) {
            return $this->raiseError("`phpize' failed");
        }
 
        // {{{ start of interactive part
        $configure_command = "$dir/configure";
 
        $phpConfigName = $this->config->get('php_prefix')
            . 'php-config'
            . $this->config->get('php_suffix');
        $phpConfigPath = System::which($phpConfigName);
        if ($phpConfigPath !== false) {
            $configure_command .= ' --with-php-config='
                . $phpConfigPath;
        }
 
        $configure_options = $pkg->getConfigureOptions();
        if ($configure_options) {
            foreach ($configure_options as $option) {
                $default = array_key_exists('default', $option) ? $option['default'] : null;
                if (array_key_exists($option['name'], $this->_parsed_configure_options)) {
                    $response = $this->_parsed_configure_options[$option['name']];
                } else {
                    list($response) = $this->ui->userDialog(
                            'build', [$option['prompt']], ['text'], [$default]);
                }
                if (substr($option['name'], 0, 5) === 'with-' &&
                    ($response === 'yes' || $response === 'autodetect')) {
                    $configure_command .= " --{$option['name']}";
                } else {
                    $configure_command .= " --{$option['name']}=".trim($response);
                }
            }
        }
        // }}} end of interactive part
 
        // FIXME make configurable
        if (!$user=getenv('USER')) {
            $user='defaultuser';
        }
 
        $tmpdir = $this->config->get('temp_dir');
        $build_basedir = System::mktemp(' -t "' . $tmpdir . '" -d "pear-build-' . $user . '"');
        $build_dir = "$build_basedir/$vdir";
        $inst_dir = "$build_basedir/install-$vdir";
        $this->log(1, "building in $build_dir");
        if (is_dir($build_dir)) {
            System::rm(array('-rf', $build_dir));
        }
 
        if (!System::mkDir(array('-p', $build_dir))) {
            return $this->raiseError("could not create build dir: $build_dir");
        }
 
        self::addTempFile($build_dir);
        if (!System::mkDir(array('-p', $inst_dir))) {
            return $this->raiseError("could not create temporary install dir: $inst_dir");
        }
        self::addTempFile($inst_dir);
 
        $make_command = getenv('MAKE') ? getenv('MAKE') : 'make';
 
        $to_run = array(
            $configure_command,
            $make_command,
            "$make_command INSTALL_ROOT=\"$inst_dir\" install",
            "find \"$inst_dir\" | xargs ls -dils"
            );
        if (!file_exists($build_dir) || !is_dir($build_dir) || !chdir($build_dir)) {
            return $this->raiseError("could not chdir to $build_dir");
        }
        putenv('PHP_PEAR_VERSION=1.10.18');
        foreach ($to_run as $cmd) {
            $err = $this->_runCommand($cmd, $callback);
            if (PEAR::isError($err)) {
                chdir($old_cwd);
                return $err;
            }
            if (!$err) {
                chdir($old_cwd);
                return $this->raiseError("`$cmd' failed");
            }
        }
        if (!($dp = opendir("modules"))) {
            chdir($old_cwd);
            return $this->raiseError("no `modules' directory found");
        }
        $built_files = array();
        $prefix = exec($this->config->get('php_prefix')
                        . "php-config" .
                       $this->config->get('php_suffix') . " --prefix");
        $this->_harvestInstDir($prefix, $inst_dir . DIRECTORY_SEPARATOR . $prefix, $built_files);
        chdir($old_cwd);
        return $built_files;
    }

References $response, _build_win32(), _harvestInstDir(), _runCommand(), PEAR_Common\addTempFile(), PEAR\isError(), log(), PEAR_OS, and PEAR_VALIDATE_NORMAL.

Here is the call graph for this function:

◆ log()

log	(	$level,
		$msg,
		$append_crlf = true )

Logging method.

Parameters

int	$level	log level (0 is quiet, higher is noisier)
string	$msg	message to write to the log

Returns: void

Reimplemented from PEAR_Common.

Definition at line 549 of file Builder.php.

    {
        if ($this->current_callback) {
            if ($this->debug >= $level) {
                call_user_func($this->current_callback, 'output', $msg);
            }
            return;
        }
        return parent::log($level, $msg, $append_crlf);
    }

Referenced by _build_win32(), _runCommand(), build(), and phpizeCallback().

Here is the caller graph for this function:

◆ msdevCallback()

msdevCallback	(		$what,
			$data )

Definition at line 227 of file Builder.php.

    {
        if (!$this->_firstline)
            $this->_firstline = $data;
        $this->_lastline = $data;
        call_user_func($this->current_callback, $what, $data);
    }

◆ phpizeCallback()

phpizeCallback	(		$what,
			$data )

Message callback function used when running the "phpize" program. Extracts the API numbers used. Ignores other message types than "cmdoutput".

Parameters

string	$what	the type of message
mixed	$data	the message

Returns: void

@access public

Definition at line 485 of file Builder.php.

    {
        if ($what != 'cmdoutput') {
            return;
        }
        $this->log(1, rtrim($data));
        if (preg_match('/You should update your .aclocal.m4/', $data)) {
            return;
        }
        $matches = array();
        if (preg_match('/^\s+(\S[^:]+):\s+(\d{8})/', $data, $matches)) {
            $member = preg_replace('/[^a-z]/', '_', strtolower($matches[1]));
            $apino = (int)$matches[2];
            if (isset($this->$member)) {
                $this->$member = $apino;
                //$msg = sprintf("%-22s : %d", $matches[1], $apino);
                //$this->log(1, $msg);
            }
        }
    }

References log().

Here is the call graph for this function:

Field Documentation

◆ $_firstline

$_firstline = null

Definition at line 57 of file Builder.php.

◆ $_lastline

$_lastline = null

Definition at line 56 of file Builder.php.

◆ $_parsed_configure_options

$_parsed_configure_options

Definition at line 64 of file Builder.php.

◆ $current_callback

$current_callback = null

Definition at line 53 of file Builder.php.

◆ $extensions_built

$extensions_built = array()

Definition at line 47 of file Builder.php.

◆ $php_api_version

$php_api_version = 0

Definition at line 43 of file Builder.php.

◆ $zend_extension_api_no

$zend_extension_api_no = 0

Definition at line 45 of file Builder.php.

◆ $zend_module_api_no

$zend_module_api_no = 0

Definition at line 44 of file Builder.php.

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

E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR/Builder.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _build_win32()

◆ _harvestInstDir()

◆ _parseConfigureOptions()

◆ _parseConfigureOptionsEndElement()

◆ _parseConfigureOptionsStartElement()

◆ _runCommand()

◆ build()

◆ log()

◆ msdevCallback()

◆ phpizeCallback()

Field Documentation

◆ $_firstline

◆ $_lastline

◆ $_parsed_configure_options

◆ $current_callback

◆ $extensions_built

◆ $php_api_version

◆ $zend_extension_api_no

◆ $zend_module_api_no