MediaWiki REL1_31
WebInstaller.php
Go to the documentation of this file.
1<?php
30class WebInstaller extends Installer {
31
35 public $output;
36
42 public $request;
43
49 protected $session;
50
56 protected $phpErrors;
57
68 public $pageSequence = [
69 'Language',
70 'ExistingWiki',
71 'Welcome',
72 'DBConnect',
73 'Upgrade',
74 'DBSettings',
75 'Name',
76 'Options',
77 'Install',
78 'Complete',
79 ];
80
86 protected $otherPages = [
87 'Restart',
88 'Readme',
89 'ReleaseNotes',
90 'Copying',
91 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
92 ];
93
100 protected $happyPages;
101
109 protected $skippedPages;
110
116 public $showSessionWarning = false;
117
123 protected $tabIndex = 1;
124
131
135 public function __construct( WebRequest $request ) {
136 parent::__construct();
137 $this->output = new WebInstallerOutput( $this );
138 $this->request = $request;
139
140 // Add parser hooks
141 global $wgParser;
142 $wgParser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
143 $wgParser->setHook( 'doclink', [ $this, 'docLink' ] );
144 }
145
153 public function execute( array $session ) {
154 $this->session = $session;
155
156 if ( isset( $session['settings'] ) ) {
157 $this->settings = $session['settings'] + $this->settings;
158 // T187586 MediaWikiServices works with globals
159 foreach ( $this->settings as $key => $val ) {
160 $GLOBALS[$key] = $val;
161 }
162 }
163
164 $this->setupLanguage();
165
166 if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
167 && $this->request->getVal( 'localsettings' )
168 ) {
169 $this->request->response()->header( 'Content-type: application/x-httpd-php' );
170 $this->request->response()->header(
171 'Content-Disposition: attachment; filename="LocalSettings.php"'
172 );
173
175 $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
176 foreach ( $rightsProfile as $group => $rightsArr ) {
177 $ls->setGroupRights( $group, $rightsArr );
178 }
179 echo $ls->getText();
180
181 return $this->session;
182 }
183
184 $isCSS = $this->request->getVal( 'css' );
185 if ( $isCSS ) {
186 $this->outputCss();
187 return $this->session;
188 }
189
190 if ( isset( $session['happyPages'] ) ) {
191 $this->happyPages = $session['happyPages'];
192 } else {
193 $this->happyPages = [];
194 }
195
196 if ( isset( $session['skippedPages'] ) ) {
197 $this->skippedPages = $session['skippedPages'];
198 } else {
199 $this->skippedPages = [];
200 }
201
202 $lowestUnhappy = $this->getLowestUnhappy();
203
204 # Special case for Creative Commons partner chooser box.
205 if ( $this->request->getVal( 'SubmitCC' ) ) {
206 $page = $this->getPageByName( 'Options' );
207 $this->output->useShortHeader();
208 $this->output->allowFrames();
209 $page->submitCC();
210
211 return $this->finish();
212 }
213
214 if ( $this->request->getVal( 'ShowCC' ) ) {
215 $page = $this->getPageByName( 'Options' );
216 $this->output->useShortHeader();
217 $this->output->allowFrames();
218 $this->output->addHTML( $page->getCCDoneBox() );
219
220 return $this->finish();
221 }
222
223 # Get the page name.
224 $pageName = $this->request->getVal( 'page' );
225
226 if ( in_array( $pageName, $this->otherPages ) ) {
227 # Out of sequence
228 $pageId = false;
229 $page = $this->getPageByName( $pageName );
230 } else {
231 # Main sequence
232 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
233 $pageId = $lowestUnhappy;
234 } else {
235 $pageId = array_search( $pageName, $this->pageSequence );
236 }
237
238 # If necessary, move back to the lowest-numbered unhappy page
239 if ( $pageId > $lowestUnhappy ) {
240 $pageId = $lowestUnhappy;
241 if ( $lowestUnhappy == 0 ) {
242 # Knocked back to start, possible loss of session data.
243 $this->showSessionWarning = true;
244 }
245 }
246
247 $pageName = $this->pageSequence[$pageId];
248 $page = $this->getPageByName( $pageName );
249 }
250
251 # If a back button was submitted, go back without submitting the form data.
252 if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
253 if ( $this->request->getVal( 'lastPage' ) ) {
254 $nextPage = $this->request->getVal( 'lastPage' );
255 } elseif ( $pageId !== false ) {
256 # Main sequence page
257 # Skip the skipped pages
258 $nextPageId = $pageId;
259
260 do {
261 $nextPageId--;
262 $nextPage = $this->pageSequence[$nextPageId];
263 } while ( isset( $this->skippedPages[$nextPage] ) );
264 } else {
265 $nextPage = $this->pageSequence[$lowestUnhappy];
266 }
267
268 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
269
270 return $this->finish();
271 }
272
273 # Execute the page.
274 $this->currentPageName = $page->getName();
275 $this->startPageWrapper( $pageName );
276
277 if ( $page->isSlow() ) {
278 $this->disableTimeLimit();
279 }
280
281 $result = $page->execute();
282
283 $this->endPageWrapper();
284
285 if ( $result == 'skip' ) {
286 # Page skipped without explicit submission.
287 # Skip it when we click "back" so that we don't just go forward again.
288 $this->skippedPages[$pageName] = true;
289 $result = 'continue';
290 } else {
291 unset( $this->skippedPages[$pageName] );
292 }
293
294 # If it was posted, the page can request a continue to the next page.
295 if ( $result === 'continue' && !$this->output->headerDone() ) {
296 if ( $pageId !== false ) {
297 $this->happyPages[$pageId] = true;
298 }
299
300 $lowestUnhappy = $this->getLowestUnhappy();
301
302 if ( $this->request->getVal( 'lastPage' ) ) {
303 $nextPage = $this->request->getVal( 'lastPage' );
304 } elseif ( $pageId !== false ) {
305 $nextPage = $this->pageSequence[$pageId + 1];
306 } else {
307 $nextPage = $this->pageSequence[$lowestUnhappy];
308 }
309
310 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
311 $nextPage = $this->pageSequence[$lowestUnhappy];
312 }
313
314 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
315 }
316
317 return $this->finish();
318 }
319
324 public function getLowestUnhappy() {
325 if ( count( $this->happyPages ) == 0 ) {
326 return 0;
327 } else {
328 return max( array_keys( $this->happyPages ) ) + 1;
329 }
330 }
331
338 public function startSession() {
339 if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
340 // Done already
341 return true;
342 }
343
344 // Use secure cookies if we are on HTTPS
345 $options = [];
346 if ( $this->request->getProtocol() === 'https' ) {
347 $options['cookie_secure'] = '1';
348 }
349
350 $this->phpErrors = [];
351 set_error_handler( [ $this, 'errorHandler' ] );
352 try {
353 session_name( 'mw_installer_session' );
354 session_start( $options );
355 } catch ( Exception $e ) {
356 restore_error_handler();
357 throw $e;
358 }
359 restore_error_handler();
360
361 if ( $this->phpErrors ) {
362 return false;
363 }
364
365 return true;
366 }
367
376 public function getFingerprint() {
377 // Get the base URL of the installation
378 $url = $this->request->getFullRequestURL();
379 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
380 // Trim query string
381 $url = $m[1];
382 }
383 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
384 // This... seems to try to get the base path from
385 // the /mw-config/index.php. Kinda scary though?
386 $url = $m[1];
387 }
388
389 return md5( serialize( [
390 'local path' => dirname( __DIR__ ),
391 'url' => $url,
392 'version' => $GLOBALS['wgVersion']
393 ] ) );
394 }
395
401 public function showError( $msg /*...*/ ) {
402 if ( !( $msg instanceof Message ) ) {
403 $args = func_get_args();
404 array_shift( $args );
405 $args = array_map( 'htmlspecialchars', $args );
406 $msg = wfMessage( $msg, $args );
407 }
408 $text = $msg->useDatabase( false )->plain();
409 $this->output->addHTML( $this->getErrorBox( $text ) );
410 }
411
418 public function errorHandler( $errno, $errstr ) {
419 $this->phpErrors[] = $errstr;
420 }
421
427 public function finish() {
428 $this->output->output();
429
430 $this->session['happyPages'] = $this->happyPages;
431 $this->session['skippedPages'] = $this->skippedPages;
432 $this->session['settings'] = $this->settings;
433
434 return $this->session;
435 }
436
440 public function reset() {
441 $this->session = [];
442 $this->happyPages = [];
443 $this->settings = [];
444 }
445
453 public function getUrl( $query = [] ) {
454 $url = $this->request->getRequestURL();
455 # Remove existing query
456 $url = preg_replace( '/\?.*$/', '', $url );
457
458 if ( $query ) {
459 $url .= '?' . wfArrayToCgi( $query );
460 }
461
462 return $url;
463 }
464
471 public function getPageByName( $pageName ) {
472 $pageClass = 'WebInstaller' . $pageName;
473
474 return new $pageClass( $this );
475 }
476
485 public function getSession( $name, $default = null ) {
486 if ( !isset( $this->session[$name] ) ) {
487 return $default;
488 } else {
489 return $this->session[$name];
490 }
491 }
492
499 public function setSession( $name, $value ) {
500 $this->session[$name] = $value;
501 }
502
508 public function nextTabIndex() {
509 return $this->tabIndex++;
510 }
511
515 public function setupLanguage() {
517
518 if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
520 $wgLang = $wgContLang = Language::factory( $wgLanguageCode );
521 RequestContext::getMain()->setLanguage( $wgLang );
522 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
523 $this->setVar( '_UserLang', $wgLanguageCode );
524 } else {
525 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
526 $wgContLang = Language::factory( $wgLanguageCode );
527 }
528 }
529
535 public function getAcceptLanguage() {
537
538 $mwLanguages = Language::fetchLanguageNames();
539 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
540
541 foreach ( $headerLanguages as $lang ) {
542 if ( isset( $mwLanguages[$lang] ) ) {
543 return $lang;
544 }
545 }
546
547 return $wgLanguageCode;
548 }
549
555 private function startPageWrapper( $currentPageName ) {
556 $s = "<div class=\"config-page-wrapper\">\n";
557 $s .= "<div class=\"config-page\">\n";
558 $s .= "<div class=\"config-page-list\"><ul>\n";
559 $lastHappy = -1;
560
561 foreach ( $this->pageSequence as $id => $pageName ) {
562 $happy = !empty( $this->happyPages[$id] );
563 $s .= $this->getPageListItem(
564 $pageName,
565 $happy || $lastHappy == $id - 1,
567 );
568
569 if ( $happy ) {
570 $lastHappy = $id;
571 }
572 }
573
574 $s .= "</ul><br/><ul>\n";
575 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
576 // End list pane
577 $s .= "</ul></div>\n";
578
579 // Messages:
580 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
581 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
582 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
583 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
584 $s .= Html::element( 'h2', [],
585 wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
586
587 $this->output->addHTMLNoFlush( $s );
588 }
589
599 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
600 $s = "<li class=\"config-page-list-item\">";
601
602 // Messages:
603 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
604 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
605 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
606 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
607 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
608
609 if ( $enabled ) {
610 $query = [ 'page' => $pageName ];
611
612 if ( !in_array( $pageName, $this->pageSequence ) ) {
613 if ( in_array( $currentPageName, $this->pageSequence ) ) {
614 $query['lastPage'] = $currentPageName;
615 }
616
617 $link = Html::element( 'a',
618 [
619 'href' => $this->getUrl( $query )
620 ],
621 $name
622 );
623 } else {
624 $link = htmlspecialchars( $name );
625 }
626
627 if ( $pageName == $currentPageName ) {
628 $s .= "<span class=\"config-page-current\">$link</span>";
629 } else {
630 $s .= $link;
631 }
632 } else {
633 $s .= Html::element( 'span',
634 [
635 'class' => 'config-page-disabled'
636 ],
637 $name
638 );
639 }
640
641 $s .= "</li>\n";
642
643 return $s;
644 }
645
649 private function endPageWrapper() {
650 $this->output->addHTMLNoFlush(
651 "<div class=\"visualClear\"></div>\n" .
652 "</div>\n" .
653 "<div class=\"visualClear\"></div>\n" .
654 "</div>" );
655 }
656
664 public function getErrorBox( $text ) {
665 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
666 }
667
675 public function getWarningBox( $text ) {
676 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
677 }
678
688 public function getInfoBox( $text, $icon = false, $class = false ) {
689 $text = $this->parse( $text, true );
690 $icon = ( $icon == false ) ?
691 'images/info-32.png' :
692 'images/' . $icon;
693 $alt = wfMessage( 'config-information' )->text();
694
695 return Html::infoBox( $text, $icon, $alt, $class );
696 }
697
705 public function getHelpBox( $msg /*, ... */ ) {
706 $args = func_get_args();
707 array_shift( $args );
708 $args = array_map( 'htmlspecialchars', $args );
709 $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
710 $html = $this->parse( $text, true );
711
712 return "<div class=\"config-help-field-container\">\n" .
713 "<span class=\"config-help-field-hint\" title=\"" .
714 wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
715 wfMessage( 'config-help' )->escaped() . "</span>\n" .
716 "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
717 "</div>\n";
718 }
719
724 public function showHelpBox( $msg /*, ... */ ) {
725 $args = func_get_args();
726 $html = call_user_func_array( [ $this, 'getHelpBox' ], $args );
727 $this->output->addHTML( $html );
728 }
729
736 public function showMessage( $msg /*, ... */ ) {
737 $args = func_get_args();
738 array_shift( $args );
739 $html = '<div class="config-message">' .
740 $this->parse( wfMessage( $msg, $args )->useDatabase( false )->plain() ) .
741 "</div>\n";
742 $this->output->addHTML( $html );
743 }
744
748 public function showStatusMessage( Status $status ) {
749 $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
750 foreach ( $errors as $error ) {
751 call_user_func_array( [ $this, 'showMessage' ], $error );
752 }
753 }
754
765 public function label( $msg, $forId, $contents, $helpData = "" ) {
766 if ( strval( $msg ) == '' ) {
767 $labelText = '&#160;';
768 } else {
769 $labelText = wfMessage( $msg )->escaped();
770 }
771
772 $attributes = [ 'class' => 'config-label' ];
773
774 if ( $forId ) {
775 $attributes['for'] = $forId;
776 }
777
778 return "<div class=\"config-block\">\n" .
779 " <div class=\"config-block-label\">\n" .
780 Xml::tags( 'label',
781 $attributes,
782 $labelText
783 ) . "\n" .
784 $helpData .
785 " </div>\n" .
786 " <div class=\"config-block-elements\">\n" .
787 $contents .
788 " </div>\n" .
789 "</div>\n";
790 }
791
806 public function getTextBox( $params ) {
807 if ( !isset( $params['controlName'] ) ) {
808 $params['controlName'] = 'config_' . $params['var'];
809 }
810
811 if ( !isset( $params['value'] ) ) {
812 $params['value'] = $this->getVar( $params['var'] );
813 }
814
815 if ( !isset( $params['attribs'] ) ) {
816 $params['attribs'] = [];
817 }
818 if ( !isset( $params['help'] ) ) {
819 $params['help'] = "";
820 }
821
822 return $this->label(
823 $params['label'],
824 $params['controlName'],
825 Xml::input(
826 $params['controlName'],
827 30, // intended to be overridden by CSS
828 $params['value'],
829 $params['attribs'] + [
830 'id' => $params['controlName'],
831 'class' => 'config-input-text',
832 'tabindex' => $this->nextTabIndex()
833 ]
834 ),
835 $params['help']
836 );
837 }
838
853 public function getTextArea( $params ) {
854 if ( !isset( $params['controlName'] ) ) {
855 $params['controlName'] = 'config_' . $params['var'];
856 }
857
858 if ( !isset( $params['value'] ) ) {
859 $params['value'] = $this->getVar( $params['var'] );
860 }
861
862 if ( !isset( $params['attribs'] ) ) {
863 $params['attribs'] = [];
864 }
865 if ( !isset( $params['help'] ) ) {
866 $params['help'] = "";
867 }
868
869 return $this->label(
870 $params['label'],
871 $params['controlName'],
872 Xml::textarea(
873 $params['controlName'],
874 $params['value'],
875 30,
876 5,
877 $params['attribs'] + [
878 'id' => $params['controlName'],
879 'class' => 'config-input-text',
880 'tabindex' => $this->nextTabIndex()
881 ]
882 ),
883 $params['help']
884 );
885 }
886
902 public function getPasswordBox( $params ) {
903 if ( !isset( $params['value'] ) ) {
904 $params['value'] = $this->getVar( $params['var'] );
905 }
906
907 if ( !isset( $params['attribs'] ) ) {
908 $params['attribs'] = [];
909 }
910
911 $params['value'] = $this->getFakePassword( $params['value'] );
912 $params['attribs']['type'] = 'password';
913
914 return $this->getTextBox( $params );
915 }
916
932 public function getCheckBox( $params ) {
933 if ( !isset( $params['controlName'] ) ) {
934 $params['controlName'] = 'config_' . $params['var'];
935 }
936
937 if ( !isset( $params['value'] ) ) {
938 $params['value'] = $this->getVar( $params['var'] );
939 }
940
941 if ( !isset( $params['attribs'] ) ) {
942 $params['attribs'] = [];
943 }
944 if ( !isset( $params['help'] ) ) {
945 $params['help'] = "";
946 }
947 if ( !isset( $params['labelAttribs'] ) ) {
948 $params['labelAttribs'] = [];
949 }
950 if ( isset( $params['rawtext'] ) ) {
951 $labelText = $params['rawtext'];
952 } else {
953 $labelText = $this->parse( wfMessage( $params['label'] )->text() );
954 }
955
956 return "<div class=\"config-input-check\">\n" .
957 $params['help'] .
958 Html::rawElement(
959 'label',
960 $params['labelAttribs'],
961 Xml::check(
962 $params['controlName'],
963 $params['value'],
964 $params['attribs'] + [
965 'id' => $params['controlName'],
966 'tabindex' => $this->nextTabIndex(),
967 ]
968 ) .
969 $labelText . "\n"
970 ) .
971 "</div>\n";
972 }
973
993 public function getRadioSet( $params ) {
994 $items = $this->getRadioElements( $params );
995
996 if ( !isset( $params['label'] ) ) {
997 $label = '';
998 } else {
999 $label = $params['label'];
1000 }
1001
1002 if ( !isset( $params['controlName'] ) ) {
1003 $params['controlName'] = 'config_' . $params['var'];
1004 }
1005
1006 if ( !isset( $params['help'] ) ) {
1007 $params['help'] = "";
1008 }
1009
1010 $s = "<ul>\n";
1011 foreach ( $items as $value => $item ) {
1012 $s .= "<li>$item</li>\n";
1013 }
1014 $s .= "</ul>\n";
1015
1016 return $this->label( $label, $params['controlName'], $s, $params['help'] );
1017 }
1018
1027 public function getRadioElements( $params ) {
1028 if ( !isset( $params['controlName'] ) ) {
1029 $params['controlName'] = 'config_' . $params['var'];
1030 }
1031
1032 if ( !isset( $params['value'] ) ) {
1033 $params['value'] = $this->getVar( $params['var'] );
1034 }
1035
1036 $items = [];
1037
1038 foreach ( $params['values'] as $value ) {
1039 $itemAttribs = [];
1040
1041 if ( isset( $params['commonAttribs'] ) ) {
1042 $itemAttribs = $params['commonAttribs'];
1043 }
1044
1045 if ( isset( $params['itemAttribs'][$value] ) ) {
1046 $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1047 }
1048
1049 $checked = $value == $params['value'];
1050 $id = $params['controlName'] . '_' . $value;
1051 $itemAttribs['id'] = $id;
1052 $itemAttribs['tabindex'] = $this->nextTabIndex();
1053
1054 $items[$value] =
1055 Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1056 '&#160;' .
1057 Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1058 isset( $params['itemLabels'] ) ?
1059 wfMessage( $params['itemLabels'][$value] )->plain() :
1060 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1061 ) );
1062 }
1063
1064 return $items;
1065 }
1066
1072 public function showStatusBox( $status ) {
1073 if ( !$status->isGood() ) {
1074 $text = $status->getWikiText();
1075
1076 if ( $status->isOK() ) {
1077 $box = $this->getWarningBox( $text );
1078 } else {
1079 $box = $this->getErrorBox( $text );
1080 }
1081
1082 $this->output->addHTML( $box );
1083 }
1084 }
1085
1096 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1097 $newValues = [];
1098
1099 foreach ( $varNames as $name ) {
1100 $value = $this->request->getVal( $prefix . $name );
1101 // T32524, do not trim passwords
1102 if ( stripos( $name, 'password' ) === false ) {
1103 $value = trim( $value );
1104 }
1105 $newValues[$name] = $value;
1106
1107 if ( $value === null ) {
1108 // Checkbox?
1109 $this->setVar( $name, false );
1110 } else {
1111 if ( stripos( $name, 'password' ) !== false ) {
1112 $this->setPassword( $name, $value );
1113 } else {
1114 $this->setVar( $name, $value );
1115 }
1116 }
1117 }
1118
1119 return $newValues;
1120 }
1121
1129 protected function getDocUrl( $page ) {
1130 $url = "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1131
1132 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1133 $url .= '&lastPage=' . urlencode( $this->currentPageName );
1134 }
1135
1136 return $url;
1137 }
1138
1148 public function docLink( $linkText, $attribs, $parser ) {
1149 $url = $this->getDocUrl( $attribs['href'] );
1150
1151 return '<a href="' . htmlspecialchars( $url ) . '">' .
1152 htmlspecialchars( $linkText ) .
1153 '</a>';
1154 }
1155
1165 public function downloadLinkHook( $text, $attribs, $parser ) {
1166 $anchor = Html::rawElement( 'a',
1167 [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1168 wfMessage( 'config-download-localsettings' )->parse()
1169 );
1170
1171 return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1172 }
1173
1184 public function getLocalSettingsLocation() {
1185 return false;
1186 }
1187
1191 public function envCheckPath() {
1192 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1193 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1194 // to get the path to the current script... hopefully it's reliable. SIGH
1195 $path = false;
1196 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1197 $path = $_SERVER['PHP_SELF'];
1198 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1199 $path = $_SERVER['SCRIPT_NAME'];
1200 }
1201 if ( $path === false ) {
1202 $this->showError( 'config-no-uri' );
1203 return false;
1204 }
1205
1206 return parent::envCheckPath();
1207 }
1208
1209 public function envPrepPath() {
1210 parent::envPrepPath();
1211 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1212 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1213 // to get the path to the current script... hopefully it's reliable. SIGH
1214 $path = false;
1215 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1216 $path = $_SERVER['PHP_SELF'];
1217 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1218 $path = $_SERVER['SCRIPT_NAME'];
1219 }
1220 if ( $path !== false ) {
1221 $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1222
1223 $this->setVar( 'wgScriptPath', "$scriptPath" );
1224 // Update variables set from Setup.php that are derived from wgScriptPath
1225 $this->setVar( 'wgScript', "$scriptPath/index.php" );
1226 $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1227 $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1228 $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1229 $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1230 $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1231 $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1232 }
1233 }
1234
1238 protected function envGetDefaultServer() {
1239 return WebRequest::detectServer();
1240 }
1241
1245 public function outputCss() {
1246 $this->request->response()->header( 'Content-type: text/css' );
1247 echo $this->output->getCSS();
1248 }
1249
1253 public function getPhpErrors() {
1254 return $this->phpErrors;
1255 }
1256
1257}
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....
$wgParser
Definition Setup.php:917
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:737
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.
The Message class provides methods which fulfil two basic services:
Definition Message.php:159
static getMain()
Get the RequestContext object associated with the main request.
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.
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...
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
do that in ParserLimitReportFormat instead $parser
Definition hooks.txt:2603
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. '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:1051
either a plain
Definition hooks.txt:2056
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 & $options
Definition hooks.txt:2001
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 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:2013
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:3021
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:2014
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:1620
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:2176
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
$params
if(!isset( $args[0])) $lang