MediaWiki REL1_30
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 }
159
160 $this->setupLanguage();
161
162 if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
163 && $this->request->getVal( 'localsettings' )
164 ) {
165 $this->request->response()->header( 'Content-type: application/x-httpd-php' );
166 $this->request->response()->header(
167 'Content-Disposition: attachment; filename="LocalSettings.php"'
168 );
169
171 $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
172 foreach ( $rightsProfile as $group => $rightsArr ) {
173 $ls->setGroupRights( $group, $rightsArr );
174 }
175 echo $ls->getText();
176
177 return $this->session;
178 }
179
180 $isCSS = $this->request->getVal( 'css' );
181 if ( $isCSS ) {
182 $this->outputCss();
183 return $this->session;
184 }
185
186 if ( isset( $session['happyPages'] ) ) {
187 $this->happyPages = $session['happyPages'];
188 } else {
189 $this->happyPages = [];
190 }
191
192 if ( isset( $session['skippedPages'] ) ) {
193 $this->skippedPages = $session['skippedPages'];
194 } else {
195 $this->skippedPages = [];
196 }
197
198 $lowestUnhappy = $this->getLowestUnhappy();
199
200 # Special case for Creative Commons partner chooser box.
201 if ( $this->request->getVal( 'SubmitCC' ) ) {
202 $page = $this->getPageByName( 'Options' );
203 $this->output->useShortHeader();
204 $this->output->allowFrames();
205 $page->submitCC();
206
207 return $this->finish();
208 }
209
210 if ( $this->request->getVal( 'ShowCC' ) ) {
211 $page = $this->getPageByName( 'Options' );
212 $this->output->useShortHeader();
213 $this->output->allowFrames();
214 $this->output->addHTML( $page->getCCDoneBox() );
215
216 return $this->finish();
217 }
218
219 # Get the page name.
220 $pageName = $this->request->getVal( 'page' );
221
222 if ( in_array( $pageName, $this->otherPages ) ) {
223 # Out of sequence
224 $pageId = false;
225 $page = $this->getPageByName( $pageName );
226 } else {
227 # Main sequence
228 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
229 $pageId = $lowestUnhappy;
230 } else {
231 $pageId = array_search( $pageName, $this->pageSequence );
232 }
233
234 # If necessary, move back to the lowest-numbered unhappy page
235 if ( $pageId > $lowestUnhappy ) {
236 $pageId = $lowestUnhappy;
237 if ( $lowestUnhappy == 0 ) {
238 # Knocked back to start, possible loss of session data.
239 $this->showSessionWarning = true;
240 }
241 }
242
243 $pageName = $this->pageSequence[$pageId];
244 $page = $this->getPageByName( $pageName );
245 }
246
247 # If a back button was submitted, go back without submitting the form data.
248 if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
249 if ( $this->request->getVal( 'lastPage' ) ) {
250 $nextPage = $this->request->getVal( 'lastPage' );
251 } elseif ( $pageId !== false ) {
252 # Main sequence page
253 # Skip the skipped pages
254 $nextPageId = $pageId;
255
256 do {
257 $nextPageId--;
258 $nextPage = $this->pageSequence[$nextPageId];
259 } while ( isset( $this->skippedPages[$nextPage] ) );
260 } else {
261 $nextPage = $this->pageSequence[$lowestUnhappy];
262 }
263
264 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
265
266 return $this->finish();
267 }
268
269 # Execute the page.
270 $this->currentPageName = $page->getName();
271 $this->startPageWrapper( $pageName );
272
273 if ( $page->isSlow() ) {
274 $this->disableTimeLimit();
275 }
276
277 $result = $page->execute();
278
279 $this->endPageWrapper();
280
281 if ( $result == 'skip' ) {
282 # Page skipped without explicit submission.
283 # Skip it when we click "back" so that we don't just go forward again.
284 $this->skippedPages[$pageName] = true;
285 $result = 'continue';
286 } else {
287 unset( $this->skippedPages[$pageName] );
288 }
289
290 # If it was posted, the page can request a continue to the next page.
291 if ( $result === 'continue' && !$this->output->headerDone() ) {
292 if ( $pageId !== false ) {
293 $this->happyPages[$pageId] = true;
294 }
295
296 $lowestUnhappy = $this->getLowestUnhappy();
297
298 if ( $this->request->getVal( 'lastPage' ) ) {
299 $nextPage = $this->request->getVal( 'lastPage' );
300 } elseif ( $pageId !== false ) {
301 $nextPage = $this->pageSequence[$pageId + 1];
302 } else {
303 $nextPage = $this->pageSequence[$lowestUnhappy];
304 }
305
306 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
307 $nextPage = $this->pageSequence[$lowestUnhappy];
308 }
309
310 $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
311 }
312
313 return $this->finish();
314 }
315
320 public function getLowestUnhappy() {
321 if ( count( $this->happyPages ) == 0 ) {
322 return 0;
323 } else {
324 return max( array_keys( $this->happyPages ) ) + 1;
325 }
326 }
327
334 public function startSession() {
335 if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
336 // Done already
337 return true;
338 }
339
340 $this->phpErrors = [];
341 set_error_handler( [ $this, 'errorHandler' ] );
342 try {
343 session_name( 'mw_installer_session' );
344 session_start();
345 } catch ( Exception $e ) {
346 restore_error_handler();
347 throw $e;
348 }
349 restore_error_handler();
350
351 if ( $this->phpErrors ) {
352 return false;
353 }
354
355 return true;
356 }
357
366 public function getFingerprint() {
367 // Get the base URL of the installation
368 $url = $this->request->getFullRequestURL();
369 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
370 // Trim query string
371 $url = $m[1];
372 }
373 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
374 // This... seems to try to get the base path from
375 // the /mw-config/index.php. Kinda scary though?
376 $url = $m[1];
377 }
378
379 return md5( serialize( [
380 'local path' => dirname( __DIR__ ),
381 'url' => $url,
382 'version' => $GLOBALS['wgVersion']
383 ] ) );
384 }
385
391 public function showError( $msg /*...*/ ) {
392 if ( !( $msg instanceof Message ) ) {
393 $args = func_get_args();
394 array_shift( $args );
395 $args = array_map( 'htmlspecialchars', $args );
396 $msg = wfMessage( $msg, $args );
397 }
398 $text = $msg->useDatabase( false )->plain();
399 $this->output->addHTML( $this->getErrorBox( $text ) );
400 }
401
408 public function errorHandler( $errno, $errstr ) {
409 $this->phpErrors[] = $errstr;
410 }
411
417 public function finish() {
418 $this->output->output();
419
420 $this->session['happyPages'] = $this->happyPages;
421 $this->session['skippedPages'] = $this->skippedPages;
422 $this->session['settings'] = $this->settings;
423
424 return $this->session;
425 }
426
430 public function reset() {
431 $this->session = [];
432 $this->happyPages = [];
433 $this->settings = [];
434 }
435
443 public function getUrl( $query = [] ) {
444 $url = $this->request->getRequestURL();
445 # Remove existing query
446 $url = preg_replace( '/\?.*$/', '', $url );
447
448 if ( $query ) {
449 $url .= '?' . wfArrayToCgi( $query );
450 }
451
452 return $url;
453 }
454
461 public function getPageByName( $pageName ) {
462 $pageClass = 'WebInstaller' . $pageName;
463
464 return new $pageClass( $this );
465 }
466
475 public function getSession( $name, $default = null ) {
476 if ( !isset( $this->session[$name] ) ) {
477 return $default;
478 } else {
479 return $this->session[$name];
480 }
481 }
482
489 public function setSession( $name, $value ) {
490 $this->session[$name] = $value;
491 }
492
498 public function nextTabIndex() {
499 return $this->tabIndex++;
500 }
501
505 public function setupLanguage() {
507
508 if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
510 $wgLang = $wgContLang = Language::factory( $wgLanguageCode );
511 RequestContext::getMain()->setLanguage( $wgLang );
512 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
513 $this->setVar( '_UserLang', $wgLanguageCode );
514 } else {
515 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
516 $wgContLang = Language::factory( $wgLanguageCode );
517 }
518 }
519
525 public function getAcceptLanguage() {
527
528 $mwLanguages = Language::fetchLanguageNames();
529 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
530
531 foreach ( $headerLanguages as $lang ) {
532 if ( isset( $mwLanguages[$lang] ) ) {
533 return $lang;
534 }
535 }
536
537 return $wgLanguageCode;
538 }
539
545 private function startPageWrapper( $currentPageName ) {
546 $s = "<div class=\"config-page-wrapper\">\n";
547 $s .= "<div class=\"config-page\">\n";
548 $s .= "<div class=\"config-page-list\"><ul>\n";
549 $lastHappy = -1;
550
551 foreach ( $this->pageSequence as $id => $pageName ) {
552 $happy = !empty( $this->happyPages[$id] );
553 $s .= $this->getPageListItem(
554 $pageName,
555 $happy || $lastHappy == $id - 1,
557 );
558
559 if ( $happy ) {
560 $lastHappy = $id;
561 }
562 }
563
564 $s .= "</ul><br/><ul>\n";
565 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
566 // End list pane
567 $s .= "</ul></div>\n";
568
569 // Messages:
570 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
571 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
572 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
573 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
574 $s .= Html::element( 'h2', [],
575 wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
576
577 $this->output->addHTMLNoFlush( $s );
578 }
579
589 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
590 $s = "<li class=\"config-page-list-item\">";
591
592 // Messages:
593 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
594 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
595 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
596 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
597 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
598
599 if ( $enabled ) {
600 $query = [ 'page' => $pageName ];
601
602 if ( !in_array( $pageName, $this->pageSequence ) ) {
603 if ( in_array( $currentPageName, $this->pageSequence ) ) {
604 $query['lastPage'] = $currentPageName;
605 }
606
607 $link = Html::element( 'a',
608 [
609 'href' => $this->getUrl( $query )
610 ],
611 $name
612 );
613 } else {
614 $link = htmlspecialchars( $name );
615 }
616
617 if ( $pageName == $currentPageName ) {
618 $s .= "<span class=\"config-page-current\">$link</span>";
619 } else {
620 $s .= $link;
621 }
622 } else {
623 $s .= Html::element( 'span',
624 [
625 'class' => 'config-page-disabled'
626 ],
627 $name
628 );
629 }
630
631 $s .= "</li>\n";
632
633 return $s;
634 }
635
639 private function endPageWrapper() {
640 $this->output->addHTMLNoFlush(
641 "<div class=\"visualClear\"></div>\n" .
642 "</div>\n" .
643 "<div class=\"visualClear\"></div>\n" .
644 "</div>" );
645 }
646
654 public function getErrorBox( $text ) {
655 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
656 }
657
665 public function getWarningBox( $text ) {
666 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
667 }
668
678 public function getInfoBox( $text, $icon = false, $class = false ) {
679 $text = $this->parse( $text, true );
680 $icon = ( $icon == false ) ?
681 'images/info-32.png' :
682 'images/' . $icon;
683 $alt = wfMessage( 'config-information' )->text();
684
685 return Html::infoBox( $text, $icon, $alt, $class );
686 }
687
695 public function getHelpBox( $msg /*, ... */ ) {
696 $args = func_get_args();
697 array_shift( $args );
698 $args = array_map( 'htmlspecialchars', $args );
699 $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
700 $html = $this->parse( $text, true );
701
702 return "<div class=\"config-help-field-container\">\n" .
703 "<span class=\"config-help-field-hint\" title=\"" .
704 wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
705 wfMessage( 'config-help' )->escaped() . "</span>\n" .
706 "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
707 "</div>\n";
708 }
709
714 public function showHelpBox( $msg /*, ... */ ) {
715 $args = func_get_args();
716 $html = call_user_func_array( [ $this, 'getHelpBox' ], $args );
717 $this->output->addHTML( $html );
718 }
719
726 public function showMessage( $msg /*, ... */ ) {
727 $args = func_get_args();
728 array_shift( $args );
729 $html = '<div class="config-message">' .
730 $this->parse( wfMessage( $msg, $args )->useDatabase( false )->plain() ) .
731 "</div>\n";
732 $this->output->addHTML( $html );
733 }
734
738 public function showStatusMessage( Status $status ) {
739 $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
740 foreach ( $errors as $error ) {
741 call_user_func_array( [ $this, 'showMessage' ], $error );
742 }
743 }
744
755 public function label( $msg, $forId, $contents, $helpData = "" ) {
756 if ( strval( $msg ) == '' ) {
757 $labelText = '&#160;';
758 } else {
759 $labelText = wfMessage( $msg )->escaped();
760 }
761
762 $attributes = [ 'class' => 'config-label' ];
763
764 if ( $forId ) {
765 $attributes['for'] = $forId;
766 }
767
768 return "<div class=\"config-block\">\n" .
769 " <div class=\"config-block-label\">\n" .
770 Xml::tags( 'label',
771 $attributes,
772 $labelText
773 ) . "\n" .
774 $helpData .
775 " </div>\n" .
776 " <div class=\"config-block-elements\">\n" .
777 $contents .
778 " </div>\n" .
779 "</div>\n";
780 }
781
796 public function getTextBox( $params ) {
797 if ( !isset( $params['controlName'] ) ) {
798 $params['controlName'] = 'config_' . $params['var'];
799 }
800
801 if ( !isset( $params['value'] ) ) {
802 $params['value'] = $this->getVar( $params['var'] );
803 }
804
805 if ( !isset( $params['attribs'] ) ) {
806 $params['attribs'] = [];
807 }
808 if ( !isset( $params['help'] ) ) {
809 $params['help'] = "";
810 }
811
812 return $this->label(
813 $params['label'],
814 $params['controlName'],
815 Xml::input(
816 $params['controlName'],
817 30, // intended to be overridden by CSS
818 $params['value'],
819 $params['attribs'] + [
820 'id' => $params['controlName'],
821 'class' => 'config-input-text',
822 'tabindex' => $this->nextTabIndex()
823 ]
824 ),
825 $params['help']
826 );
827 }
828
843 public function getTextArea( $params ) {
844 if ( !isset( $params['controlName'] ) ) {
845 $params['controlName'] = 'config_' . $params['var'];
846 }
847
848 if ( !isset( $params['value'] ) ) {
849 $params['value'] = $this->getVar( $params['var'] );
850 }
851
852 if ( !isset( $params['attribs'] ) ) {
853 $params['attribs'] = [];
854 }
855 if ( !isset( $params['help'] ) ) {
856 $params['help'] = "";
857 }
858
859 return $this->label(
860 $params['label'],
861 $params['controlName'],
862 Xml::textarea(
863 $params['controlName'],
864 $params['value'],
865 30,
866 5,
867 $params['attribs'] + [
868 'id' => $params['controlName'],
869 'class' => 'config-input-text',
870 'tabindex' => $this->nextTabIndex()
871 ]
872 ),
873 $params['help']
874 );
875 }
876
892 public function getPasswordBox( $params ) {
893 if ( !isset( $params['value'] ) ) {
894 $params['value'] = $this->getVar( $params['var'] );
895 }
896
897 if ( !isset( $params['attribs'] ) ) {
898 $params['attribs'] = [];
899 }
900
901 $params['value'] = $this->getFakePassword( $params['value'] );
902 $params['attribs']['type'] = 'password';
903
904 return $this->getTextBox( $params );
905 }
906
921 public function getCheckBox( $params ) {
922 if ( !isset( $params['controlName'] ) ) {
923 $params['controlName'] = 'config_' . $params['var'];
924 }
925
926 if ( !isset( $params['value'] ) ) {
927 $params['value'] = $this->getVar( $params['var'] );
928 }
929
930 if ( !isset( $params['attribs'] ) ) {
931 $params['attribs'] = [];
932 }
933 if ( !isset( $params['help'] ) ) {
934 $params['help'] = "";
935 }
936 if ( isset( $params['rawtext'] ) ) {
937 $labelText = $params['rawtext'];
938 } else {
939 $labelText = $this->parse( wfMessage( $params['label'] )->text() );
940 }
941
942 return "<div class=\"config-input-check\">\n" .
943 $params['help'] .
944 "<label>\n" .
945 Xml::check(
946 $params['controlName'],
947 $params['value'],
948 $params['attribs'] + [
949 'id' => $params['controlName'],
950 'tabindex' => $this->nextTabIndex(),
951 ]
952 ) .
953 $labelText . "\n" .
954 "</label>\n" .
955 "</div>\n";
956 }
957
977 public function getRadioSet( $params ) {
978 $items = $this->getRadioElements( $params );
979
980 if ( !isset( $params['label'] ) ) {
981 $label = '';
982 } else {
983 $label = $params['label'];
984 }
985
986 if ( !isset( $params['controlName'] ) ) {
987 $params['controlName'] = 'config_' . $params['var'];
988 }
989
990 if ( !isset( $params['help'] ) ) {
991 $params['help'] = "";
992 }
993
994 $s = "<ul>\n";
995 foreach ( $items as $value => $item ) {
996 $s .= "<li>$item</li>\n";
997 }
998 $s .= "</ul>\n";
999
1000 return $this->label( $label, $params['controlName'], $s, $params['help'] );
1001 }
1002
1011 public function getRadioElements( $params ) {
1012 if ( !isset( $params['controlName'] ) ) {
1013 $params['controlName'] = 'config_' . $params['var'];
1014 }
1015
1016 if ( !isset( $params['value'] ) ) {
1017 $params['value'] = $this->getVar( $params['var'] );
1018 }
1019
1020 $items = [];
1021
1022 foreach ( $params['values'] as $value ) {
1023 $itemAttribs = [];
1024
1025 if ( isset( $params['commonAttribs'] ) ) {
1026 $itemAttribs = $params['commonAttribs'];
1027 }
1028
1029 if ( isset( $params['itemAttribs'][$value] ) ) {
1030 $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1031 }
1032
1033 $checked = $value == $params['value'];
1034 $id = $params['controlName'] . '_' . $value;
1035 $itemAttribs['id'] = $id;
1036 $itemAttribs['tabindex'] = $this->nextTabIndex();
1037
1038 $items[$value] =
1039 Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1040 '&#160;' .
1041 Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1042 isset( $params['itemLabels'] ) ?
1043 wfMessage( $params['itemLabels'][$value] )->plain() :
1044 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1045 ) );
1046 }
1047
1048 return $items;
1049 }
1050
1056 public function showStatusBox( $status ) {
1057 if ( !$status->isGood() ) {
1058 $text = $status->getWikiText();
1059
1060 if ( $status->isOK() ) {
1061 $box = $this->getWarningBox( $text );
1062 } else {
1063 $box = $this->getErrorBox( $text );
1064 }
1065
1066 $this->output->addHTML( $box );
1067 }
1068 }
1069
1080 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1081 $newValues = [];
1082
1083 foreach ( $varNames as $name ) {
1084 $value = $this->request->getVal( $prefix . $name );
1085 // T32524, do not trim passwords
1086 if ( stripos( $name, 'password' ) === false ) {
1087 $value = trim( $value );
1088 }
1089 $newValues[$name] = $value;
1090
1091 if ( $value === null ) {
1092 // Checkbox?
1093 $this->setVar( $name, false );
1094 } else {
1095 if ( stripos( $name, 'password' ) !== false ) {
1096 $this->setPassword( $name, $value );
1097 } else {
1098 $this->setVar( $name, $value );
1099 }
1100 }
1101 }
1102
1103 return $newValues;
1104 }
1105
1113 protected function getDocUrl( $page ) {
1114 $url = "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1115
1116 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1117 $url .= '&lastPage=' . urlencode( $this->currentPageName );
1118 }
1119
1120 return $url;
1121 }
1122
1132 public function docLink( $linkText, $attribs, $parser ) {
1133 $url = $this->getDocUrl( $attribs['href'] );
1134
1135 return '<a href="' . htmlspecialchars( $url ) . '">' .
1136 htmlspecialchars( $linkText ) .
1137 '</a>';
1138 }
1139
1149 public function downloadLinkHook( $text, $attribs, $parser ) {
1150 $anchor = Html::rawElement( 'a',
1151 [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1152 wfMessage( 'config-download-localsettings' )->parse()
1153 );
1154
1155 return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1156 }
1157
1168 public function getLocalSettingsLocation() {
1169 return false;
1170 }
1171
1175 public function envCheckPath() {
1176 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1177 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1178 // to get the path to the current script... hopefully it's reliable. SIGH
1179 $path = false;
1180 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1181 $path = $_SERVER['PHP_SELF'];
1182 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1183 $path = $_SERVER['SCRIPT_NAME'];
1184 }
1185 if ( $path === false ) {
1186 $this->showError( 'config-no-uri' );
1187 return false;
1188 }
1189
1190 return parent::envCheckPath();
1191 }
1192
1193 public function envPrepPath() {
1194 parent::envPrepPath();
1195 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1196 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1197 // to get the path to the current script... hopefully it's reliable. SIGH
1198 $path = false;
1199 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1200 $path = $_SERVER['PHP_SELF'];
1201 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1202 $path = $_SERVER['SCRIPT_NAME'];
1203 }
1204 if ( $path !== false ) {
1205 $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1206
1207 $this->setVar( 'wgScriptPath', "$scriptPath" );
1208 // Update variables set from Setup.php that are derived from wgScriptPath
1209 $this->setVar( 'wgScript', "$scriptPath/index.php" );
1210 $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1211 $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1212 $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1213 $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1214 $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1215 $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1216 }
1217 }
1218
1222 protected function envGetDefaultServer() {
1223 return WebRequest::detectServer();
1224 }
1225
1229 public function outputCss() {
1230 $this->request->response()->header( 'Content-type: text/css' );
1231 echo $this->output->getCSS();
1232 }
1233
1237 public function getPhpErrors() {
1238 return $this->phpErrors;
1239 }
1240
1241}
serialize()
$GLOBALS['wgAutoloadClasses']['LocalisationUpdate']
Definition Autoload.php:10
$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:832
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:662
if( $line===false) $args
Definition cdb.php:63
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
Base installer class.
Definition Installer.php:43
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:56
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()
Static methods.
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:2572
either a plain
Definition hooks.txt:2026
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:1983
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2989
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:1984
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). '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:1049
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:1610
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:2146
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