MediaWiki  master
WebInstaller.php
Go to the documentation of this file.
1 <?php
25 
32 class 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 
132  protected $helpBoxId = 1;
133 
139  protected $currentPageName;
140 
144  public function __construct( WebRequest $request ) {
145  parent::__construct();
146  $this->output = new WebInstallerOutput( $this );
147  $this->request = $request;
148 
149  // Add parser hooks
150  $parser = MediaWikiServices::getInstance()->getParser();
151  $parser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
152  $parser->setHook( 'doclink', [ $this, 'docLink' ] );
153  }
154 
162  public function execute( array $session ) {
163  $this->session = $session;
164 
165  if ( isset( $session['settings'] ) ) {
166  $this->settings = $session['settings'] + $this->settings;
167  // T187586 MediaWikiServices works with globals
168  foreach ( $this->settings as $key => $val ) {
169  $GLOBALS[$key] = $val;
170  }
171  }
172 
173  $this->setupLanguage();
174 
175  if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
176  && $this->request->getVal( 'localsettings' )
177  ) {
178  $this->outputLS();
179  return $this->session;
180  }
181 
182  $isCSS = $this->request->getVal( 'css' );
183  if ( $isCSS ) {
184  $this->outputCss();
185  return $this->session;
186  }
187 
188  $this->happyPages = $session['happyPages'] ?? [];
189 
190  $this->skippedPages = $session['skippedPages'] ?? [];
191 
192  $lowestUnhappy = $this->getLowestUnhappy();
193 
194  # Special case for Creative Commons partner chooser box.
195  if ( $this->request->getVal( 'SubmitCC' ) ) {
196  $page = $this->getPageByName( 'Options' );
197  $this->output->useShortHeader();
198  $this->output->allowFrames();
199  $page->submitCC();
200 
201  return $this->finish();
202  }
203 
204  if ( $this->request->getVal( 'ShowCC' ) ) {
205  $page = $this->getPageByName( 'Options' );
206  $this->output->useShortHeader();
207  $this->output->allowFrames();
208  $this->output->addHTML( $page->getCCDoneBox() );
209 
210  return $this->finish();
211  }
212 
213  # Get the page name.
214  $pageName = $this->request->getVal( 'page' );
215 
216  if ( in_array( $pageName, $this->otherPages ) ) {
217  # Out of sequence
218  $pageId = false;
219  $page = $this->getPageByName( $pageName );
220  } else {
221  # Main sequence
222  if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
223  $pageId = $lowestUnhappy;
224  } else {
225  $pageId = array_search( $pageName, $this->pageSequence );
226  }
227 
228  # If necessary, move back to the lowest-numbered unhappy page
229  if ( $pageId > $lowestUnhappy ) {
230  $pageId = $lowestUnhappy;
231  if ( $lowestUnhappy == 0 ) {
232  # Knocked back to start, possible loss of session data.
233  $this->showSessionWarning = true;
234  }
235  }
236 
237  $pageName = $this->pageSequence[$pageId];
238  $page = $this->getPageByName( $pageName );
239  }
240 
241  # If a back button was submitted, go back without submitting the form data.
242  if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
243  if ( $this->request->getVal( 'lastPage' ) ) {
244  $nextPage = $this->request->getVal( 'lastPage' );
245  } elseif ( $pageId !== false ) {
246  # Main sequence page
247  # Skip the skipped pages
248  $nextPageId = $pageId;
249 
250  do {
251  $nextPageId--;
252  $nextPage = $this->pageSequence[$nextPageId];
253  } while ( isset( $this->skippedPages[$nextPage] ) );
254  } else {
255  $nextPage = $this->pageSequence[$lowestUnhappy];
256  }
257 
258  $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
259 
260  return $this->finish();
261  }
262 
263  # Execute the page.
264  $this->currentPageName = $page->getName();
265  $this->startPageWrapper( $pageName );
266 
267  if ( $page->isSlow() ) {
268  $this->disableTimeLimit();
269  }
270 
271  $result = $page->execute();
272 
273  $this->endPageWrapper();
274 
275  if ( $result == 'skip' ) {
276  # Page skipped without explicit submission.
277  # Skip it when we click "back" so that we don't just go forward again.
278  $this->skippedPages[$pageName] = true;
279  $result = 'continue';
280  } else {
281  unset( $this->skippedPages[$pageName] );
282  }
283 
284  # If it was posted, the page can request a continue to the next page.
285  if ( $result === 'continue' && !$this->output->headerDone() ) {
286  if ( $pageId !== false ) {
287  $this->happyPages[$pageId] = true;
288  }
289 
290  $lowestUnhappy = $this->getLowestUnhappy();
291 
292  if ( $this->request->getVal( 'lastPage' ) ) {
293  $nextPage = $this->request->getVal( 'lastPage' );
294  } elseif ( $pageId !== false ) {
295  $nextPage = $this->pageSequence[$pageId + 1];
296  } else {
297  $nextPage = $this->pageSequence[$lowestUnhappy];
298  }
299 
300  if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
301  $nextPage = $this->pageSequence[$lowestUnhappy];
302  }
303 
304  $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
305  }
306 
307  return $this->finish();
308  }
309 
314  public function getLowestUnhappy() {
315  if ( count( $this->happyPages ) == 0 ) {
316  return 0;
317  } else {
318  return max( array_keys( $this->happyPages ) ) + 1;
319  }
320  }
321 
328  public function startSession() {
329  if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
330  // Done already
331  return true;
332  }
333 
334  $this->phpErrors = [];
335  set_error_handler( [ $this, 'errorHandler' ] );
336  try {
337  session_name( 'mw_installer_session' );
338  session_start();
339  } catch ( Exception $e ) {
340  restore_error_handler();
341  throw $e;
342  }
343  restore_error_handler();
344 
345  if ( $this->phpErrors ) {
346  return false;
347  }
348 
349  return true;
350  }
351 
360  public function getFingerprint() {
361  // Get the base URL of the installation
362  $url = $this->request->getFullRequestURL();
363  if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
364  // Trim query string
365  $url = $m[1];
366  }
367  if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
368  // This... seems to try to get the base path from
369  // the /mw-config/index.php. Kinda scary though?
370  $url = $m[1];
371  }
372 
373  return md5( serialize( [
374  'local path' => dirname( __DIR__ ),
375  'url' => $url,
376  'version' => $GLOBALS['wgVersion']
377  ] ) );
378  }
379 
386  public function showError( $msg, ...$params ) {
387  if ( !( $msg instanceof Message ) ) {
388  $msg = wfMessage(
389  $msg,
390  array_map( 'htmlspecialchars', $params )
391  );
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  return $this->session[$name] ?? $default;
472  }
473 
480  public function setSession( $name, $value ) {
481  $this->session[$name] = $value;
482  }
483 
489  public function nextTabIndex() {
490  return $this->tabIndex++;
491  }
492 
496  public function setupLanguage() {
498 
499  if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
500  $wgLanguageCode = $this->getAcceptLanguage();
501  $wgLang = Language::factory( $wgLanguageCode );
502  RequestContext::getMain()->setLanguage( $wgLang );
503  $this->setVar( 'wgLanguageCode', $wgLanguageCode );
504  $this->setVar( '_UserLang', $wgLanguageCode );
505  } else {
506  $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
507  }
508  $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
509  }
510 
516  public function getAcceptLanguage() {
517  global $wgLanguageCode, $wgRequest;
518 
519  $mwLanguages = Language::fetchLanguageNames( null, 'mwfile' );
520  $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
521 
522  foreach ( $headerLanguages as $lang ) {
523  if ( isset( $mwLanguages[$lang] ) ) {
524  return $lang;
525  }
526  }
527 
528  return $wgLanguageCode;
529  }
530 
536  private function startPageWrapper( $currentPageName ) {
537  $s = "<div class=\"config-page-wrapper\">\n";
538  $s .= "<div class=\"config-page\">\n";
539  $s .= "<div class=\"config-page-list\"><ul>\n";
540  $lastHappy = -1;
541 
542  foreach ( $this->pageSequence as $id => $pageName ) {
543  $happy = !empty( $this->happyPages[$id] );
544  $s .= $this->getPageListItem(
545  $pageName,
546  $happy || $lastHappy == $id - 1,
548  );
549 
550  if ( $happy ) {
551  $lastHappy = $id;
552  }
553  }
554 
555  $s .= "</ul><br/><ul>\n";
556  $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
557  // End list pane
558  $s .= "</ul></div>\n";
559 
560  // Messages:
561  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
562  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
563  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
564  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
565  $s .= Html::element( 'h2', [],
566  wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
567 
568  $this->output->addHTMLNoFlush( $s );
569  }
570 
580  private function getPageListItem( $pageName, $enabled, $currentPageName ) {
581  $s = "<li class=\"config-page-list-item\">";
582 
583  // Messages:
584  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
585  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
586  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
587  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
588  $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
589 
590  if ( $enabled ) {
591  $query = [ 'page' => $pageName ];
592 
593  if ( !in_array( $pageName, $this->pageSequence ) ) {
594  if ( in_array( $currentPageName, $this->pageSequence ) ) {
595  $query['lastPage'] = $currentPageName;
596  }
597 
598  $link = Html::element( 'a',
599  [
600  'href' => $this->getUrl( $query )
601  ],
602  $name
603  );
604  } else {
605  $link = htmlspecialchars( $name );
606  }
607 
608  if ( $pageName == $currentPageName ) {
609  $s .= "<span class=\"config-page-current\">$link</span>";
610  } else {
611  $s .= $link;
612  }
613  } else {
614  $s .= Html::element( 'span',
615  [
616  'class' => 'config-page-disabled'
617  ],
618  $name
619  );
620  }
621 
622  $s .= "</li>\n";
623 
624  return $s;
625  }
626 
630  private function endPageWrapper() {
631  $this->output->addHTMLNoFlush(
632  "<div class=\"visualClear\"></div>\n" .
633  "</div>\n" .
634  "<div class=\"visualClear\"></div>\n" .
635  "</div>" );
636  }
637 
645  public function getErrorBox( $text ) {
646  return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
647  }
648 
656  public function getWarningBox( $text ) {
657  return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
658  }
659 
669  public function getInfoBox( $text, $icon = false, $class = false ) {
670  $text = $this->parse( $text, true );
671  $icon = ( $icon == false ) ?
672  'images/info-32.png' :
673  'images/' . $icon;
674  $alt = wfMessage( 'config-information' )->text();
675 
676  return Html::infoBox( $text, $icon, $alt, $class );
677  }
678 
686  public function getHelpBox( $msg, ...$args ) {
687  $args = array_map( 'htmlspecialchars', $args );
688  $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
689  $html = $this->parse( $text, true );
690  $id = 'helpBox-' . $this->helpBoxId++;
691 
692  return "<div class=\"config-help-field-container\">\n" .
693  "<input type=\"checkbox\" class=\"config-help-field-checkbox\" id=\"$id\" />" .
694  "<label class=\"config-help-field-hint\" for=\"$id\" title=\"" .
695  wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
696  wfMessage( 'config-help' )->escaped() . "</label>\n" .
697  "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
698  "</div>\n";
699  }
700 
706  public function showHelpBox( $msg, ...$params ) {
707  $html = $this->getHelpBox( $msg, ...$params );
708  $this->output->addHTML( $html );
709  }
710 
718  public function showMessage( $msg, ...$params ) {
719  $html = '<div class="config-message">' .
720  $this->parse( wfMessage( $msg, $params )->useDatabase( false )->plain() ) .
721  "</div>\n";
722  $this->output->addHTML( $html );
723  }
724 
728  public function showStatusMessage( Status $status ) {
729  $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
730  foreach ( $errors as $error ) {
731  $this->showMessage( ...$error );
732  }
733  }
734 
745  public function label( $msg, $forId, $contents, $helpData = "" ) {
746  if ( strval( $msg ) == '' ) {
747  $labelText = "\u{00A0}";
748  } else {
749  $labelText = wfMessage( $msg )->escaped();
750  }
751 
752  $attributes = [ 'class' => 'config-label' ];
753 
754  if ( $forId ) {
755  $attributes['for'] = $forId;
756  }
757 
758  return "<div class=\"config-block\">\n" .
759  " <div class=\"config-block-label\">\n" .
760  Xml::tags( 'label',
761  $attributes,
762  $labelText
763  ) . "\n" .
764  $helpData .
765  " </div>\n" .
766  " <div class=\"config-block-elements\">\n" .
767  $contents .
768  " </div>\n" .
769  "</div>\n";
770  }
771 
786  public function getTextBox( $params ) {
787  if ( !isset( $params['controlName'] ) ) {
788  $params['controlName'] = 'config_' . $params['var'];
789  }
790 
791  if ( !isset( $params['value'] ) ) {
792  $params['value'] = $this->getVar( $params['var'] );
793  }
794 
795  if ( !isset( $params['attribs'] ) ) {
796  $params['attribs'] = [];
797  }
798  if ( !isset( $params['help'] ) ) {
799  $params['help'] = "";
800  }
801 
802  return $this->label(
803  $params['label'],
804  $params['controlName'],
805  Xml::input(
806  $params['controlName'],
807  30, // intended to be overridden by CSS
808  $params['value'],
809  $params['attribs'] + [
810  'id' => $params['controlName'],
811  'class' => 'config-input-text',
812  'tabindex' => $this->nextTabIndex()
813  ]
814  ),
815  $params['help']
816  );
817  }
818 
833  public function getTextArea( $params ) {
834  if ( !isset( $params['controlName'] ) ) {
835  $params['controlName'] = 'config_' . $params['var'];
836  }
837 
838  if ( !isset( $params['value'] ) ) {
839  $params['value'] = $this->getVar( $params['var'] );
840  }
841 
842  if ( !isset( $params['attribs'] ) ) {
843  $params['attribs'] = [];
844  }
845  if ( !isset( $params['help'] ) ) {
846  $params['help'] = "";
847  }
848 
849  return $this->label(
850  $params['label'],
851  $params['controlName'],
853  $params['controlName'],
854  $params['value'],
855  30,
856  5,
857  $params['attribs'] + [
858  'id' => $params['controlName'],
859  'class' => 'config-input-text',
860  'tabindex' => $this->nextTabIndex()
861  ]
862  ),
863  $params['help']
864  );
865  }
866 
882  public function getPasswordBox( $params ) {
883  if ( !isset( $params['value'] ) ) {
884  $params['value'] = $this->getVar( $params['var'] );
885  }
886 
887  if ( !isset( $params['attribs'] ) ) {
888  $params['attribs'] = [];
889  }
890 
891  $params['value'] = $this->getFakePassword( $params['value'] );
892  $params['attribs']['type'] = 'password';
893 
894  return $this->getTextBox( $params );
895  }
896 
912  public function getCheckBox( $params ) {
913  if ( !isset( $params['controlName'] ) ) {
914  $params['controlName'] = 'config_' . $params['var'];
915  }
916 
917  if ( !isset( $params['value'] ) ) {
918  $params['value'] = $this->getVar( $params['var'] );
919  }
920 
921  if ( !isset( $params['attribs'] ) ) {
922  $params['attribs'] = [];
923  }
924  if ( !isset( $params['help'] ) ) {
925  $params['help'] = "";
926  }
927  if ( !isset( $params['labelAttribs'] ) ) {
928  $params['labelAttribs'] = [];
929  }
930  $labelText = $params['rawtext'] ?? $this->parse( wfMessage( $params['label'] )->plain() );
931 
932  return "<div class=\"config-input-check\">\n" .
933  $params['help'] .
935  'label',
936  $params['labelAttribs'],
937  Xml::check(
938  $params['controlName'],
939  $params['value'],
940  $params['attribs'] + [
941  'id' => $params['controlName'],
942  'tabindex' => $this->nextTabIndex(),
943  ]
944  ) .
945  $labelText . "\n"
946  ) .
947  "</div>\n";
948  }
949 
969  public function getRadioSet( $params ) {
970  $items = $this->getRadioElements( $params );
971 
972  $label = $params['label'] ?? '';
973 
974  if ( !isset( $params['controlName'] ) ) {
975  $params['controlName'] = 'config_' . $params['var'];
976  }
977 
978  if ( !isset( $params['help'] ) ) {
979  $params['help'] = "";
980  }
981 
982  $s = "<ul>\n";
983  foreach ( $items as $value => $item ) {
984  $s .= "<li>$item</li>\n";
985  }
986  $s .= "</ul>\n";
987 
988  return $this->label( $label, $params['controlName'], $s, $params['help'] );
989  }
990 
999  public function getRadioElements( $params ) {
1000  if ( !isset( $params['controlName'] ) ) {
1001  $params['controlName'] = 'config_' . $params['var'];
1002  }
1003 
1004  if ( !isset( $params['value'] ) ) {
1005  $params['value'] = $this->getVar( $params['var'] );
1006  }
1007 
1008  $items = [];
1009 
1010  foreach ( $params['values'] as $value ) {
1011  $itemAttribs = [];
1012 
1013  if ( isset( $params['commonAttribs'] ) ) {
1014  $itemAttribs = $params['commonAttribs'];
1015  }
1016 
1017  if ( isset( $params['itemAttribs'][$value] ) ) {
1018  $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1019  }
1020 
1021  $checked = $value == $params['value'];
1022  $id = $params['controlName'] . '_' . $value;
1023  $itemAttribs['id'] = $id;
1024  $itemAttribs['tabindex'] = $this->nextTabIndex();
1025 
1026  $items[$value] =
1027  Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1028  "\u{00A0}" .
1029  Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1030  isset( $params['itemLabels'] ) ?
1031  wfMessage( $params['itemLabels'][$value] )->plain() :
1032  wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1033  ) );
1034  }
1035 
1036  return $items;
1037  }
1038 
1044  public function showStatusBox( $status ) {
1045  if ( !$status->isGood() ) {
1046  $text = $status->getWikiText();
1047 
1048  if ( $status->isOK() ) {
1049  $box = $this->getWarningBox( $text );
1050  } else {
1051  $box = $this->getErrorBox( $text );
1052  }
1053 
1054  $this->output->addHTML( $box );
1055  }
1056  }
1057 
1068  public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1069  $newValues = [];
1070 
1071  foreach ( $varNames as $name ) {
1072  $value = $this->request->getVal( $prefix . $name );
1073  // T32524, do not trim passwords
1074  if ( stripos( $name, 'password' ) === false ) {
1075  $value = trim( $value );
1076  }
1077  $newValues[$name] = $value;
1078 
1079  if ( $value === null ) {
1080  // Checkbox?
1081  $this->setVar( $name, false );
1082  } elseif ( stripos( $name, 'password' ) !== false ) {
1083  $this->setPassword( $name, $value );
1084  } else {
1085  $this->setVar( $name, $value );
1086  }
1087  }
1088 
1089  return $newValues;
1090  }
1091 
1099  protected function getDocUrl( $page ) {
1100  $query = [ 'page' => $page ];
1101 
1102  if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1103  $query['lastPage'] = $this->currentPageName;
1104  }
1105 
1106  return $this->getUrl( $query );
1107  }
1108 
1118  public function docLink( $linkText, $attribs, $parser ) {
1119  $url = $this->getDocUrl( $attribs['href'] );
1120 
1121  return Html::element( 'a', [ 'href' => $url ], $linkText );
1122  }
1123 
1133  public function downloadLinkHook( $text, $attribs, $parser ) {
1134  $anchor = Html::rawElement( 'a',
1135  [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1136  wfMessage( 'config-download-localsettings' )->parse()
1137  );
1138 
1139  return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1140  }
1141 
1152  public function getLocalSettingsLocation() {
1153  return false;
1154  }
1155 
1159  public function envCheckPath() {
1160  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1161  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1162  // to get the path to the current script... hopefully it's reliable. SIGH
1163  $path = false;
1164  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1165  $path = $_SERVER['PHP_SELF'];
1166  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1167  $path = $_SERVER['SCRIPT_NAME'];
1168  }
1169  if ( $path === false ) {
1170  $this->showError( 'config-no-uri' );
1171  return false;
1172  }
1173 
1174  return parent::envCheckPath();
1175  }
1176 
1177  public function envPrepPath() {
1178  parent::envPrepPath();
1179  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1180  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1181  // to get the path to the current script... hopefully it's reliable. SIGH
1182  $path = false;
1183  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1184  $path = $_SERVER['PHP_SELF'];
1185  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1186  $path = $_SERVER['SCRIPT_NAME'];
1187  }
1188  if ( $path !== false ) {
1189  $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1190 
1191  $this->setVar( 'wgScriptPath', "$scriptPath" );
1192  // Update variables set from Setup.php that are derived from wgScriptPath
1193  $this->setVar( 'wgScript', "$scriptPath/index.php" );
1194  $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1195  $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1196  $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1197  $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1198  $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1199  $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1200  }
1201  }
1202 
1206  protected function envGetDefaultServer() {
1207  return WebRequest::detectServer();
1208  }
1209 
1215  private function outputLS() {
1216  $this->request->response()->header( 'Content-type: application/x-httpd-php' );
1217  $this->request->response()->header(
1218  'Content-Disposition: attachment; filename="LocalSettings.php"'
1219  );
1220 
1222  $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
1223  foreach ( $rightsProfile as $group => $rightsArr ) {
1224  $ls->setGroupRights( $group, $rightsArr );
1225  }
1226  echo $ls->getText();
1227  }
1228 
1232  public function outputCss() {
1233  $this->request->response()->header( 'Content-type: text/css' );
1234  echo $this->output->getCSS();
1235  }
1236 
1240  public function getPhpErrors() {
1241  return $this->phpErrors;
1242  }
1243 
1244 }
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:1982
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:840
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:1585
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
either a plain
Definition: hooks.txt:2043
getWarningBox( $text)
Get HTML for a warning box with an icon.
int $tabIndex
Numeric index of the page we&#39;re on.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
serialize()
getPageByName( $pageName)
Get a WebInstallerPage by name.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
__construct(WebRequest $request)
getRadioSet( $params)
Get a set of labelled radio buttons.
bool [] $happyPages
Array of pages which have declared that they have been submitted, have validated their input...
if(!isset( $args[0])) $lang
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
getInfoBox( $text, $icon=false, $class=false)
Get HTML for an info box with an icon.
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
Class for the core installer web interface.
$value
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
array $settings
Definition: Installer.php:59
getFingerprint()
Get a hash of data identifying this MW installation.
WebRequest $request
WebRequest object.
getRadioElements( $params)
Get a set of labelled radio buttons.
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1799
startSession()
Start the PHP session.
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
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
Definition: Installer.php:643
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
showStatusMessage(Status $status)
getWarningsArray()
Get the list of warnings (but not errors)
Definition: Status.php:353
array [] $session
Cached session array.
getCheckBox( $params)
Get a labelled checkbox to configure a boolean variable.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
label( $msg, $forId, $contents, $helpData="")
Label a control by wrapping a config-input div around it and putting a label before it...
if( $line===false) $args
Definition: cdb.php:64
int $helpBoxId
Numeric index of the help box.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3051
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
Output class modelled on OutputPage.
$wgLanguageCode
Site language code.
string [] $pageSequence
The main sequence of page names.
static detectServer()
Work out an appropriate URL prefix containing scheme and host, based on information detected from $_S...
Definition: WebRequest.php:200
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 '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:1263
$wgLang
Definition: Setup.php:931
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
static getMain()
Get the RequestContext object associated with the main request.
getErrorsArray()
Get the list of errors (but not warnings)
Definition: Status.php:342
showStatusBox( $status)
Output an error or warning box using a Status object.
getLowestUnhappy()
Find the next page in sequence that hasn&#39;t been completed.
$params
setVarsFromRequest( $varNames, $prefix='config_')
Convenience function to set variables based on form data.
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
showHelpBox( $msg,... $params)
Output a help box.
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
Definition: Installer.php:632
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:1982
outputCss()
Output stylesheet for web installer pages.
WebInstallerOutput $output
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:541
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
getLocalSettingsLocation()
If the software package wants the LocalSettings.php file to be placed in a specific location...
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
setSession( $name, $value)
Set a session variable.
getErrorBox( $text)
Get HTML for an error box with an icon.
disableTimeLimit()
Disable the time limit for execution.
Definition: Installer.php:1818
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set this hook should only be used to add variables that depend on the current page request
Definition: hooks.txt:2159
$GLOBALS['IP']
nextTabIndex()
Get the next tabindex attribute value.
bool [] $skippedPages
List of "skipped" pages.
getHelpBox( $msg,... $args)
Get small text indented help for a preceding form field.
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:25
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
getTextArea( $params)
Get a labelled textarea to configure a variable.
getDocUrl( $page)
Helper for Installer::docLink()
execute(array $session)
Main entry point.
errorHandler( $errno, $errstr)
Temporary error handler for session start debugging.
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
Definition: Installer.php:690
showError( $msg,... $params)
Show an error message in a box.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static textarea( $name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
Definition: Xml.php:635
string [] $phpErrors
Captured PHP error text.
outputLS()
Actually output LocalSettings.php for download.
downloadLinkHook( $text, $attribs, $parser)
Helper for "Download LocalSettings" link on WebInstall_Complete.
showMessage( $msg,... $params)
Show a short informational message.
getSession( $name, $default=null)
Get a session variable.
finish()
Clean up from execute()
getPasswordBox( $params)
Get a labelled password box to configure a variable.
Base installer class.
Definition: Installer.php:46
string [] $otherPages
Out of sequence pages, selectable by the user at any time.
string $currentPageName
Name of the page we&#39;re on.
getUrl( $query=[])
Get a URL for submission back to the same script.
static infoBox( $text, $icon, $alt, $class='')
Get HTML for an info box with an icon.
Definition: Html.php:1018
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:783
getAcceptLanguage()
Retrieves MediaWiki language from Accept-Language HTTP header.
reset()
We&#39;re restarting the installation, reset the session, happyPages, etc.
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:527
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
Definition: Xml.php:341
docLink( $linkText, $attribs, $parser)
Extension tag hook for a documentation link.
startPageWrapper( $currentPageName)
Called by execute() before page output starts, to show a page list.
getPageListItem( $pageName, $enabled, $currentPageName)
Get a list item for the page list.
endPageWrapper()
Output some stuff after a page is finished.
bool $showSessionWarning
Flag indicating that session data may have been lost.
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:323
setupLanguage()
Initializes language-related variables.
$wgContLang
Definition: Setup.php:846
getTextBox( $params)
Get a labelled text box to configure a variable.