50867bcefc9f1c844f107617d70e83e84f8bc64c
[lhc/web/wiklou.git] / includes / installer / Installer.php
1 <?php
2 /**
3 * Base code for MediaWiki installer.
4 *
5 * @file
6 * @ingroup Deployment
7 */
8
9 /**
10 * This documentation group collects source code files with deployment functionality.
11 *
12 * @defgroup Deployment Deployment
13 */
14
15 /**
16 * Base installer class.
17 *
18 * This class provides the base for installation and update functionality
19 * for both MediaWiki core and extensions.
20 *
21 * @ingroup Deployment
22 * @since 1.17
23 */
24 abstract class Installer {
25
26 // This is the absolute minimum PHP version we can support
27 // @deprecated since 1.18
28 const MINIMUM_PHP_VERSION = MW_MIN_PHP_VERSION;
29
30 /**
31 * @var array
32 */
33 protected $settings;
34
35 /**
36 * Cached DB installer instances, access using getDBInstaller().
37 *
38 * @var array
39 */
40 protected $dbInstallers = array();
41
42 /**
43 * Minimum memory size in MB.
44 *
45 * @var integer
46 */
47 protected $minMemorySize = 50;
48
49 /**
50 * Cached Title, used by parse().
51 *
52 * @var Title
53 */
54 protected $parserTitle;
55
56 /**
57 * Cached ParserOptions, used by parse().
58 *
59 * @var ParserOptions
60 */
61 protected $parserOptions;
62
63 /**
64 * Known database types. These correspond to the class names <type>Installer,
65 * and are also MediaWiki database types valid for $wgDBtype.
66 *
67 * To add a new type, create a <type>Installer class and a Database<type>
68 * class, and add a config-type-<type> message to MessagesEn.php.
69 *
70 * @var array
71 */
72 protected static $dbTypes = array(
73 'mysql',
74 'postgres',
75 'oracle',
76 'sqlite',
77 'ibm_db2',
78 );
79
80 /**
81 * A list of environment check methods called by doEnvironmentChecks().
82 * These may output warnings using showMessage(), and/or abort the
83 * installation process by returning false.
84 *
85 * @var array
86 */
87 protected $envChecks = array(
88 'envCheckDB',
89 'envCheckRegisterGlobals',
90 'envCheckBrokenXML',
91 'envCheckPHP531',
92 'envCheckMagicQuotes',
93 'envCheckMagicSybase',
94 'envCheckMbstring',
95 'envCheckZE1',
96 'envCheckSafeMode',
97 'envCheckXML',
98 'envCheckPCRE',
99 'envCheckMemory',
100 'envCheckCache',
101 'envCheckDiff3',
102 'envCheckGraphics',
103 'envCheckPath',
104 'envCheckExtension',
105 'envCheckShellLocale',
106 'envCheckUploadsDirectory',
107 'envCheckLibicu',
108 'envCheckSuhosinMaxValueLength',
109 );
110
111 /**
112 * MediaWiki configuration globals that will eventually be passed through
113 * to LocalSettings.php. The names only are given here, the defaults
114 * typically come from DefaultSettings.php.
115 *
116 * @var array
117 */
118 protected $defaultVarNames = array(
119 'wgSitename',
120 'wgPasswordSender',
121 'wgLanguageCode',
122 'wgRightsIcon',
123 'wgRightsText',
124 'wgRightsUrl',
125 'wgMainCacheType',
126 'wgEnableEmail',
127 'wgEnableUserEmail',
128 'wgEnotifUserTalk',
129 'wgEnotifWatchlist',
130 'wgEmailAuthentication',
131 'wgDBtype',
132 'wgDiff3',
133 'wgImageMagickConvertCommand',
134 'IP',
135 'wgScriptPath',
136 'wgScriptExtension',
137 'wgMetaNamespace',
138 'wgDeletedDirectory',
139 'wgEnableUploads',
140 'wgLogo',
141 'wgShellLocale',
142 'wgSecretKey',
143 'wgUseInstantCommons',
144 'wgUpgradeKey',
145 'wgDefaultSkin',
146 'wgResourceLoaderMaxQueryLength',
147 );
148
149 /**
150 * Variables that are stored alongside globals, and are used for any
151 * configuration of the installation process aside from the MediaWiki
152 * configuration. Map of names to defaults.
153 *
154 * @var array
155 */
156 protected $internalDefaults = array(
157 '_UserLang' => 'en',
158 '_Environment' => false,
159 '_CompiledDBs' => array(),
160 '_SafeMode' => false,
161 '_RaiseMemory' => false,
162 '_UpgradeDone' => false,
163 '_InstallDone' => false,
164 '_Caches' => array(),
165 '_InstallUser' => 'root',
166 '_InstallPassword' => '',
167 '_SameAccount' => true,
168 '_CreateDBAccount' => false,
169 '_NamespaceType' => 'site-name',
170 '_AdminName' => '', // will be set later, when the user selects language
171 '_AdminPassword' => '',
172 '_AdminPassword2' => '',
173 '_AdminEmail' => '',
174 '_Subscribe' => false,
175 '_SkipOptional' => 'continue',
176 '_RightsProfile' => 'wiki',
177 '_LicenseCode' => 'none',
178 '_CCDone' => false,
179 '_Extensions' => array(),
180 '_MemCachedServers' => '',
181 '_UpgradeKeySupplied' => false,
182 '_ExistingDBSettings' => false,
183 );
184
185 /**
186 * The actual list of installation steps. This will be initialized by getInstallSteps()
187 *
188 * @var array
189 */
190 private $installSteps = array();
191
192 /**
193 * Extra steps for installation, for things like DatabaseInstallers to modify
194 *
195 * @var array
196 */
197 protected $extraInstallSteps = array();
198
199 /**
200 * Known object cache types and the functions used to test for their existence.
201 *
202 * @var array
203 */
204 protected $objectCaches = array(
205 'xcache' => 'xcache_get',
206 'apc' => 'apc_fetch',
207 'eaccel' => 'eaccelerator_get',
208 'wincache' => 'wincache_ucache_get'
209 );
210
211 /**
212 * User rights profiles.
213 *
214 * @var array
215 */
216 public $rightsProfiles = array(
217 'wiki' => array(),
218 'no-anon' => array(
219 '*' => array( 'edit' => false )
220 ),
221 'fishbowl' => array(
222 '*' => array(
223 'createaccount' => false,
224 'edit' => false,
225 ),
226 ),
227 'private' => array(
228 '*' => array(
229 'createaccount' => false,
230 'edit' => false,
231 'read' => false,
232 ),
233 ),
234 );
235
236 /**
237 * License types.
238 *
239 * @var array
240 */
241 public $licenses = array(
242 'cc-by' => array(
243 'url' => 'http://creativecommons.org/licenses/by/3.0/',
244 'icon' => '{$wgStylePath}/common/images/cc-by.png',
245 ),
246 'cc-by-sa' => array(
247 'url' => 'http://creativecommons.org/licenses/by-sa/3.0/',
248 'icon' => '{$wgStylePath}/common/images/cc-by-sa.png',
249 ),
250 'cc-by-nc-sa' => array(
251 'url' => 'http://creativecommons.org/licenses/by-nc-sa/3.0/',
252 'icon' => '{$wgStylePath}/common/images/cc-by-nc-sa.png',
253 ),
254 'cc-0' => array(
255 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
256 'icon' => '{$wgStylePath}/common/images/cc-0.png',
257 ),
258 'pd' => array(
259 'url' => '',
260 'icon' => '{$wgStylePath}/common/images/public-domain.png',
261 ),
262 'gfdl' => array(
263 'url' => 'http://www.gnu.org/copyleft/fdl.html',
264 'icon' => '{$wgStylePath}/common/images/gnu-fdl.png',
265 ),
266 'none' => array(
267 'url' => '',
268 'icon' => '',
269 'text' => ''
270 ),
271 'cc-choose' => array(
272 // Details will be filled in by the selector.
273 'url' => '',
274 'icon' => '',
275 'text' => '',
276 ),
277 );
278
279 /**
280 * URL to mediawiki-announce subscription
281 */
282 protected $mediaWikiAnnounceUrl = 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
283
284 /**
285 * Supported language codes for Mailman
286 */
287 protected $mediaWikiAnnounceLanguages = array(
288 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
289 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
290 'sl', 'sr', 'sv', 'tr', 'uk'
291 );
292
293 /**
294 * UI interface for displaying a short message
295 * The parameters are like parameters to wfMsg().
296 * The messages will be in wikitext format, which will be converted to an
297 * output format such as HTML or text before being sent to the user.
298 */
299 public abstract function showMessage( $msg /*, ... */ );
300
301 /**
302 * Same as showMessage(), but for displaying errors
303 */
304 public abstract function showError( $msg /*, ... */ );
305
306 /**
307 * Show a message to the installing user by using a Status object
308 * @param $status Status
309 */
310 public abstract function showStatusMessage( Status $status );
311
312 /**
313 * Constructor, always call this from child classes.
314 */
315 public function __construct() {
316 global $wgExtensionMessagesFiles, $wgUser;
317
318 // Disable the i18n cache and LoadBalancer
319 Language::getLocalisationCache()->disableBackend();
320 LBFactory::disableBackend();
321
322 // Load the installer's i18n file.
323 $wgExtensionMessagesFiles['MediawikiInstaller'] =
324 dirname( __FILE__ ) . '/Installer.i18n.php';
325
326 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
327 $wgUser = User::newFromId( 0 );
328
329 $this->settings = $this->internalDefaults;
330
331 foreach ( $this->defaultVarNames as $var ) {
332 $this->settings[$var] = $GLOBALS[$var];
333 }
334
335 foreach ( self::getDBTypes() as $type ) {
336 $installer = $this->getDBInstaller( $type );
337
338 if ( !$installer->isCompiled() ) {
339 continue;
340 }
341
342 $defaults = $installer->getGlobalDefaults();
343
344 foreach ( $installer->getGlobalNames() as $var ) {
345 if ( isset( $defaults[$var] ) ) {
346 $this->settings[$var] = $defaults[$var];
347 } else {
348 $this->settings[$var] = $GLOBALS[$var];
349 }
350 }
351 }
352
353 $this->parserTitle = Title::newFromText( 'Installer' );
354 $this->parserOptions = new ParserOptions; // language will be wrong :(
355 $this->parserOptions->setEditSection( false );
356 }
357
358 /**
359 * Get a list of known DB types.
360 *
361 * @return array
362 */
363 public static function getDBTypes() {
364 return self::$dbTypes;
365 }
366
367 /**
368 * Do initial checks of the PHP environment. Set variables according to
369 * the observed environment.
370 *
371 * It's possible that this may be called under the CLI SAPI, not the SAPI
372 * that the wiki will primarily run under. In that case, the subclass should
373 * initialise variables such as wgScriptPath, before calling this function.
374 *
375 * Under the web subclass, it can already be assumed that PHP 5+ is in use
376 * and that sessions are working.
377 *
378 * @return Status
379 */
380 public function doEnvironmentChecks() {
381 $phpVersion = phpversion();
382 if( version_compare( $phpVersion, MW_MIN_PHP_VERSION, '>=' ) ) {
383 $this->showMessage( 'config-env-php', $phpVersion );
384 $good = true;
385 } else {
386 $this->showMessage( 'config-env-php-toolow', $phpVersion, MW_MIN_PHP_VERSION );
387 $good = false;
388 }
389
390 if( $good ) {
391 foreach ( $this->envChecks as $check ) {
392 $status = $this->$check();
393 if ( $status === false ) {
394 $good = false;
395 }
396 }
397 }
398
399 $this->setVar( '_Environment', $good );
400
401 return $good ? Status::newGood() : Status::newFatal( 'config-env-bad' );
402 }
403
404 /**
405 * Set a MW configuration variable, or internal installer configuration variable.
406 *
407 * @param $name String
408 * @param $value Mixed
409 */
410 public function setVar( $name, $value ) {
411 $this->settings[$name] = $value;
412 }
413
414 /**
415 * Get an MW configuration variable, or internal installer configuration variable.
416 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
417 * Installer variables are typically prefixed by an underscore.
418 *
419 * @param $name String
420 * @param $default Mixed
421 *
422 * @return mixed
423 */
424 public function getVar( $name, $default = null ) {
425 if ( !isset( $this->settings[$name] ) ) {
426 return $default;
427 } else {
428 return $this->settings[$name];
429 }
430 }
431
432 /**
433 * Get an instance of DatabaseInstaller for the specified DB type.
434 *
435 * @param $type Mixed: DB installer for which is needed, false to use default.
436 *
437 * @return DatabaseInstaller
438 */
439 public function getDBInstaller( $type = false ) {
440 if ( !$type ) {
441 $type = $this->getVar( 'wgDBtype' );
442 }
443
444 $type = strtolower( $type );
445
446 if ( !isset( $this->dbInstallers[$type] ) ) {
447 $class = ucfirst( $type ). 'Installer';
448 $this->dbInstallers[$type] = new $class( $this );
449 }
450
451 return $this->dbInstallers[$type];
452 }
453
454 /**
455 * Determine if LocalSettings.php exists. If it does, return its variables,
456 * merged with those from AdminSettings.php, as an array.
457 *
458 * @return Array
459 */
460 public function getExistingLocalSettings() {
461 global $IP;
462
463 wfSuppressWarnings();
464 $_lsExists = file_exists( "$IP/LocalSettings.php" );
465 wfRestoreWarnings();
466
467 if( !$_lsExists ) {
468 return false;
469 }
470 unset($_lsExists);
471
472 require( "$IP/includes/DefaultSettings.php" );
473 require( "$IP/LocalSettings.php" );
474 if ( file_exists( "$IP/AdminSettings.php" ) ) {
475 require( "$IP/AdminSettings.php" );
476 }
477 return get_defined_vars();
478 }
479
480 /**
481 * Get a fake password for sending back to the user in HTML.
482 * This is a security mechanism to avoid compromise of the password in the
483 * event of session ID compromise.
484 *
485 * @param $realPassword String
486 *
487 * @return string
488 */
489 public function getFakePassword( $realPassword ) {
490 return str_repeat( '*', strlen( $realPassword ) );
491 }
492
493 /**
494 * Set a variable which stores a password, except if the new value is a
495 * fake password in which case leave it as it is.
496 *
497 * @param $name String
498 * @param $value Mixed
499 */
500 public function setPassword( $name, $value ) {
501 if ( !preg_match( '/^\*+$/', $value ) ) {
502 $this->setVar( $name, $value );
503 }
504 }
505
506 /**
507 * On POSIX systems return the primary group of the webserver we're running under.
508 * On other systems just returns null.
509 *
510 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
511 * webserver user before he can install.
512 *
513 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
514 *
515 * @return mixed
516 */
517 public static function maybeGetWebserverPrimaryGroup() {
518 if ( !function_exists( 'posix_getegid' ) || !function_exists( 'posix_getpwuid' ) ) {
519 # I don't know this, this isn't UNIX.
520 return null;
521 }
522
523 # posix_getegid() *not* getmygid() because we want the group of the webserver,
524 # not whoever owns the current script.
525 $gid = posix_getegid();
526 $getpwuid = posix_getpwuid( $gid );
527 $group = $getpwuid['name'];
528
529 return $group;
530 }
531
532 /**
533 * Convert wikitext $text to HTML.
534 *
535 * This is potentially error prone since many parser features require a complete
536 * installed MW database. The solution is to just not use those features when you
537 * write your messages. This appears to work well enough. Basic formatting and
538 * external links work just fine.
539 *
540 * But in case a translator decides to throw in a #ifexist or internal link or
541 * whatever, this function is guarded to catch the attempted DB access and to present
542 * some fallback text.
543 *
544 * @param $text String
545 * @param $lineStart Boolean
546 * @return String
547 */
548 public function parse( $text, $lineStart = false ) {
549 global $wgParser;
550
551 try {
552 $out = $wgParser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
553 $html = $out->getText();
554 } catch ( DBAccessError $e ) {
555 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
556
557 if ( !empty( $this->debug ) ) {
558 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
559 }
560 }
561
562 return $html;
563 }
564
565 /**
566 * @return ParserOptions
567 */
568 public function getParserOptions() {
569 return $this->parserOptions;
570 }
571
572 public function disableLinkPopups() {
573 $this->parserOptions->setExternalLinkTarget( false );
574 }
575
576 public function restoreLinkPopups() {
577 global $wgExternalLinkTarget;
578 $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
579 }
580
581 /**
582 * Install step which adds a row to the site_stats table with appropriate
583 * initial values.
584 *
585 * @param $installer DatabaseInstaller
586 *
587 * @return Status
588 */
589 public function populateSiteStats( DatabaseInstaller $installer ) {
590 $status = $installer->getConnection();
591 if ( !$status->isOK() ) {
592 return $status;
593 }
594 $status->value->insert( 'site_stats', array(
595 'ss_row_id' => 1,
596 'ss_total_views' => 0,
597 'ss_total_edits' => 0,
598 'ss_good_articles' => 0,
599 'ss_total_pages' => 0,
600 'ss_users' => 0,
601 'ss_admins' => 0,
602 'ss_images' => 0 ),
603 __METHOD__, 'IGNORE' );
604 return Status::newGood();
605 }
606
607 /**
608 * Exports all wg* variables stored by the installer into global scope.
609 */
610 public function exportVars() {
611 foreach ( $this->settings as $name => $value ) {
612 if ( substr( $name, 0, 2 ) == 'wg' ) {
613 $GLOBALS[$name] = $value;
614 }
615 }
616 }
617
618 /**
619 * Environment check for DB types.
620 */
621 protected function envCheckDB() {
622 global $wgLang;
623
624 $compiledDBs = array();
625 $allNames = array();
626
627 foreach ( self::getDBTypes() as $name ) {
628 if ( $this->getDBInstaller( $name )->isCompiled() ) {
629 $compiledDBs[] = $name;
630 }
631 $allNames[] = wfMsg( 'config-type-' . $name );
632 }
633
634 $this->setVar( '_CompiledDBs', $compiledDBs );
635
636 if ( !$compiledDBs ) {
637 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ) );
638 // FIXME: this only works for the web installer!
639 return false;
640 }
641
642 // Check for FTS3 full-text search module
643 $sqlite = $this->getDBInstaller( 'sqlite' );
644 if ( $sqlite->isCompiled() ) {
645 if( DatabaseSqlite::getFulltextSearchModule() != 'FTS3' ) {
646 $this->showMessage( 'config-no-fts3' );
647 }
648 }
649 }
650
651 /**
652 * Environment check for register_globals.
653 */
654 protected function envCheckRegisterGlobals() {
655 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
656 $this->showMessage( 'config-register-globals' );
657 }
658 }
659
660 /**
661 * Some versions of libxml+PHP break < and > encoding horribly
662 */
663 protected function envCheckBrokenXML() {
664 $test = new PhpXmlBugTester();
665 if ( !$test->ok ) {
666 $this->showError( 'config-brokenlibxml' );
667 return false;
668 }
669 }
670
671 /**
672 * Test PHP (probably 5.3.1, but it could regress again) to make sure that
673 * reference parameters to __call() are not converted to null
674 */
675 protected function envCheckPHP531() {
676 $test = new PhpRefCallBugTester;
677 $test->execute();
678 if ( !$test->ok ) {
679 $this->showError( 'config-using531', phpversion() );
680 return false;
681 }
682 }
683
684 /**
685 * Environment check for magic_quotes_runtime.
686 */
687 protected function envCheckMagicQuotes() {
688 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
689 $this->showError( 'config-magic-quotes-runtime' );
690 return false;
691 }
692 }
693
694 /**
695 * Environment check for magic_quotes_sybase.
696 */
697 protected function envCheckMagicSybase() {
698 if ( wfIniGetBool( 'magic_quotes_sybase' ) ) {
699 $this->showError( 'config-magic-quotes-sybase' );
700 return false;
701 }
702 }
703
704 /**
705 * Environment check for mbstring.func_overload.
706 */
707 protected function envCheckMbstring() {
708 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
709 $this->showError( 'config-mbstring' );
710 return false;
711 }
712 }
713
714 /**
715 * Environment check for zend.ze1_compatibility_mode.
716 */
717 protected function envCheckZE1() {
718 if ( wfIniGetBool( 'zend.ze1_compatibility_mode' ) ) {
719 $this->showError( 'config-ze1' );
720 return false;
721 }
722 }
723
724 /**
725 * Environment check for safe_mode.
726 */
727 protected function envCheckSafeMode() {
728 if ( wfIniGetBool( 'safe_mode' ) ) {
729 $this->setVar( '_SafeMode', true );
730 $this->showMessage( 'config-safe-mode' );
731 }
732 }
733
734 /**
735 * Environment check for the XML module.
736 */
737 protected function envCheckXML() {
738 if ( !function_exists( "utf8_encode" ) ) {
739 $this->showError( 'config-xml-bad' );
740 return false;
741 }
742 }
743
744 /**
745 * Environment check for the PCRE module.
746 */
747 protected function envCheckPCRE() {
748 if ( !function_exists( 'preg_match' ) ) {
749 $this->showError( 'config-pcre' );
750 return false;
751 }
752 wfSuppressWarnings();
753 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
754 wfRestoreWarnings();
755 if ( $regexd != '--' ) {
756 $this->showError( 'config-pcre-no-utf8' );
757 return false;
758 }
759 }
760
761 /**
762 * Environment check for available memory.
763 */
764 protected function envCheckMemory() {
765 $limit = ini_get( 'memory_limit' );
766
767 if ( !$limit || $limit == -1 ) {
768 return true;
769 }
770
771 $n = wfShorthandToInteger( $limit );
772
773 if( $n < $this->minMemorySize * 1024 * 1024 ) {
774 $newLimit = "{$this->minMemorySize}M";
775
776 if( ini_set( "memory_limit", $newLimit ) === false ) {
777 $this->showMessage( 'config-memory-bad', $limit );
778 } else {
779 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
780 $this->setVar( '_RaiseMemory', true );
781 }
782 } else {
783 return true;
784 }
785 }
786
787 /**
788 * Environment check for compiled object cache types.
789 */
790 protected function envCheckCache() {
791 $caches = array();
792 foreach ( $this->objectCaches as $name => $function ) {
793 if ( function_exists( $function ) ) {
794 $caches[$name] = true;
795 }
796 }
797
798 if ( !$caches ) {
799 $this->showMessage( 'config-no-cache' );
800 }
801
802 $this->setVar( '_Caches', $caches );
803 }
804
805 /**
806 * Search for GNU diff3.
807 */
808 protected function envCheckDiff3() {
809 $names = array( "gdiff3", "diff3", "diff3.exe" );
810 $versionInfo = array( '$1 --version 2>&1', 'GNU diffutils' );
811
812 $diff3 = self::locateExecutableInDefaultPaths( $names, $versionInfo );
813
814 if ( $diff3 ) {
815 $this->setVar( 'wgDiff3', $diff3 );
816 } else {
817 $this->setVar( 'wgDiff3', false );
818 $this->showMessage( 'config-diff3-bad' );
819 }
820 }
821
822 /**
823 * Environment check for ImageMagick and GD.
824 */
825 protected function envCheckGraphics() {
826 $names = array( wfIsWindows() ? 'convert.exe' : 'convert' );
827 $convert = self::locateExecutableInDefaultPaths( $names, array( '$1 -version', 'ImageMagick' ) );
828
829 $this->setVar( 'wgImageMagickConvertCommand', '' );
830 if ( $convert ) {
831 $this->setVar( 'wgImageMagickConvertCommand', $convert );
832 $this->showMessage( 'config-imagemagick', $convert );
833 return true;
834 } elseif ( function_exists( 'imagejpeg' ) ) {
835 $this->showMessage( 'config-gd' );
836 return true;
837 } else {
838 $this->showMessage( 'config-no-scaling' );
839 }
840 }
841
842 /**
843 * Environment check for setting $IP and $wgScriptPath.
844 */
845 protected function envCheckPath() {
846 global $IP;
847 $IP = dirname( dirname( dirname( __FILE__ ) ) );
848
849 $this->setVar( 'IP', $IP );
850
851 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
852 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
853 // to get the path to the current script... hopefully it's reliable. SIGH
854 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
855 $path = $_SERVER['PHP_SELF'];
856 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
857 $path = $_SERVER['SCRIPT_NAME'];
858 } elseif ( $this->getVar( 'wgScriptPath' ) ) {
859 // Some kind soul has set it for us already (e.g. debconf)
860 return true;
861 } else {
862 $this->showError( 'config-no-uri' );
863 return false;
864 }
865
866 $uri = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
867 $this->setVar( 'wgScriptPath', $uri );
868 }
869
870 /**
871 * Environment check for setting the preferred PHP file extension.
872 */
873 protected function envCheckExtension() {
874 // FIXME: detect this properly
875 if ( defined( 'MW_INSTALL_PHP5_EXT' ) ) {
876 $ext = 'php5';
877 } else {
878 $ext = 'php';
879 }
880 $this->setVar( 'wgScriptExtension', ".$ext" );
881 }
882
883 /**
884 * TODO: document
885 */
886 protected function envCheckShellLocale() {
887 $os = php_uname( 's' );
888 $supported = array( 'Linux', 'SunOS', 'HP-UX', 'Darwin' ); # Tested these
889
890 if ( !in_array( $os, $supported ) ) {
891 return true;
892 }
893
894 # Get a list of available locales.
895 $ret = false;
896 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
897
898 if ( $ret ) {
899 return true;
900 }
901
902 $lines = wfArrayMap( 'trim', explode( "\n", $lines ) );
903 $candidatesByLocale = array();
904 $candidatesByLang = array();
905
906 foreach ( $lines as $line ) {
907 if ( $line === '' ) {
908 continue;
909 }
910
911 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
912 continue;
913 }
914
915 list( $all, $lang, $territory, $charset, $modifier ) = $m;
916
917 $candidatesByLocale[$m[0]] = $m;
918 $candidatesByLang[$lang][] = $m;
919 }
920
921 # Try the current value of LANG.
922 if ( isset( $candidatesByLocale[ getenv( 'LANG' ) ] ) ) {
923 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
924 return true;
925 }
926
927 # Try the most common ones.
928 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
929 foreach ( $commonLocales as $commonLocale ) {
930 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
931 $this->setVar( 'wgShellLocale', $commonLocale );
932 return true;
933 }
934 }
935
936 # Is there an available locale in the Wiki's language?
937 $wikiLang = $this->getVar( 'wgLanguageCode' );
938
939 if ( isset( $candidatesByLang[$wikiLang] ) ) {
940 $m = reset( $candidatesByLang[$wikiLang] );
941 $this->setVar( 'wgShellLocale', $m[0] );
942 return true;
943 }
944
945 # Are there any at all?
946 if ( count( $candidatesByLocale ) ) {
947 $m = reset( $candidatesByLocale );
948 $this->setVar( 'wgShellLocale', $m[0] );
949 return true;
950 }
951
952 # Give up.
953 return true;
954 }
955
956 /**
957 * TODO: document
958 */
959 protected function envCheckUploadsDirectory() {
960 global $IP, $wgServer;
961
962 $dir = $IP . '/images/';
963 $url = $wgServer . $this->getVar( 'wgScriptPath' ) . '/images/';
964 $safe = !$this->dirIsExecutable( $dir, $url );
965
966 if ( $safe ) {
967 return true;
968 } else {
969 $this->showMessage( 'config-uploads-not-safe', $dir );
970 }
971 }
972
973 /**
974 * Checks if suhosin.get.max_value_length is set, and if so, sets
975 * $wgResourceLoaderMaxQueryLength to that value in the generated
976 * LocalSettings file
977 */
978 protected function envCheckSuhosinMaxValueLength() {
979 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
980 if ( $maxValueLength > 0 ) {
981 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
982 } else {
983 $maxValueLength = -1;
984 }
985 $this->setVar( 'wgResourceLoaderMaxQueryLength', $maxValueLength );
986 }
987
988 /**
989 * Convert a hex string representing a Unicode code point to that code point.
990 * @param $c String
991 * @return string
992 */
993 protected function unicodeChar( $c ) {
994 $c = hexdec($c);
995 if ($c <= 0x7F) {
996 return chr($c);
997 } else if ($c <= 0x7FF) {
998 return chr(0xC0 | $c >> 6) . chr(0x80 | $c & 0x3F);
999 } else if ($c <= 0xFFFF) {
1000 return chr(0xE0 | $c >> 12) . chr(0x80 | $c >> 6 & 0x3F)
1001 . chr(0x80 | $c & 0x3F);
1002 } else if ($c <= 0x10FFFF) {
1003 return chr(0xF0 | $c >> 18) . chr(0x80 | $c >> 12 & 0x3F)
1004 . chr(0x80 | $c >> 6 & 0x3F)
1005 . chr(0x80 | $c & 0x3F);
1006 } else {
1007 return false;
1008 }
1009 }
1010
1011
1012 /**
1013 * Check the libicu version
1014 */
1015 protected function envCheckLibicu() {
1016 $utf8 = function_exists( 'utf8_normalize' );
1017 $intl = function_exists( 'normalizer_normalize' );
1018
1019 /**
1020 * This needs to be updated something that the latest libicu
1021 * will properly normalize. This normalization was found at
1022 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1023 * Note that we use the hex representation to create the code
1024 * points in order to avoid any Unicode-destroying during transit.
1025 */
1026 $not_normal_c = $this->unicodeChar("FA6C");
1027 $normal_c = $this->unicodeChar("242EE");
1028
1029 $useNormalizer = 'php';
1030 $needsUpdate = false;
1031
1032 /**
1033 * We're going to prefer the pecl extension here unless
1034 * utf8_normalize is more up to date.
1035 */
1036 if( $utf8 ) {
1037 $useNormalizer = 'utf8';
1038 $utf8 = utf8_normalize( $not_normal_c, UNORM_NFC );
1039 if ( $utf8 !== $normal_c ) $needsUpdate = true;
1040 }
1041 if( $intl ) {
1042 $useNormalizer = 'intl';
1043 $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1044 if ( $intl !== $normal_c ) $needsUpdate = true;
1045 }
1046
1047 // Uses messages 'config-unicode-using-php', 'config-unicode-using-utf8', 'config-unicode-using-intl'
1048 if( $useNormalizer === 'php' ) {
1049 $this->showMessage( 'config-unicode-pure-php-warning' );
1050 } else {
1051 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1052 if( $needsUpdate ) {
1053 $this->showMessage( 'config-unicode-update-warning' );
1054 }
1055 }
1056 }
1057
1058 /**
1059 * Get an array of likely places we can find executables. Check a bunch
1060 * of known Unix-like defaults, as well as the PATH environment variable
1061 * (which should maybe make it work for Windows?)
1062 *
1063 * @return Array
1064 */
1065 protected static function getPossibleBinPaths() {
1066 return array_merge(
1067 array( '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
1068 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ),
1069 explode( PATH_SEPARATOR, getenv( 'PATH' ) )
1070 );
1071 }
1072
1073 /**
1074 * Search a path for any of the given executable names. Returns the
1075 * executable name if found. Also checks the version string returned
1076 * by each executable.
1077 *
1078 * Used only by environment checks.
1079 *
1080 * @param $path String: path to search
1081 * @param $names Array of executable names
1082 * @param $versionInfo Boolean false or array with two members:
1083 * 0 => Command to run for version check, with $1 for the full executable name
1084 * 1 => String to compare the output with
1085 *
1086 * If $versionInfo is not false, only executables with a version
1087 * matching $versionInfo[1] will be returned.
1088 */
1089 public static function locateExecutable( $path, $names, $versionInfo = false ) {
1090 if ( !is_array( $names ) ) {
1091 $names = array( $names );
1092 }
1093
1094 foreach ( $names as $name ) {
1095 $command = $path . DIRECTORY_SEPARATOR . $name;
1096
1097 wfSuppressWarnings();
1098 $file_exists = file_exists( $command );
1099 wfRestoreWarnings();
1100
1101 if ( $file_exists ) {
1102 if ( !$versionInfo ) {
1103 return $command;
1104 }
1105
1106 $file = str_replace( '$1', wfEscapeShellArg( $command ), $versionInfo[0] );
1107 if ( strstr( wfShellExec( $file ), $versionInfo[1] ) !== false ) {
1108 return $command;
1109 }
1110 }
1111 }
1112 return false;
1113 }
1114
1115 /**
1116 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
1117 * @see locateExecutable()
1118 */
1119 public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
1120 foreach( self::getPossibleBinPaths() as $path ) {
1121 $exe = self::locateExecutable( $path, $names, $versionInfo );
1122 if( $exe !== false ) {
1123 return $exe;
1124 }
1125 }
1126 return false;
1127 }
1128
1129 /**
1130 * Checks if scripts located in the given directory can be executed via the given URL.
1131 *
1132 * Used only by environment checks.
1133 */
1134 public function dirIsExecutable( $dir, $url ) {
1135 $scriptTypes = array(
1136 'php' => array(
1137 "<?php echo 'ex' . 'ec';",
1138 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1139 ),
1140 );
1141
1142 // it would be good to check other popular languages here, but it'll be slow.
1143
1144 wfSuppressWarnings();
1145
1146 foreach ( $scriptTypes as $ext => $contents ) {
1147 foreach ( $contents as $source ) {
1148 $file = 'exectest.' . $ext;
1149
1150 if ( !file_put_contents( $dir . $file, $source ) ) {
1151 break;
1152 }
1153
1154 $text = Http::get( $url . $file, array( 'timeout' => 3 ) );
1155 unlink( $dir . $file );
1156
1157 if ( $text == 'exec' ) {
1158 wfRestoreWarnings();
1159 return $ext;
1160 }
1161 }
1162 }
1163
1164 wfRestoreWarnings();
1165
1166 return false;
1167 }
1168
1169 /**
1170 * ParserOptions are constructed before we determined the language, so fix it
1171 */
1172 public function setParserLanguage( $lang ) {
1173 $this->parserOptions->setTargetLanguage( $lang );
1174 $this->parserOptions->setUserLang( $lang->getCode() );
1175 }
1176
1177 /**
1178 * Overridden by WebInstaller to provide lastPage parameters.
1179 */
1180 protected function getDocUrl( $page ) {
1181 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1182 }
1183
1184 /**
1185 * Finds extensions that follow the format /extensions/Name/Name.php,
1186 * and returns an array containing the value for 'Name' for each found extension.
1187 *
1188 * @return array
1189 */
1190 public function findExtensions() {
1191 if( $this->getVar( 'IP' ) === null ) {
1192 return false;
1193 }
1194
1195 $exts = array();
1196 $dir = $this->getVar( 'IP' ) . '/extensions';
1197 $dh = opendir( $dir );
1198
1199 while ( ( $file = readdir( $dh ) ) !== false ) {
1200 if( file_exists( "$dir/$file/$file.php" ) ) {
1201 $exts[] = $file;
1202 }
1203 }
1204
1205 return $exts;
1206 }
1207
1208 /**
1209 * Installs the auto-detected extensions.
1210 *
1211 * @return Status
1212 */
1213 protected function includeExtensions() {
1214 global $IP;
1215 $exts = $this->getVar( '_Extensions' );
1216 $IP = $this->getVar( 'IP' );
1217 $path = $IP . '/extensions';
1218
1219 /**
1220 * We need to include DefaultSettings before including extensions to avoid
1221 * warnings about unset variables. However, the only thing we really
1222 * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1223 * if the extension has hidden hook registration in $wgExtensionFunctions,
1224 * but we're not opening that can of worms
1225 * @see https://bugzilla.wikimedia.org/show_bug.cgi?id=26857
1226 */
1227 global $wgAutoloadClasses;
1228 $wgAutoloadClasses = array();
1229
1230 require( "$IP/includes/DefaultSettings.php" );
1231
1232 foreach( $exts as $e ) {
1233 require_once( "$path/$e/$e.php" );
1234 }
1235
1236 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1237 $wgHooks['LoadExtensionSchemaUpdates'] : array();
1238
1239 // Unset everyone else's hooks. Lord knows what someone might be doing
1240 // in ParserFirstCallInit (see bug 27171)
1241 $GLOBALS['wgHooks'] = array( 'LoadExtensionSchemaUpdates' => $hooksWeWant );
1242
1243 return Status::newGood();
1244 }
1245
1246 /**
1247 * Get an array of install steps. Should always be in the format of
1248 * array(
1249 * 'name' => 'someuniquename',
1250 * 'callback' => array( $obj, 'method' ),
1251 * )
1252 * There must be a config-install-$name message defined per step, which will
1253 * be shown on install.
1254 *
1255 * @param $installer DatabaseInstaller so we can make callbacks
1256 * @return array
1257 */
1258 protected function getInstallSteps( DatabaseInstaller $installer ) {
1259 $coreInstallSteps = array(
1260 array( 'name' => 'database', 'callback' => array( $installer, 'setupDatabase' ) ),
1261 array( 'name' => 'tables', 'callback' => array( $installer, 'createTables' ) ),
1262 array( 'name' => 'interwiki', 'callback' => array( $installer, 'populateInterwikiTable' ) ),
1263 array( 'name' => 'stats', 'callback' => array( $this, 'populateSiteStats' ) ),
1264 array( 'name' => 'keys', 'callback' => array( $this, 'generateKeys' ) ),
1265 array( 'name' => 'sysop', 'callback' => array( $this, 'createSysop' ) ),
1266 array( 'name' => 'mainpage', 'callback' => array( $this, 'createMainpage' ) ),
1267 );
1268
1269 // Build the array of install steps starting from the core install list,
1270 // then adding any callbacks that wanted to attach after a given step
1271 foreach( $coreInstallSteps as $step ) {
1272 $this->installSteps[] = $step;
1273 if( isset( $this->extraInstallSteps[ $step['name'] ] ) ) {
1274 $this->installSteps = array_merge(
1275 $this->installSteps,
1276 $this->extraInstallSteps[ $step['name'] ]
1277 );
1278 }
1279 }
1280
1281 // Prepend any steps that want to be at the beginning
1282 if( isset( $this->extraInstallSteps['BEGINNING'] ) ) {
1283 $this->installSteps = array_merge(
1284 $this->extraInstallSteps['BEGINNING'],
1285 $this->installSteps
1286 );
1287 }
1288
1289 // Extensions should always go first, chance to tie into hooks and such
1290 if( count( $this->getVar( '_Extensions' ) ) ) {
1291 array_unshift( $this->installSteps,
1292 array( 'name' => 'extensions', 'callback' => array( $this, 'includeExtensions' ) )
1293 );
1294 $this->installSteps[] = array(
1295 'name' => 'extension-tables',
1296 'callback' => array( $installer, 'createExtensionTables' )
1297 );
1298 }
1299 return $this->installSteps;
1300 }
1301
1302 /**
1303 * Actually perform the installation.
1304 *
1305 * @param $startCB Array A callback array for the beginning of each step
1306 * @param $endCB Array A callback array for the end of each step
1307 *
1308 * @return Array of Status objects
1309 */
1310 public function performInstallation( $startCB, $endCB ) {
1311 $installResults = array();
1312 $installer = $this->getDBInstaller();
1313 $installer->preInstall();
1314 $steps = $this->getInstallSteps( $installer );
1315 foreach( $steps as $stepObj ) {
1316 $name = $stepObj['name'];
1317 call_user_func_array( $startCB, array( $name ) );
1318
1319 // Perform the callback step
1320 $status = call_user_func( $stepObj['callback'], $installer );
1321
1322 // Output and save the results
1323 call_user_func( $endCB, $name, $status );
1324 $installResults[$name] = $status;
1325
1326 // If we've hit some sort of fatal, we need to bail.
1327 // Callback already had a chance to do output above.
1328 if( !$status->isOk() ) {
1329 break;
1330 }
1331 }
1332 if( $status->isOk() ) {
1333 $this->setVar( '_InstallDone', true );
1334 }
1335 return $installResults;
1336 }
1337
1338 /**
1339 * Generate $wgSecretKey. Will warn if we had to use mt_rand() instead of
1340 * /dev/urandom
1341 *
1342 * @return Status
1343 */
1344 public function generateKeys() {
1345 $keys = array( 'wgSecretKey' => 64 );
1346 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1347 $keys['wgUpgradeKey'] = 16;
1348 }
1349 return $this->doGenerateKeys( $keys );
1350 }
1351
1352 /**
1353 * Generate a secret value for variables using either
1354 * /dev/urandom or mt_rand(). Produce a warning in the later case.
1355 *
1356 * @param $keys Array
1357 * @return Status
1358 */
1359 protected function doGenerateKeys( $keys ) {
1360 $status = Status::newGood();
1361
1362 wfSuppressWarnings();
1363 $file = fopen( "/dev/urandom", "r" );
1364 wfRestoreWarnings();
1365
1366 foreach ( $keys as $name => $length ) {
1367 if ( $file ) {
1368 $secretKey = bin2hex( fread( $file, $length / 2 ) );
1369 } else {
1370 $secretKey = '';
1371
1372 for ( $i = 0; $i < $length / 8; $i++ ) {
1373 $secretKey .= dechex( mt_rand( 0, 0x7fffffff ) );
1374 }
1375 }
1376
1377 $this->setVar( $name, $secretKey );
1378 }
1379
1380 if ( $file ) {
1381 fclose( $file );
1382 } else {
1383 $names = array_keys ( $keys );
1384 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1385 global $wgLang;
1386 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1387 }
1388
1389 return $status;
1390 }
1391
1392 /**
1393 * Create the first user account, grant it sysop and bureaucrat rights
1394 *
1395 * @return Status
1396 */
1397 protected function createSysop() {
1398 $name = $this->getVar( '_AdminName' );
1399 $user = User::newFromName( $name );
1400
1401 if ( !$user ) {
1402 // We should've validated this earlier anyway!
1403 return Status::newFatal( 'config-admin-error-user', $name );
1404 }
1405
1406 if ( $user->idForName() == 0 ) {
1407 $user->addToDatabase();
1408
1409 try {
1410 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1411 } catch( PasswordError $pwe ) {
1412 return Status::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1413 }
1414
1415 $user->addGroup( 'sysop' );
1416 $user->addGroup( 'bureaucrat' );
1417 if( $this->getVar( '_AdminEmail' ) ) {
1418 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1419 }
1420 $user->saveSettings();
1421
1422 // Update user count
1423 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1424 $ssUpdate->doUpdate();
1425 }
1426 $status = Status::newGood();
1427
1428 if( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1429 $this->subscribeToMediaWikiAnnounce( $status );
1430 }
1431
1432 return $status;
1433 }
1434
1435 private function subscribeToMediaWikiAnnounce( Status $s ) {
1436 $params = array(
1437 'email' => $this->getVar( '_AdminEmail' ),
1438 'language' => 'en',
1439 'digest' => 0
1440 );
1441
1442 // Mailman doesn't support as many languages as we do, so check to make
1443 // sure their selected language is available
1444 $myLang = $this->getVar( '_UserLang' );
1445 if( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1446 $myLang = $myLang == 'pt-br' ? 'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1447 $params['language'] = $myLang;
1448 }
1449
1450 $res = Http::post( $this->mediaWikiAnnounceUrl, array( 'postData' => $params ) );
1451 if( !$res ) {
1452 $s->warning( 'config-install-subscribe-fail' );
1453 }
1454 }
1455
1456 /**
1457 * Insert Main Page with default content.
1458 *
1459 * @return Status
1460 */
1461 protected function createMainpage( DatabaseInstaller $installer ) {
1462 $status = Status::newGood();
1463 try {
1464 $article = new Article( Title::newMainPage() );
1465 $article->doEdit( wfMsgForContent( 'mainpagetext' ) . "\n\n" .
1466 wfMsgForContent( 'mainpagedocfooter' ),
1467 '',
1468 EDIT_NEW,
1469 false,
1470 User::newFromName( 'MediaWiki default' ) );
1471 } catch (MWException $e) {
1472 //using raw, because $wgShowExceptionDetails can not be set yet
1473 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1474 }
1475
1476 return $status;
1477 }
1478
1479 /**
1480 * Override the necessary bits of the config to run an installation.
1481 */
1482 public static function overrideConfig() {
1483 define( 'MW_NO_SESSION', 1 );
1484
1485 // Don't access the database
1486 $GLOBALS['wgUseDatabaseMessages'] = false;
1487 // Debug-friendly
1488 $GLOBALS['wgShowExceptionDetails'] = true;
1489 // Don't break forms
1490 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1491
1492 // Extended debugging
1493 $GLOBALS['wgShowSQLErrors'] = true;
1494 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1495
1496 // Allow multiple ob_flush() calls
1497 $GLOBALS['wgDisableOutputCompression'] = true;
1498
1499 // Use a sensible cookie prefix (not my_wiki)
1500 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1501
1502 // Some of the environment checks make shell requests, remove limits
1503 $GLOBALS['wgMaxShellMemory'] = 0;
1504 }
1505
1506 /**
1507 * Add an installation step following the given step.
1508 *
1509 * @param $callback Array A valid installation callback array, in this form:
1510 * array( 'name' => 'some-unique-name', 'callback' => array( $obj, 'function' ) );
1511 * @param $findStep String the step to find. Omit to put the step at the beginning
1512 */
1513 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1514 $this->extraInstallSteps[$findStep][] = $callback;
1515 }
1516 }