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 && count($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 (count($requirements) > 0) {
 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) $requirement = array_shift($possibleRequirements);
 260                                         else {
 261                                                 $requirement = $possibleRequirements[$this->selectedRequirements[$identifier]];
 262                                         }
 263
 264                                         $statement->execute(array($package->packageID, $requirement['packageID']));
 265                                 }
 266                         }
 267
 268                         // build requirement map
 269                         Package::rebuildPackageRequirementMap($package->packageID);
 270
 271                         // rebuild dependencies
 272                         Package::rebuildPackageDependencies($package->packageID);
 273                         if ($this->action == 'update') {
 274                                 Package::rebuildParentPackageDependencies($package->packageID);
 275                         }
 276
 277                         // reload queue
 278                         $this->queue = new PackageInstallationQueue($this->queue->queueID);
 279                         $this->package = null;
 280
 281                         if ($package->isApplication) {
 282                                 $host = StringUtil::replace(RouteHandler::getProtocol(), '', RouteHandler::getHost());
 283                                 $path = RouteHandler::getPath(array('acp'));
 284
 285                                 // insert as application
 286                                 ApplicationEditor::create(array(
 287                                         'domainName' => $host,
 288                                         'domainPath' => $path,
 289                                         'packageID' => $package->packageID
 290                                 ));
 291                         }
 292
 293                         // insert dependencies on parent package if applicable
 294                         $this->installPackageParent();
 295                 }
 296
 297                 if ($this->getPackage()->isApplication && $this->getPackage()->package != 'com.woltlab.wcf' && $this->getAction() == 'install') {
 298                         if (empty($this->getPackage()->packageDir)) {
 299                                 $document = $this->promptPackageDir();
 300                                 if ($document !== null && $document instanceof form\FormDocument) {
 301                                         $installationStep->setDocument($document);
 302                                 }
 303
 304                                 $installationStep->setSplitNode();
 305                         }
 306                 }
 307                 else if ($this->getPackage()->parentPackageID) {
 308                         $packageEditor = new PackageEditor($this->getPackage());
 309                         $packageEditor->update(array(
 310                                 'packageDir' => $this->getPackage()->getParentPackage()->packageDir
 311                         ));
 312                 }
 313
 314                 return $installationStep;
 315         }
 316
 317         /**
 318          * Saves the localized package infos.
 319          *
 320          * @todo        license and readme
 321          */
 322         protected function saveLocalizedPackageInfos() {
 323                 $package = new Package($this->queue->packageID);
 324
 325                 // localize package information
 326                 $sql = "INSERT INTO     wcf".WCF_N."_language_item
 327                                         (languageID, languageItem, languageItemValue, languageCategoryID, packageID)
 328                         VALUES          (?, ?, ?, ?, ?)";
 329                 $statement = WCF::getDB()->prepareStatement($sql);
 330
 331                 // get language list
 332                 $languageList = new LanguageList();
 333                 $languageList->sqlLimit = 0;
 334                 $languageList->readObjects();
 335
 336                 // workaround for WCFSetup
 337                 if (!PACKAGE_ID) {
 338                         $sql = "SELECT  *
 339                                 FROM    wcf".WCF_N."_language_category
 340                                 WHERE   languageCategory = ?";
 341                         $statement2 = WCF::getDB()->prepareStatement($sql);
 342                         $statement2->execute(array('wcf.acp.package'));
 343                         $languageCategory = $statement2->fetchObject('wcf\data\language\category\LanguageCategory');
 344                 }
 345                 else {
 346                         $languageCategory = LanguageFactory::getInstance()->getCategory('wcf.acp.package');
 347                 }
 348
 349                 // save package name
 350                 $this->saveLocalizedPackageInfo($statement, $languageList, $languageCategory, $package, 'packageName');
 351
 352                 // save package description
 353                 $this->saveLocalizedPackageInfo($statement, $languageList, $languageCategory, $package, 'packageDescription');
 354
 355                 // update description and name
 356                 $packageEditor = new PackageEditor($package);
 357                 $packageEditor->update(array(
 358                         'packageDescription' => 'wcf.acp.package.packageDescription.package'.$this->queue->packageID,
 359                         'packageName' => 'wcf.acp.package.packageName.package'.$this->queue->packageID
 360                 ));
 361         }
 362
 363         /**
 364          * Saves a localized package info.
 365          *
 366          * @param       wcf\system\database\statement\PreparedStatement         $statement
 367          * @param       wcf\data\language\LanguageList                          $languageList
 368          * @param       wcf\data\language\category\LanguageCategory             $languageCategory
 369          * @param       wcf\data\package\Package                                $package
 370          * @param       string                                                  $infoName
 371          */
 372         protected function saveLocalizedPackageInfo(PreparedStatement $statement, $languageList, LanguageCategory $languageCategory, Package $package, $infoName) {
 373                 $infoValues = $this->getArchive()->getPackageInfo($infoName);
 374
 375                 // get default value for languages without specified information
 376                 $defaultValue = '';
 377                 if (isset($infoValues['default'])) {
 378                         $defaultValue = $infoValues['default'];
 379                 }
 380                 else if (isset($infoValues['en'])) {
 381                         // fallback to English
 382                         $defaultValue = $infoValues['en'];
 383                 }
 384                 else if (isset($infoValues[WCF::getLanguage()->getFixedLanguageCode()])) {
 385                         // fallback to the language of the current user
 386                         $defaultValue = $infoValues[WCF::getLanguage()->getFixedLanguageCode()];
 387                 }
 388                 else if ($infoName == 'packageName') {
 389                         // fallback to the package identifier for the package name
 390                         $defaultValue = $this->archive->getPackageInfo('name');
 391                 }
 392
 393                 foreach ($languageList as $language) {
 394                         $value = $defaultValue;
 395                         if (isset($infoValues[$language->languageCode])) {
 396                                 $value = $infoValues[$language->languageCode];
 397                         }
 398
 399                         $statement->execute(array(
 400                                 $language->languageID,
 401                                 'wcf.acp.package.'.$infoName.'.package'.$package->packageID,
 402                                 $value,
 403                                 $languageCategory->languageCategoryID,
 404                                 1
 405                         ));
 406                 }
 407         }
 408
 409         /**
 410          * Sets parent package and rebuilds dependencies for both.
 411          */
 412         protected function installPackageParent() {
 413                 // do not handle parent package if current package is an application or does not have a plugin tag while within installation process
 414                 if ($this->getArchive()->getPackageInfo('isApplication') || $this->getAction() != 'install' || !$this->getArchive()->getPackageInfo('plugin')) {
 415                         return;
 416                 }
 417
 418                 // get parent package from requirements
 419                 $sql = "SELECT  requirement
 420                         FROM    wcf".WCF_N."_package_requirement
 421                         WHERE   packageID = ?
 422                                 AND requirement IN (
 423                                         SELECT  packageID
 424                                         FROM    wcf".WCF_N."_package
 425                                         WHERE   package = ?
 426                                 )";
 427                 $statement = WCF::getDB()->prepareStatement($sql);
 428                 $statement->execute(array(
 429                         $this->getPackage()->packageID,
 430                         $this->getArchive()->getPackageInfo('plugin')
 431                 ));
 432                 $row = $statement->fetchArray();
 433                 if (!$row || empty($row['requirement'])) {
 434                         throw new SystemException("can not find any available installations of required parent package '".$this->getArchive()->getPackageInfo('plugin')."'");
 435                 }
 436
 437                 // save parent package
 438                 $packageEditor = new PackageEditor($this->getPackage());
 439                 $packageEditor->update(array(
 440                         'parentPackageID' => $row['requirement']
 441                 ));
 442
 443                 // rebuild parent package dependencies
 444                 Package::rebuildParentPackageDependencies($this->getPackage()->packageID);
 445
 446                 // rebuild parent's parent package dependencies
 447                 Package::rebuildParentPackageDependencies($row['requirement']);
 448
 449                 // reload package object on next request
 450                 $this->package = null;
 451         }
 452
 453         /**
 454          * Executes a package installation plugin.
 455          *
 456          * @param       array           step
 457          * @return      boolean
 458          */
 459         protected function executePIP(array $nodeData) {
 460                 $step = new PackageInstallationStep();
 461
 462                 // fetch all pips associated with current PACKAGE_ID and include pips
 463                 // previously installed by current installation queue
 464                 $sql = "SELECT  pluginName, className
 465                         FROM    wcf".WCF_N."_package_installation_plugin
 466                         WHERE   pluginName = ?";
 467                 $statement = WCF::getDB()->prepareStatement($sql);
 468                 $statement->execute(array(
 469                         $nodeData['pip']
 470                 ));
 471                 $row = $statement->fetchArray();
 472
 473                 // PIP is unknown
 474                 if (!$row || (strcmp($nodeData['pip'], $row['pluginName']) !== 0)) {
 475                         throw new SystemException("unable to find package installation plugin '".$nodeData['pip']."'");
 476                 }
 477
 478                 // valdidate class definition
 479                 $className = $row['className'];
 480                 if (!class_exists($className)) {
 481                         throw new SystemException("unable to find class '".$className."'");
 482                 }
 483
 484                 $plugin = new $className($this, $nodeData);
 485
 486                 if (!($plugin instanceof \wcf\system\package\plugin\IPackageInstallationPlugin)) {
 487                         throw new SystemException("'".$className."' does not implement 'wcf\system\package\plugin\IPackageInstallationPlugin'");
 488                 }
 489
 490                 // execute PIP
 491                 try {
 492                         $document = $plugin->{$this->action}();
 493                 }
 494                 catch (SplitNodeException $e) {
 495                         $step->setSplitNode();
 496                 }
 497
 498                 if ($document !== null && ($document instanceof FormDocument)) {
 499                         $step->setDocument($document);
 500                         $step->setSplitNode();
 501                 }
 502
 503                 return $step;
 504         }
 505
 506         protected function selectOptionalPackages($currentNode, array $nodeData) {
 507                 $installationStep = new PackageInstallationStep();
 508
 509                 $document = $this->promptOptionalPackages($nodeData);
 510                 if ($document !== null && $document instanceof form\FormDocument) {
 511                         $installationStep->setDocument($document);
 512                         $installationStep->setSplitNode();
 513                 }
 514                 // insert new nodes for each package
 515                 else if (is_array($document)) {
 516                         // get target child node
 517                         $node = $currentNode;
 518                         $queue = $this->queue;
 519                         $shiftNodes = false;
 520
 521                         foreach ($nodeData as $package) {
 522                                 if (in_array($package['package'], $document)) {
 523                                         if (!$shiftNodes) {
 524                                                 $this->nodeBuilder->shiftNodes($currentNode, 'tempNode');
 525                                                 $shiftNodes = true;
 526                                         }
 527
 528                                         $queue = PackageInstallationQueueEditor::create(array(
 529                                                 'parentQueueID' => $queue->queueID,
 530                                                 'processNo' => $this->queue->processNo,
 531                                                 'userID' => WCF::getUser()->userID,
 532                                                 'package' => $package['package'],
 533                                                 'packageName' => $package['packageName'],
 534                                                 'archive' => $package['archive'],
 535                                                 'action' => $queue->action
 536                                         ));
 537
 538                                         $installation = new PackageInstallationDispatcher($queue);
 539                                         $installation->nodeBuilder->setParentNode($node);
 540                                         $installation->nodeBuilder->buildNodes();
 541                                         $node = $installation->nodeBuilder->getCurrentNode();
 542                                 }
 543                         }
 544
 545                         // shift nodes
 546                         if ($shiftNodes) {
 547                                 $this->nodeBuilder->shiftNodes('tempNode', $node);
 548                         }
 549                 }
 550
 551                 return $installationStep;
 552         }
 553
 554         /**
 555          * Extracts files from .tar (or .tar.gz) archive and installs them
 556          *
 557          * @param       string                  $targetDir
 558          * @param       string                  $sourceArchive
 559          * @param       FileHandler             $fileHandler
 560          * @return      wcf\system\setup\Installer
 561          */
 562         public function extractFiles($targetDir, $sourceArchive, $fileHandler = null) {
 563                 return new \wcf\system\setup\Installer($targetDir, $sourceArchive, $fileHandler);
 564         }
 565
 566         /**
 567          * Returns current package.
 568          *
 569          * @return      wcf\data\package\Package
 570          */
 571         public function getPackage() {
 572                 if ($this->package === null) {
 573                         $this->package = new Package($this->queue->packageID);
 574                 }
 575
 576                 return $this->package;
 577         }
 578
 579         /**
 580          * Prompts for a text input for package directory (applies for applications only)
 581          *
 582          * @return      wcf\system\form\FormDocument
 583          */
 584         protected function promptPackageDir() {
 585                 if (!PackageInstallationFormManager::findForm($this->queue, 'packageDir')) {
 586
 587                         $container = new container\GroupFormElementContainer();
 588                         $packageDir = new element\TextInputFormElement($container);
 589                         $packageDir->setName('packageDir');
 590                         $packageDir->setLabel(WCF::getLanguage()->get('wcf.acp.package.packageDir.input'));
 591
 592                         $path = RouteHandler::getPath(array('wcf', 'acp'));
 593                         $defaultPath = FileUtil::addTrailingSlash(FileUtil::unifyDirSeperator($_SERVER['DOCUMENT_ROOT'] . $path));
 594                         $packageDir->setValue($defaultPath);
 595                         $container->appendChild($packageDir);
 596
 597                         $document = new form\FormDocument('packageDir');
 598                         $document->appendContainer($container);
 599
 600                         PackageInstallationFormManager::registerForm($this->queue, $document);
 601                         return $document;
 602                 }
 603                 else {
 604                         $document = PackageInstallationFormManager::getForm($this->queue, 'packageDir');
 605                         $document->handleRequest();
 606                         $packageDir = $document->getValue('packageDir');
 607
 608                         if ($packageDir !== null) {
 609                                 // validate package dir
 610                                 if (file_exists(FileUtil::addTrailingSlash($packageDir) . 'global.php')) {
 611                                         $document->setError('packageDir', WCF::getLanguage()->get('wcf.acp.package.packageDir.notAvailable'));
 612                                         return $document;
 613                                 }
 614
 615                                 // set package dir
 616                                 $packageEditor = new PackageEditor($this->getPackage());
 617                                 $packageEditor->update(array(
 618                                         'packageDir' => FileUtil::getRelativePath(WCF_DIR, $packageDir)
 619                                 ));
 620
 621                                 // parse domain path
 622                                 $domainPath = FileUtil::getRelativePath(FileUtil::unifyDirSeperator($_SERVER['DOCUMENT_ROOT']), FileUtil::unifyDirSeperator($packageDir));
 623                                 $domainPath = FileUtil::addLeadingSlash(FileUtil::addTrailingSlash($domainPath));
 624
 625                                 // update application path
 626                                 $application = new Application($this->getPackage()->packageID);
 627                                 $applicationEditor = new ApplicationEditor($application);
 628                                 $applicationEditor->update(array(
 629                                         'domainPath' => $domainPath
 630                                 ));
 631
 632                                 // create directory and set permissions
 633                                 @mkdir($packageDir, 0777, true);
 634                                 @chmod($packageDir, 0777);
 635                         }
 636
 637                         return null;
 638                 }
 639         }
 640
 641         protected function promptOptionalPackages(array $packages) {
 642                 if (!PackageInstallationFormManager::findForm($this->queue, 'optionalPackages')) {
 643                         $container = new container\MultipleSelectionFormElementContainer();
 644                         $container->setName('optionalPackages');
 645
 646                         foreach ($packages as $package) {
 647                                 $optionalPackage = new element\MultipleSelectionFormElement($container);
 648                                 $optionalPackage->setName('optionalPackages');
 649                                 $optionalPackage->setLabel($package['packageName']);
 650                                 $optionalPackage->setValue($package['package']);
 651
 652                                 $container->appendChild($optionalPackage);
 653                         }
 654
 655                         $document = new form\FormDocument('optionalPackages');
 656                         $document->appendContainer($container);
 657
 658                         PackageInstallationFormManager::registerForm($this->queue, $document);
 659                         return $document;
 660                 }
 661                 else {
 662                         $document = PackageInstallationFormManager::getForm($this->queue, 'optionalPackages');
 663                         $document->handleRequest();
 664
 665                         return $document->getValue('optionalPackages');
 666                 }
 667         }
 668
 669         /**
 670          * Returns current package id.
 671          *
 672          * @return      integer
 673          */
 674         public function getPackageID() {
 675                 return $this->queue->packageID;
 676         }
 677
 678         /**
 679          * Returns current package installation type.
 680          *
 681          * @return      string
 682          */
 683         public function getAction() {
 684                 return $this->action;
 685         }
 686
 687         /**
 688          * Opens the package installation queue and
 689          * starts the installation, update or uninstallation of the first entry.
 690          *
 691          * @param       integer         $parentQueueID
 692          * @param       integer         $processNo
 693          */
 694         public static function openQueue($parentQueueID = 0, $processNo = 0) {
 695                 $conditions = new PreparedStatementConditionBuilder();
 696                 $conditions->add("userID = ?", array(WCF::getUser()->userID));
 697                 $conditions->add("parentQueueID = ?", array($parentQueueID));
 698                 if ($processNo != 0) $conditions->add("processNo = ?", array($processNo));
 699                 $conditions->add("done = ?", array(0));
 700
 701                 $sql = "SELECT          *
 702                         FROM            wcf".WCF_N."_package_installation_queue
 703                         ".$conditions."
 704                         ORDER BY        queueID ASC";
 705                 $statement = WCF::getDB()->prepareStatement($sql);
 706                 $statement->execute($conditions->getParameters());
 707                 $packageInstallation = $statement->fetchArray();
 708
 709                 if (!isset($packageInstallation['queueID'])) {
 710                         $url = LinkHandler::getInstance()->getLink('PackageList');
 711                         HeaderUtil::redirect($url);
 712                         exit;
 713                 }
 714                 else {
 715                         $url = LinkHandler::getInstance()->getLink('Package', array(), 'action='.$packageInstallation['action'].'&queueID='.$packageInstallation['queueID']);
 716                         HeaderUtil::redirect($url);
 717                         exit;
 718                 }
 719         }
 720
 721         /**
 722          * Displays last confirmation before plugin installation.
 723          */
 724         public function beginInstallation() {
 725                 // get requirements
 726                 $requirements = $this->getArchive()->getRequirements();
 727                 $openRequirements = $this->getArchive()->getOpenRequirements();
 728
 729                 $updatableInstances = array();
 730                 $missingPackages = 0;
 731                 foreach ($requirements as $key => $requirement) {
 732                         if (isset($openRequirements[$requirement['name']])) {
 733                                 $requirements[$key]['status'] = 'missing';
 734                                 $requirements[$key]['action'] = $openRequirements[$requirement['name']]['action'];
 735
 736                                 if (!isset($requirements[$key]['file'])) {
 737                                         if ($openRequirements[$requirement['name']]['action'] === 'update') {
 738                                                 $requirements[$key]['status'] = 'missingVersion';
 739                                                 $requirements[$key]['existingVersion'] = $openRequirements[$requirement['name']]['existingVersion'];
 740                                         }
 741                                         $missingPackages++;
 742                                 }
 743                                 else {
 744                                         $requirements[$key]['status'] = 'delivered';
 745                                 }
 746                         }
 747                         else {
 748                                 $requirements[$key]['status'] = 'installed';
 749                         }
 750                 }
 751
 752                 // get other instances
 753                 if ($this->action == 'install') {
 754                         $updatableInstances = $this->getArchive()->getUpdatableInstances();
 755                 }
 756
 757                 ACPMenu::getInstance()->setActiveMenuItem('wcf.acp.menu.link.package.install');
 758                 WCF::getTPL()->assign(array(
 759                         'archive' => $this->getArchive(),
 760                         'requiredPackages' => $requirements,
 761                         'missingPackages' => $missingPackages,
 762                         'updatableInstances' => $updatableInstances,
 763                         'excludingPackages' => $this->getArchive()->getConflictedExcludingPackages(),
 764                         'excludedPackages' => $this->getArchive()->getConflictedExcludedPackages(),
 765                         'queueID' => $this->queue->queueID
 766                 ));
 767                 WCF::getTPL()->display('packageInstallationConfirm');
 768                 exit;
 769         }
 770
 771         /**
 772          * Checks the package installation queue for outstanding entries.
 773          *
 774          * @return      integer
 775          */
 776         public static function checkPackageInstallationQueue() {
 777                 $sql = "SELECT          queueID
 778                         FROM            wcf".WCF_N."_package_installation_queue
 779                         WHERE           userID = ?
 780                                         AND parentQueueID = 0
 781                                         AND done = 0
 782                         ORDER BY        queueID ASC";
 783                 $statement = WCF::getDB()->prepareStatement($sql);
 784                 $statement->execute(array(WCF::getUser()->userID));
 785                 $row = $statement->fetchArray();
 786
 787                 if (!$row) {
 788                         return 0;
 789                 }
 790
 791                 return $row['queueID'];
 792         }
 793
 794         /**
 795          * Executes post-setup actions.
 796          */
 797         public function completeSetup() {
 798                 // rebuild dependencies
 799                 Package::rebuildPackageDependencies($this->queue->packageID);
 800
 801                 // mark queue as done
 802                 $queueEditor = new PackageInstallationQueueEditor($this->queue);
 803                 $queueEditor->update(array(
 804                         'done' => 1
 805                 ));
 806
 807                 // remove node data
 808                 $this->nodeBuilder->purgeNodes();
 809
 810                 // update package version
 811                 if ($this->action == 'update') {
 812                         $packageEditor = new PackageEditor($this->getPackage());
 813                         $packageEditor->update(array(
 814                                 'updateDate' => TIME_NOW,
 815                                 'packageVersion' => $this->archive->getPackageInfo('version')
 816                         ));
 817                 }
 818
 819                 // clear language files once whole installation is completed
 820                 LanguageEditor::deleteLanguageFiles();
 821
 822                 // reset all caches
 823                 CacheHandler::getInstance()->clear(WCF_DIR.'cache/', '*');
 824         }
 825
 826         /**
 827          * Updates queue information.
 828          */
 829         public function updatePackage() {
 830                 if (empty($this->queue->packageName)) {
 831                         $queueEditor = new PackageInstallationQueueEditor($this->queue);
 832                         $queueEditor->update(array(
 833                                 'packageName' => $this->getArchive()->getLocalizedPackageInfo('packageName')
 834                         ));
 835
 836                         // reload queue
 837                         $this->queue = new PackageInstallationQueue($this->queue->queueID);
 838                 }
 839         }
 840
 841         /**
 842          * Validates specific php requirements.
 843          *
 844          * @param       array           $requirements
 845          * @return      array<array>
 846          */
 847         public static function validatePHPRequirements(array $requirements) {
 848                 $errors = array();
 849
 850                 // validate php version
 851                 if (isset($requirements['version'])) {
 852                         $passed = false;
 853                         if (version_compare(PHP_VERSION, $requirements['version'], '>=')) {
 854                                 $passed = true;
 855                         }
 856
 857                         if (!$passed) {
 858                                 $errors['version'] = array(
 859                                         'required' => $requirements['version'],
 860                                         'installed' => PHP_VERSION
 861                                 );
 862                         }
 863                 }
 864
 865                 // validate extensions
 866                 if (isset($requirements['extensions'])) {
 867                         foreach ($requirements['extensions'] as $extension) {
 868                                 $passed = (extension_loaded($extension)) ? true : false;
 869
 870                                 if (!$passed) {
 871                                         $errors['extension'][] = array(
 872                                                 'extension' => $extension
 873                                         );
 874                                 }
 875                         }
 876                 }
 877
 878                 // validate settings
 879                 if (isset($requirements['settings'])) {
 880                         foreach ($requirements['settings'] as $setting => $value) {
 881                                 $iniValue = ini_get($setting);
 882
 883                                 $passed = self::compareSetting($setting, $value, $iniValue);
 884                                 if (!$passed) {
 885                                         $errors['setting'][] = array(
 886                                                 'setting' => $setting,
 887                                                 'required' => $value,
 888                                                 'installed' => ($iniValue === false) ? '(unknown)' : $iniValue
 889                                         );
 890                                 }
 891                         }
 892                 }
 893
 894                 // validate functions
 895                 if (isset($requirements['functions'])) {
 896                         foreach ($requirements['functions'] as $function) {
 897                                 $function = StringUtil::toLowerCase($function);
 898
 899                                 $passed = self::functionExists($function);
 900                                 if (!$passed) {
 901                                         $errors['function'][] = array(
 902                                                 'function' => $function
 903                                         );
 904                                 }
 905                         }
 906                 }
 907
 908                 // validate classes
 909                 if (isset($requirements['classes'])) {
 910                         foreach ($requirements['classes'] as $class) {
 911                                 $passed = false;
 912
 913                                 // see: http://de.php.net/manual/en/language.oop5.basic.php
 914                                 if (preg_match('~[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*.~', $class)) {
 915                                         $globalClass = '\\'.$class;
 916
 917                                         if (class_exists($globalClass, false)) {
 918                                                 $passed = true;
 919                                         }
 920                                 }
 921
 922                                 if (!$passed) {
 923                                         $errors['class'][] = array(
 924                                                 'class' => $class
 925                                         );
 926                                 }
 927                         }
 928
 929                 }
 930
 931                 return $errors;
 932         }
 933
 934         /**
 935          * Validates if an function exists and is not blacklisted by suhosin extension.
 936          *
 937          * @param       string          $function
 938          * @return      boolean
 939          * @see         http://de.php.net/manual/en/function.function-exists.php#77980
 940          */
 941         protected static function functionExists($function) {
 942                 if (extension_loaded('suhosin')) {
 943                         $blacklist = @ini_get('suhosin.executor.func.blacklist');
 944                         if (!empty($blacklist)) {
 945                                 $blacklist = explode(',', $blacklist);
 946                                 foreach ($blacklist as $disabledFunction) {
 947                                         $disabledFunction = StringUtil::toLowerCase(StringUtil::trim($disabledFunction));
 948
 949                                         if ($function == $disabledFunction) {
 950                                                 return false;
 951                                         }
 952                                 }
 953                         }
 954                 }
 955
 956                 return function_exists($function);
 957         }
 958
 959         /**
 960          * Compares settings, converting values into compareable ones.
 961          *
 962          * @param       string          $setting
 963          * @param       string          $value
 964          * @param       mixed           $compareValue
 965          * @return      boolean
 966          */
 967         protected static function compareSetting($setting, $value, $compareValue) {
 968                 if ($compareValue === false) return false;
 969
 970                 $value = StringUtil::toLowerCase($value);
 971                 $trueValues = array('1', 'on', 'true');
 972                 $falseValues = array('0', 'off', 'false');
 973
 974                 // handle values considered as 'true'
 975                 if (in_array($value, $trueValues)) {
 976                         return ($compareValue) ? true : false;
 977                 }
 978                 // handle values considered as 'false'
 979                 else if (in_array($value, $falseValues)) {
 980                         return (!$compareValue) ? true : false;
 981                 }
 982                 else if (!is_numeric($value)) {
 983                         $compareValue = self::convertShorthandByteValue($compareValue);
 984                         $value = self::convertShorthandByteValue($value);
 985                 }
 986
 987                 return ($compareValue >= $value) ? true : false;
 988         }
 989
 990         /**
 991          * Converts shorthand byte values into an integer representing bytes.
 992          *
 993          * @param       string          $value
 994          * @return      integer
 995          * @see         http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
 996          */
 997         protected static function convertShorthandByteValue($value) {
 998                 // convert into bytes
 999                 $lastCharacter = StringUtil::substring($value, -1);
1000                 switch ($lastCharacter) {
1001                         // gigabytes
1002                         case 'g':
1003                                 return (int)$value * 1073741824;
1004                         break;
1005
1006                         // megabytes
1007                         case 'm':
1008                                 return (int)$value * 1048576;
1009                         break;
1010
1011                         // kilobytes
1012                         case 'k':
1013                                 return (int)$value * 1024;
1014                         break;
1015
1016                         default:
1017                                 return $value;
1018                         break;
1019                 }
1020         }
1021 }