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
;
24 use wcf\system\language\LanguageFactory
;
25 use wcf\system\package\plugin\IPackageInstallationPlugin
;
26 use wcf\system\package\plugin\ObjectTypePackageInstallationPlugin
;
27 use wcf\system\package\plugin\SQLPackageInstallationPlugin
;
28 use wcf\system\request\LinkHandler
;
29 use wcf\system\request\RouteHandler
;
30 use wcf\system\style\StyleHandler
;
31 use wcf\system\version\VersionHandler
;
33 use wcf\util\FileUtil
;
34 use wcf\util\HeaderUtil
;
35 use wcf\util\StringUtil
;
38 * PackageInstallationDispatcher handles the whole installation process.
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
47 class PackageInstallationDispatcher
{
49 * current installation type
52 protected $action = '';
55 * instance of PackageArchive
56 * @var wcf\system\package\PackageArchive
58 public $archive = null;
61 * instance of PackageInstallationNodeBuilder
62 * @var wcf\system\package\PackageInstallationNodeBuilder
64 public $nodeBuilder = null;
68 * @var wcf\data\package\Package
70 public $package = null;
73 * instance of PackageInstallationQueue
74 * @var wcf\system\package\PackageInstallationQueue
79 * default name of the config file
82 const CONFIG_FILE
= 'config.inc.php';
85 * holds state of structuring version tables
88 protected $requireRestructureVersionTables = false;
91 * Creates a new instance of PackageInstallationDispatcher.
93 * @param wcf\data\package\installation\queue\PackageInstallationQueue $queue
95 public function __construct(PackageInstallationQueue
$queue) {
96 $this->queue
= $queue;
97 $this->nodeBuilder
= new PackageInstallationNodeBuilder($this);
99 $this->action
= $this->queue
->action
;
103 * Installs node components and returns next node.
105 * @param string $node
106 * @return wcf\system\package\PackageInstallationStep
108 public function install($node) {
109 $nodes = $this->nodeBuilder
->getNodeData($node);
111 // invoke node-specific actions
112 foreach ($nodes as $data) {
113 $nodeData = unserialize($data['nodeData']);
115 switch ($data['nodeType']) {
117 $step = $this->installPackage($nodeData);
121 $step = $this->executePIP($nodeData);
124 case 'optionalPackages':
125 $step = $this->selectOptionalPackages($node, $nodeData);
129 die("Unknown node type: '".$data['nodeType']."'");
133 if ($step->splitNode()) {
134 $this->nodeBuilder
->cloneNode($node, $data['sequenceNo']);
139 // mark node as completed
140 $this->nodeBuilder
->completeNode($node);
143 $node = $this->nodeBuilder
->getNextNode($node);
144 $step->setNode($node);
146 // perform post-install/update actions
148 // update options.inc.php
149 OptionEditor
::resetCache();
151 if ($this->action
== 'install') {
152 // save localized package infos
153 $this->saveLocalizedPackageInfos();
155 // remove all cache files after WCFSetup
157 CacheHandler
::getInstance()->clear(WCF_DIR
.'cache/', 'cache.*.php');
160 // rebuild application paths
161 ApplicationHandler
::rebuild();
162 ApplicationEditor
::setup();
165 // remove template listener cache
166 CacheHandler
::getInstance()->clear(WCF_DIR
.'cache/templateListener/', '*.php');
168 // reset language cache
169 LanguageFactory
::getInstance()->clearCache();
170 LanguageFactory
::getInstance()->deleteLanguageCache();
173 StyleHandler
::resetStylesheets();
176 if ($this->requireRestructureVersionTables
) {
177 $this->restructureVersionTables();
184 * Returns current package archive.
186 * @return wcf\system\package\PackageArchive
188 public function getArchive() {
189 if ($this->archive
=== null) {
190 $this->archive
= new PackageArchive($this->queue
->archive
, $this->getPackage());
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
202 $this->archive
->openArchive();
205 return $this->archive
;
209 * Installs current package.
211 * @param array $nodeData
213 protected function installPackage(array $nodeData) {
214 $installationStep = new PackageInstallationStep();
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']));
228 // try to find matching package
229 $sql = "SELECT packageName, packageVersion
230 FROM wcf".WCF_N
."_package
232 $statement = WCF
::getDB()->prepareStatement($sql);
233 $statement->execute(array($package));
235 $row = $statement->fetchArray();
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.");
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']."'");
250 unset($nodeData['requirements']);
252 if (!$this->queue
->packageID
) {
253 // create package entry
254 $package = PackageEditor
::create($nodeData);
256 // update package id for current queue
257 $queueEditor = new PackageInstallationQueueEditor($this->queue
);
258 $queueEditor->update(array(
259 'packageID' => $package->packageID
262 // save excluded packages
263 if (count($this->getArchive()->getExcludedPackages()) > 0) {
264 $sql = "INSERT INTO wcf".WCF_N
."_package_exclusion
265 (packageID, excludedPackage, excludedPackageVersion)
267 $statement = WCF
::getDB()->prepareStatement($sql);
269 foreach ($this->getArchive()->getExcludedPackages() as $excludedPackage) {
270 $statement->execute(array($package->packageID
, $excludedPackage['name'], (!empty($excludedPackage['version']) ?
$excludedPackage['version'] : '')));
274 // if package is plugin to com.woltlab.wcf it must not have any other requirement
275 $requirements = $this->getArchive()->getRequirements();
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)
283 $statement = WCF
::getDB()->prepareStatement($sql);
285 foreach ($requirements as $identifier => $possibleRequirements) {
286 if (count($possibleRequirements) == 1) {
287 $requirement = array_shift($possibleRequirements);
290 $requirement = $possibleRequirements[$this->selectedRequirements
[$identifier]];
293 $statement->execute(array($package->packageID
, $requirement['packageID']));
298 $this->queue
= new PackageInstallationQueue($this->queue
->queueID
);
299 $this->package
= null;
301 if ($package->isApplication
) {
302 $host = StringUtil
::replace(RouteHandler
::getProtocol(), '', RouteHandler
::getHost());
303 $path = RouteHandler
::getPath(array('acp'));
305 // insert as application
306 ApplicationEditor
::create(array(
307 'domainName' => $host,
308 'domainPath' => $path,
309 'cookieDomain' => $host,
310 'cookiePath' => $path,
311 'packageID' => $package->packageID
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 form\FormDocument
) {
320 $installationStep->setDocument($document);
323 $installationStep->setSplitNode();
327 return $installationStep;
331 * Saves the localized package infos.
333 * @todo license and readme
335 protected function saveLocalizedPackageInfos() {
336 $package = new Package($this->queue
->packageID
);
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);
345 $languageList = new LanguageList();
346 $languageList->sqlLimit
= 0;
347 $languageList->readObjects();
349 // workaround for WCFSetup
352 FROM wcf".WCF_N
."_language_category
353 WHERE languageCategory = ?";
354 $statement2 = WCF
::getDB()->prepareStatement($sql);
355 $statement2->execute(array('wcf.acp.package'));
356 $languageCategory = $statement2->fetchObject('wcf\data\language\category\LanguageCategory');
359 $languageCategory = LanguageFactory
::getInstance()->getCategory('wcf.acp.package');
363 $this->saveLocalizedPackageInfo($statement, $languageList, $languageCategory, $package, 'packageName');
365 // save package description
366 $this->saveLocalizedPackageInfo($statement, $languageList, $languageCategory, $package, 'packageDescription');
368 // update description and name
369 $packageEditor = new PackageEditor($package);
370 $packageEditor->update(array(
371 'packageDescription' => 'wcf.acp.package.packageDescription.package'.$this->queue
->packageID
,
372 'packageName' => 'wcf.acp.package.packageName.package'.$this->queue
->packageID
377 * Saves a localized package info.
379 * @param wcf\system\database\statement\PreparedStatement $statement
380 * @param wcf\data\language\LanguageList $languageList
381 * @param wcf\data\language\category\LanguageCategory $languageCategory
382 * @param wcf\data\package\Package $package
383 * @param string $infoName
385 protected function saveLocalizedPackageInfo(PreparedStatement
$statement, $languageList, LanguageCategory
$languageCategory, Package
$package, $infoName) {
386 $infoValues = $this->getArchive()->getPackageInfo($infoName);
388 // get default value for languages without specified information
390 if (isset($infoValues['default'])) {
391 $defaultValue = $infoValues['default'];
393 else if (isset($infoValues['en'])) {
394 // fallback to English
395 $defaultValue = $infoValues['en'];
397 else if (isset($infoValues[WCF
::getLanguage()->getFixedLanguageCode()])) {
398 // fallback to the language of the current user
399 $defaultValue = $infoValues[WCF
::getLanguage()->getFixedLanguageCode()];
401 else if ($infoName == 'packageName') {
402 // fallback to the package identifier for the package name
403 $defaultValue = $this->archive
->getPackageInfo('name');
406 foreach ($languageList as $language) {
407 $value = $defaultValue;
408 if (isset($infoValues[$language->languageCode
])) {
409 $value = $infoValues[$language->languageCode
];
412 $statement->execute(array(
413 $language->languageID
,
414 'wcf.acp.package.'.$infoName.'.package'.$package->packageID
,
416 $languageCategory->languageCategoryID
,
423 * Executes a package installation plugin.
428 protected function executePIP(array $nodeData) {
429 $step = new PackageInstallationStep();
431 // fetch all pips associated with current PACKAGE_ID and include pips
432 // previously installed by current installation queue
433 $sql = "SELECT pluginName, className
434 FROM wcf".WCF_N
."_package_installation_plugin
435 WHERE pluginName = ?";
436 $statement = WCF
::getDB()->prepareStatement($sql);
437 $statement->execute(array(
440 $row = $statement->fetchArray();
443 if (!$row ||
(strcmp($nodeData['pip'], $row['pluginName']) !== 0)) {
444 throw new SystemException("unable to find package installation plugin '".$nodeData['pip']."'");
447 // valdidate class definition
448 $className = $row['className'];
449 if (!class_exists($className)) {
450 throw new SystemException("unable to find class '".$className."'");
453 $plugin = new $className($this, $nodeData);
455 if (!($plugin instanceof IPackageInstallationPlugin
)) {
456 throw new SystemException("'".$className."' does not implement 'wcf\system\package\plugin\IPackageInstallationPlugin'");
459 if ($plugin instanceof SQLPackageInstallationPlugin ||
$plugin instanceof ObjectTypePackageInstallationPlugin
) {
460 $this->requireRestructureVersionTables
= true;
465 $document = $plugin->{$this->action
}();
467 catch (SplitNodeException
$e) {
468 $step->setSplitNode();
471 if ($document !== null && ($document instanceof FormDocument
)) {
472 $step->setDocument($document);
473 $step->setSplitNode();
480 * Displays a list to select optional packages or installs selection.
482 * @param string $currentNode
483 * @param array $nodeData
484 * @return wcf\system\package\PackageInstallationStep
486 protected function selectOptionalPackages($currentNode, array $nodeData) {
487 $installationStep = new PackageInstallationStep();
489 $document = $this->promptOptionalPackages($nodeData);
490 if ($document !== null && $document instanceof form\FormDocument
) {
491 $installationStep->setDocument($document);
492 $installationStep->setSplitNode();
494 // insert new nodes for each package
495 else if (is_array($document)) {
496 // get target child node
497 $node = $currentNode;
498 $queue = $this->queue
;
501 foreach ($nodeData as $package) {
502 if (in_array($package['package'], $document)) {
504 $this->nodeBuilder
->shiftNodes($currentNode, 'tempNode');
508 $queue = PackageInstallationQueueEditor
::create(array(
509 'parentQueueID' => $queue->queueID
,
510 'processNo' => $this->queue
->processNo
,
511 'userID' => WCF
::getUser()->userID
,
512 'package' => $package['package'],
513 'packageName' => $package['packageName'],
514 'archive' => $package['archive'],
515 'action' => $queue->action
518 $installation = new PackageInstallationDispatcher($queue);
519 $installation->nodeBuilder
->setParentNode($node);
520 $installation->nodeBuilder
->buildNodes();
521 $node = $installation->nodeBuilder
->getCurrentNode();
527 $this->nodeBuilder
->shiftNodes('tempNode', $node);
531 return $installationStep;
535 * Extracts files from .tar(.gz) archive and installs them
537 * @param string $targetDir
538 * @param string $sourceArchive
539 * @param FileHandler $fileHandler
540 * @return wcf\system\setup\Installer
542 public function extractFiles($targetDir, $sourceArchive, $fileHandler = null) {
543 return new \wcf\system\setup\
Installer($targetDir, $sourceArchive, $fileHandler);
547 * Returns current package.
549 * @return wcf\data\package\Package
551 public function getPackage() {
552 if ($this->package
=== null) {
553 $this->package
= new Package($this->queue
->packageID
);
556 return $this->package
;
560 * Prompts for a text input for package directory (applies for applications only)
562 * @return wcf\system\form\FormDocument
564 protected function promptPackageDir() {
565 if (!PackageInstallationFormManager
::findForm($this->queue
, 'packageDir')) {
567 $container = new GroupFormElementContainer();
568 $packageDir = new TextInputFormElement($container);
569 $packageDir->setName('packageDir');
570 $packageDir->setLabel(WCF
::getLanguage()->get('wcf.acp.package.packageDir.input'));
572 $path = RouteHandler
::getPath(array('wcf', 'acp'));
573 $defaultPath = FileUtil
::addTrailingSlash(FileUtil
::unifyDirSeperator($_SERVER['DOCUMENT_ROOT'] . $path));
574 $packageDir->setValue($defaultPath);
575 $container->appendChild($packageDir);
577 $document = new form\
FormDocument('packageDir');
578 $document->appendContainer($container);
580 PackageInstallationFormManager
::registerForm($this->queue
, $document);
584 $document = PackageInstallationFormManager
::getForm($this->queue
, 'packageDir');
585 $document->handleRequest();
586 $packageDir = $document->getValue('packageDir');
588 if ($packageDir !== null) {
589 // validate package dir
590 if (file_exists(FileUtil
::addTrailingSlash($packageDir) . 'global.php')) {
591 $document->setError('packageDir', WCF
::getLanguage()->get('wcf.acp.package.packageDir.notAvailable'));
596 $packageEditor = new PackageEditor($this->getPackage());
597 $packageEditor->update(array(
598 'packageDir' => FileUtil
::getRelativePath(WCF_DIR
, $packageDir)
602 $domainPath = FileUtil
::getRelativePath(FileUtil
::unifyDirSeperator($_SERVER['DOCUMENT_ROOT']), FileUtil
::unifyDirSeperator($packageDir));
604 // work-around for applications installed in document root
605 if ($domainPath == './') {
609 $domainPath = FileUtil
::addLeadingSlash(FileUtil
::addTrailingSlash($domainPath));
611 // update application path
612 $application = new Application($this->getPackage()->packageID
);
613 $applicationEditor = new ApplicationEditor($application);
614 $applicationEditor->update(array(
615 'domainPath' => $domainPath,
616 'cookiePath' => $domainPath
619 // create directory and set permissions
620 @mkdir
($packageDir, 0777, true);
621 @chmod
($packageDir, 0777);
629 * Prompts a selection of optional packages.
633 protected function promptOptionalPackages(array $packages) {
634 if (!PackageInstallationFormManager
::findForm($this->queue
, 'optionalPackages')) {
635 $container = new MultipleSelectionFormElementContainer();
636 $container->setName('optionalPackages');
638 foreach ($packages as $package) {
639 $optionalPackage = new MultipleSelectionFormElement($container);
640 $optionalPackage->setName('optionalPackages');
641 $optionalPackage->setLabel($package['packageName']);
642 $optionalPackage->setValue($package['package']);
644 $container->appendChild($optionalPackage);
647 $document = new form\
FormDocument('optionalPackages');
648 $document->appendContainer($container);
650 PackageInstallationFormManager
::registerForm($this->queue
, $document);
654 $document = PackageInstallationFormManager
::getForm($this->queue
, 'optionalPackages');
655 $document->handleRequest();
657 return $document->getValue('optionalPackages');
662 * Returns current package id.
666 public function getPackageID() {
667 return $this->queue
->packageID
;
671 * Returns current package installation type.
675 public function getAction() {
676 return $this->action
;
680 * Opens the package installation queue and
681 * starts the installation, update or uninstallation of the first entry.
683 * @param integer $parentQueueID
684 * @param integer $processNo
686 public static function openQueue($parentQueueID = 0, $processNo = 0) {
687 $conditions = new PreparedStatementConditionBuilder();
688 $conditions->add("userID = ?", array(WCF
::getUser()->userID
));
689 $conditions->add("parentQueueID = ?", array($parentQueueID));
690 if ($processNo != 0) $conditions->add("processNo = ?", array($processNo));
691 $conditions->add("done = ?", array(0));
694 FROM wcf".WCF_N
."_package_installation_queue
696 ORDER BY queueID ASC";
697 $statement = WCF
::getDB()->prepareStatement($sql);
698 $statement->execute($conditions->getParameters());
699 $packageInstallation = $statement->fetchArray();
701 if (!isset($packageInstallation['queueID'])) {
702 $url = LinkHandler
::getInstance()->getLink('PackageList');
703 HeaderUtil
::redirect($url);
707 $url = LinkHandler
::getInstance()->getLink('PackageInstallationConfirm', array(), 'action='.$packageInstallation['action'].'&queueID='.$packageInstallation['queueID']);
708 HeaderUtil
::redirect($url);
714 * Checks the package installation queue for outstanding entries.
718 public static function checkPackageInstallationQueue() {
719 $sql = "SELECT queueID
720 FROM wcf".WCF_N
."_package_installation_queue
722 AND parentQueueID = 0
724 ORDER BY queueID ASC";
725 $statement = WCF
::getDB()->prepareStatement($sql);
726 $statement->execute(array(WCF
::getUser()->userID
));
727 $row = $statement->fetchArray();
733 return $row['queueID'];
737 * Executes post-setup actions.
739 public function completeSetup() {
740 // mark queue as done
741 $queueEditor = new PackageInstallationQueueEditor($this->queue
);
742 $queueEditor->update(array(
747 $this->nodeBuilder
->purgeNodes();
749 // update package version
750 if ($this->action
== 'update') {
751 $packageEditor = new PackageEditor($this->getPackage());
752 $packageEditor->update(array(
753 'updateDate' => TIME_NOW
,
754 'packageVersion' => $this->archive
->getPackageInfo('version')
758 // clear language files once whole installation is completed
759 LanguageEditor
::deleteLanguageFiles();
762 CacheHandler
::getInstance()->clear(WCF_DIR
.'cache/', '*');
766 * Updates queue information.
768 public function updatePackage() {
769 if (empty($this->queue
->packageName
)) {
770 $queueEditor = new PackageInstallationQueueEditor($this->queue
);
771 $queueEditor->update(array(
772 'packageName' => $this->getArchive()->getLocalizedPackageInfo('packageName')
776 $this->queue
= new PackageInstallationQueue($this->queue
->queueID
);
781 * Validates specific php requirements.
783 * @param array $requirements
784 * @return array<array>
786 public static function validatePHPRequirements(array $requirements) {
789 // validate php version
790 if (isset($requirements['version'])) {
792 if (version_compare(PHP_VERSION
, $requirements['version'], '>=')) {
797 $errors['version'] = array(
798 'required' => $requirements['version'],
799 'installed' => PHP_VERSION
804 // validate extensions
805 if (isset($requirements['extensions'])) {
806 foreach ($requirements['extensions'] as $extension) {
807 $passed = (extension_loaded($extension)) ?
true : false;
810 $errors['extension'][] = array(
811 'extension' => $extension
818 if (isset($requirements['settings'])) {
819 foreach ($requirements['settings'] as $setting => $value) {
820 $iniValue = ini_get($setting);
822 $passed = self
::compareSetting($setting, $value, $iniValue);
824 $errors['setting'][] = array(
825 'setting' => $setting,
826 'required' => $value,
827 'installed' => ($iniValue === false) ?
'(unknown)' : $iniValue
833 // validate functions
834 if (isset($requirements['functions'])) {
835 foreach ($requirements['functions'] as $function) {
836 $function = StringUtil
::toLowerCase($function);
838 $passed = self
::functionExists($function);
840 $errors['function'][] = array(
841 'function' => $function
848 if (isset($requirements['classes'])) {
849 foreach ($requirements['classes'] as $class) {
852 // see: http://de.php.net/manual/en/language.oop5.basic.php
853 if (preg_match('~[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*.~', $class)) {
854 $globalClass = '\\'.$class;
856 if (class_exists($globalClass, false)) {
862 $errors['class'][] = array(
874 * Validates if an function exists and is not blacklisted by suhosin extension.
876 * @param string $function
878 * @see http://de.php.net/manual/en/function.function-exists.php#77980
880 protected static function functionExists($function) {
881 if (extension_loaded('suhosin')) {
882 $blacklist = @ini_get
('suhosin.executor.func.blacklist');
883 if (!empty($blacklist)) {
884 $blacklist = explode(',', $blacklist);
885 foreach ($blacklist as $disabledFunction) {
886 $disabledFunction = StringUtil
::toLowerCase(StringUtil
::trim($disabledFunction));
888 if ($function == $disabledFunction) {
895 return function_exists($function);
899 * Compares settings, converting values into compareable ones.
901 * @param string $setting
902 * @param string $value
903 * @param mixed $compareValue
906 protected static function compareSetting($setting, $value, $compareValue) {
907 if ($compareValue === false) return false;
909 $value = StringUtil
::toLowerCase($value);
910 $trueValues = array('1', 'on', 'true');
911 $falseValues = array('0', 'off', 'false');
913 // handle values considered as 'true'
914 if (in_array($value, $trueValues)) {
915 return ($compareValue) ?
true : false;
917 // handle values considered as 'false'
918 else if (in_array($value, $falseValues)) {
919 return (!$compareValue) ?
true : false;
921 else if (!is_numeric($value)) {
922 $compareValue = self
::convertShorthandByteValue($compareValue);
923 $value = self
::convertShorthandByteValue($value);
926 return ($compareValue >= $value) ?
true : false;
930 * Converts shorthand byte values into an integer representing bytes.
932 * @param string $value
934 * @see http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
936 protected static function convertShorthandByteValue($value) {
937 // convert into bytes
938 $lastCharacter = StringUtil
::substring($value, -1);
939 switch ($lastCharacter) {
942 return (int)$value * 1073741824;
947 return (int)$value * 1048576;
952 return (int)$value * 1024;
962 * Restructure version tables.
964 protected function restructureVersionTables() {
965 $objectTypes = VersionHandler
::getInstance()->getObjectTypes();
967 if (empty($objectTypes)) {
971 // base structure of version tables
972 $versionTableBaseColumns = array();
973 $versionTableBaseColumns[] = array('name' => 'versionID', 'data' => array('type' => 'INT', 'key' => 'PRIMARY', 'autoIncrement' => 'AUTO_INCREMENT'));
974 $versionTableBaseColumns[] = array('name' => 'versionUserID', 'data' => array('type' => 'INT'));
975 $versionTableBaseColumns[] = array('name' => 'versionUsername', 'data' => array('type' => 'VARCHAR', 'length' => 255));
976 $versionTableBaseColumns[] = array('name' => 'versionTime', 'data' => array('type' => 'INT'));
978 foreach ($objectTypes as $objectTypeID => $objectType) {
979 // get structure of base table
980 $baseTableColumns = WCF
::getDB()->getEditor()->getColumns($objectType::getDatabaseTableName());
981 // get structure of version table
982 $versionTableColumns = WCF
::getDB()->getEditor()->getColumns($objectType::getDatabaseVersionTableName());
984 if (empty($versionTableColumns)) {
985 $columns = array_merge($versionTableBaseColumns, $baseTableColumns);
987 WCF
::getDB()->getEditor()->createTable($objectType::getDatabaseVersionTableName(), $columns);
990 // check garbage columns in versioned table
991 foreach ($versionTableColumns as $columnData) {
992 if (!array_search($columnData['name'], $baseTableColumns, true)) {
994 WCF
::getDB()->getEditor()->dropColumn($objectType::getDatabaseVersionTableName(), $columnData['name']);
998 // check new columns for versioned table
999 foreach ($baseTableColumns as $columnData) {
1000 if (!array_search($columnData['name'], $versionTableColumns, true)) {
1002 WCF
::getDB()->getEditor()->addColumn($objectType::getDatabaseVersionTableName(), $columnData['name'], $columnData['data']);