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