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 
157  public function execute( array $session ) {
158  $this->session = $session;
159 
160  if ( isset( $session['settings'] ) ) {
161  $this->settings = $session['settings'] + $this->settings;
162  // T187586 MediaWikiServices works with globals
163  foreach ( $this->settings as $key => $val ) {
164  $GLOBALS[$key] = $val;
165  }
166  }
167 
168  $this->setupLanguage();
169 
170  if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
171  && $this->request->getVal( 'localsettings' )
172  ) {
173  $this->outputLS();
174  return $this->session;
175  }
176 
177  $isCSS = $this->request->getVal( 'css' );
178  if ( $isCSS ) {
179  $this->outputCss();
180  return $this->session;
181  }
182 
183  $this->happyPages = $session['happyPages'] ?? [];
184 
185  $this->skippedPages = $session['skippedPages'] ?? [];
186 
187  $lowestUnhappy = $this->getLowestUnhappy();
188 
189  # Special case for Creative Commons partner chooser box.
190  if ( $this->request->getVal( 'SubmitCC' ) ) {
191  $page = $this->getPageByName( 'Options' );
192  $this->output->useShortHeader();
193  $this->output->allowFrames();
194  $page->submitCC();
195 
196  return $this->finish();
197  }
198 
199  if ( $this->request->getVal( 'ShowCC' ) ) {
200  $page = $this->getPageByName( 'Options' );
201  $this->output->useShortHeader();
202  $this->output->allowFrames();
203  $this->output->addHTML( $page->getCCDoneBox() );
204 
205  return $this->finish();
206  }
207 
208  # Get the page name.
209  $pageName = $this->request->getVal( 'page' );
210 
211  if ( in_array( $pageName, $this->otherPages ) ) {
212  # Out of sequence
213  $pageId = false;
214  $page = $this->getPageByName( $pageName );
215  } else {
216  # Main sequence
217  if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
218  $pageId = $lowestUnhappy;
219  } else {
220  $pageId = array_search( $pageName, $this->pageSequence );
221  }
222 
223  # If necessary, move back to the lowest-numbered unhappy page
224  if ( $pageId > $lowestUnhappy ) {
225  $pageId = $lowestUnhappy;
226  if ( $lowestUnhappy == 0 ) {
227  # Knocked back to start, possible loss of session data.
228  $this->showSessionWarning = true;
229  }
230  }
231 
232  $pageName = $this->pageSequence[$pageId];
233  $page = $this->getPageByName( $pageName );
234  }
235 
236  # If a back button was submitted, go back without submitting the form data.
237  if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
238  if ( $this->request->getVal( 'lastPage' ) ) {
239  $nextPage = $this->request->getVal( 'lastPage' );
240  } elseif ( $pageId !== false ) {
241  # Main sequence page
242  # Skip the skipped pages
243  $nextPageId = $pageId;
244 
245  do {
246  $nextPageId--;
247  $nextPage = $this->pageSequence[$nextPageId];
248  } while ( isset( $this->skippedPages[$nextPage] ) );
249  } else {
250  $nextPage = $this->pageSequence[$lowestUnhappy];
251  }
252 
253  $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
254 
255  return $this->finish();
256  }
257 
258  # Execute the page.
259  $this->currentPageName = $page->getName();
260  $this->startPageWrapper( $pageName );
261 
262  if ( $page->isSlow() ) {
263  $this->disableTimeLimit();
264  }
265 
266  $result = $page->execute();
267 
268  $this->endPageWrapper();
269 
270  if ( $result == 'skip' ) {
271  # Page skipped without explicit submission.
272  # Skip it when we click "back" so that we don't just go forward again.
273  $this->skippedPages[$pageName] = true;
274  $result = 'continue';
275  } else {
276  unset( $this->skippedPages[$pageName] );
277  }
278 
279  # If it was posted, the page can request a continue to the next page.
280  if ( $result === 'continue' && !$this->output->headerDone() ) {
281  if ( $pageId !== false ) {
282  $this->happyPages[$pageId] = true;
283  }
284 
285  $lowestUnhappy = $this->getLowestUnhappy();
286 
287  if ( $this->request->getVal( 'lastPage' ) ) {
288  $nextPage = $this->request->getVal( 'lastPage' );
289  } elseif ( $pageId !== false ) {
290  $nextPage = $this->pageSequence[$pageId + 1];
291  } else {
292  $nextPage = $this->pageSequence[$lowestUnhappy];
293  }
294 
295  if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
296  $nextPage = $this->pageSequence[$lowestUnhappy];
297  }
298 
299  $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
300  }
301 
302  return $this->finish();
303  }
304 
309  public function getLowestUnhappy() {
310  if ( count( $this->happyPages ) == 0 ) {
311  return 0;
312  } else {
313  return max( array_keys( $this->happyPages ) ) + 1;
314  }
315  }
316 
323  public function startSession() {
324  if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
325  // Done already
326  return true;
327  }
328 
329  $this->phpErrors = [];
330  set_error_handler( [ $this, 'errorHandler' ] );
331  try {
332  session_name( 'mw_installer_session' );
333  session_start();
334  } catch ( Exception $e ) {
335  restore_error_handler();
336  throw $e;
337  }
338  restore_error_handler();
339 
340  if ( $this->phpErrors ) {
341  return false;
342  }
343 
344  return true;
345  }
346 
355  public function getFingerprint() {
356  // Get the base URL of the installation
357  $url = $this->request->getFullRequestURL();
358  if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
359  // Trim query string
360  $url = $m[1];
361  }
362  if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
363  // This... seems to try to get the base path from
364  // the /mw-config/index.php. Kinda scary though?
365  $url = $m[1];
366  }
367 
368  return md5( serialize( [
369  'local path' => dirname( __DIR__ ),
370  'url' => $url,
371  'version' => $GLOBALS['wgVersion']
372  ] ) );
373  }
374 
381  public function showError( $msg, ...$params ) {
382  if ( !( $msg instanceof Message ) ) {
383  $msg = wfMessage(
384  $msg,
385  array_map( 'htmlspecialchars', $params )
386  );
387  }
388  $text = $msg->useDatabase( false )->plain();
389  $this->output->addHTML( $this->getErrorBox( $text ) );
390  }
391 
398  public function errorHandler( $errno, $errstr ) {
399  $this->phpErrors[] = $errstr;
400  }
401 
407  public function finish() {
408  $this->output->output();
409 
410  $this->session['happyPages'] = $this->happyPages;
411  $this->session['skippedPages'] = $this->skippedPages;
412  $this->session['settings'] = $this->settings;
413 
414  return $this->session;
415  }
416 
420  public function reset() {
421  $this->session = [];
422  $this->happyPages = [];
423  $this->settings = [];
424  }
425 
433  public function getUrl( $query = [] ) {
434  $url = $this->request->getRequestURL();
435  # Remove existing query
436  $url = preg_replace( '/\?.*$/', '', $url );
437 
438  if ( $query ) {
439  $url .= '?' . wfArrayToCgi( $query );
440  }
441 
442  return $url;
443  }
444 
451  public function getPageByName( $pageName ) {
452  $pageClass = 'WebInstaller' . $pageName;
453 
454  return new $pageClass( $this );
455  }
456 
465  public function getSession( $name, $default = null ) {
466  return $this->session[$name] ?? $default;
467  }
468 
475  public function setSession( $name, $value ) {
476  $this->session[$name] = $value;
477  }
478 
484  public function nextTabIndex() {
485  return $this->tabIndex++;
486  }
487 
491  public function setupLanguage() {
493 
494  if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
495  $wgLanguageCode = $this->getAcceptLanguage();
496  $wgLang = Language::factory( $wgLanguageCode );
497  RequestContext::getMain()->setLanguage( $wgLang );
498  $this->setVar( 'wgLanguageCode', $wgLanguageCode );
499  $this->setVar( '_UserLang', $wgLanguageCode );
500  } else {
501  $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
502  }
503  $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
504  }
505 
511  public function getAcceptLanguage() {
512  global $wgLanguageCode, $wgRequest;
513 
514  $mwLanguages = Language::fetchLanguageNames( null, 'mwfile' );
515  $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
516 
517  foreach ( $headerLanguages as $lang ) {
518  if ( isset( $mwLanguages[$lang] ) ) {
519  return $lang;
520  }
521  }
522 
523  return $wgLanguageCode;
524  }
525 
531  private function startPageWrapper( $currentPageName ) {
532  $s = "<div class=\"config-page-wrapper\">\n";
533  $s .= "<div class=\"config-page\">\n";
534  $s .= "<div class=\"config-page-list\"><ul>\n";
535  $lastHappy = -1;
536 
537  foreach ( $this->pageSequence as $id => $pageName ) {
538  $happy = !empty( $this->happyPages[$id] );
539  $s .= $this->getPageListItem(
540  $pageName,
541  $happy || $lastHappy == $id - 1,
543  );
544 
545  if ( $happy ) {
546  $lastHappy = $id;
547  }
548  }
549 
550  $s .= "</ul><br/><ul>\n";
551  $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
552  // End list pane
553  $s .= "</ul></div>\n";
554 
555  // Messages:
556  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
557  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
558  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
559  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
560  $s .= Html::element( 'h2', [],
561  wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
562 
563  $this->output->addHTMLNoFlush( $s );
564  }
565 
575  private function getPageListItem( $pageName, $enabled, $currentPageName ) {
576  $s = "<li class=\"config-page-list-item\">";
577 
578  // Messages:
579  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
580  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
581  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
582  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
583  $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
584 
585  if ( $enabled ) {
586  $query = [ 'page' => $pageName ];
587 
588  if ( !in_array( $pageName, $this->pageSequence ) ) {
589  if ( in_array( $currentPageName, $this->pageSequence ) ) {
590  $query['lastPage'] = $currentPageName;
591  }
592 
593  $link = Html::element( 'a',
594  [
595  'href' => $this->getUrl( $query )
596  ],
597  $name
598  );
599  } else {
600  $link = htmlspecialchars( $name );
601  }
602 
603  if ( $pageName == $currentPageName ) {
604  $s .= "<span class=\"config-page-current\">$link</span>";
605  } else {
606  $s .= $link;
607  }
608  } else {
609  $s .= Html::element( 'span',
610  [
611  'class' => 'config-page-disabled'
612  ],
613  $name
614  );
615  }
616 
617  $s .= "</li>\n";
618 
619  return $s;
620  }
621 
625  private function endPageWrapper() {
626  $this->output->addHTMLNoFlush(
627  "<div class=\"visualClear\"></div>\n" .
628  "</div>\n" .
629  "<div class=\"visualClear\"></div>\n" .
630  "</div>" );
631  }
632 
640  public function getErrorBox( $text ) {
641  return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
642  }
643 
651  public function getWarningBox( $text ) {
652  return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
653  }
654 
663  public function getInfoBox( $text, $icon = false, $class = false ) {
664  $html = ( $text instanceof HtmlArmor ) ?
665  HtmlArmor::getHtml( $text ) :
666  $this->parse( $text, true );
667  $icon = ( $icon == false ) ?
668  'images/info-32.png' :
669  'images/' . $icon;
670  $alt = wfMessage( 'config-information' )->text();
671 
672  return Html::infoBox( $html, $icon, $alt, $class );
673  }
674 
682  public function getHelpBox( $msg, ...$args ) {
683  $args = array_map( 'htmlspecialchars', $args );
684  $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
685  $html = $this->parse( $text, true );
686  $id = 'helpBox-' . $this->helpBoxId++;
687 
688  return "<div class=\"config-help-field-container\">\n" .
689  "<input type=\"checkbox\" class=\"config-help-field-checkbox\" id=\"$id\" />" .
690  "<label class=\"config-help-field-hint\" for=\"$id\" title=\"" .
691  wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
692  wfMessage( 'config-help' )->escaped() . "</label>\n" .
693  "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
694  "</div>\n";
695  }
696 
702  public function showHelpBox( $msg, ...$params ) {
703  $html = $this->getHelpBox( $msg, ...$params );
704  $this->output->addHTML( $html );
705  }
706 
714  public function showMessage( $msg, ...$params ) {
715  $html = '<div class="config-message">' .
716  $this->parse( wfMessage( $msg, $params )->useDatabase( false )->plain() ) .
717  "</div>\n";
718  $this->output->addHTML( $html );
719  }
720 
724  public function showStatusMessage( Status $status ) {
725  $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
726  foreach ( $errors as $error ) {
727  $this->showMessage( ...$error );
728  }
729  }
730 
741  public function label( $msg, $forId, $contents, $helpData = "" ) {
742  if ( strval( $msg ) == '' ) {
743  $labelText = "\u{00A0}";
744  } else {
745  $labelText = wfMessage( $msg )->escaped();
746  }
747 
748  $attributes = [ 'class' => 'config-label' ];
749 
750  if ( $forId ) {
751  $attributes['for'] = $forId;
752  }
753 
754  return "<div class=\"config-block\">\n" .
755  " <div class=\"config-block-label\">\n" .
756  Xml::tags( 'label',
757  $attributes,
758  $labelText
759  ) . "\n" .
760  $helpData .
761  " </div>\n" .
762  " <div class=\"config-block-elements\">\n" .
763  $contents .
764  " </div>\n" .
765  "</div>\n";
766  }
767 
782  public function getTextBox( $params ) {
783  if ( !isset( $params['controlName'] ) ) {
784  $params['controlName'] = 'config_' . $params['var'];
785  }
786 
787  if ( !isset( $params['value'] ) ) {
788  $params['value'] = $this->getVar( $params['var'] );
789  }
790 
791  if ( !isset( $params['attribs'] ) ) {
792  $params['attribs'] = [];
793  }
794  if ( !isset( $params['help'] ) ) {
795  $params['help'] = "";
796  }
797 
798  return $this->label(
799  $params['label'],
800  $params['controlName'],
801  Xml::input(
802  $params['controlName'],
803  30, // intended to be overridden by CSS
804  $params['value'],
805  $params['attribs'] + [
806  'id' => $params['controlName'],
807  'class' => 'config-input-text',
808  'tabindex' => $this->nextTabIndex()
809  ]
810  ),
811  $params['help']
812  );
813  }
814 
829  public function getTextArea( $params ) {
830  if ( !isset( $params['controlName'] ) ) {
831  $params['controlName'] = 'config_' . $params['var'];
832  }
833 
834  if ( !isset( $params['value'] ) ) {
835  $params['value'] = $this->getVar( $params['var'] );
836  }
837 
838  if ( !isset( $params['attribs'] ) ) {
839  $params['attribs'] = [];
840  }
841  if ( !isset( $params['help'] ) ) {
842  $params['help'] = "";
843  }
844 
845  return $this->label(
846  $params['label'],
847  $params['controlName'],
849  $params['controlName'],
850  $params['value'],
851  30,
852  5,
853  $params['attribs'] + [
854  'id' => $params['controlName'],
855  'class' => 'config-input-text',
856  'tabindex' => $this->nextTabIndex()
857  ]
858  ),
859  $params['help']
860  );
861  }
862 
878  public function getPasswordBox( $params ) {
879  if ( !isset( $params['value'] ) ) {
880  $params['value'] = $this->getVar( $params['var'] );
881  }
882 
883  if ( !isset( $params['attribs'] ) ) {
884  $params['attribs'] = [];
885  }
886 
887  $params['value'] = $this->getFakePassword( $params['value'] );
888  $params['attribs']['type'] = 'password';
889 
890  return $this->getTextBox( $params );
891  }
892 
908  public function getCheckBox( $params ) {
909  if ( !isset( $params['controlName'] ) ) {
910  $params['controlName'] = 'config_' . $params['var'];
911  }
912 
913  if ( !isset( $params['value'] ) ) {
914  $params['value'] = $this->getVar( $params['var'] );
915  }
916 
917  if ( !isset( $params['attribs'] ) ) {
918  $params['attribs'] = [];
919  }
920  if ( !isset( $params['help'] ) ) {
921  $params['help'] = "";
922  }
923  if ( !isset( $params['labelAttribs'] ) ) {
924  $params['labelAttribs'] = [];
925  }
926  $labelText = $params['rawtext'] ?? $this->parse( wfMessage( $params['label'] )->plain() );
927 
928  return "<div class=\"config-input-check\">\n" .
929  $params['help'] .
931  'label',
932  $params['labelAttribs'],
933  Xml::check(
934  $params['controlName'],
935  $params['value'],
936  $params['attribs'] + [
937  'id' => $params['controlName'],
938  'tabindex' => $this->nextTabIndex(),
939  ]
940  ) .
941  $labelText . "\n"
942  ) .
943  "</div>\n";
944  }
945 
965  public function getRadioSet( $params ) {
966  $items = $this->getRadioElements( $params );
967 
968  $label = $params['label'] ?? '';
969 
970  if ( !isset( $params['controlName'] ) ) {
971  $params['controlName'] = 'config_' . $params['var'];
972  }
973 
974  if ( !isset( $params['help'] ) ) {
975  $params['help'] = "";
976  }
977 
978  $s = "<ul>\n";
979  foreach ( $items as $value => $item ) {
980  $s .= "<li>$item</li>\n";
981  }
982  $s .= "</ul>\n";
983 
984  return $this->label( $label, $params['controlName'], $s, $params['help'] );
985  }
986 
995  public function getRadioElements( $params ) {
996  if ( !isset( $params['controlName'] ) ) {
997  $params['controlName'] = 'config_' . $params['var'];
998  }
999 
1000  if ( !isset( $params['value'] ) ) {
1001  $params['value'] = $this->getVar( $params['var'] );
1002  }
1003 
1004  $items = [];
1005 
1006  foreach ( $params['values'] as $value ) {
1007  $itemAttribs = [];
1008 
1009  if ( isset( $params['commonAttribs'] ) ) {
1010  $itemAttribs = $params['commonAttribs'];
1011  }
1012 
1013  if ( isset( $params['itemAttribs'][$value] ) ) {
1014  $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1015  }
1016 
1017  $checked = $value == $params['value'];
1018  $id = $params['controlName'] . '_' . $value;
1019  $itemAttribs['id'] = $id;
1020  $itemAttribs['tabindex'] = $this->nextTabIndex();
1021 
1022  $items[$value] =
1023  Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1024  "\u{00A0}" .
1025  Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1026  isset( $params['itemLabels'] ) ?
1027  wfMessage( $params['itemLabels'][$value] )->plain() :
1028  wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1029  ) );
1030  }
1031 
1032  return $items;
1033  }
1034 
1040  public function showStatusBox( $status ) {
1041  if ( !$status->isGood() ) {
1042  $text = $status->getWikiText();
1043 
1044  if ( $status->isOK() ) {
1045  $box = $this->getWarningBox( $text );
1046  } else {
1047  $box = $this->getErrorBox( $text );
1048  }
1049 
1050  $this->output->addHTML( $box );
1051  }
1052  }
1053 
1064  public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1065  $newValues = [];
1066 
1067  foreach ( $varNames as $name ) {
1068  $value = $this->request->getVal( $prefix . $name );
1069  // T32524, do not trim passwords
1070  if ( stripos( $name, 'password' ) === false ) {
1071  $value = trim( $value );
1072  }
1073  $newValues[$name] = $value;
1074 
1075  if ( $value === null ) {
1076  // Checkbox?
1077  $this->setVar( $name, false );
1078  } elseif ( stripos( $name, 'password' ) !== false ) {
1079  $this->setPassword( $name, $value );
1080  } else {
1081  $this->setVar( $name, $value );
1082  }
1083  }
1084 
1085  return $newValues;
1086  }
1087 
1095  public function getDocUrl( $page ) {
1096  $query = [ 'page' => $page ];
1097 
1098  if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1099  $query['lastPage'] = $this->currentPageName;
1100  }
1101 
1102  return $this->getUrl( $query );
1103  }
1104 
1113  public function makeLinkItem( $url, $linkText ) {
1114  return Html::rawElement( 'li', [],
1115  Html::element( 'a', [ 'href' => $url ], $linkText )
1116  );
1117  }
1118 
1125  public function makeDownloadLinkHtml() {
1126  $anchor = Html::rawElement( 'a',
1127  [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1128  wfMessage( 'config-download-localsettings' )->parse()
1129  );
1130 
1131  return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1132  }
1133 
1144  public function getLocalSettingsLocation() {
1145  return false;
1146  }
1147 
1151  public function envCheckPath() {
1152  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1153  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1154  // to get the path to the current script... hopefully it's reliable. SIGH
1155  $path = false;
1156  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1157  $path = $_SERVER['PHP_SELF'];
1158  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1159  $path = $_SERVER['SCRIPT_NAME'];
1160  }
1161  if ( $path === false ) {
1162  $this->showError( 'config-no-uri' );
1163  return false;
1164  }
1165 
1166  return parent::envCheckPath();
1167  }
1168 
1169  public function envPrepPath() {
1170  parent::envPrepPath();
1171  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1172  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1173  // to get the path to the current script... hopefully it's reliable. SIGH
1174  $path = false;
1175  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1176  $path = $_SERVER['PHP_SELF'];
1177  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1178  $path = $_SERVER['SCRIPT_NAME'];
1179  }
1180  if ( $path !== false ) {
1181  $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1182 
1183  $this->setVar( 'wgScriptPath', "$scriptPath" );
1184  // Update variables set from Setup.php that are derived from wgScriptPath
1185  $this->setVar( 'wgScript', "$scriptPath/index.php" );
1186  $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1187  $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1188  $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1189  $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1190  $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1191  $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1192  }
1193  }
1194 
1198  protected function envGetDefaultServer() {
1199  return WebRequest::detectServer();
1200  }
1201 
1207  private function outputLS() {
1208  $this->request->response()->header( 'Content-type: application/x-httpd-php' );
1209  $this->request->response()->header(
1210  'Content-Disposition: attachment; filename="LocalSettings.php"'
1211  );
1212 
1214  $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
1215  foreach ( $rightsProfile as $group => $rightsArr ) {
1216  $ls->setGroupRights( $group, $rightsArr );
1217  }
1218  echo $ls->getText();
1219  }
1220 
1224  public function outputCss() {
1225  $this->request->response()->header( 'Content-type: text/css' );
1226  echo $this->output->getCSS();
1227  }
1228 
1232  public function getPhpErrors() {
1233  return $this->phpErrors;
1234  }
1235 
1236 }
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1983
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:815
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1535
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
either a plain
Definition: hooks.txt:2044
getWarningBox( $text)
Get HTML for a warning box with an icon.
int $tabIndex
Numeric index of the page we&#39;re on.
static getHtml( $input)
Provide a string or HtmlArmor object and get safe HTML back.
Definition: HtmlArmor.php:50
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:193
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:2158
__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:209
getInfoBox( $text, $icon=false, $class=false)
Get HTML for an information message 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.
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:644
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. '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:1981
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: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:1250
$wgLang
Definition: Setup.php:922
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.
makeDownloadLinkHtml()
Helper for "Download LocalSettings" link.
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:633
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:542
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:773
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:1824
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:2158
$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 WebInstallerOutput.
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:691
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.
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.
static infoBox( $rawHtml, $icon, $alt, $class='')
Get HTML for an information message box with an icon.
Definition: Html.php:1015
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.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:277
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:776
getAcceptLanguage()
Retrieves MediaWiki language from Accept-Language HTTP header.
reset()
We&#39;re restarting the installation, reset the session, happyPages, etc.
makeLinkItem( $url, $linkText)
Helper for sidebar links.
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:528
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
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:837
getTextBox( $params)
Get a labelled text box to configure a variable.