/usr/share/php/PEAR/Task/Postinstallscript.php is in php-pear 1:1.10.1+submodules+notgz-9+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | <?php
/**
* <tasks:postinstallscript>
*
* PHP versions 4 and 5
*
* @category pear
* @package PEAR
* @author Greg Beaver <cellog@php.net>
* @copyright 1997-2009 The Authors
* @license http://opensource.org/licenses/bsd-license.php New BSD License
* @link http://pear.php.net/package/PEAR
* @since File available since Release 1.4.0a1
*/
/**
* Base class
*/
require_once 'PEAR/Task/Common.php';
/**
* Implements the postinstallscript file task.
*
* Note that post-install scripts are handled separately from installation, by the
* "pear run-scripts" command
*
* @category pear
* @package PEAR
* @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.10.1
* @link http://pear.php.net/package/PEAR
* @since Class available since Release 1.4.0a1
*/
class PEAR_Task_Postinstallscript extends PEAR_Task_Common
{
public $type = 'script';
public $_class;
public $_params;
public $_obj;
/**
*
* @var PEAR_PackageFile_v2
*/
public $_pkg;
public $_contents;
public $phase = PEAR_TASK_INSTALL;
/**
* Validate the raw xml at parsing-time.
*
* This also attempts to validate the script to make sure it meets the criteria
* for a post-install script
*
* @param PEAR_PackageFile_v2
* @param array The XML contents of the <postinstallscript> tag
* @param PEAR_Config
* @param array the entire parsed <file> tag
*/
public static function validateXml($pkg, $xml, $config, $fileXml)
{
if ($fileXml['role'] != 'php') {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" must be role="php"', );
}
PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
$file = $pkg->getFileContents($fileXml['name']);
if (PEAR::isError($file)) {
PEAR::popErrorHandling();
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" is not valid: '.
$file->getMessage(), );
} elseif ($file === null) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" could not be retrieved for processing!', );
} else {
$analysis = $pkg->analyzeSourceCode($file, true);
if (!$analysis) {
PEAR::popErrorHandling();
$warnings = '';
foreach ($pkg->getValidationWarnings() as $warn) {
$warnings .= $warn['message']."\n";
}
return array(PEAR_TASK_ERROR_INVALID, 'Analysis of post-install script "'.
$fileXml['name'].'" failed: '.$warnings, );
}
if (count($analysis['declared_classes']) != 1) {
PEAR::popErrorHandling();
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" must declare exactly 1 class', );
}
$class = $analysis['declared_classes'][0];
if ($class != str_replace(
array('/', '.php'), array('_', ''),
$fileXml['name']
).'_postinstall') {
PEAR::popErrorHandling();
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" class "'.$class.'" must be named "'.
str_replace(
array('/', '.php'), array('_', ''),
$fileXml['name']
).'_postinstall"', );
}
if (!isset($analysis['declared_methods'][$class])) {
PEAR::popErrorHandling();
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" must declare methods init() and run()', );
}
$methods = array('init' => 0, 'run' => 1);
foreach ($analysis['declared_methods'][$class] as $method) {
if (isset($methods[$method])) {
unset($methods[$method]);
}
}
if (count($methods)) {
PEAR::popErrorHandling();
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" must declare methods init() and run()', );
}
}
PEAR::popErrorHandling();
$definedparams = array();
$tasksNamespace = $pkg->getTasksNs().':';
if (!isset($xml[$tasksNamespace.'paramgroup']) && isset($xml['paramgroup'])) {
// in order to support the older betas, which did not expect internal tags
// to also use the namespace
$tasksNamespace = '';
}
if (isset($xml[$tasksNamespace.'paramgroup'])) {
$params = $xml[$tasksNamespace.'paramgroup'];
if (!is_array($params) || !isset($params[0])) {
$params = array($params);
}
foreach ($params as $param) {
if (!isset($param[$tasksNamespace.'id'])) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" <paramgroup> must have '.
'an '.$tasksNamespace.'id> tag', );
}
if (isset($param[$tasksNamespace.'name'])) {
if (!in_array($param[$tasksNamespace.'name'], $definedparams)) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" '.$tasksNamespace.
'paramgroup> id "'.$param[$tasksNamespace.'id'].
'" parameter "'.$param[$tasksNamespace.'name'].
'" has not been previously defined', );
}
if (!isset($param[$tasksNamespace.'conditiontype'])) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" '.$tasksNamespace.
'paramgroup> id "'.$param[$tasksNamespace.'id'].
'" must have a '.$tasksNamespace.
'conditiontype> tag containing either "=", '.
'"!=", or "preg_match"', );
}
if (!in_array(
$param[$tasksNamespace.'conditiontype'],
array('=', '!=', 'preg_match')
)) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" '.$tasksNamespace.
'paramgroup> id "'.$param[$tasksNamespace.'id'].
'" must have a '.$tasksNamespace.
'conditiontype> tag containing either "=", '.
'"!=", or "preg_match"', );
}
if (!isset($param[$tasksNamespace.'value'])) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" '.$tasksNamespace.
'paramgroup> id "'.$param[$tasksNamespace.'id'].
'" must have a '.$tasksNamespace.
'value> tag containing expected parameter value', );
}
}
if (isset($param[$tasksNamespace.'instructions'])) {
if (!is_string($param[$tasksNamespace.'instructions'])) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" '.$tasksNamespace.
'paramgroup> id "'.$param[$tasksNamespace.'id'].
'" '.$tasksNamespace.'instructions> must be simple text', );
}
}
if (!isset($param[$tasksNamespace.'param'])) {
continue; // <param> is no longer required
}
$subparams = $param[$tasksNamespace.'param'];
if (!is_array($subparams) || !isset($subparams[0])) {
$subparams = array($subparams);
}
foreach ($subparams as $subparam) {
if (!isset($subparam[$tasksNamespace.'name'])) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" parameter for '.
$tasksNamespace.'paramgroup> id "'.
$param[$tasksNamespace.'id'].'" must have '.
'a '.$tasksNamespace.'name> tag', );
}
if (!preg_match(
'/[a-zA-Z0-9]+/',
$subparam[$tasksNamespace.'name']
)) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" parameter "'.
$subparam[$tasksNamespace.'name'].
'" for '.$tasksNamespace.'paramgroup> id "'.
$param[$tasksNamespace.'id'].
'" is not a valid name. Must contain only alphanumeric characters', );
}
if (!isset($subparam[$tasksNamespace.'prompt'])) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" parameter "'.
$subparam[$tasksNamespace.'name'].
'" for '.$tasksNamespace.'paramgroup> id "'.
$param[$tasksNamespace.'id'].
'" must have a '.$tasksNamespace.'prompt> tag', );
}
if (!isset($subparam[$tasksNamespace.'type'])) {
return array(PEAR_TASK_ERROR_INVALID, 'Post-install script "'.
$fileXml['name'].'" parameter "'.
$subparam[$tasksNamespace.'name'].
'" for '.$tasksNamespace.'paramgroup> id "'.
$param[$tasksNamespace.'id'].
'" must have a '.$tasksNamespace.'type> tag', );
}
$definedparams[] = $param[$tasksNamespace.'id'].'::'.
$subparam[$tasksNamespace.'name'];
}
}
}
return true;
}
/**
* Initialize a task instance with the parameters
* @param array $xml raw, parsed xml
* @param array $fileattribs attributes from the <file> tag containing
* this task
* @param string|null $lastversion last installed version of this package,
* if any (useful for upgrades)
*/
public function init($xml, $fileattribs, $lastversion)
{
$this->_class = str_replace('/', '_', $fileattribs['name']);
$this->_filename = $fileattribs['name'];
$this->_class = str_replace('.php', '', $this->_class).'_postinstall';
$this->_params = $xml;
$this->_lastversion = $lastversion;
}
/**
* Strip the tasks: namespace from internal params
*
* @access private
*/
public function _stripNamespace($params = null)
{
if ($params === null) {
$params = array();
if (!is_array($this->_params)) {
return;
}
foreach ($this->_params as $i => $param) {
if (is_array($param)) {
$param = $this->_stripNamespace($param);
}
$params[str_replace($this->_pkg->getTasksNs().':', '', $i)] = $param;
}
$this->_params = $params;
} else {
$newparams = array();
foreach ($params as $i => $param) {
if (is_array($param)) {
$param = $this->_stripNamespace($param);
}
$newparams[str_replace($this->_pkg->getTasksNs().':', '', $i)] = $param;
}
return $newparams;
}
}
/**
* Unlike other tasks, the installed file name is passed in instead of the
* file contents, because this task is handled post-installation
*
* @param mixed $pkg PEAR_PackageFile_v1|PEAR_PackageFile_v2
* @param string $contents file name
*
* @return bool|PEAR_Error false to skip this file, PEAR_Error to fail
* (use $this->throwError)
*/
public function startSession($pkg, $contents)
{
if ($this->installphase != PEAR_TASK_INSTALL) {
return false;
}
// remove the tasks: namespace if present
$this->_pkg = $pkg;
$this->_stripNamespace();
$this->logger->log(
0, 'Including external post-installation script "'.
$contents.'" - any errors are in this script'
);
include_once $contents;
if (class_exists($this->_class)) {
$this->logger->log(0, 'Inclusion succeeded');
} else {
return $this->throwError(
'init of post-install script class "'.$this->_class
.'" failed'
);
}
$this->_obj = new $this->_class();
$this->logger->log(1, 'running post-install script "'.$this->_class.'->init()"');
PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
$res = $this->_obj->init($this->config, $pkg, $this->_lastversion);
PEAR::popErrorHandling();
if ($res) {
$this->logger->log(0, 'init succeeded');
} else {
return $this->throwError(
'init of post-install script "'.$this->_class.
'->init()" failed'
);
}
$this->_contents = $contents;
return true;
}
/**
* No longer used
*
* @see PEAR_PackageFile_v2::runPostinstallScripts()
* @param array an array of tasks
* @param string install or upgrade
* @access protected
*/
public static function run()
{
}
}
|