MediaWiki master
WebInstaller.php
Go to the documentation of this file.
1<?php
24namespace MediaWiki\Installer;
25
26use Exception;
27use HtmlArmor;
36
43class WebInstaller extends Installer {
44
48 public $output;
49
55 public $request;
56
62 protected $session;
63
69 protected $phpErrors;
70
81 public $pageSequence = [
82 'Language',
83 'ExistingWiki',
84 'Welcome',
85 'DBConnect',
86 'Upgrade',
87 'DBSettings',
88 'Name',
89 'Options',
90 'Install',
91 'Complete',
92 ];
93
99 protected $otherPages = [
100 'Restart',
101 'ReleaseNotes',
102 'Copying',
103 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
104 ];
105
112 protected $happyPages;
113
121 protected $skippedPages;
122
128 public $showSessionWarning = false;
129
135 protected $tabIndex = 1;
136
142 protected $helpBoxId = 1;
143
150
154 public function __construct( WebRequest $request ) {
155 parent::__construct();
156 $this->output = new WebInstallerOutput( $this );
157 $this->request = $request;
158 }
159
167 public function execute( array $session ) {
168 $this->session = $session;
169
170 if ( isset( $session['settings'] ) ) {
171 $this->settings = $session['settings'] + $this->settings;
172 // T187586 MediaWikiServices works with globals
173 foreach ( $this->settings as $key => $val ) {
174 $GLOBALS[$key] = $val;
175 }
176 }
177
178 $this->setupLanguage();
179
180 if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
181 && $this->request->getVal( 'localsettings' )
182 ) {
183 $this->outputLS();
184 return $this->session;
185 }
186
187 $isCSS = $this->request->getCheck( 'css' );
188 if ( $isCSS ) {
189 $this->outputCss();
190 return $this->session;
191 }
192
193 $this->happyPages = $session['happyPages'] ?? [];
194
195 $this->skippedPages = $session['skippedPages'] ?? [];
196
197 $lowestUnhappy = $this->getLowestUnhappy();
198
199 # Get the page name.
200 $pageName = $this->request->getVal( 'page', '' );
201
202 if ( in_array( $pageName, $this->otherPages ) ) {
203 # Out of sequence
204 $pageId = false;
205 $page = $this->getPageByName( $pageName );
206 } else {
207 # Main sequence
208 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
209 $pageId = $lowestUnhappy;
210 } else {
211 $pageId = array_search( $pageName, $this->pageSequence );
212 }
213
214 # If necessary, move back to the lowest-numbered unhappy page
215 if ( $pageId > $lowestUnhappy ) {
216 $pageId = $lowestUnhappy;
217 if ( $lowestUnhappy == 0 ) {
218 # Knocked back to start, possible loss of session data.
219 $this->showSessionWarning = true;
220 }
221 }
222
223 $pageName = $this->pageSequence[$pageId];
224 $page = $this->getPageByName( $pageName );
225 }
226
227 # If a back button was submitted, go back without submitting the form data.
228 if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
229 if ( $this->request->getVal( 'lastPage' ) ) {
230 $nextPage = $this->request->getVal( 'lastPage' );
231 } elseif ( $pageId !== false ) {
232 # Main sequence page
233 # Skip the skipped pages
234 $nextPageId = $pageId;
235
236 do {
237 $nextPageId--;
238 $nextPage = $this->pageSequence[$nextPageId];
239 } while ( isset( $this->skippedPages[$nextPage] ) );
240 } else {
241 $nextPage = $this->pageSequence[$lowestUnhappy];
242 }
243
244 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
245
246 return $this->finish();
247 }
248
249 # Execute the page.
250 $this->currentPageName = $page->getName();
251 $this->startPageWrapper( $pageName );
252
253 if ( $page->isSlow() ) {
254 $this->disableTimeLimit();
255 }
256
257 $result = $page->execute();
258
259 $this->endPageWrapper();
260
261 if ( $result == 'skip' ) {
262 # Page skipped without explicit submission.
263 # Skip it when we click "back" so that we don't just go forward again.
264 $this->skippedPages[$pageName] = true;
265 $result = 'continue';
266 } else {
267 unset( $this->skippedPages[$pageName] );
268 }
269
270 # If it was posted, the page can request a continue to the next page.
271 if ( $result === 'continue' && !$this->output->headerDone() ) {
272 if ( $pageId !== false ) {
273 $this->happyPages[$pageId] = true;
274 }
275
276 $lowestUnhappy = $this->getLowestUnhappy();
277
278 if ( $this->request->getVal( 'lastPage' ) ) {
279 $nextPage = $this->request->getVal( 'lastPage' );
280 } elseif ( $pageId !== false ) {
281 $nextPage = $this->pageSequence[$pageId + 1];
282 } else {
283 $nextPage = $this->pageSequence[$lowestUnhappy];
284 }
285
286 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
287 $nextPage = $this->pageSequence[$lowestUnhappy];
288 }
289
290 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
291 }
292
293 return $this->finish();
294 }
295
300 public function getLowestUnhappy() {
301 if ( count( $this->happyPages ) == 0 ) {
302 return 0;
303 } else {
304 return max( array_keys( $this->happyPages ) ) + 1;
305 }
306 }
307
314 public function startSession() {
315 if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
316 // Done already
317 return true;
318 }
319
320 // Use secure cookies if we are on HTTPS
321 $options = [];
322 if ( $this->request->getProtocol() === 'https' ) {
323 $options['cookie_secure'] = '1';
324 }
325
326 $this->phpErrors = [];
327 set_error_handler( [ $this, 'errorHandler' ] );
328 try {
329 session_name( 'mw_installer_session' );
330 session_start( $options );
331 } catch ( Exception $e ) {
332 restore_error_handler();
333 throw $e;
334 }
335 restore_error_handler();
336
337 if ( $this->phpErrors ) {
338 return false;
339 }
340
341 return true;
342 }
343
352 public function getFingerprint() {
353 // Get the base URL of the installation
354 $url = $this->request->getFullRequestURL();
355 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
356 // Trim query string
357 $url = $m[1];
358 }
359 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
360 // This... seems to try to get the base path from
361 // the /mw-config/index.php. Kinda scary though?
362 $url = $m[1];
363 }
364
365 return md5( serialize( [
366 'local path' => dirname( __DIR__ ),
367 'url' => $url,
368 'version' => MW_VERSION
369 ] ) );
370 }
371
372 public function showError( $msg, ...$params ) {
373 if ( !( $msg instanceof Message ) ) {
374 $msg = wfMessage(
375 $msg,
376 array_map( 'htmlspecialchars', $params )
377 );
378 }
379 $text = $msg->useDatabase( false )->parse();
380 $box = Html::errorBox( $text, '', 'config-error-box' );
381 $this->output->addHTML( $box );
382 }
383
390 public function errorHandler( $errno, $errstr ) {
391 $this->phpErrors[] = $errstr;
392 }
393
399 public function finish() {
400 $this->output->output();
401
402 $this->session['happyPages'] = $this->happyPages;
403 $this->session['skippedPages'] = $this->skippedPages;
404 $this->session['settings'] = $this->settings;
405
406 return $this->session;
407 }
408
412 public function reset() {
413 $this->session = [];
414 $this->happyPages = [];
415 $this->settings = [];
416 }
417
425 public function getUrl( $query = [] ) {
426 $url = $this->request->getRequestURL();
427 # Remove existing query
428 $url = preg_replace( '/\?.*$/', '', $url );
429
430 if ( $query ) {
431 $url .= '?' . wfArrayToCgi( $query );
432 }
433
434 return $url;
435 }
436
443 public function getPageByName( $pageName ) {
444 $pageClass = 'MediaWiki\\Installer\\WebInstaller' . $pageName;
445
446 return new $pageClass( $this );
447 }
448
457 public function getSession( $name, $default = null ) {
458 return $this->session[$name] ?? $default;
459 }
460
467 public function setSession( $name, $value ) {
468 $this->session[$name] = $value;
469 }
470
476 public function nextTabIndex() {
477 return $this->tabIndex++;
478 }
479
483 public function setupLanguage() {
484 global $wgLang, $wgLanguageCode;
485
486 if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
488 $wgLang = MediaWikiServices::getInstance()->getLanguageFactory()
489 ->getLanguage( $wgLanguageCode );
490 RequestContext::getMain()->setLanguage( $wgLang );
491 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
492 $this->setVar( '_UserLang', $wgLanguageCode );
493 } else {
494 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
495 }
496 }
497
504 public function getAcceptLanguage() {
505 global $wgLanguageCode;
506
507 $mwLanguages = MediaWikiServices::getInstance()
508 ->getLanguageNameUtils()
509 ->getLanguageNames( LanguageNameUtils::AUTONYMS, LanguageNameUtils::SUPPORTED );
510 $headerLanguages = array_keys( $this->request->getAcceptLang() );
511
512 foreach ( $headerLanguages as $lang ) {
513 if ( isset( $mwLanguages[$lang] ) ) {
514 return $lang;
515 }
516 }
517
518 return $wgLanguageCode;
519 }
520
526 private function startPageWrapper( $currentPageName ) {
527 $s = "<div class=\"config-page-wrapper\">\n";
528 $s .= "<div class=\"config-page\">\n";
529 $s .= "<div class=\"config-page-list cdx-card\"><span class=\"cdx-card__text\">";
530 $s .= "<span class=\"cdx-card__text__description\"><ul>\n";
531 $lastHappy = -1;
532
533 foreach ( $this->pageSequence as $id => $pageName ) {
534 $happy = !empty( $this->happyPages[$id] );
535 $s .= $this->getPageListItem(
536 $pageName,
537 $happy || $lastHappy == $id - 1,
539 );
540
541 if ( $happy ) {
542 $lastHappy = $id;
543 }
544 }
545
546 $s .= "</ul><br/><ul>\n";
547 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
548 // End list pane
549 $s .= "</ul></span></span></div>\n";
550
551 // Messages:
552 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
553 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
554 // config-page-complete, config-page-restart, config-page-releasenotes,
555 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
556 $s .= Html::element( 'h2', [],
557 wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
558
559 $this->output->addHTMLNoFlush( $s );
560 }
561
571 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
572 $s = "<li class=\"config-page-list-item\">";
573
574 // Messages:
575 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
576 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
577 // config-page-complete, config-page-restart, config-page-releasenotes,
578 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
579 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
580
581 if ( $enabled ) {
582 $query = [ 'page' => $pageName ];
583
584 if ( !in_array( $pageName, $this->pageSequence ) ) {
585 if ( in_array( $currentPageName, $this->pageSequence ) ) {
586 $query['lastPage'] = $currentPageName;
587 }
588
589 $link = Html::element( 'a',
590 [
591 'href' => $this->getUrl( $query )
592 ],
593 $name
594 );
595 } else {
596 $link = htmlspecialchars( $name );
597 }
598
599 if ( $pageName == $currentPageName ) {
600 $s .= "<span class=\"config-page-current\">$link</span>";
601 } else {
602 $s .= $link;
603 }
604 } else {
605 $s .= Html::element( 'span',
606 [
607 'class' => 'config-page-disabled'
608 ],
609 $name
610 );
611 }
612
613 $s .= "</li>\n";
614
615 return $s;
616 }
617
621 private function endPageWrapper() {
622 $this->output->addHTMLNoFlush(
623 "<div class=\"visualClear\"></div>\n" .
624 "</div>\n" .
625 "<div class=\"visualClear\"></div>\n" .
626 "</div>" );
627 }
628
637 public function getInfoBox( $text, $icon = false, $class = '' ) {
638 $html = ( $text instanceof HtmlArmor ) ?
639 HtmlArmor::getHtml( $text ) :
640 $this->parse( $text, true );
641 $alt = wfMessage( 'config-information' )->text();
642
643 return self::infoBox( $html, '', $alt, $class );
644 }
645
655 public function getHelpBox( $msg, ...$params ) {
656 $params = array_map( 'htmlspecialchars', $params );
657 $text = wfMessage( $msg, $params )->useDatabase( false )->plain();
658 $html = $this->parse( $text, true );
659
660 return "<div class=\"config-help-field-container\">\n" .
661 "<a class=\"config-help-field-hint\" title=\"" .
662 wfMessage( 'config-help-tooltip' )->escaped() . "\">ℹ️ " .
663 wfMessage( 'config-help' )->escaped() . "</a>\n" .
664 "<div class=\"config-help-field-content config-help-field-content-hidden " .
665 "cdx-message cdx-message--block cdx-message--notice\" style=\"margin: 10px\">" .
666 "<div class=\"cdx-message__content\">" . $html . "</div></div>\n" .
667 "</div>\n";
668 }
669
670 public function showMessage( $msg, ...$params ) {
671 $html = '<div class="cdx-message cdx-message--block cdx-message--notice">' .
672 '<span class="cdx-message__icon"></span><div class="cdx-message__content">' .
673 $this->parse( wfMessage( $msg, $params )->useDatabase( false )->plain() ) .
674 "</div></div>\n";
675 $this->output->addHTML( $html );
676 }
677
678 public function showStatusMessage( Status $status ) {
679 // Show errors at the top in web installer to make them easier to notice
680 foreach ( $status->getMessages( 'error' ) as $msg ) {
681 $this->showMessage( $msg );
682 }
683 foreach ( $status->getMessages( 'warning' ) as $msg ) {
684 $this->showMessage( $msg );
685 }
686 }
687
699 public function label( $msg, $forId, $contents, $helpData = "" ) {
700 if ( strval( $msg ) == '' ) {
701 $labelText = "\u{00A0}";
702 } else {
703 $labelText = wfMessage( $msg )->escaped();
704 }
705
706 $attributes = [ 'class' => 'config-label' ];
707
708 if ( $forId ) {
709 $attributes['for'] = $forId;
710 }
711
712 return "<div class=\"config-block\">\n" .
713 " <div class=\"config-block-label\">\n" .
714 Xml::tags( 'label',
715 $attributes,
716 $labelText
717 ) . "\n" .
718 $helpData .
719 " </div>\n" .
720 " <div class=\"config-block-elements\">\n" .
721 $contents .
722 " </div>\n" .
723 "</div>\n";
724 }
725
741 public function getTextBox( $params ) {
742 if ( !isset( $params['controlName'] ) ) {
743 $params['controlName'] = 'config_' . $params['var'];
744 }
745
746 if ( !isset( $params['value'] ) ) {
747 $params['value'] = $this->getVar( $params['var'] );
748 }
749
750 if ( !isset( $params['attribs'] ) ) {
751 $params['attribs'] = [];
752 }
753 if ( !isset( $params['help'] ) ) {
754 $params['help'] = "";
755 }
756
757 return $this->label(
758 $params['label'],
759 $params['controlName'],
760 "<div class=\"cdx-text-input\">" .
762 $params['controlName'],
763 30, // intended to be overridden by CSS
764 $params['value'],
765 $params['attribs'] + [
766 'id' => $params['controlName'],
767 'class' => 'cdx-text-input__input',
768 'tabindex' => $this->nextTabIndex()
769 ]
770 ) . "</div>",
771 $params['help']
772 );
773 }
774
789 public function getTextArea( $params ) {
790 if ( !isset( $params['controlName'] ) ) {
791 $params['controlName'] = 'config_' . $params['var'];
792 }
793
794 if ( !isset( $params['value'] ) ) {
795 $params['value'] = $this->getVar( $params['var'] );
796 }
797
798 if ( !isset( $params['attribs'] ) ) {
799 $params['attribs'] = [];
800 }
801 if ( !isset( $params['help'] ) ) {
802 $params['help'] = "";
803 }
804
805 return $this->label(
806 $params['label'],
807 $params['controlName'],
809 $params['controlName'],
810 $params['value'],
811 30,
812 5,
813 $params['attribs'] + [
814 'id' => $params['controlName'],
815 'class' => 'config-input-text',
816 'tabindex' => $this->nextTabIndex()
817 ]
818 ),
819 $params['help']
820 );
821 }
822
839 public function getPasswordBox( $params ) {
840 if ( !isset( $params['value'] ) ) {
841 $params['value'] = $this->getVar( $params['var'] );
842 }
843
844 if ( !isset( $params['attribs'] ) ) {
845 $params['attribs'] = [];
846 }
847
848 $params['value'] = $this->getFakePassword( $params['value'] );
849 $params['attribs']['type'] = 'password';
850
851 return $this->getTextBox( $params );
852 }
853
861 private static function addClassAttrib( &$attribs, $class ) {
862 if ( isset( $attribs['class'] ) ) {
863 $attribs['class'] .= ' ' . $class;
864 } else {
865 $attribs['class'] = $class;
866 }
867 }
868
885 public function getCheckBox( $params ) {
886 if ( !isset( $params['controlName'] ) ) {
887 $params['controlName'] = 'config_' . $params['var'];
888 }
889
890 if ( !isset( $params['value'] ) ) {
891 $params['value'] = $this->getVar( $params['var'] );
892 }
893
894 if ( !isset( $params['attribs'] ) ) {
895 $params['attribs'] = [];
896 }
897 if ( !isset( $params['help'] ) ) {
898 $params['help'] = "";
899 }
900 if ( !isset( $params['labelAttribs'] ) ) {
901 $params['labelAttribs'] = [];
902 }
903 $labelText = $params['rawtext'] ?? $this->parse( wfMessage( $params['label'] )->plain() );
904 self::addClassAttrib( $params['attribs'], 'cdx-checkbox__input' );
905 self::addClassAttrib( $params['labelAttribs'], 'cdx-checkbox__label' );
906
907 return "<div class=\"cdx-checkbox\" style=\"margin-top: 12px; margin-bottom: 2px;\">\n" .
909 $params['controlName'],
910 $params['value'],
911 $params['attribs'] + [
912 'id' => $params['controlName'],
913 'tabindex' => $this->nextTabIndex()
914 ]
915 ) .
916 "<span class=\"cdx-checkbox__icon\"></span>" .
917 Html::rawElement(
918 'label',
919 $params['labelAttribs'] + [
920 'for' => $params['controlName']
921 ],
922 $labelText
923 ) .
924 "</div>\n" . $params['help'];
925 }
926
947 public function getRadioSet( $params ) {
948 $items = $this->getRadioElements( $params );
949
950 $label = $params['label'] ?? '';
951
952 if ( !isset( $params['controlName'] ) ) {
953 $params['controlName'] = 'config_' . $params['var'];
954 }
955
956 if ( !isset( $params['help'] ) ) {
957 $params['help'] = "";
958 }
959
960 $s = "";
961 foreach ( $items as $item ) {
962 $s .= "$item\n";
963 }
964
965 return $this->label( $label, $params['controlName'], $s, $params['help'] );
966 }
967
977 public function getRadioElements( $params ) {
978 if ( !isset( $params['controlName'] ) ) {
979 $params['controlName'] = 'config_' . $params['var'];
980 }
981
982 if ( !isset( $params['value'] ) ) {
983 $params['value'] = $this->getVar( $params['var'] );
984 }
985
986 $items = [];
987
988 foreach ( $params['values'] as $value ) {
989 $itemAttribs = [];
990
991 if ( isset( $params['commonAttribs'] ) ) {
992 $itemAttribs = $params['commonAttribs'];
993 }
994
995 if ( isset( $params['itemAttribs'][$value] ) ) {
996 $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
997 }
998
999 $checked = $value == $params['value'];
1000 $id = $params['controlName'] . '_' . $value;
1001 $itemAttribs['id'] = $id;
1002 $itemAttribs['tabindex'] = $this->nextTabIndex();
1003 self::addClassAttrib( $itemAttribs, 'cdx-radio__input' );
1004
1005 $items[$value] =
1006 '<span class="cdx-radio">' .
1007 Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1008 "<span class=\"cdx-radio__icon\"></span>\u{00A0}" .
1009 Xml::tags( 'label', [ 'for' => $id, 'class' => 'cdx-radio__label' ], $this->parse(
1010 isset( $params['itemLabels'] ) ?
1011 wfMessage( $params['itemLabels'][$value] )->plain() :
1012 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1013 ) ) . '</span>';
1014 }
1015
1016 return $items;
1017 }
1018
1024 public function showStatusBox( $status ) {
1025 if ( !$status->isGood() ) {
1026 $html = $status->getHTML();
1027
1028 if ( $status->isOK() ) {
1029 $box = Html::warningBox( $html, 'config-warning-box' );
1030 } else {
1031 $box = Html::errorBox( $html, '', 'config-error-box' );
1032 }
1033
1034 $this->output->addHTML( $box );
1035 }
1036 }
1037
1048 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1049 $newValues = [];
1050
1051 foreach ( $varNames as $name ) {
1052 $value = $this->request->getVal( $prefix . $name );
1053 // T32524, do not trim passwords
1054 if ( $value !== null && stripos( $name, 'password' ) === false ) {
1055 $value = trim( $value );
1056 }
1057 $newValues[$name] = $value;
1058
1059 if ( $value === null ) {
1060 // Checkbox?
1061 $this->setVar( $name, false );
1062 } elseif ( stripos( $name, 'password' ) !== false ) {
1063 $this->setPassword( $name, $value );
1064 } else {
1065 $this->setVar( $name, $value );
1066 }
1067 }
1068
1069 return $newValues;
1070 }
1071
1079 public function getDocUrl( $page ) {
1080 $query = [ 'page' => $page ];
1081
1082 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1083 $query['lastPage'] = $this->currentPageName;
1084 }
1085
1086 return $this->getUrl( $query );
1087 }
1088
1097 public function makeLinkItem( $url, $linkText ) {
1098 return Html::rawElement( 'li', [],
1099 Html::element( 'a', [ 'href' => $url ], $linkText )
1100 );
1101 }
1102
1109 public function makeDownloadLinkHtml() {
1110 $anchor = Html::rawElement( 'a',
1111 [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1112 wfMessage( 'config-download-localsettings' )->parse()
1113 );
1114
1115 return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1116 }
1117
1128 public function getLocalSettingsLocation() {
1129 return false;
1130 }
1131
1135 public function envCheckPath() {
1136 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1137 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1138 // to get the path to the current script... hopefully it's reliable. SIGH
1139 $path = false;
1140 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1141 $path = $_SERVER['PHP_SELF'];
1142 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1143 $path = $_SERVER['SCRIPT_NAME'];
1144 }
1145 if ( $path === false ) {
1146 $this->showError( 'config-no-uri' );
1147 return false;
1148 }
1149
1150 return parent::envCheckPath();
1151 }
1152
1153 protected function detectWebPaths() {
1154 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1155 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1156 // to get the path to the current script... hopefully it's reliable. SIGH
1157 $path = false;
1158 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1159 $path = $_SERVER['PHP_SELF'];
1160 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1161 $path = $_SERVER['SCRIPT_NAME'];
1162 }
1163 if ( $path !== false ) {
1164 $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1165
1166 return [
1167 'wgScriptPath' => "$scriptPath",
1168 // Update variables set from Setup.php that are derived from wgScriptPath
1169 'wgScript' => "$scriptPath/index.php",
1170 'wgLoadScript' => "$scriptPath/load.php",
1171 'wgStylePath' => "$scriptPath/skins",
1172 'wgLocalStylePath' => "$scriptPath/skins",
1173 'wgExtensionAssetsPath' => "$scriptPath/extensions",
1174 'wgUploadPath' => "$scriptPath/images",
1175 'wgResourceBasePath' => "$scriptPath",
1176 ];
1177 }
1178 return [];
1179 }
1180
1184 protected function envGetDefaultServer() {
1185 $assumeProxiesUseDefaultProtocolPorts =
1186 $this->getVar( 'wgAssumeProxiesUseDefaultProtocolPorts' );
1187
1188 return WebRequest::detectServer( $assumeProxiesUseDefaultProtocolPorts );
1189 }
1190
1194 private function outputLS() {
1195 $this->request->response()->header( 'Content-type: application/x-httpd-php' );
1196 $this->request->response()->header(
1197 'Content-Disposition: attachment; filename="LocalSettings.php"'
1198 );
1199
1201 $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
1202 foreach ( $rightsProfile as $group => $rightsArr ) {
1203 $ls->setGroupRights( $group, $rightsArr );
1204 }
1205 echo $ls->getText();
1206 }
1207
1211 public function outputCss() {
1212 $this->request->response()->header( 'Content-type: text/css' );
1213 echo $this->output->getCSS();
1214 }
1215
1219 public function getPhpErrors() {
1220 return $this->phpErrors;
1221 }
1222
1233 protected static function infoBox( $rawHtml, $icon, $alt, $class = '' ) {
1234 $s = Html::openElement( 'div', [ 'class' => 'mw-installer-box-left' ] ) .
1235 Html::element( 'img',
1236 [
1237 'src' => $icon,
1238 'alt' => $alt,
1239 ]
1240 ) .
1241 Html::closeElement( 'div' ) .
1242 Html::openElement( 'div', [ 'class' => 'mw-installer-box-right' ] ) .
1243 $rawHtml .
1244 Html::closeElement( 'div' ) .
1245 Html::element( 'div', [ 'style' => 'clear: left;' ], ' ' );
1246
1247 return Html::warningBox( $s, $class )
1248 . Html::element( 'div', [ 'style' => 'clear: left;' ], ' ' );
1249 }
1250
1257 public function needsUpgrade() {
1258 return $this->getDBInstaller()->needsUpgrade();
1259 }
1260
1266 public function doUpgrade() {
1267 $dbInstaller = $this->getDBInstaller();
1268 $dbInstaller->preUpgrade();
1269 $this->restoreServices();
1270
1271 $ret = true;
1272 ob_start( [ $this, 'outputHandler' ] );
1274 $dbInstaller->definitelyGetConnection( DatabaseInstaller::CONN_CREATE_TABLES ) );
1275 try {
1276 $up->doUpdates();
1277 $up->purgeCache();
1278
1279 $this->setVar( '_UpgradeDone', true );
1280 } catch ( Exception $e ) {
1281 // TODO: Should this use MWExceptionRenderer?
1282 echo "\nAn error occurred:\n";
1283 echo $e->getMessage();
1284 $ret = false;
1285 }
1286 ob_end_flush();
1287
1288 return $ret;
1289 }
1290
1291 public function outputHandler( $string ) {
1292 return htmlspecialchars( $string );
1293 }
1294
1295}
const MW_VERSION
The running version of MediaWiki.
Definition Defines.php:37
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
if(!defined( 'MW_NO_SESSION') &&MW_ENTRY_POINT !=='cli' $wgLang
Definition Setup.php:572
array $params
The job parameters.
Marks HTML that shouldn't be escaped.
Definition HtmlArmor.php:30
Group all the pieces relevant to the context of a request into one instance.
This class is a collection of static functions that serve two purposes:
Definition Html.php:56
static check( $name, $checked=false, array $attribs=[])
Convenience function to produce a checkbox (input element with type=checkbox)
Definition Html.php:672
static radio( $name, $checked=false, array $attribs=[])
Convenience function to produce a radio button (input element with type=radio)
Definition Html.php:812
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an <input> element.
Definition Html.php:657
static textarea( $name, $value='', array $attribs=[])
Convenience function to produce a <textarea> element.
Definition Html.php:867
static newForDB(IMaintainableDatabase $db, $shared=false, ?Maintenance $maintenance=null)
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
Base installer class.
Definition Installer.php:85
restoreServices()
Restore services that have been redefined in the early stage of installation.
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
disableTimeLimit()
Disable the time limit for execution.
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
getDBInstaller( $type=false)
Get an instance of DatabaseInstaller for the specified DB type.
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Output class modelled on OutputPage.
Class for the core installer web interface.
makeDownloadLinkHtml()
Helper for "Download LocalSettings" link.
int $tabIndex
Numeric index of the page we're on.
string[] $otherPages
Out of sequence pages, selectable by the user at any time.
detectWebPaths()
This is overridden by the web installer to provide the detected wgScriptPath.
getPageByName( $pageName)
Get a WebInstallerPage by name.
getLocalSettingsLocation()
If the software package wants the LocalSettings.php file to be placed in a specific location,...
errorHandler( $errno, $errstr)
Temporary error handler for session start debugging.
outputCss()
Output stylesheet for web installer pages.
showStatusMessage(Status $status)
Show a message to the installing user by using a Status object.
needsUpgrade()
Determine whether the current database needs to be upgraded, i.e.
string $currentPageName
Name of the page we're on.
array[] $session
Cached session array.
getUrl( $query=[])
Get a URL for submission back to the same script.
getFingerprint()
Get a hash of data identifying this MW installation.
makeLinkItem( $url, $linkText)
Helper for sidebar links.
string[] $pageSequence
The main sequence of page names.
static infoBox( $rawHtml, $icon, $alt, $class='')
Get HTML for an information message box with an icon.
getTextArea( $params)
Get a labelled textarea to configure a variable.
setupLanguage()
Initializes language-related variables.
getInfoBox( $text, $icon=false, $class='')
Get HTML for an information message box with an icon.
reset()
We're restarting the installation, reset the session, happyPages, etc.
getRadioSet( $params)
Get a set of labelled radio buttons.
setSession( $name, $value)
Set a session variable.
getSession( $name, $default=null)
Get a session variable.
finish()
Clean up from execute()
label( $msg, $forId, $contents, $helpData="")
Label a control by wrapping a config-input div around it and putting a label before it.
startSession()
Start the PHP session.
__construct(WebRequest $request)
getRadioElements( $params)
Get a set of labelled radio buttons.
setVarsFromRequest( $varNames, $prefix='config_')
Convenience function to set variables based on form data.
getPasswordBox( $params)
Get a labelled password box to configure a variable.
getTextBox( $params)
Get a labelled text box to configure a variable.
getHelpBox( $msg,... $params)
Get small text indented help for a preceding form field.
bool $showSessionWarning
Flag indicating that session data may have been lost.
execute(array $session)
Main entry point.
int $helpBoxId
Numeric index of the help box.
getDocUrl( $page)
Helper for WebInstallerOutput.
bool[] $skippedPages
List of "skipped" pages.
showStatusBox( $status)
Output an error or warning box using a Status object.
WebRequest $request
WebRequest object.
getAcceptLanguage()
Retrieves MediaWiki language from Accept-Language HTTP header.
string[] $phpErrors
Captured PHP error text.
doUpgrade()
Perform database upgrades.
getCheckBox( $params)
Get a labelled checkbox to configure a boolean variable.
bool[] $happyPages
Array of pages which have declared that they have been submitted, have validated their input,...
showMessage( $msg,... $params)
UI interface for displaying a short message The parameters are like parameters to wfMessage().
nextTabIndex()
Get the next tabindex attribute value.
getLowestUnhappy()
Find the next page in sequence that hasn't been completed.
showError( $msg,... $params)
Same as showMessage(), but for displaying errors.
A service that provides utilities to do with language names and codes.
Service locator for MediaWiki core services.
static getInstance()
Returns the global default instance of the top level service locator.
The Message class deals with fetching and processing of interface message into a variety of formats.
Definition Message.php:155
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form,...
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:54
Module of static functions for generating XML.
Definition Xml.php:37
getMessages(?string $type=null)
Returns a list of error messages, optionally only those of the given type.
$wgLanguageCode
Config variable stub for the LanguageCode setting, for use by phpdoc and IDEs.
const CONN_CREATE_TABLES
A connection with a role suitable for creating tables.
element(SerializerNode $parent, SerializerNode $node, $contents)