wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php

   1 <?php
   2 namespace wcf\system\package;
   3 use wcf\data\application\Application;
   4 use wcf\data\application\ApplicationEditor;
   5 use wcf\data\language\category\LanguageCategory;
   6 use wcf\data\language\LanguageEditor;
   7 use wcf\data\language\LanguageList;
   8 use wcf\data\option\OptionEditor;
   9 use wcf\data\package\installation\queue\PackageInstallationQueue;
  10 use wcf\data\package\installation\queue\PackageInstallationQueueEditor;
  11 use wcf\data\package\Package;
  12 use wcf\data\package\PackageEditor;
  13 use wcf\system\cache\CacheHandler;
  14 use wcf\system\database\statement\PreparedStatement;
  15 use wcf\system\database\util\PreparedStatementConditionBuilder;
  16 use wcf\system\exception\SystemException;
  17 use wcf\system\form\container;
  18 use wcf\system\form\element;
  19 use wcf\system\form\FormDocument;
  20 use wcf\system\form;
  21 use wcf\system\language\LanguageFactory;
  22 use wcf\system\menu\acp\ACPMenu;
  23 use wcf\system\request\LinkHandler;
  24 use wcf\system\request\RouteHandler;
  25 use wcf\system\WCF;
  26 use wcf\util\FileUtil;
  27 use wcf\util\HeaderUtil;
  28 use wcf\util\StringUtil;
  29
  30 /**
  31  * PackageInstallationDispatcher handles the whole installation process.
  32  *
  33  * @author      Alexander Ebert
  34  * @copyright   2001-2012 WoltLab GmbH
  35  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  36  * @package     com.woltlab.wcf
  37  * @subpackage  system.package
  38  * @category    Community Framework
  39  */
  40 class PackageInstallationDispatcher {
  41         /**
  42          * current installation type
  43          * @var string
  44          */
  45         protected $action = '';
  46
  47         /**
  48          * instance of PackageArchive
  49          * @var wcf\system\package\PackageArchive
  50          */
  51         public $archive = null;
  52
  53         /**
  54          * instance of PackageInstallationNodeBuilder
  55          * @var wcf\system\package\PackageInstallationNodeBuilder
  56          */
  57         public $nodeBuilder = null;
  58
  59         /**
  60          * instance of Package
  61          * @var wcf\data\package\Package
  62          */
  63         public $package = null;
  64
  65         /**
  66          * instance of PackageInstallationQueue
  67          * @var wcf\system\package\PackageInstallationQueue
  68          */
  69         public $queue = null;
  70
  71         /**
  72          * default name of the config file
  73          * @var string
  74          */
  75         const CONFIG_FILE = 'config.inc.php';
  76
  77         /**
  78          * Creates a new instance of PackageInstallationDispatcher.
  79          *
  80          * @param       wcf\data\package\installation\queue\PackageInstallationQueue    $queue
  81          */
  82         public function __construct(PackageInstallationQueue $queue) {
  83                 $this->queue = $queue;
  84                 $this->nodeBuilder = new PackageInstallationNodeBuilder($this);
  85
  86                 $this->action = $this->queue->action;
  87         }
  88
  89         /**
  90          * Installs node components and returns next node.
  91          *
  92          * @param       string          $node
  93          * @return      PackageInstallationStep
  94          */
  95         public function install($node) {
  96                 $nodes = $this->nodeBuilder->getNodeData($node);
  97
  98                 // invoke node-specific actions
  99                 foreach ($nodes as $data) {
 100                         $nodeData = unserialize($data['nodeData']);
 101
 102                         switch ($data['nodeType']) {
 103                                 case 'package':
 104                                         $step = $this->installPackage($nodeData);
 105                                 break;
 106
 107                                 case 'pip':
 108                                         $step = $this->executePIP($nodeData);
 109                                 break;
 110
 111                                 case 'optionalPackages':
 112                                         $step = $this->selectOptionalPackages($node, $nodeData);
 113                                 break;
 114
 115                                 default:
 116                                         die("Unknown node type: '".$data['nodeType']."'");
 117                                 break;
 118                         }
 119
 120                         if ($step->splitNode()) {
 121                                 $this->nodeBuilder->cloneNode($node, $data['sequenceNo']);
 122                                 break;
 123                         }
 124                 }
 125
 126                 // mark node as completed
 127                 $this->nodeBuilder->completeNode($node);
 128
 129                 // assign next node
 130                 $node = $this->nodeBuilder->getNextNode($node);
 131                 $step->setNode($node);
 132
 133                 // update options.inc.php and save localized package infos
 134                 if ($node == '') {
 135                         OptionEditor::resetCache();
 136
 137                         if ($this->action == 'install') {
 138                                 $this->saveLocalizedPackageInfos();
 139
 140                                 // remove all cache files after WCFSetup
 141                                 if (!PACKAGE_ID) {
 142                                         CacheHandler::getInstance()->clear(WCF_DIR.'cache/', 'cache.*.php');
 143                                 }
 144                         }
 145                 }
 146
 147                 return $step;
 148         }
 149
 150         /**
 151          * Returns current package archive.
 152          *
 153          * @return      PackageArchive
 154          */
 155         public function getArchive() {
 156                 if ($this->archive === null) {
 157                         $this->archive = new PackageArchive($this->queue->archive, $this->getPackage());
 158
 159                         if (FileUtil::isURL($this->archive->getArchive())) {
 160                                 // get return value and update entry in
 161                                 // package_installation_queue with this value
 162                                 $archive = $this->archive->downloadArchive();
 163                                 $queueEditor = new PackageInstallationQueueEditor($this->queue);
 164                                 $queueEditor->update(array(
 165                                         'archive' => $archive
 166                                 ));
 167                         }
 168
 169                         $this->archive->openArchive();
 170                 }
 171
 172                 return $this->archive;
 173         }
 174
 175         /**
 176          * Installs current package.
 177          *
 178          * @param       array           $nodeData
 179          */
 180         protected function installPackage(array $nodeData) {
 181                 $installationStep = new PackageInstallationStep();
 182
 183                 // check requirements
 184                 if (!empty($nodeData['requirements'])) {
 185                         foreach ($nodeData['requirements'] as $package => $requirementData) {
 186                                 // get existing package
 187                                 if ($requirementData['packageID']) {
 188                                         $sql = "SELECT  packageName, packageVersion
 189                                                 FROM    wcf".WCF_N."_package
 190                                                 WHERE   packageID = ?";
 191                                         $statement = WCF::getDB()->prepareStatement($sql);
 192                                         $statement->execute(array($requirementData['packageID']));
 193                                 }
 194                                 else {
 195                                         // try to find matching package
 196                                         $sql = "SELECT  packageName, packageVersion
 197                                                 FROM    wcf".WCF_N."_package
 198                                                 WHERE   package = ?";
 199                                         $statement = WCF::getDB()->prepareStatement($sql);
 200                                         $statement->execute(array($package));
 201                                 }
 202                                 $row = $statement->fetchArray();
 203
 204                                 // package is required but not available
 205                                 if ($row === false) {
 206                                         throw new SystemException("Package '".$package."' is required by '".$nodeData['packageName']."', but is neither installed nor shipped.");
 207                                 }
 208
 209                                 // check version requirements
 210                                 if ($requirementData['minVersion']) {
 211                                         if (Package::compareVersion($row['packageVersion'], $requirementData['minVersion']) < 0) {
 212                                                 throw new SystemException("Package '".$nodeData['packageName']."' requires the package '".$row['packageName']."' in version '".$requirementData['minVersion']."', but version '".$row['packageVersion']."'");
 213                                         }
 214                                 }
 215                         }
 216                 }
 217                 unset($nodeData['requirements']);
 218
 219                 if (!$this->queue->packageID) {
 220                         // create package entry
 221                         $package = PackageEditor::create($nodeData);
 222
 223                         // update package id for current queue
 224                         $queueEditor = new PackageInstallationQueueEditor($this->queue);
 225                         $queueEditor->update(array(
 226                                 'packageID' => $package->packageID
 227                         ));
 228
 229                         // save excluded packages
 230                         if (count($this->getArchive()->getExcludedPackages()) > 0) {
 231                                 $sql = "INSERT INTO     wcf".WCF_N."_package_exclusion
 232                                                         (packageID, excludedPackage, excludedPackageVersion)
 233                                         VALUES          (?, ?, ?)";
 234                                 $statement = WCF::getDB()->prepareStatement($sql);
 235
 236                                 foreach ($this->getArchive()->getExcludedPackages() as $excludedPackage) {
 237                                         $statement->execute(array($package->packageID, $excludedPackage['name'], (!empty($excludedPackage['version']) ? $excludedPackage['version'] : '')));
 238                                 }
 239                         }
 240
 241                         // if package is plugin to com.woltlab.wcf it must not have any other requirement
 242                         $requirements = $this->getArchive()->getRequirements();
 243                         if ($package->parentPackageID == 1 && !empty($requirements)) {
 244                                 foreach ($requirements as $package => $data) {
 245                                         if ($package == 'com.woltlab.wcf') continue;
 246                                         throw new SystemException('Package '.$package->package.' is plugin of com.woltlab.wcf (WCF) but has more than one requirement.');
 247                                 }
 248                         }
 249
 250                         // insert requirements and dependencies
 251                         $requirements = $this->getArchive()->getAllExistingRequirements();
 252                         if (!empty($requirements)) {
 253                                 $sql = "INSERT INTO     wcf".WCF_N."_package_requirement
 254                                                         (packageID, requirement)
 255                                         VALUES          (?, ?)";
 256                                 $statement = WCF::getDB()->prepareStatement($sql);
 257
 258                                 foreach ($requirements as $identifier => $possibleRequirements) {
 259                                         if (count($possibleRequirements) == 1) {
 260                                                 $requirement = array_shift($possibleRequirements);
 261                                         }
 262                                         else {
 263                                                 $requirement = $possibleRequirements[$this->selectedRequirements[$identifier]];
 264                                         }
 265
 266                                         $statement->execute(array($package->packageID, $requirement['packageID']));
 267                                 }
 268                         }
 269
 270                         // build requirement map
 271                         Package::rebuildPackageRequirementMap($package->packageID);
 272
 273                         // rebuild dependencies
 274                         Package::rebuildPackageDependencies($package->packageID);
 275                         if ($this->action == 'update') {
 276                                 Package::rebuildParentPackageDependencies($package->packageID);
 277                         }
 278
 279                         // reload queue
 280                         $this->queue = new PackageInstallationQueue($this->queue->queueID);
 281                         $this->package = null;
 282
 283                         if ($package->isApplication) {
 284                                 $host = StringUtil::replace(RouteHandler::getProtocol(), '', RouteHandler::getHost());
 285                                 $path = RouteHandler::getPath(array('acp'));
 286
 287                                 // insert as application
 288                                 ApplicationEditor::create(array(
 289                                         'domainName' => $host,
 290                                         'domainPath' => $path,
 291                                         'cookieDomain' => $host,
 292                                         'cookiePath' => $path,
 293                                         'packageID' => $package->packageID
 294                                 ));
 295                         }
 296
 297                         // insert dependencies on parent package if applicable
 298                         $this->installPackageParent();
 299                 }
 300
 301                 if ($this->getPackage()->isApplication && $this->getPackage()->package != 'com.woltlab.wcf' && $this->getAction() == 'install') {
 302                         if (empty($this->getPackage()->packageDir)) {
 303                                 $document = $this->promptPackageDir();
 304                                 if ($document !== null && $document instanceof form\FormDocument) {
 305                                         $installationStep->setDocument($document);
 306                                 }
 307
 308                                 $installationStep->setSplitNode();
 309                         }
 310                 }
 311                 else if ($this->getPackage()->parentPackageID) {
 312                         $packageEditor = new PackageEditor($this->getPackage());
 313                         $packageEditor->update(array(
 314                                 'packageDir' => $this->getPackage()->getParentPackage()->packageDir
 315                         ));
 316                 }
 317
 318                 return $installationStep;
 319         }
 320
 321         /**
 322          * Saves the localized package infos.
 323          *
 324          * @todo        license and readme
 325          */
 326         protected function saveLocalizedPackageInfos() {
 327                 $package = new Package($this->queue->packageID);
 328
 329                 // localize package information
 330                 $sql = "INSERT INTO     wcf".WCF_N."_language_item
 331                                         (languageID, languageItem, languageItemValue, languageCategoryID, packageID)
 332                         VALUES          (?, ?, ?, ?, ?)";
 333                 $statement = WCF::getDB()->prepareStatement($sql);
 334
 335                 // get language list
 336                 $languageList = new LanguageList();
 337                 $languageList->sqlLimit = 0;
 338                 $languageList->readObjects();
 339
 340                 // workaround for WCFSetup
 341                 if (!PACKAGE_ID) {
 342                         $sql = "SELECT  *
 343                                 FROM    wcf".WCF_N."_language_category
 344                                 WHERE   languageCategory = ?";
 345                         $statement2 = WCF::getDB()->prepareStatement($sql);
 346                         $statement2->execute(array('wcf.acp.package'));
 347                         $languageCategory = $statement2->fetchObject('wcf\data\language\category\LanguageCategory');
 348                 }
 349                 else {
 350                         $languageCategory = LanguageFactory::getInstance()->getCategory('wcf.acp.package');
 351                 }
 352
 353                 // save package name
 354                 $this->saveLocalizedPackageInfo($statement, $languageList, $languageCategory, $package, 'packageName');
 355
 356                 // save package description
 357                 $this->saveLocalizedPackageInfo($statement, $languageList, $languageCategory, $package, 'packageDescription');
 358
 359                 // update description and name
 360                 $packageEditor = new PackageEditor($package);
 361                 $packageEditor->update(array(
 362                         'packageDescription' => 'wcf.acp.package.packageDescription.package'.$this->queue->packageID,
 363                         'packageName' => 'wcf.acp.package.packageName.package'.$this->queue->packageID
 364                 ));
 365         }
 366
 367         /**
 368          * Saves a localized package info.
 369          *
 370          * @param       wcf\system\database\statement\PreparedStatement         $statement
 371          * @param       wcf\data\language\LanguageList                          $languageList
 372          * @param       wcf\data\language\category\LanguageCategory             $languageCategory
 373          * @param       wcf\data\package\Package                                $package
 374          * @param       string                                                  $infoName
 375          */
 376         protected function saveLocalizedPackageInfo(PreparedStatement $statement, $languageList, LanguageCategory $languageCategory, Package $package, $infoName) {
 377                 $infoValues = $this->getArchive()->getPackageInfo($infoName);
 378
 379                 // get default value for languages without specified information
 380                 $defaultValue = '';
 381                 if (isset($infoValues['default'])) {
 382                         $defaultValue = $infoValues['default'];
 383                 }
 384                 else if (isset($infoValues['en'])) {
 385                         // fallback to English
 386                         $defaultValue = $infoValues['en'];
 387                 }
 388                 else if (isset($infoValues[WCF::getLanguage()->getFixedLanguageCode()])) {
 389                         // fallback to the language of the current user
 390                         $defaultValue = $infoValues[WCF::getLanguage()->getFixedLanguageCode()];
 391                 }
 392                 else if ($infoName == 'packageName') {
 393                         // fallback to the package identifier for the package name
 394                         $defaultValue = $this->archive->getPackageInfo('name');
 395                 }
 396
 397                 foreach ($languageList as $language) {
 398                         $value = $defaultValue;
 399                         if (isset($infoValues[$language->languageCode])) {
 400                                 $value = $infoValues[$language->languageCode];
 401                         }
 402
 403                         $statement->execute(array(
 404                                 $language->languageID,
 405                                 'wcf.acp.package.'.$infoName.'.package'.$package->packageID,
 406                                 $value,
 407                                 $languageCategory->languageCategoryID,
 408                                 1
 409                         ));
 410                 }
 411         }
 412
 413         /**
 414          * Sets parent package and rebuilds dependencies for both.
 415          */
 416         protected function installPackageParent() {
 417                 // do not handle parent package if current package is an application or does not have a plugin tag while within installation process
 418                 if ($this->getArchive()->getPackageInfo('isApplication') || $this->getAction() != 'install' || !$this->getArchive()->getPackageInfo('plugin')) {
 419                         return;
 420                 }
 421
 422                 // get parent package from requirements
 423                 $sql = "SELECT  requirement
 424                         FROM    wcf".WCF_N."_package_requirement
 425                         WHERE   packageID = ?
 426                                 AND requirement IN (
 427                                         SELECT  packageID
 428                                         FROM    wcf".WCF_N."_package
 429                                         WHERE   package = ?
 430                                 )";
 431                 $statement = WCF::getDB()->prepareStatement($sql);
 432                 $statement->execute(array(
 433                         $this->getPackage()->packageID,
 434                         $this->getArchive()->getPackageInfo('plugin')
 435                 ));
 436                 $row = $statement->fetchArray();
 437                 if (!$row || empty($row['requirement'])) {
 438                         throw new SystemException("can not find any available installations of required parent package '".$this->getArchive()->getPackageInfo('plugin')."'");
 439                 }
 440
 441                 // save parent package
 442                 $packageEditor = new PackageEditor($this->getPackage());
 443                 $packageEditor->update(array(
 444                         'parentPackageID' => $row['requirement']
 445                 ));
 446
 447                 // rebuild parent package dependencies
 448                 Package::rebuildParentPackageDependencies($this->getPackage()->packageID);
 449
 450                 // rebuild parent's parent package dependencies
 451                 Package::rebuildParentPackageDependencies($row['requirement']);
 452
 453                 // reload package object on next request
 454                 $this->package = null;
 455         }
 456
 457         /**
 458          * Executes a package installation plugin.
 459          *
 460          * @param       array           step
 461          * @return      boolean
 462          */
 463         protected function executePIP(array $nodeData) {
 464                 $step = new PackageInstallationStep();
 465
 466                 // fetch all pips associated with current PACKAGE_ID and include pips
 467                 // previously installed by current installation queue
 468                 $sql = "SELECT  pluginName, className
 469                         FROM    wcf".WCF_N."_package_installation_plugin
 470                         WHERE   pluginName = ?";
 471                 $statement = WCF::getDB()->prepareStatement($sql);
 472                 $statement->execute(array(
 473                         $nodeData['pip']
 474                 ));
 475                 $row = $statement->fetchArray();
 476
 477                 // PIP is unknown
 478                 if (!$row || (strcmp($nodeData['pip'], $row['pluginName']) !== 0)) {
 479                         throw new SystemException("unable to find package installation plugin '".$nodeData['pip']."'");
 480                 }
 481
 482                 // valdidate class definition
 483                 $className = $row['className'];
 484                 if (!class_exists($className)) {
 485                         throw new SystemException("unable to find class '".$className."'");
 486                 }
 487
 488                 $plugin = new $className($this, $nodeData);
 489
 490                 if (!($plugin instanceof \wcf\system\package\plugin\IPackageInstallationPlugin)) {
 491                         throw new SystemException("'".$className."' does not implement 'wcf\system\package\plugin\IPackageInstallationPlugin'");
 492                 }
 493
 494                 // execute PIP
 495                 try {
 496                         $document = $plugin->{$this->action}();
 497                 }
 498                 catch (SplitNodeException $e) {
 499                         $step->setSplitNode();
 500                 }
 501
 502                 if ($document !== null && ($document instanceof FormDocument)) {
 503                         $step->setDocument($document);
 504                         $step->setSplitNode();
 505                 }
 506
 507                 return $step;
 508         }
 509
 510         protected function selectOptionalPackages($currentNode, array $nodeData) {
 511                 $installationStep = new PackageInstallationStep();
 512
 513                 $document = $this->promptOptionalPackages($nodeData);
 514                 if ($document !== null && $document instanceof form\FormDocument) {
 515                         $installationStep->setDocument($document);
 516                         $installationStep->setSplitNode();
 517                 }
 518                 // insert new nodes for each package
 519                 else if (is_array($document)) {
 520                         // get target child node
 521                         $node = $currentNode;
 522                         $queue = $this->queue;
 523                         $shiftNodes = false;
 524
 525                         foreach ($nodeData as $package) {
 526                                 if (in_array($package['package'], $document)) {
 527                                         if (!$shiftNodes) {
 528                                                 $this->nodeBuilder->shiftNodes($currentNode, 'tempNode');
 529                                                 $shiftNodes = true;
 530                                         }
 531
 532                                         $queue = PackageInstallationQueueEditor::create(array(
 533                                                 'parentQueueID' => $queue->queueID,
 534                                                 'processNo' => $this->queue->processNo,
 535                                                 'userID' => WCF::getUser()->userID,
 536                                                 'package' => $package['package'],
 537                                                 'packageName' => $package['packageName'],
 538                                                 'archive' => $package['archive'],
 539                                                 'action' => $queue->action
 540                                         ));
 541
 542                                         $installation = new PackageInstallationDispatcher($queue);
 543                                         $installation->nodeBuilder->setParentNode($node);
 544                                         $installation->nodeBuilder->buildNodes();
 545                                         $node = $installation->nodeBuilder->getCurrentNode();
 546                                 }
 547                         }
 548
 549                         // shift nodes
 550                         if ($shiftNodes) {
 551                                 $this->nodeBuilder->shiftNodes('tempNode', $node);
 552                         }
 553                 }
 554
 555                 return $installationStep;
 556         }
 557
 558         /**
 559          * Extracts files from .tar (or .tar.gz) archive and installs them
 560          *
 561          * @param       string                  $targetDir
 562          * @param       string                  $sourceArchive
 563          * @param       FileHandler             $fileHandler
 564          * @return      wcf\system\setup\Installer
 565          */
 566         public function extractFiles($targetDir, $sourceArchive, $fileHandler = null) {
 567                 return new \wcf\system\setup\Installer($targetDir, $sourceArchive, $fileHandler);
 568         }
 569
 570         /**
 571          * Returns current package.
 572          *
 573          * @return      wcf\data\package\Package
 574          */
 575         public function getPackage() {
 576                 if ($this->package === null) {
 577                         $this->package = new Package($this->queue->packageID);
 578                 }
 579
 580                 return $this->package;
 581         }
 582
 583         /**
 584          * Prompts for a text input for package directory (applies for applications only)
 585          *
 586          * @return      wcf\system\form\FormDocument
 587          */
 588         protected function promptPackageDir() {
 589                 if (!PackageInstallationFormManager::findForm($this->queue, 'packageDir')) {
 590
 591                         $container = new container\GroupFormElementContainer();
 592                         $packageDir = new element\TextInputFormElement($container);
 593                         $packageDir->setName('packageDir');
 594                         $packageDir->setLabel(WCF::getLanguage()->get('wcf.acp.package.packageDir.input'));
 595
 596                         $path = RouteHandler::getPath(array('wcf', 'acp'));
 597                         $defaultPath = FileUtil::addTrailingSlash(FileUtil::unifyDirSeperator($_SERVER['DOCUMENT_ROOT'] . $path));
 598                         $packageDir->setValue($defaultPath);
 599                         $container->appendChild($packageDir);
 600
 601                         $document = new form\FormDocument('packageDir');
 602                         $document->appendContainer($container);
 603
 604                         PackageInstallationFormManager::registerForm($this->queue, $document);
 605                         return $document;
 606                 }
 607                 else {
 608                         $document = PackageInstallationFormManager::getForm($this->queue, 'packageDir');
 609                         $document->handleRequest();
 610                         $packageDir = $document->getValue('packageDir');
 611
 612                         if ($packageDir !== null) {
 613                                 // validate package dir
 614                                 if (file_exists(FileUtil::addTrailingSlash($packageDir) . 'global.php')) {
 615                                         $document->setError('packageDir', WCF::getLanguage()->get('wcf.acp.package.packageDir.notAvailable'));
 616                                         return $document;
 617                                 }
 618
 619                                 // set package dir
 620                                 $packageEditor = new PackageEditor($this->getPackage());
 621                                 $packageEditor->update(array(
 622                                         'packageDir' => FileUtil::getRelativePath(WCF_DIR, $packageDir)
 623                                 ));
 624
 625                                 // parse domain path
 626                                 $domainPath = FileUtil::getRelativePath(FileUtil::unifyDirSeperator($_SERVER['DOCUMENT_ROOT']), FileUtil::unifyDirSeperator($packageDir));
 627                                 $domainPath = FileUtil::addLeadingSlash(FileUtil::addTrailingSlash($domainPath));
 628
 629                                 // update application path
 630                                 $application = new Application($this->getPackage()->packageID);
 631                                 $applicationEditor = new ApplicationEditor($application);
 632                                 $applicationEditor->update(array(
 633                                         'domainPath' => $domainPath,
 634                                         'cookiePath' => $domainPath
 635                                 ));
 636
 637                                 // create directory and set permissions
 638                                 @mkdir($packageDir, 0777, true);
 639                                 @chmod($packageDir, 0777);
 640                         }
 641
 642                         return null;
 643                 }
 644         }
 645
 646         protected function promptOptionalPackages(array $packages) {
 647                 if (!PackageInstallationFormManager::findForm($this->queue, 'optionalPackages')) {
 648                         $container = new container\MultipleSelectionFormElementContainer();
 649                         $container->setName('optionalPackages');
 650
 651                         foreach ($packages as $package) {
 652                                 $optionalPackage = new element\MultipleSelectionFormElement($container);
 653                                 $optionalPackage->setName('optionalPackages');
 654                                 $optionalPackage->setLabel($package['packageName']);
 655                                 $optionalPackage->setValue($package['package']);
 656
 657                                 $container->appendChild($optionalPackage);
 658                         }
 659
 660                         $document = new form\FormDocument('optionalPackages');
 661                         $document->appendContainer($container);
 662
 663                         PackageInstallationFormManager::registerForm($this->queue, $document);
 664                         return $document;
 665                 }
 666                 else {
 667                         $document = PackageInstallationFormManager::getForm($this->queue, 'optionalPackages');
 668                         $document->handleRequest();
 669
 670                         return $document->getValue('optionalPackages');
 671                 }
 672         }
 673
 674         /**
 675          * Returns current package id.
 676          *
 677          * @return      integer
 678          */
 679         public function getPackageID() {
 680                 return $this->queue->packageID;
 681         }
 682
 683         /**
 684          * Returns current package installation type.
 685          *
 686          * @return      string
 687          */
 688         public function getAction() {
 689                 return $this->action;
 690         }
 691
 692         /**
 693          * Opens the package installation queue and
 694          * starts the installation, update or uninstallation of the first entry.
 695          *
 696          * @param       integer         $parentQueueID
 697          * @param       integer         $processNo
 698          */
 699         public static function openQueue($parentQueueID = 0, $processNo = 0) {
 700                 $conditions = new PreparedStatementConditionBuilder();
 701                 $conditions->add("userID = ?", array(WCF::getUser()->userID));
 702                 $conditions->add("parentQueueID = ?", array($parentQueueID));
 703                 if ($processNo != 0) $conditions->add("processNo = ?", array($processNo));
 704                 $conditions->add("done = ?", array(0));
 705
 706                 $sql = "SELECT          *
 707                         FROM            wcf".WCF_N."_package_installation_queue
 708                         ".$conditions."
 709                         ORDER BY        queueID ASC";
 710                 $statement = WCF::getDB()->prepareStatement($sql);
 711                 $statement->execute($conditions->getParameters());
 712                 $packageInstallation = $statement->fetchArray();
 713
 714                 if (!isset($packageInstallation['queueID'])) {
 715                         $url = LinkHandler::getInstance()->getLink('PackageList');
 716                         HeaderUtil::redirect($url);
 717                         exit;
 718                 }
 719                 else {
 720                         $url = LinkHandler::getInstance()->getLink('Package', array(), 'action='.$packageInstallation['action'].'&queueID='.$packageInstallation['queueID']);
 721                         HeaderUtil::redirect($url);
 722                         exit;
 723                 }
 724         }
 725
 726         /**
 727          * Displays last confirmation before plugin installation.
 728          */
 729         public function beginInstallation() {
 730                 // get requirements
 731                 $requirements = $this->getArchive()->getRequirements();
 732                 $openRequirements = $this->getArchive()->getOpenRequirements();
 733
 734                 $updatableInstances = array();
 735                 $missingPackages = 0;
 736                 foreach ($requirements as $key => $requirement) {
 737                         if (isset($openRequirements[$requirement['name']])) {
 738                                 $requirements[$key]['status'] = 'missing';
 739                                 $requirements[$key]['action'] = $openRequirements[$requirement['name']]['action'];
 740
 741                                 if (!isset($requirements[$key]['file'])) {
 742                                         if ($openRequirements[$requirement['name']]['action'] === 'update') {
 743                                                 $requirements[$key]['status'] = 'missingVersion';
 744                                                 $requirements[$key]['existingVersion'] = $openRequirements[$requirement['name']]['existingVersion'];
 745                                         }
 746                                         $missingPackages++;
 747                                 }
 748                                 else {
 749                                         $requirements[$key]['status'] = 'delivered';
 750                                 }
 751                         }
 752                         else {
 753                                 $requirements[$key]['status'] = 'installed';
 754                         }
 755                 }
 756
 757                 // get other instances
 758                 if ($this->action == 'install') {
 759                         $updatableInstances = $this->getArchive()->getUpdatableInstances();
 760                 }
 761
 762                 ACPMenu::getInstance()->setActiveMenuItem('wcf.acp.menu.link.package.install');
 763                 WCF::getTPL()->assign(array(
 764                         'archive' => $this->getArchive(),
 765                         'requiredPackages' => $requirements,
 766                         'missingPackages' => $missingPackages,
 767                         'updatableInstances' => $updatableInstances,
 768                         'excludingPackages' => $this->getArchive()->getConflictedExcludingPackages(),
 769                         'excludedPackages' => $this->getArchive()->getConflictedExcludedPackages(),
 770                         'queueID' => $this->queue->queueID
 771                 ));
 772                 WCF::getTPL()->display('packageInstallationConfirm');
 773                 exit;
 774         }
 775
 776         /**
 777          * Checks the package installation queue for outstanding entries.
 778          *
 779          * @return      integer
 780          */
 781         public static function checkPackageInstallationQueue() {
 782                 $sql = "SELECT          queueID
 783                         FROM            wcf".WCF_N."_package_installation_queue
 784                         WHERE           userID = ?
 785                                         AND parentQueueID = 0
 786                                         AND done = 0
 787                         ORDER BY        queueID ASC";
 788                 $statement = WCF::getDB()->prepareStatement($sql);
 789                 $statement->execute(array(WCF::getUser()->userID));
 790                 $row = $statement->fetchArray();
 791
 792                 if (!$row) {
 793                         return 0;
 794                 }
 795
 796                 return $row['queueID'];
 797         }
 798
 799         /**
 800          * Executes post-setup actions.
 801          */
 802         public function completeSetup() {
 803                 // rebuild dependencies
 804                 Package::rebuildPackageDependencies($this->queue->packageID);
 805
 806                 // mark queue as done
 807                 $queueEditor = new PackageInstallationQueueEditor($this->queue);
 808                 $queueEditor->update(array(
 809                         'done' => 1
 810                 ));
 811
 812                 // remove node data
 813                 $this->nodeBuilder->purgeNodes();
 814
 815                 // update package version
 816                 if ($this->action == 'update') {
 817                         $packageEditor = new PackageEditor($this->getPackage());
 818                         $packageEditor->update(array(
 819                                 'updateDate' => TIME_NOW,
 820                                 'packageVersion' => $this->archive->getPackageInfo('version')
 821                         ));
 822                 }
 823
 824                 // clear language files once whole installation is completed
 825                 LanguageEditor::deleteLanguageFiles();
 826
 827                 // reset all caches
 828                 CacheHandler::getInstance()->clear(WCF_DIR.'cache/', '*');
 829         }
 830
 831         /**
 832          * Updates queue information.
 833          */
 834         public function updatePackage() {
 835                 if (empty($this->queue->packageName)) {
 836                         $queueEditor = new PackageInstallationQueueEditor($this->queue);
 837                         $queueEditor->update(array(
 838                                 'packageName' => $this->getArchive()->getLocalizedPackageInfo('packageName')
 839                         ));
 840
 841                         // reload queue
 842                         $this->queue = new PackageInstallationQueue($this->queue->queueID);
 843                 }
 844         }
 845
 846         /**
 847          * Validates specific php requirements.
 848          *
 849          * @param       array           $requirements
 850          * @return      array<array>
 851          */
 852         public static function validatePHPRequirements(array $requirements) {
 853                 $errors = array();
 854
 855                 // validate php version
 856                 if (isset($requirements['version'])) {
 857                         $passed = false;
 858                         if (version_compare(PHP_VERSION, $requirements['version'], '>=')) {
 859                                 $passed = true;
 860                         }
 861
 862                         if (!$passed) {
 863                                 $errors['version'] = array(
 864                                         'required' => $requirements['version'],
 865                                         'installed' => PHP_VERSION
 866                                 );
 867                         }
 868                 }
 869
 870                 // validate extensions
 871                 if (isset($requirements['extensions'])) {
 872                         foreach ($requirements['extensions'] as $extension) {
 873                                 $passed = (extension_loaded($extension)) ? true : false;
 874
 875                                 if (!$passed) {
 876                                         $errors['extension'][] = array(
 877                                                 'extension' => $extension
 878                                         );
 879                                 }
 880                         }
 881                 }
 882
 883                 // validate settings
 884                 if (isset($requirements['settings'])) {
 885                         foreach ($requirements['settings'] as $setting => $value) {
 886                                 $iniValue = ini_get($setting);
 887
 888                                 $passed = self::compareSetting($setting, $value, $iniValue);
 889                                 if (!$passed) {
 890                                         $errors['setting'][] = array(
 891                                                 'setting' => $setting,
 892                                                 'required' => $value,
 893                                                 'installed' => ($iniValue === false) ? '(unknown)' : $iniValue
 894                                         );
 895                                 }
 896                         }
 897                 }
 898
 899                 // validate functions
 900                 if (isset($requirements['functions'])) {
 901                         foreach ($requirements['functions'] as $function) {
 902                                 $function = StringUtil::toLowerCase($function);
 903
 904                                 $passed = self::functionExists($function);
 905                                 if (!$passed) {
 906                                         $errors['function'][] = array(
 907                                                 'function' => $function
 908                                         );
 909                                 }
 910                         }
 911                 }
 912
 913                 // validate classes
 914                 if (isset($requirements['classes'])) {
 915                         foreach ($requirements['classes'] as $class) {
 916                                 $passed = false;
 917
 918                                 // see: http://de.php.net/manual/en/language.oop5.basic.php
 919                                 if (preg_match('~[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*.~', $class)) {
 920                                         $globalClass = '\\'.$class;
 921
 922                                         if (class_exists($globalClass, false)) {
 923                                                 $passed = true;
 924                                         }
 925                                 }
 926
 927                                 if (!$passed) {
 928                                         $errors['class'][] = array(
 929                                                 'class' => $class
 930                                         );
 931                                 }
 932                         }
 933
 934                 }
 935
 936                 return $errors;
 937         }
 938
 939         /**
 940          * Validates if an function exists and is not blacklisted by suhosin extension.
 941          *
 942          * @param       string          $function
 943          * @return      boolean
 944          * @see         http://de.php.net/manual/en/function.function-exists.php#77980
 945          */
 946         protected static function functionExists($function) {
 947                 if (extension_loaded('suhosin')) {
 948                         $blacklist = @ini_get('suhosin.executor.func.blacklist');
 949                         if (!empty($blacklist)) {
 950                                 $blacklist = explode(',', $blacklist);
 951                                 foreach ($blacklist as $disabledFunction) {
 952                                         $disabledFunction = StringUtil::toLowerCase(StringUtil::trim($disabledFunction));
 953
 954                                         if ($function == $disabledFunction) {
 955                                                 return false;
 956                                         }
 957                                 }
 958                         }
 959                 }
 960
 961                 return function_exists($function);
 962         }
 963
 964         /**
 965          * Compares settings, converting values into compareable ones.
 966          *
 967          * @param       string          $setting
 968          * @param       string          $value
 969          * @param       mixed           $compareValue
 970          * @return      boolean
 971          */
 972         protected static function compareSetting($setting, $value, $compareValue) {
 973                 if ($compareValue === false) return false;
 974
 975                 $value = StringUtil::toLowerCase($value);
 976                 $trueValues = array('1', 'on', 'true');
 977                 $falseValues = array('0', 'off', 'false');
 978
 979                 // handle values considered as 'true'
 980                 if (in_array($value, $trueValues)) {
 981                         return ($compareValue) ? true : false;
 982                 }
 983                 // handle values considered as 'false'
 984                 else if (in_array($value, $falseValues)) {
 985                         return (!$compareValue) ? true : false;
 986                 }
 987                 else if (!is_numeric($value)) {
 988                         $compareValue = self::convertShorthandByteValue($compareValue);
 989                         $value = self::convertShorthandByteValue($value);
 990                 }
 991
 992                 return ($compareValue >= $value) ? true : false;
 993         }
 994
 995         /**
 996          * Converts shorthand byte values into an integer representing bytes.
 997          *
 998          * @param       string          $value
 999          * @return      integer
1000          * @see         http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
1001          */
1002         protected static function convertShorthandByteValue($value) {
1003                 // convert into bytes
1004                 $lastCharacter = StringUtil::substring($value, -1);
1005                 switch ($lastCharacter) {
1006                         // gigabytes
1007                         case 'g':
1008                                 return (int)$value * 1073741824;
1009                         break;
1010
1011                         // megabytes
1012                         case 'm':
1013                                 return (int)$value * 1048576;
1014                         break;
1015
1016                         // kilobytes
1017                         case 'k':
1018                                 return (int)$value * 1024;
1019                         break;
1020
1021                         default:
1022                                 return $value;
1023                         break;
1024                 }
1025         }
1026 }