MediaWiki REL1_32
WebInstaller.php
Go to the documentation of this file.
1<?php
25
32class WebInstaller extends Installer {
33
37 public $output;
38
44 public $request;
45
51 protected $session;
52
58 protected $phpErrors;
59
70 public $pageSequence = [
71 'Language',
72 'ExistingWiki',
73 'Welcome',
74 'DBConnect',
75 'Upgrade',
76 'DBSettings',
77 'Name',
78 'Options',
79 'Install',
80 'Complete',
81 ];
82
88 protected $otherPages = [
89 'Restart',
90 'Readme',
91 'ReleaseNotes',
92 'Copying',
93 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
94 ];
95
102 protected $happyPages;
103
111 protected $skippedPages;
112
118 public $showSessionWarning = false;
119
125 protected $tabIndex = 1;
126
133
137 public function __construct( WebRequest $request ) {
138 parent::__construct();
139 $this->output = new WebInstallerOutput( $this );
140 $this->request = $request;
141
142 // Add parser hooks
143 global $wgParser;
144 $wgParser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
145 $wgParser->setHook( 'doclink', [ $this, 'docLink' ] );
146 }
147
155 public function execute( array $session ) {
156 $this->session = $session;
157
158 if ( isset( $session['settings'] ) ) {
159 $this->settings = $session['settings'] + $this->settings;
160 // T187586 MediaWikiServices works with globals
161 foreach ( $this->settings as $key => $val ) {
162 $GLOBALS[$key] = $val;
163 }
164 }
165
166 $this->setupLanguage();
167
168 if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
169 && $this->request->getVal( 'localsettings' )
170 ) {
171 $this->outputLS();
172 return $this->session;
173 }
174
175 $isCSS = $this->request->getVal( 'css' );
176 if ( $isCSS ) {
177 $this->outputCss();
178 return $this->session;
179 }
180
181 if ( isset( $session['happyPages'] ) ) {
182 $this->happyPages = $session['happyPages'];
183 } else {
184 $this->happyPages = [];
185 }
186
187 if ( isset( $session['skippedPages'] ) ) {
188 $this->skippedPages = $session['skippedPages'];
189 } else {
190 $this->skippedPages = [];
191 }
192
193 $lowestUnhappy = $this->getLowestUnhappy();
194
195 # Special case for Creative Commons partner chooser box.
196 if ( $this->request->getVal( 'SubmitCC' ) ) {
197 $page = $this->getPageByName( 'Options' );
198 $this->output->useShortHeader();
199 $this->output->allowFrames();
200 $page->submitCC();
201
202 return $this->finish();
203 }
204
205 if ( $this->request->getVal( 'ShowCC' ) ) {
206 $page = $this->getPageByName( 'Options' );
207 $this->output->useShortHeader();
208 $this->output->allowFrames();
209 $this->output->addHTML( $page->getCCDoneBox() );
210
211 return $this->finish();
212 }
213
214 # Get the page name.
215 $pageName = $this->request->getVal( 'page' );
216
217 if ( in_array( $pageName, $this->otherPages ) ) {
218 # Out of sequence
219 $pageId = false;
220 $page = $this->getPageByName( $pageName );
221 } else {
222 # Main sequence
223 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
224 $pageId = $lowestUnhappy;
225 } else {
226 $pageId = array_search( $pageName, $this->pageSequence );
227 }
228
229 # If necessary, move back to the lowest-numbered unhappy page
230 if ( $pageId > $lowestUnhappy ) {
231 $pageId = $lowestUnhappy;
232 if ( $lowestUnhappy == 0 ) {
233 # Knocked back to start, possible loss of session data.
234 $this->showSessionWarning = true;
235 }
236 }
237
238 $pageName = $this->pageSequence[$pageId];
239 $page = $this->getPageByName( $pageName );
240 }
241
242 # If a back button was submitted, go back without submitting the form data.
243 if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
244 if ( $this->request->getVal( 'lastPage' ) ) {
245 $nextPage = $this->request->getVal( 'lastPage' );
246 } elseif ( $pageId !== false ) {
247 # Main sequence page
248 # Skip the skipped pages
249 $nextPageId = $pageId;
250
251 do {
252 $nextPageId--;
253 $nextPage = $this->pageSequence[$nextPageId];
254 } while ( isset( $this->skippedPages[$nextPage] ) );
255 } else {
256 $nextPage = $this->pageSequence[$lowestUnhappy];
257 }
258
259 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
260
261 return $this->finish();
262 }
263
264 # Execute the page.
265 $this->currentPageName = $page->getName();
266 $this->startPageWrapper( $pageName );
267
268 if ( $page->isSlow() ) {
269 $this->disableTimeLimit();
270 }
271
272 $result = $page->execute();
273
274 $this->endPageWrapper();
275
276 if ( $result == 'skip' ) {
277 # Page skipped without explicit submission.
278 # Skip it when we click "back" so that we don't just go forward again.
279 $this->skippedPages[$pageName] = true;
280 $result = 'continue';
281 } else {
282 unset( $this->skippedPages[$pageName] );
283 }
284
285 # If it was posted, the page can request a continue to the next page.
286 if ( $result === 'continue' && !$this->output->headerDone() ) {
287 if ( $pageId !== false ) {
288 $this->happyPages[$pageId] = true;
289 }
290
291 $lowestUnhappy = $this->getLowestUnhappy();
292
293 if ( $this->request->getVal( 'lastPage' ) ) {
294 $nextPage = $this->request->getVal( 'lastPage' );
295 } elseif ( $pageId !== false ) {
296 $nextPage = $this->pageSequence[$pageId + 1];
297 } else {
298 $nextPage = $this->pageSequence[$lowestUnhappy];
299 }
300
301 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
302 $nextPage = $this->pageSequence[$lowestUnhappy];
303 }
304
305 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
306 }
307
308 return $this->finish();
309 }
310
315 public function getLowestUnhappy() {
316 if ( count( $this->happyPages ) == 0 ) {
317 return 0;
318 } else {
319 return max( array_keys( $this->happyPages ) ) + 1;
320 }
321 }
322
329 public function startSession() {
330 if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
331 // Done already
332 return true;
333 }
334
335 $this->phpErrors = [];
336 set_error_handler( [ $this, 'errorHandler' ] );
337 try {
338 session_name( 'mw_installer_session' );
339 session_start();
340 } catch ( Exception $e ) {
341 restore_error_handler();
342 throw $e;
343 }
344 restore_error_handler();
345
346 if ( $this->phpErrors ) {
347 return false;
348 }
349
350 return true;
351 }
352
361 public function getFingerprint() {
362 // Get the base URL of the installation
363 $url = $this->request->getFullRequestURL();
364 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
365 // Trim query string
366 $url = $m[1];
367 }
368 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
369 // This... seems to try to get the base path from
370 // the /mw-config/index.php. Kinda scary though?
371 $url = $m[1];
372 }
373
374 return md5( serialize( [
375 'local path' => dirname( __DIR__ ),
376 'url' => $url,
377 'version' => $GLOBALS['wgVersion']
378 ] ) );
379 }
380
386 public function showError( $msg /*...*/ ) {
387 if ( !( $msg instanceof Message ) ) {
388 $args = func_get_args();
389 array_shift( $args );
390 $args = array_map( 'htmlspecialchars', $args );
391 $msg = wfMessage( $msg, $args );
392 }
393 $text = $msg->useDatabase( false )->plain();
394 $this->output->addHTML( $this->getErrorBox( $text ) );
395 }
396
403 public function errorHandler( $errno, $errstr ) {
404 $this->phpErrors[] = $errstr;
405 }
406
412 public function finish() {
413 $this->output->output();
414
415 $this->session['happyPages'] = $this->happyPages;
416 $this->session['skippedPages'] = $this->skippedPages;
417 $this->session['settings'] = $this->settings;
418
419 return $this->session;
420 }
421
425 public function reset() {
426 $this->session = [];
427 $this->happyPages = [];
428 $this->settings = [];
429 }
430
438 public function getUrl( $query = [] ) {
439 $url = $this->request->getRequestURL();
440 # Remove existing query
441 $url = preg_replace( '/\?.*$/', '', $url );
442
443 if ( $query ) {
444 $url .= '?' . wfArrayToCgi( $query );
445 }
446
447 return $url;
448 }
449
456 public function getPageByName( $pageName ) {
457 $pageClass = 'WebInstaller' . $pageName;
458
459 return new $pageClass( $this );
460 }
461
470 public function getSession( $name, $default = null ) {
471 if ( !isset( $this->session[$name] ) ) {
472 return $default;
473 } else {
474 return $this->session[$name];
475 }
476 }
477
484 public function setSession( $name, $value ) {
485 $this->session[$name] = $value;
486 }
487
493 public function nextTabIndex() {
494 return $this->tabIndex++;
495 }
496
500 public function setupLanguage() {
502
503 if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
505 $wgLang = Language::factory( $wgLanguageCode );
506 RequestContext::getMain()->setLanguage( $wgLang );
507 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
508 $this->setVar( '_UserLang', $wgLanguageCode );
509 } else {
510 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
511 }
512 $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
513 }
514
520 public function getAcceptLanguage() {
522
523 $mwLanguages = Language::fetchLanguageNames( null, 'mwfile' );
524 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
525
526 foreach ( $headerLanguages as $lang ) {
527 if ( isset( $mwLanguages[$lang] ) ) {
528 return $lang;
529 }
530 }
531
532 return $wgLanguageCode;
533 }
534
540 private function startPageWrapper( $currentPageName ) {
541 $s = "<div class=\"config-page-wrapper\">\n";
542 $s .= "<div class=\"config-page\">\n";
543 $s .= "<div class=\"config-page-list\"><ul>\n";
544 $lastHappy = -1;
545
546 foreach ( $this->pageSequence as $id => $pageName ) {
547 $happy = !empty( $this->happyPages[$id] );
548 $s .= $this->getPageListItem(
549 $pageName,
550 $happy || $lastHappy == $id - 1,
552 );
553
554 if ( $happy ) {
555 $lastHappy = $id;
556 }
557 }
558
559 $s .= "</ul><br/><ul>\n";
560 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
561 // End list pane
562 $s .= "</ul></div>\n";
563
564 // Messages:
565 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
566 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
567 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
568 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
569 $s .= Html::element( 'h2', [],
570 wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
571
572 $this->output->addHTMLNoFlush( $s );
573 }
574
584 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
585 $s = "<li class=\"config-page-list-item\">";
586
587 // Messages:
588 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
589 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
590 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
591 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
592 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
593
594 if ( $enabled ) {
595 $query = [ 'page' => $pageName ];
596
597 if ( !in_array( $pageName, $this->pageSequence ) ) {
598 if ( in_array( $currentPageName, $this->pageSequence ) ) {
599 $query['lastPage'] = $currentPageName;
600 }
601
602 $link = Html::element( 'a',
603 [
604 'href' => $this->getUrl( $query )
605 ],
606 $name
607 );
608 } else {
609 $link = htmlspecialchars( $name );
610 }
611
612 if ( $pageName == $currentPageName ) {
613 $s .= "<span class=\"config-page-current\">$link</span>";
614 } else {
615 $s .= $link;
616 }
617 } else {
618 $s .= Html::element( 'span',
619 [
620 'class' => 'config-page-disabled'
621 ],
622 $name
623 );
624 }
625
626 $s .= "</li>\n";
627
628 return $s;
629 }
630
634 private function endPageWrapper() {
635 $this->output->addHTMLNoFlush(
636 "<div class=\"visualClear\"></div>\n" .
637 "</div>\n" .
638 "<div class=\"visualClear\"></div>\n" .
639 "</div>" );
640 }
641
649 public function getErrorBox( $text ) {
650 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
651 }
652
660 public function getWarningBox( $text ) {
661 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
662 }
663
673 public function getInfoBox( $text, $icon = false, $class = false ) {
674 $text = $this->parse( $text, true );
675 $icon = ( $icon == false ) ?
676 'images/info-32.png' :
677 'images/' . $icon;
678 $alt = wfMessage( 'config-information' )->text();
679
680 return Html::infoBox( $text, $icon, $alt, $class );
681 }
682
690 public function getHelpBox( $msg /*, ... */ ) {
691 $args = func_get_args();
692 array_shift( $args );
693 $args = array_map( 'htmlspecialchars', $args );
694 $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
695 $html = $this->parse( $text, true );
696
697 return "<div class=\"config-help-field-container\">\n" .
698 "<span class=\"config-help-field-hint\" title=\"" .
699 wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
700 wfMessage( 'config-help' )->escaped() . "</span>\n" .
701 "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
702 "</div>\n";
703 }
704
709 public function showHelpBox( $msg /*, ... */ ) {
710 $args = func_get_args();
711 $html = $this->getHelpBox( ...$args );
712 $this->output->addHTML( $html );
713 }
714
721 public function showMessage( $msg /*, ... */ ) {
722 $args = func_get_args();
723 array_shift( $args );
724 $html = '<div class="config-message">' .
725 $this->parse( wfMessage( $msg, $args )->useDatabase( false )->plain() ) .
726 "</div>\n";
727 $this->output->addHTML( $html );
728 }
729
733 public function showStatusMessage( Status $status ) {
734 $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
735 foreach ( $errors as $error ) {
736 $this->showMessage( ...$error );
737 }
738 }
739
750 public function label( $msg, $forId, $contents, $helpData = "" ) {
751 if ( strval( $msg ) == '' ) {
752 $labelText = "\u{00A0}";
753 } else {
754 $labelText = wfMessage( $msg )->escaped();
755 }
756
757 $attributes = [ 'class' => 'config-label' ];
758
759 if ( $forId ) {
760 $attributes['for'] = $forId;
761 }
762
763 return "<div class=\"config-block\">\n" .
764 " <div class=\"config-block-label\">\n" .
765 Xml::tags( 'label',
766 $attributes,
767 $labelText
768 ) . "\n" .
769 $helpData .
770 " </div>\n" .
771 " <div class=\"config-block-elements\">\n" .
772 $contents .
773 " </div>\n" .
774 "</div>\n";
775 }
776
791 public function getTextBox( $params ) {
792 if ( !isset( $params['controlName'] ) ) {
793 $params['controlName'] = 'config_' . $params['var'];
794 }
795
796 if ( !isset( $params['value'] ) ) {
797 $params['value'] = $this->getVar( $params['var'] );
798 }
799
800 if ( !isset( $params['attribs'] ) ) {
801 $params['attribs'] = [];
802 }
803 if ( !isset( $params['help'] ) ) {
804 $params['help'] = "";
805 }
806
807 return $this->label(
808 $params['label'],
809 $params['controlName'],
810 Xml::input(
811 $params['controlName'],
812 30, // intended to be overridden by CSS
813 $params['value'],
814 $params['attribs'] + [
815 'id' => $params['controlName'],
816 'class' => 'config-input-text',
817 'tabindex' => $this->nextTabIndex()
818 ]
819 ),
820 $params['help']
821 );
822 }
823
838 public function getTextArea( $params ) {
839 if ( !isset( $params['controlName'] ) ) {
840 $params['controlName'] = 'config_' . $params['var'];
841 }
842
843 if ( !isset( $params['value'] ) ) {
844 $params['value'] = $this->getVar( $params['var'] );
845 }
846
847 if ( !isset( $params['attribs'] ) ) {
848 $params['attribs'] = [];
849 }
850 if ( !isset( $params['help'] ) ) {
851 $params['help'] = "";
852 }
853
854 return $this->label(
855 $params['label'],
856 $params['controlName'],
857 Xml::textarea(
858 $params['controlName'],
859 $params['value'],
860 30,
861 5,
862 $params['attribs'] + [
863 'id' => $params['controlName'],
864 'class' => 'config-input-text',
865 'tabindex' => $this->nextTabIndex()
866 ]
867 ),
868 $params['help']
869 );
870 }
871
887 public function getPasswordBox( $params ) {
888 if ( !isset( $params['value'] ) ) {
889 $params['value'] = $this->getVar( $params['var'] );
890 }
891
892 if ( !isset( $params['attribs'] ) ) {
893 $params['attribs'] = [];
894 }
895
896 $params['value'] = $this->getFakePassword( $params['value'] );
897 $params['attribs']['type'] = 'password';
898
899 return $this->getTextBox( $params );
900 }
901
917 public function getCheckBox( $params ) {
918 if ( !isset( $params['controlName'] ) ) {
919 $params['controlName'] = 'config_' . $params['var'];
920 }
921
922 if ( !isset( $params['value'] ) ) {
923 $params['value'] = $this->getVar( $params['var'] );
924 }
925
926 if ( !isset( $params['attribs'] ) ) {
927 $params['attribs'] = [];
928 }
929 if ( !isset( $params['help'] ) ) {
930 $params['help'] = "";
931 }
932 if ( !isset( $params['labelAttribs'] ) ) {
933 $params['labelAttribs'] = [];
934 }
935 if ( isset( $params['rawtext'] ) ) {
936 $labelText = $params['rawtext'];
937 } else {
938 $labelText = $this->parse( wfMessage( $params['label'] )->text() );
939 }
940
941 return "<div class=\"config-input-check\">\n" .
942 $params['help'] .
943 Html::rawElement(
944 'label',
945 $params['labelAttribs'],
946 Xml::check(
947 $params['controlName'],
948 $params['value'],
949 $params['attribs'] + [
950 'id' => $params['controlName'],
951 'tabindex' => $this->nextTabIndex(),
952 ]
953 ) .
954 $labelText . "\n"
955 ) .
956 "</div>\n";
957 }
958
978 public function getRadioSet( $params ) {
979 $items = $this->getRadioElements( $params );
980
981 if ( !isset( $params['label'] ) ) {
982 $label = '';
983 } else {
984 $label = $params['label'];
985 }
986
987 if ( !isset( $params['controlName'] ) ) {
988 $params['controlName'] = 'config_' . $params['var'];
989 }
990
991 if ( !isset( $params['help'] ) ) {
992 $params['help'] = "";
993 }
994
995 $s = "<ul>\n";
996 foreach ( $items as $value => $item ) {
997 $s .= "<li>$item</li>\n";
998 }
999 $s .= "</ul>\n";
1000
1001 return $this->label( $label, $params['controlName'], $s, $params['help'] );
1002 }
1003
1012 public function getRadioElements( $params ) {
1013 if ( !isset( $params['controlName'] ) ) {
1014 $params['controlName'] = 'config_' . $params['var'];
1015 }
1016
1017 if ( !isset( $params['value'] ) ) {
1018 $params['value'] = $this->getVar( $params['var'] );
1019 }
1020
1021 $items = [];
1022
1023 foreach ( $params['values'] as $value ) {
1024 $itemAttribs = [];
1025
1026 if ( isset( $params['commonAttribs'] ) ) {
1027 $itemAttribs = $params['commonAttribs'];
1028 }
1029
1030 if ( isset( $params['itemAttribs'][$value] ) ) {
1031 $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1032 }
1033
1034 $checked = $value == $params['value'];
1035 $id = $params['controlName'] . '_' . $value;
1036 $itemAttribs['id'] = $id;
1037 $itemAttribs['tabindex'] = $this->nextTabIndex();
1038
1039 $items[$value] =
1040 Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1041 "\u{00A0}" .
1042 Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1043 isset( $params['itemLabels'] ) ?
1044 wfMessage( $params['itemLabels'][$value] )->plain() :
1045 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1046 ) );
1047 }
1048
1049 return $items;
1050 }
1051
1057 public function showStatusBox( $status ) {
1058 if ( !$status->isGood() ) {
1059 $text = $status->getWikiText();
1060
1061 if ( $status->isOK() ) {
1062 $box = $this->getWarningBox( $text );
1063 } else {
1064 $box = $this->getErrorBox( $text );
1065 }
1066
1067 $this->output->addHTML( $box );
1068 }
1069 }
1070
1081 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1082 $newValues = [];
1083
1084 foreach ( $varNames as $name ) {
1085 $value = $this->request->getVal( $prefix . $name );
1086 // T32524, do not trim passwords
1087 if ( stripos( $name, 'password' ) === false ) {
1088 $value = trim( $value );
1089 }
1090 $newValues[$name] = $value;
1091
1092 if ( $value === null ) {
1093 // Checkbox?
1094 $this->setVar( $name, false );
1095 } else {
1096 if ( stripos( $name, 'password' ) !== false ) {
1097 $this->setPassword( $name, $value );
1098 } else {
1099 $this->setVar( $name, $value );
1100 }
1101 }
1102 }
1103
1104 return $newValues;
1105 }
1106
1114 protected function getDocUrl( $page ) {
1115 $query = [ 'page' => $page ];
1116
1117 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1118 $query['lastPage'] = $this->currentPageName;
1119 }
1120
1121 return $this->getUrl( $query );
1122 }
1123
1133 public function docLink( $linkText, $attribs, $parser ) {
1134 $url = $this->getDocUrl( $attribs['href'] );
1135
1136 return Html::element( 'a', [ 'href' => $url ], $linkText );
1137 }
1138
1148 public function downloadLinkHook( $text, $attribs, $parser ) {
1149 $anchor = Html::rawElement( 'a',
1150 [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1151 wfMessage( 'config-download-localsettings' )->parse()
1152 );
1153
1154 return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1155 }
1156
1167 public function getLocalSettingsLocation() {
1168 return false;
1169 }
1170
1174 public function envCheckPath() {
1175 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1176 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1177 // to get the path to the current script... hopefully it's reliable. SIGH
1178 $path = false;
1179 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1180 $path = $_SERVER['PHP_SELF'];
1181 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1182 $path = $_SERVER['SCRIPT_NAME'];
1183 }
1184 if ( $path === false ) {
1185 $this->showError( 'config-no-uri' );
1186 return false;
1187 }
1188
1189 return parent::envCheckPath();
1190 }
1191
1192 public function envPrepPath() {
1193 parent::envPrepPath();
1194 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1195 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1196 // to get the path to the current script... hopefully it's reliable. SIGH
1197 $path = false;
1198 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1199 $path = $_SERVER['PHP_SELF'];
1200 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1201 $path = $_SERVER['SCRIPT_NAME'];
1202 }
1203 if ( $path !== false ) {
1204 $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1205
1206 $this->setVar( 'wgScriptPath', "$scriptPath" );
1207 // Update variables set from Setup.php that are derived from wgScriptPath
1208 $this->setVar( 'wgScript', "$scriptPath/index.php" );
1209 $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1210 $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1211 $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1212 $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1213 $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1214 $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1215 }
1216 }
1217
1221 protected function envGetDefaultServer() {
1222 return WebRequest::detectServer();
1223 }
1224
1230 private function outputLS() {
1231 $this->request->response()->header( 'Content-type: application/x-httpd-php' );
1232 $this->request->response()->header(
1233 'Content-Disposition: attachment; filename="LocalSettings.php"'
1234 );
1235
1237 $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
1238 foreach ( $rightsProfile as $group => $rightsArr ) {
1239 $ls->setGroupRights( $group, $rightsArr );
1240 }
1241 echo $ls->getText();
1242 }
1243
1247 public function outputCss() {
1248 $this->request->response()->header( 'Content-type: text/css' );
1249 echo $this->output->getCSS();
1250 }
1251
1255 public function getPhpErrors() {
1256 return $this->phpErrors;
1257 }
1258
1259}
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
serialize()
$GLOBALS['IP']
$wgLanguageCode
Site language code.
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....
$wgContLang
Definition Setup.php:809
$wgParser
Definition Setup.php:921
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:747
$wgLang
Definition Setup.php:910
if( $line===false) $args
Definition cdb.php:64
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
Base installer class.
Definition Installer.php:46
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
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.
array $settings
Definition Installer.php:59
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
MediaWikiServices is the service locator for the application scope of MediaWiki.
The Message class provides methods which fulfil two basic services:
Definition Message.php:160
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
Output class modelled on OutputPage.
Class for the core installer web interface.
setupLanguage()
Initializes language-related variables.
getHelpBox( $msg)
Get small text indented help for a preceding form field.
WebInstallerOutput $output
finish()
Clean up from execute()
getTextBox( $params)
Get a labelled text box to configure a variable.
getAcceptLanguage()
Retrieves MediaWiki language from Accept-Language HTTP header.
nextTabIndex()
Get the next tabindex attribute value.
startPageWrapper( $currentPageName)
Called by execute() before page output starts, to show a page list.
showStatusBox( $status)
Output an error or warning box using a Status object.
setVarsFromRequest( $varNames, $prefix='config_')
Convenience function to set variables based on form data.
getPageByName( $pageName)
Get a WebInstallerPage by name.
errorHandler( $errno, $errstr)
Temporary error handler for session start debugging.
bool[] $happyPages
Array of pages which have declared that they have been submitted, have validated their input,...
getSession( $name, $default=null)
Get a session variable.
outputCss()
Output stylesheet for web installer pages.
getLowestUnhappy()
Find the next page in sequence that hasn't been completed.
label( $msg, $forId, $contents, $helpData="")
Label a control by wrapping a config-input div around it and putting a label before it.
execute(array $session)
Main entry point.
getLocalSettingsLocation()
If the software package wants the LocalSettings.php file to be placed in a specific location,...
getDocUrl( $page)
Helper for Installer::docLink()
bool[] $skippedPages
List of "skipped" pages.
showHelpBox( $msg)
Output a help box.
endPageWrapper()
Output some stuff after a page is finished.
outputLS()
Actually output LocalSettings.php for download.
downloadLinkHook( $text, $attribs, $parser)
Helper for "Download LocalSettings" link on WebInstall_Complete.
getRadioElements( $params)
Get a set of labelled radio buttons.
setSession( $name, $value)
Set a session variable.
reset()
We're restarting the installation, reset the session, happyPages, etc.
string $currentPageName
Name of the page we're on.
getRadioSet( $params)
Get a set of labelled radio buttons.
getWarningBox( $text)
Get HTML for a warning box with an icon.
getPasswordBox( $params)
Get a labelled password box to configure a variable.
WebRequest $request
WebRequest object.
__construct(WebRequest $request)
getTextArea( $params)
Get a labelled textarea to configure a variable.
getFingerprint()
Get a hash of data identifying this MW installation.
string[] $otherPages
Out of sequence pages, selectable by the user at any time.
string[] $pageSequence
The main sequence of page names.
string[] $phpErrors
Captured PHP error text.
showError( $msg)
Show an error message in a box.
bool $showSessionWarning
Flag indicating that session data may have been lost.
getErrorBox( $text)
Get HTML for an error box with an icon.
getPageListItem( $pageName, $enabled, $currentPageName)
Get a list item for the page list.
showStatusMessage(Status $status)
getCheckBox( $params)
Get a labelled checkbox to configure a boolean variable.
getInfoBox( $text, $icon=false, $class=false)
Get HTML for an info box with an icon.
docLink( $linkText, $attribs, $parser)
Extension tag hook for a documentation link.
startSession()
Start the PHP session.
int $tabIndex
Numeric index of the page we're on.
array[] $session
Cached session array.
getUrl( $query=[])
Get a URL for submission back to the same script.
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
showMessage( $msg)
Show a short informational message.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition hooks.txt:1873
either a plain
Definition hooks.txt:2105
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition hooks.txt:2062
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:3106
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition hooks.txt:2063
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1071
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1656
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
returning false will NOT prevent logging $e
Definition hooks.txt:2226
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration settings
Definition globals.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$params
if(!isset( $args[0])) $lang