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 $currentPageName;
133 
137  public function __construct( WebRequest $request ) {
138  parent::__construct();
139  $this->output = new WebInstallerOutput( $this );
140  $this->request = $request;
141 
142  // Add parser hooks
143  $parser = MediaWikiServices::getInstance()->getParser();
144  $parser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
145  $parser->setHook( 'doclink', [ $this, 'docLink' ] );
146  }
147 
155  public function execute( array $session ) {
156  $this->session = $session;
157 
158  if ( isset( $session['settings'] ) ) {
159  $this->settings = $session['settings'] + $this->settings;
160  // T187586 MediaWikiServices works with globals
161  foreach ( $this->settings as $key => $val ) {
162  $GLOBALS[$key] = $val;
163  }
164  }
165 
166  $this->setupLanguage();
167 
168  if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
169  && $this->request->getVal( 'localsettings' )
170  ) {
171  $this->outputLS();
172  return $this->session;
173  }
174 
175  $isCSS = $this->request->getVal( 'css' );
176  if ( $isCSS ) {
177  $this->outputCss();
178  return $this->session;
179  }
180 
181  $this->happyPages = $session['happyPages'] ?? [];
182 
183  $this->skippedPages = $session['skippedPages'] ?? [];
184 
185  $lowestUnhappy = $this->getLowestUnhappy();
186 
187  # Special case for Creative Commons partner chooser box.
188  if ( $this->request->getVal( 'SubmitCC' ) ) {
189  $page = $this->getPageByName( 'Options' );
190  $this->output->useShortHeader();
191  $this->output->allowFrames();
192  $page->submitCC();
193 
194  return $this->finish();
195  }
196 
197  if ( $this->request->getVal( 'ShowCC' ) ) {
198  $page = $this->getPageByName( 'Options' );
199  $this->output->useShortHeader();
200  $this->output->allowFrames();
201  $this->output->addHTML( $page->getCCDoneBox() );
202 
203  return $this->finish();
204  }
205 
206  # Get the page name.
207  $pageName = $this->request->getVal( 'page' );
208 
209  if ( in_array( $pageName, $this->otherPages ) ) {
210  # Out of sequence
211  $pageId = false;
212  $page = $this->getPageByName( $pageName );
213  } else {
214  # Main sequence
215  if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
216  $pageId = $lowestUnhappy;
217  } else {
218  $pageId = array_search( $pageName, $this->pageSequence );
219  }
220 
221  # If necessary, move back to the lowest-numbered unhappy page
222  if ( $pageId > $lowestUnhappy ) {
223  $pageId = $lowestUnhappy;
224  if ( $lowestUnhappy == 0 ) {
225  # Knocked back to start, possible loss of session data.
226  $this->showSessionWarning = true;
227  }
228  }
229 
230  $pageName = $this->pageSequence[$pageId];
231  $page = $this->getPageByName( $pageName );
232  }
233 
234  # If a back button was submitted, go back without submitting the form data.
235  if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
236  if ( $this->request->getVal( 'lastPage' ) ) {
237  $nextPage = $this->request->getVal( 'lastPage' );
238  } elseif ( $pageId !== false ) {
239  # Main sequence page
240  # Skip the skipped pages
241  $nextPageId = $pageId;
242 
243  do {
244  $nextPageId--;
245  $nextPage = $this->pageSequence[$nextPageId];
246  } while ( isset( $this->skippedPages[$nextPage] ) );
247  } else {
248  $nextPage = $this->pageSequence[$lowestUnhappy];
249  }
250 
251  $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
252 
253  return $this->finish();
254  }
255 
256  # Execute the page.
257  $this->currentPageName = $page->getName();
258  $this->startPageWrapper( $pageName );
259 
260  if ( $page->isSlow() ) {
261  $this->disableTimeLimit();
262  }
263 
264  $result = $page->execute();
265 
266  $this->endPageWrapper();
267 
268  if ( $result == 'skip' ) {
269  # Page skipped without explicit submission.
270  # Skip it when we click "back" so that we don't just go forward again.
271  $this->skippedPages[$pageName] = true;
272  $result = 'continue';
273  } else {
274  unset( $this->skippedPages[$pageName] );
275  }
276 
277  # If it was posted, the page can request a continue to the next page.
278  if ( $result === 'continue' && !$this->output->headerDone() ) {
279  if ( $pageId !== false ) {
280  $this->happyPages[$pageId] = true;
281  }
282 
283  $lowestUnhappy = $this->getLowestUnhappy();
284 
285  if ( $this->request->getVal( 'lastPage' ) ) {
286  $nextPage = $this->request->getVal( 'lastPage' );
287  } elseif ( $pageId !== false ) {
288  $nextPage = $this->pageSequence[$pageId + 1];
289  } else {
290  $nextPage = $this->pageSequence[$lowestUnhappy];
291  }
292 
293  if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
294  $nextPage = $this->pageSequence[$lowestUnhappy];
295  }
296 
297  $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
298  }
299 
300  return $this->finish();
301  }
302 
307  public function getLowestUnhappy() {
308  if ( count( $this->happyPages ) == 0 ) {
309  return 0;
310  } else {
311  return max( array_keys( $this->happyPages ) ) + 1;
312  }
313  }
314 
321  public function startSession() {
322  if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
323  // Done already
324  return true;
325  }
326 
327  $this->phpErrors = [];
328  set_error_handler( [ $this, 'errorHandler' ] );
329  try {
330  session_name( 'mw_installer_session' );
331  session_start();
332  } catch ( Exception $e ) {
333  restore_error_handler();
334  throw $e;
335  }
336  restore_error_handler();
337 
338  if ( $this->phpErrors ) {
339  return false;
340  }
341 
342  return true;
343  }
344 
353  public function getFingerprint() {
354  // Get the base URL of the installation
355  $url = $this->request->getFullRequestURL();
356  if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
357  // Trim query string
358  $url = $m[1];
359  }
360  if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
361  // This... seems to try to get the base path from
362  // the /mw-config/index.php. Kinda scary though?
363  $url = $m[1];
364  }
365 
366  return md5( serialize( [
367  'local path' => dirname( __DIR__ ),
368  'url' => $url,
369  'version' => $GLOBALS['wgVersion']
370  ] ) );
371  }
372 
379  public function showError( $msg, ...$params ) {
380  if ( !( $msg instanceof Message ) ) {
381  $msg = wfMessage(
382  $msg,
383  array_map( 'htmlspecialchars', $params )
384  );
385  }
386  $text = $msg->useDatabase( false )->plain();
387  $this->output->addHTML( $this->getErrorBox( $text ) );
388  }
389 
396  public function errorHandler( $errno, $errstr ) {
397  $this->phpErrors[] = $errstr;
398  }
399 
405  public function finish() {
406  $this->output->output();
407 
408  $this->session['happyPages'] = $this->happyPages;
409  $this->session['skippedPages'] = $this->skippedPages;
410  $this->session['settings'] = $this->settings;
411 
412  return $this->session;
413  }
414 
418  public function reset() {
419  $this->session = [];
420  $this->happyPages = [];
421  $this->settings = [];
422  }
423 
431  public function getUrl( $query = [] ) {
432  $url = $this->request->getRequestURL();
433  # Remove existing query
434  $url = preg_replace( '/\?.*$/', '', $url );
435 
436  if ( $query ) {
437  $url .= '?' . wfArrayToCgi( $query );
438  }
439 
440  return $url;
441  }
442 
449  public function getPageByName( $pageName ) {
450  $pageClass = 'WebInstaller' . $pageName;
451 
452  return new $pageClass( $this );
453  }
454 
463  public function getSession( $name, $default = null ) {
464  return $this->session[$name] ?? $default;
465  }
466 
473  public function setSession( $name, $value ) {
474  $this->session[$name] = $value;
475  }
476 
482  public function nextTabIndex() {
483  return $this->tabIndex++;
484  }
485 
489  public function setupLanguage() {
491 
492  if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
493  $wgLanguageCode = $this->getAcceptLanguage();
494  $wgLang = Language::factory( $wgLanguageCode );
495  RequestContext::getMain()->setLanguage( $wgLang );
496  $this->setVar( 'wgLanguageCode', $wgLanguageCode );
497  $this->setVar( '_UserLang', $wgLanguageCode );
498  } else {
499  $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
500  }
501  $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
502  }
503 
509  public function getAcceptLanguage() {
510  global $wgLanguageCode, $wgRequest;
511 
512  $mwLanguages = Language::fetchLanguageNames( null, 'mwfile' );
513  $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
514 
515  foreach ( $headerLanguages as $lang ) {
516  if ( isset( $mwLanguages[$lang] ) ) {
517  return $lang;
518  }
519  }
520 
521  return $wgLanguageCode;
522  }
523 
529  private function startPageWrapper( $currentPageName ) {
530  $s = "<div class=\"config-page-wrapper\">\n";
531  $s .= "<div class=\"config-page\">\n";
532  $s .= "<div class=\"config-page-list\"><ul>\n";
533  $lastHappy = -1;
534 
535  foreach ( $this->pageSequence as $id => $pageName ) {
536  $happy = !empty( $this->happyPages[$id] );
537  $s .= $this->getPageListItem(
538  $pageName,
539  $happy || $lastHappy == $id - 1,
541  );
542 
543  if ( $happy ) {
544  $lastHappy = $id;
545  }
546  }
547 
548  $s .= "</ul><br/><ul>\n";
549  $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
550  // End list pane
551  $s .= "</ul></div>\n";
552 
553  // Messages:
554  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
555  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
556  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
557  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
558  $s .= Html::element( 'h2', [],
559  wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
560 
561  $this->output->addHTMLNoFlush( $s );
562  }
563 
573  private function getPageListItem( $pageName, $enabled, $currentPageName ) {
574  $s = "<li class=\"config-page-list-item\">";
575 
576  // Messages:
577  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
578  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
579  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
580  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
581  $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
582 
583  if ( $enabled ) {
584  $query = [ 'page' => $pageName ];
585 
586  if ( !in_array( $pageName, $this->pageSequence ) ) {
587  if ( in_array( $currentPageName, $this->pageSequence ) ) {
588  $query['lastPage'] = $currentPageName;
589  }
590 
591  $link = Html::element( 'a',
592  [
593  'href' => $this->getUrl( $query )
594  ],
595  $name
596  );
597  } else {
598  $link = htmlspecialchars( $name );
599  }
600 
601  if ( $pageName == $currentPageName ) {
602  $s .= "<span class=\"config-page-current\">$link</span>";
603  } else {
604  $s .= $link;
605  }
606  } else {
607  $s .= Html::element( 'span',
608  [
609  'class' => 'config-page-disabled'
610  ],
611  $name
612  );
613  }
614 
615  $s .= "</li>\n";
616 
617  return $s;
618  }
619 
623  private function endPageWrapper() {
624  $this->output->addHTMLNoFlush(
625  "<div class=\"visualClear\"></div>\n" .
626  "</div>\n" .
627  "<div class=\"visualClear\"></div>\n" .
628  "</div>" );
629  }
630 
638  public function getErrorBox( $text ) {
639  return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
640  }
641 
649  public function getWarningBox( $text ) {
650  return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
651  }
652 
662  public function getInfoBox( $text, $icon = false, $class = false ) {
663  $text = $this->parse( $text, true );
664  $icon = ( $icon == false ) ?
665  'images/info-32.png' :
666  'images/' . $icon;
667  $alt = wfMessage( 'config-information' )->text();
668 
669  return Html::infoBox( $text, $icon, $alt, $class );
670  }
671 
679  public function getHelpBox( $msg, ...$args ) {
680  $args = array_map( 'htmlspecialchars', $args );
681  $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
682  $html = $this->parse( $text, true );
683 
684  return "<div class=\"config-help-field-container\">\n" .
685  "<span class=\"config-help-field-hint\" title=\"" .
686  wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
687  wfMessage( 'config-help' )->escaped() . "</span>\n" .
688  "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
689  "</div>\n";
690  }
691 
697  public function showHelpBox( $msg, ...$params ) {
698  $html = $this->getHelpBox( $msg, ...$params );
699  $this->output->addHTML( $html );
700  }
701 
709  public function showMessage( $msg, ...$params ) {
710  $html = '<div class="config-message">' .
711  $this->parse( wfMessage( $msg, $params )->useDatabase( false )->plain() ) .
712  "</div>\n";
713  $this->output->addHTML( $html );
714  }
715 
719  public function showStatusMessage( Status $status ) {
720  $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
721  foreach ( $errors as $error ) {
722  $this->showMessage( ...$error );
723  }
724  }
725 
736  public function label( $msg, $forId, $contents, $helpData = "" ) {
737  if ( strval( $msg ) == '' ) {
738  $labelText = "\u{00A0}";
739  } else {
740  $labelText = wfMessage( $msg )->escaped();
741  }
742 
743  $attributes = [ 'class' => 'config-label' ];
744 
745  if ( $forId ) {
746  $attributes['for'] = $forId;
747  }
748 
749  return "<div class=\"config-block\">\n" .
750  " <div class=\"config-block-label\">\n" .
751  Xml::tags( 'label',
752  $attributes,
753  $labelText
754  ) . "\n" .
755  $helpData .
756  " </div>\n" .
757  " <div class=\"config-block-elements\">\n" .
758  $contents .
759  " </div>\n" .
760  "</div>\n";
761  }
762 
777  public function getTextBox( $params ) {
778  if ( !isset( $params['controlName'] ) ) {
779  $params['controlName'] = 'config_' . $params['var'];
780  }
781 
782  if ( !isset( $params['value'] ) ) {
783  $params['value'] = $this->getVar( $params['var'] );
784  }
785 
786  if ( !isset( $params['attribs'] ) ) {
787  $params['attribs'] = [];
788  }
789  if ( !isset( $params['help'] ) ) {
790  $params['help'] = "";
791  }
792 
793  return $this->label(
794  $params['label'],
795  $params['controlName'],
796  Xml::input(
797  $params['controlName'],
798  30, // intended to be overridden by CSS
799  $params['value'],
800  $params['attribs'] + [
801  'id' => $params['controlName'],
802  'class' => 'config-input-text',
803  'tabindex' => $this->nextTabIndex()
804  ]
805  ),
806  $params['help']
807  );
808  }
809 
824  public function getTextArea( $params ) {
825  if ( !isset( $params['controlName'] ) ) {
826  $params['controlName'] = 'config_' . $params['var'];
827  }
828 
829  if ( !isset( $params['value'] ) ) {
830  $params['value'] = $this->getVar( $params['var'] );
831  }
832 
833  if ( !isset( $params['attribs'] ) ) {
834  $params['attribs'] = [];
835  }
836  if ( !isset( $params['help'] ) ) {
837  $params['help'] = "";
838  }
839 
840  return $this->label(
841  $params['label'],
842  $params['controlName'],
844  $params['controlName'],
845  $params['value'],
846  30,
847  5,
848  $params['attribs'] + [
849  'id' => $params['controlName'],
850  'class' => 'config-input-text',
851  'tabindex' => $this->nextTabIndex()
852  ]
853  ),
854  $params['help']
855  );
856  }
857 
873  public function getPasswordBox( $params ) {
874  if ( !isset( $params['value'] ) ) {
875  $params['value'] = $this->getVar( $params['var'] );
876  }
877 
878  if ( !isset( $params['attribs'] ) ) {
879  $params['attribs'] = [];
880  }
881 
882  $params['value'] = $this->getFakePassword( $params['value'] );
883  $params['attribs']['type'] = 'password';
884 
885  return $this->getTextBox( $params );
886  }
887 
903  public function getCheckBox( $params ) {
904  if ( !isset( $params['controlName'] ) ) {
905  $params['controlName'] = 'config_' . $params['var'];
906  }
907 
908  if ( !isset( $params['value'] ) ) {
909  $params['value'] = $this->getVar( $params['var'] );
910  }
911 
912  if ( !isset( $params['attribs'] ) ) {
913  $params['attribs'] = [];
914  }
915  if ( !isset( $params['help'] ) ) {
916  $params['help'] = "";
917  }
918  if ( !isset( $params['labelAttribs'] ) ) {
919  $params['labelAttribs'] = [];
920  }
921  $labelText = $params['rawtext'] ?? $this->parse( wfMessage( $params['label'] )->plain() );
922 
923  return "<div class=\"config-input-check\">\n" .
924  $params['help'] .
926  'label',
927  $params['labelAttribs'],
928  Xml::check(
929  $params['controlName'],
930  $params['value'],
931  $params['attribs'] + [
932  'id' => $params['controlName'],
933  'tabindex' => $this->nextTabIndex(),
934  ]
935  ) .
936  $labelText . "\n"
937  ) .
938  "</div>\n";
939  }
940 
960  public function getRadioSet( $params ) {
961  $items = $this->getRadioElements( $params );
962 
963  $label = $params['label'] ?? '';
964 
965  if ( !isset( $params['controlName'] ) ) {
966  $params['controlName'] = 'config_' . $params['var'];
967  }
968 
969  if ( !isset( $params['help'] ) ) {
970  $params['help'] = "";
971  }
972 
973  $s = "<ul>\n";
974  foreach ( $items as $value => $item ) {
975  $s .= "<li>$item</li>\n";
976  }
977  $s .= "</ul>\n";
978 
979  return $this->label( $label, $params['controlName'], $s, $params['help'] );
980  }
981 
990  public function getRadioElements( $params ) {
991  if ( !isset( $params['controlName'] ) ) {
992  $params['controlName'] = 'config_' . $params['var'];
993  }
994 
995  if ( !isset( $params['value'] ) ) {
996  $params['value'] = $this->getVar( $params['var'] );
997  }
998 
999  $items = [];
1000 
1001  foreach ( $params['values'] as $value ) {
1002  $itemAttribs = [];
1003 
1004  if ( isset( $params['commonAttribs'] ) ) {
1005  $itemAttribs = $params['commonAttribs'];
1006  }
1007 
1008  if ( isset( $params['itemAttribs'][$value] ) ) {
1009  $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1010  }
1011 
1012  $checked = $value == $params['value'];
1013  $id = $params['controlName'] . '_' . $value;
1014  $itemAttribs['id'] = $id;
1015  $itemAttribs['tabindex'] = $this->nextTabIndex();
1016 
1017  $items[$value] =
1018  Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1019  "\u{00A0}" .
1020  Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1021  isset( $params['itemLabels'] ) ?
1022  wfMessage( $params['itemLabels'][$value] )->plain() :
1023  wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1024  ) );
1025  }
1026 
1027  return $items;
1028  }
1029 
1035  public function showStatusBox( $status ) {
1036  if ( !$status->isGood() ) {
1037  $text = $status->getWikiText();
1038 
1039  if ( $status->isOK() ) {
1040  $box = $this->getWarningBox( $text );
1041  } else {
1042  $box = $this->getErrorBox( $text );
1043  }
1044 
1045  $this->output->addHTML( $box );
1046  }
1047  }
1048 
1059  public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1060  $newValues = [];
1061 
1062  foreach ( $varNames as $name ) {
1063  $value = $this->request->getVal( $prefix . $name );
1064  // T32524, do not trim passwords
1065  if ( stripos( $name, 'password' ) === false ) {
1066  $value = trim( $value );
1067  }
1068  $newValues[$name] = $value;
1069 
1070  if ( $value === null ) {
1071  // Checkbox?
1072  $this->setVar( $name, false );
1073  } elseif ( stripos( $name, 'password' ) !== false ) {
1074  $this->setPassword( $name, $value );
1075  } else {
1076  $this->setVar( $name, $value );
1077  }
1078  }
1079 
1080  return $newValues;
1081  }
1082 
1090  protected function getDocUrl( $page ) {
1091  $query = [ 'page' => $page ];
1092 
1093  if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1094  $query['lastPage'] = $this->currentPageName;
1095  }
1096 
1097  return $this->getUrl( $query );
1098  }
1099 
1109  public function docLink( $linkText, $attribs, $parser ) {
1110  $url = $this->getDocUrl( $attribs['href'] );
1111 
1112  return Html::element( 'a', [ 'href' => $url ], $linkText );
1113  }
1114 
1124  public function downloadLinkHook( $text, $attribs, $parser ) {
1125  $anchor = Html::rawElement( 'a',
1126  [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1127  wfMessage( 'config-download-localsettings' )->parse()
1128  );
1129 
1130  return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1131  }
1132 
1143  public function getLocalSettingsLocation() {
1144  return false;
1145  }
1146 
1150  public function envCheckPath() {
1151  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1152  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1153  // to get the path to the current script... hopefully it's reliable. SIGH
1154  $path = false;
1155  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1156  $path = $_SERVER['PHP_SELF'];
1157  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1158  $path = $_SERVER['SCRIPT_NAME'];
1159  }
1160  if ( $path === false ) {
1161  $this->showError( 'config-no-uri' );
1162  return false;
1163  }
1164 
1165  return parent::envCheckPath();
1166  }
1167 
1168  public function envPrepPath() {
1169  parent::envPrepPath();
1170  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1171  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1172  // to get the path to the current script... hopefully it's reliable. SIGH
1173  $path = false;
1174  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1175  $path = $_SERVER['PHP_SELF'];
1176  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1177  $path = $_SERVER['SCRIPT_NAME'];
1178  }
1179  if ( $path !== false ) {
1180  $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1181 
1182  $this->setVar( 'wgScriptPath', "$scriptPath" );
1183  // Update variables set from Setup.php that are derived from wgScriptPath
1184  $this->setVar( 'wgScript', "$scriptPath/index.php" );
1185  $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1186  $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1187  $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1188  $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1189  $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1190  $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1191  }
1192  }
1193 
1197  protected function envGetDefaultServer() {
1198  return WebRequest::detectServer();
1199  }
1200 
1206  private function outputLS() {
1207  $this->request->response()->header( 'Content-type: application/x-httpd-php' );
1208  $this->request->response()->header(
1209  'Content-Disposition: attachment; filename="LocalSettings.php"'
1210  );
1211 
1213  $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
1214  foreach ( $rightsProfile as $group => $rightsArr ) {
1215  $ls->setGroupRights( $group, $rightsArr );
1216  }
1217  echo $ls->getText();
1218  }
1219 
1223  public function outputCss() {
1224  $this->request->response()->header( 'Content-type: text/css' );
1225  echo $this->output->getCSS();
1226  }
1227 
1231  public function getPhpErrors() {
1232  return $this->phpErrors;
1233  }
1234 
1235 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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:836
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
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3050
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:875
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:215
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:1815
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:728
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:790
getTextBox( $params)
Get a labelled text box to configure a variable.