MediaWiki  1.33.0
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 
378  public function showError( $msg /*...*/ ) {
379  if ( !( $msg instanceof Message ) ) {
380  $args = func_get_args();
381  array_shift( $args );
382  $args = array_map( 'htmlspecialchars', $args );
383  $msg = wfMessage( $msg, $args );
384  }
385  $text = $msg->useDatabase( false )->plain();
386  $this->output->addHTML( $this->getErrorBox( $text ) );
387  }
388 
395  public function errorHandler( $errno, $errstr ) {
396  $this->phpErrors[] = $errstr;
397  }
398 
404  public function finish() {
405  $this->output->output();
406 
407  $this->session['happyPages'] = $this->happyPages;
408  $this->session['skippedPages'] = $this->skippedPages;
409  $this->session['settings'] = $this->settings;
410 
411  return $this->session;
412  }
413 
417  public function reset() {
418  $this->session = [];
419  $this->happyPages = [];
420  $this->settings = [];
421  }
422 
430  public function getUrl( $query = [] ) {
431  $url = $this->request->getRequestURL();
432  # Remove existing query
433  $url = preg_replace( '/\?.*$/', '', $url );
434 
435  if ( $query ) {
436  $url .= '?' . wfArrayToCgi( $query );
437  }
438 
439  return $url;
440  }
441 
448  public function getPageByName( $pageName ) {
449  $pageClass = 'WebInstaller' . $pageName;
450 
451  return new $pageClass( $this );
452  }
453 
462  public function getSession( $name, $default = null ) {
463  return $this->session[$name] ?? $default;
464  }
465 
472  public function setSession( $name, $value ) {
473  $this->session[$name] = $value;
474  }
475 
481  public function nextTabIndex() {
482  return $this->tabIndex++;
483  }
484 
488  public function setupLanguage() {
490 
491  if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
492  $wgLanguageCode = $this->getAcceptLanguage();
493  $wgLang = Language::factory( $wgLanguageCode );
494  RequestContext::getMain()->setLanguage( $wgLang );
495  $this->setVar( 'wgLanguageCode', $wgLanguageCode );
496  $this->setVar( '_UserLang', $wgLanguageCode );
497  } else {
498  $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
499  }
500  $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
501  }
502 
508  public function getAcceptLanguage() {
509  global $wgLanguageCode, $wgRequest;
510 
511  $mwLanguages = Language::fetchLanguageNames( null, 'mwfile' );
512  $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
513 
514  foreach ( $headerLanguages as $lang ) {
515  if ( isset( $mwLanguages[$lang] ) ) {
516  return $lang;
517  }
518  }
519 
520  return $wgLanguageCode;
521  }
522 
528  private function startPageWrapper( $currentPageName ) {
529  $s = "<div class=\"config-page-wrapper\">\n";
530  $s .= "<div class=\"config-page\">\n";
531  $s .= "<div class=\"config-page-list\"><ul>\n";
532  $lastHappy = -1;
533 
534  foreach ( $this->pageSequence as $id => $pageName ) {
535  $happy = !empty( $this->happyPages[$id] );
536  $s .= $this->getPageListItem(
537  $pageName,
538  $happy || $lastHappy == $id - 1,
540  );
541 
542  if ( $happy ) {
543  $lastHappy = $id;
544  }
545  }
546 
547  $s .= "</ul><br/><ul>\n";
548  $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
549  // End list pane
550  $s .= "</ul></div>\n";
551 
552  // Messages:
553  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
554  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
555  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
556  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
557  $s .= Html::element( 'h2', [],
558  wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
559 
560  $this->output->addHTMLNoFlush( $s );
561  }
562 
572  private function getPageListItem( $pageName, $enabled, $currentPageName ) {
573  $s = "<li class=\"config-page-list-item\">";
574 
575  // Messages:
576  // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
577  // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
578  // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
579  // config-page-copying, config-page-upgradedoc, config-page-existingwiki
580  $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
581 
582  if ( $enabled ) {
583  $query = [ 'page' => $pageName ];
584 
585  if ( !in_array( $pageName, $this->pageSequence ) ) {
586  if ( in_array( $currentPageName, $this->pageSequence ) ) {
587  $query['lastPage'] = $currentPageName;
588  }
589 
590  $link = Html::element( 'a',
591  [
592  'href' => $this->getUrl( $query )
593  ],
594  $name
595  );
596  } else {
597  $link = htmlspecialchars( $name );
598  }
599 
600  if ( $pageName == $currentPageName ) {
601  $s .= "<span class=\"config-page-current\">$link</span>";
602  } else {
603  $s .= $link;
604  }
605  } else {
606  $s .= Html::element( 'span',
607  [
608  'class' => 'config-page-disabled'
609  ],
610  $name
611  );
612  }
613 
614  $s .= "</li>\n";
615 
616  return $s;
617  }
618 
622  private function endPageWrapper() {
623  $this->output->addHTMLNoFlush(
624  "<div class=\"visualClear\"></div>\n" .
625  "</div>\n" .
626  "<div class=\"visualClear\"></div>\n" .
627  "</div>" );
628  }
629 
637  public function getErrorBox( $text ) {
638  return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
639  }
640 
648  public function getWarningBox( $text ) {
649  return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
650  }
651 
661  public function getInfoBox( $text, $icon = false, $class = false ) {
662  $text = $this->parse( $text, true );
663  $icon = ( $icon == false ) ?
664  'images/info-32.png' :
665  'images/' . $icon;
666  $alt = wfMessage( 'config-information' )->text();
667 
668  return Html::infoBox( $text, $icon, $alt, $class );
669  }
670 
678  public function getHelpBox( $msg /*, ... */ ) {
679  $args = func_get_args();
680  array_shift( $args );
681  $args = array_map( 'htmlspecialchars', $args );
682  $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
683  $html = $this->parse( $text, true );
684 
685  return "<div class=\"config-help-field-container\">\n" .
686  "<span class=\"config-help-field-hint\" title=\"" .
687  wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
688  wfMessage( 'config-help' )->escaped() . "</span>\n" .
689  "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
690  "</div>\n";
691  }
692 
697  public function showHelpBox( $msg /*, ... */ ) {
698  $args = func_get_args();
699  $html = $this->getHelpBox( ...$args );
700  $this->output->addHTML( $html );
701  }
702 
709  public function showMessage( $msg /*, ... */ ) {
710  $args = func_get_args();
711  array_shift( $args );
712  $html = '<div class="config-message">' .
713  $this->parse( wfMessage( $msg, $args )->useDatabase( false )->plain() ) .
714  "</div>\n";
715  $this->output->addHTML( $html );
716  }
717 
721  public function showStatusMessage( Status $status ) {
722  $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
723  foreach ( $errors as $error ) {
724  $this->showMessage( ...$error );
725  }
726  }
727 
738  public function label( $msg, $forId, $contents, $helpData = "" ) {
739  if ( strval( $msg ) == '' ) {
740  $labelText = "\u{00A0}";
741  } else {
742  $labelText = wfMessage( $msg )->escaped();
743  }
744 
745  $attributes = [ 'class' => 'config-label' ];
746 
747  if ( $forId ) {
748  $attributes['for'] = $forId;
749  }
750 
751  return "<div class=\"config-block\">\n" .
752  " <div class=\"config-block-label\">\n" .
753  Xml::tags( 'label',
754  $attributes,
755  $labelText
756  ) . "\n" .
757  $helpData .
758  " </div>\n" .
759  " <div class=\"config-block-elements\">\n" .
760  $contents .
761  " </div>\n" .
762  "</div>\n";
763  }
764 
779  public function getTextBox( $params ) {
780  if ( !isset( $params['controlName'] ) ) {
781  $params['controlName'] = 'config_' . $params['var'];
782  }
783 
784  if ( !isset( $params['value'] ) ) {
785  $params['value'] = $this->getVar( $params['var'] );
786  }
787 
788  if ( !isset( $params['attribs'] ) ) {
789  $params['attribs'] = [];
790  }
791  if ( !isset( $params['help'] ) ) {
792  $params['help'] = "";
793  }
794 
795  return $this->label(
796  $params['label'],
797  $params['controlName'],
798  Xml::input(
799  $params['controlName'],
800  30, // intended to be overridden by CSS
801  $params['value'],
802  $params['attribs'] + [
803  'id' => $params['controlName'],
804  'class' => 'config-input-text',
805  'tabindex' => $this->nextTabIndex()
806  ]
807  ),
808  $params['help']
809  );
810  }
811 
826  public function getTextArea( $params ) {
827  if ( !isset( $params['controlName'] ) ) {
828  $params['controlName'] = 'config_' . $params['var'];
829  }
830 
831  if ( !isset( $params['value'] ) ) {
832  $params['value'] = $this->getVar( $params['var'] );
833  }
834 
835  if ( !isset( $params['attribs'] ) ) {
836  $params['attribs'] = [];
837  }
838  if ( !isset( $params['help'] ) ) {
839  $params['help'] = "";
840  }
841 
842  return $this->label(
843  $params['label'],
844  $params['controlName'],
846  $params['controlName'],
847  $params['value'],
848  30,
849  5,
850  $params['attribs'] + [
851  'id' => $params['controlName'],
852  'class' => 'config-input-text',
853  'tabindex' => $this->nextTabIndex()
854  ]
855  ),
856  $params['help']
857  );
858  }
859 
875  public function getPasswordBox( $params ) {
876  if ( !isset( $params['value'] ) ) {
877  $params['value'] = $this->getVar( $params['var'] );
878  }
879 
880  if ( !isset( $params['attribs'] ) ) {
881  $params['attribs'] = [];
882  }
883 
884  $params['value'] = $this->getFakePassword( $params['value'] );
885  $params['attribs']['type'] = 'password';
886 
887  return $this->getTextBox( $params );
888  }
889 
905  public function getCheckBox( $params ) {
906  if ( !isset( $params['controlName'] ) ) {
907  $params['controlName'] = 'config_' . $params['var'];
908  }
909 
910  if ( !isset( $params['value'] ) ) {
911  $params['value'] = $this->getVar( $params['var'] );
912  }
913 
914  if ( !isset( $params['attribs'] ) ) {
915  $params['attribs'] = [];
916  }
917  if ( !isset( $params['help'] ) ) {
918  $params['help'] = "";
919  }
920  if ( !isset( $params['labelAttribs'] ) ) {
921  $params['labelAttribs'] = [];
922  }
923  $labelText = $params['rawtext'] ?? $this->parse( wfMessage( $params['label'] )->plain() );
924 
925  return "<div class=\"config-input-check\">\n" .
926  $params['help'] .
927  Html::rawElement(
928  'label',
929  $params['labelAttribs'],
930  Xml::check(
931  $params['controlName'],
932  $params['value'],
933  $params['attribs'] + [
934  'id' => $params['controlName'],
935  'tabindex' => $this->nextTabIndex(),
936  ]
937  ) .
938  $labelText . "\n"
939  ) .
940  "</div>\n";
941  }
942 
962  public function getRadioSet( $params ) {
963  $items = $this->getRadioElements( $params );
964 
965  $label = $params['label'] ?? '';
966 
967  if ( !isset( $params['controlName'] ) ) {
968  $params['controlName'] = 'config_' . $params['var'];
969  }
970 
971  if ( !isset( $params['help'] ) ) {
972  $params['help'] = "";
973  }
974 
975  $s = "<ul>\n";
976  foreach ( $items as $value => $item ) {
977  $s .= "<li>$item</li>\n";
978  }
979  $s .= "</ul>\n";
980 
981  return $this->label( $label, $params['controlName'], $s, $params['help'] );
982  }
983 
992  public function getRadioElements( $params ) {
993  if ( !isset( $params['controlName'] ) ) {
994  $params['controlName'] = 'config_' . $params['var'];
995  }
996 
997  if ( !isset( $params['value'] ) ) {
998  $params['value'] = $this->getVar( $params['var'] );
999  }
1000 
1001  $items = [];
1002 
1003  foreach ( $params['values'] as $value ) {
1004  $itemAttribs = [];
1005 
1006  if ( isset( $params['commonAttribs'] ) ) {
1007  $itemAttribs = $params['commonAttribs'];
1008  }
1009 
1010  if ( isset( $params['itemAttribs'][$value] ) ) {
1011  $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1012  }
1013 
1014  $checked = $value == $params['value'];
1015  $id = $params['controlName'] . '_' . $value;
1016  $itemAttribs['id'] = $id;
1017  $itemAttribs['tabindex'] = $this->nextTabIndex();
1018 
1019  $items[$value] =
1020  Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1021  "\u{00A0}" .
1022  Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1023  isset( $params['itemLabels'] ) ?
1024  wfMessage( $params['itemLabels'][$value] )->plain() :
1025  wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1026  ) );
1027  }
1028 
1029  return $items;
1030  }
1031 
1037  public function showStatusBox( $status ) {
1038  if ( !$status->isGood() ) {
1039  $text = $status->getWikiText();
1040 
1041  if ( $status->isOK() ) {
1042  $box = $this->getWarningBox( $text );
1043  } else {
1044  $box = $this->getErrorBox( $text );
1045  }
1046 
1047  $this->output->addHTML( $box );
1048  }
1049  }
1050 
1061  public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1062  $newValues = [];
1063 
1064  foreach ( $varNames as $name ) {
1065  $value = $this->request->getVal( $prefix . $name );
1066  // T32524, do not trim passwords
1067  if ( stripos( $name, 'password' ) === false ) {
1068  $value = trim( $value );
1069  }
1070  $newValues[$name] = $value;
1071 
1072  if ( $value === null ) {
1073  // Checkbox?
1074  $this->setVar( $name, false );
1075  } elseif ( stripos( $name, 'password' ) !== false ) {
1076  $this->setPassword( $name, $value );
1077  } else {
1078  $this->setVar( $name, $value );
1079  }
1080  }
1081 
1082  return $newValues;
1083  }
1084 
1092  protected function getDocUrl( $page ) {
1093  $query = [ 'page' => $page ];
1094 
1095  if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1096  $query['lastPage'] = $this->currentPageName;
1097  }
1098 
1099  return $this->getUrl( $query );
1100  }
1101 
1111  public function docLink( $linkText, $attribs, $parser ) {
1112  $url = $this->getDocUrl( $attribs['href'] );
1113 
1114  return Html::element( 'a', [ 'href' => $url ], $linkText );
1115  }
1116 
1126  public function downloadLinkHook( $text, $attribs, $parser ) {
1127  $anchor = Html::rawElement( 'a',
1128  [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1129  wfMessage( 'config-download-localsettings' )->parse()
1130  );
1131 
1132  return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1133  }
1134 
1145  public function getLocalSettingsLocation() {
1146  return false;
1147  }
1148 
1152  public function envCheckPath() {
1153  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1154  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1155  // to get the path to the current script... hopefully it's reliable. SIGH
1156  $path = false;
1157  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1158  $path = $_SERVER['PHP_SELF'];
1159  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1160  $path = $_SERVER['SCRIPT_NAME'];
1161  }
1162  if ( $path === false ) {
1163  $this->showError( 'config-no-uri' );
1164  return false;
1165  }
1166 
1167  return parent::envCheckPath();
1168  }
1169 
1170  public function envPrepPath() {
1171  parent::envPrepPath();
1172  // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1173  // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1174  // to get the path to the current script... hopefully it's reliable. SIGH
1175  $path = false;
1176  if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1177  $path = $_SERVER['PHP_SELF'];
1178  } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1179  $path = $_SERVER['SCRIPT_NAME'];
1180  }
1181  if ( $path !== false ) {
1182  $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1183 
1184  $this->setVar( 'wgScriptPath', "$scriptPath" );
1185  // Update variables set from Setup.php that are derived from wgScriptPath
1186  $this->setVar( 'wgScript', "$scriptPath/index.php" );
1187  $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1188  $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1189  $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1190  $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1191  $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1192  $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1193  }
1194  }
1195 
1199  protected function envGetDefaultServer() {
1200  return WebRequest::detectServer();
1201  }
1202 
1208  private function outputLS() {
1209  $this->request->response()->header( 'Content-type: application/x-httpd-php' );
1210  $this->request->response()->header(
1211  'Content-Disposition: attachment; filename="LocalSettings.php"'
1212  );
1213 
1215  $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
1216  foreach ( $rightsProfile as $group => $rightsArr ) {
1217  $ls->setGroupRights( $group, $rightsArr );
1218  }
1219  echo $ls->getText();
1220  }
1221 
1225  public function outputCss() {
1226  $this->request->response()->header( 'Content-type: text/css' );
1227  echo $this->output->getCSS();
1228  }
1229 
1233  public function getPhpErrors() {
1234  return $this->phpErrors;
1235  }
1236 
1237 }
WebInstaller\getAcceptLanguage
getAcceptLanguage()
Retrieves MediaWiki language from Accept-Language HTTP header.
Definition: WebInstaller.php:508
$status
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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1266
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
WebInstaller\getHelpBox
getHelpBox( $msg)
Get small text indented help for a preceding form field.
Definition: WebInstaller.php:678
Installer\parse
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
Definition: Installer.php:688
WebInstaller\startPageWrapper
startPageWrapper( $currentPageName)
Called by execute() before page output starts, to show a page list.
Definition: WebInstaller.php:528
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
WebInstaller\getRadioElements
getRadioElements( $params)
Get a set of labelled radio buttons.
Definition: WebInstaller.php:992
WebInstaller\label
label( $msg, $forId, $contents, $helpData="")
Label a control by wrapping a config-input div around it and putting a label before it.
Definition: WebInstaller.php:738
WebInstaller\getPageListItem
getPageListItem( $pageName, $enabled, $currentPageName)
Get a list item for the page list.
Definition: WebInstaller.php:572
captcha-old.count
count
Definition: captcha-old.py:249
WebInstaller\startSession
startSession()
Start the PHP session.
Definition: WebInstaller.php:321
WebInstaller\$showSessionWarning
bool $showSessionWarning
Flag indicating that session data may have been lost.
Definition: WebInstaller.php:118
WebInstaller\showStatusMessage
showStatusMessage(Status $status)
Definition: WebInstaller.php:721
WebInstaller\$pageSequence
string[] $pageSequence
The main sequence of page names.
Definition: WebInstaller.php:70
WebInstaller\$session
array[] $session
Cached session array.
Definition: WebInstaller.php:51
$result
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:1983
WebInstaller\setupLanguage
setupLanguage()
Initializes language-related variables.
Definition: WebInstaller.php:488
WebInstaller\getCheckBox
getCheckBox( $params)
Get a labelled checkbox to configure a boolean variable.
Definition: WebInstaller.php:905
WebInstaller
Class for the core installer web interface.
Definition: WebInstaller.php:32
Xml\textarea
static textarea( $name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
Definition: Xml.php:635
Xml\radio
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
Definition: Xml.php:341
Installer\$settings
array $settings
Definition: Installer.php:59
WebInstaller\getWarningBox
getWarningBox( $text)
Get HTML for a warning box with an icon.
Definition: WebInstaller.php:648
$params
$params
Definition: styleTest.css.php:44
WebInstaller\$tabIndex
int $tabIndex
Numeric index of the page we're on.
Definition: WebInstaller.php:125
WebInstaller\showHelpBox
showHelpBox( $msg)
Output a help box.
Definition: WebInstaller.php:697
$s
$s
Definition: mergeMessageFileList.php:186
WebInstaller\getPageByName
getPageByName( $pageName)
Get a WebInstallerPage by name.
Definition: WebInstaller.php:448
Installer\setPassword
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:641
serialize
serialize()
Definition: ApiMessageTrait.php:134
request
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:2162
WebInstaller\__construct
__construct(WebRequest $request)
Definition: WebInstaller.php:137
WebInstaller\$happyPages
bool[] $happyPages
Array of pages which have declared that they have been submitted, have validated their input,...
Definition: WebInstaller.php:102
WebInstaller\showStatusBox
showStatusBox( $status)
Output an error or warning box using a Status object.
Definition: WebInstaller.php:1037
WebInstaller\getLowestUnhappy
getLowestUnhappy()
Find the next page in sequence that hasn't been completed.
Definition: WebInstaller.php:307
php
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
Installer\setVar
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:525
WebInstaller\getInfoBox
getInfoBox( $text, $icon=false, $class=false)
Get HTML for an info box with an icon.
Definition: WebInstaller.php:661
WebInstallerOutput
Output class modelled on OutputPage.
Definition: WebInstallerOutput.php:38
WebInstaller\$output
WebInstallerOutput $output
Definition: WebInstaller.php:37
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
WebInstaller\getRadioSet
getRadioSet( $params)
Get a set of labelled radio buttons.
Definition: WebInstaller.php:962
WebInstaller\showMessage
showMessage( $msg)
Show a short informational message.
Definition: WebInstaller.php:709
Installer\getFakePassword
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
Definition: Installer.php:630
$query
null for the 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:1588
$html
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:1985
WebInstaller\getTextArea
getTextArea( $params)
Get a labelled textarea to configure a variable.
Definition: WebInstaller.php:826
WebInstaller\setSession
setSession( $name, $value)
Set a session variable.
Definition: WebInstaller.php:472
WebInstaller\$request
WebRequest $request
WebRequest object.
Definition: WebInstaller.php:44
WebInstaller\execute
execute(array $session)
Main entry point.
Definition: WebInstaller.php:155
WebInstaller\nextTabIndex
nextTabIndex()
Get the next tabindex attribute value.
Definition: WebInstaller.php:481
WebInstaller\$skippedPages
bool[] $skippedPages
List of "skipped" pages.
Definition: WebInstaller.php:111
WebInstaller\errorHandler
errorHandler( $errno, $errstr)
Temporary error handler for session start debugging.
Definition: WebInstaller.php:395
Xml\check
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:323
$wgLang
$wgLang
Definition: Setup.php:875
$attribs
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:1985
WebInstaller\getFingerprint
getFingerprint()
Get a hash of data identifying this MW installation.
Definition: WebInstaller.php:353
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$parser
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1802
InstallerOverrides\getLocalSettingsGenerator
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
Definition: InstallerOverrides.php:50
WebInstaller\outputLS
outputLS()
Actually output LocalSettings.php for download.
Definition: WebInstaller.php:1208
WebInstaller\downloadLinkHook
downloadLinkHook( $text, $attribs, $parser)
Helper for "Download LocalSettings" link on WebInstall_Complete.
Definition: WebInstaller.php:1126
settings
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
Installer\getVar
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:539
array
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))
WebInstaller\$phpErrors
string[] $phpErrors
Captured PHP error text.
Definition: WebInstaller.php:58
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
WebInstaller\$otherPages
string[] $otherPages
Out of sequence pages, selectable by the user at any time.
Definition: WebInstaller.php:88
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2162
WebInstaller\$currentPageName
string $currentPageName
Name of the page we're on.
Definition: WebInstaller.php:132
$value
$value
Definition: styleTest.css.php:49
WebInstaller\envCheckPath
envCheckPath()
Definition: WebInstaller.php:1152
WebInstaller\getPasswordBox
getPasswordBox( $params)
Get a labelled password box to configure a variable.
Definition: WebInstaller.php:875
Xml\tags
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
$wgLanguageCode
$wgLanguageCode
Site language code.
Definition: DefaultSettings.php:2912
WebInstaller\reset
reset()
We're restarting the installation, reset the session, happyPages, etc.
Definition: WebInstaller.php:417
WebInstaller\setVarsFromRequest
setVarsFromRequest( $varNames, $prefix='config_')
Convenience function to set variables based on form data.
Definition: WebInstaller.php:1061
WebInstaller\outputCss
outputCss()
Output stylesheet for web installer pages.
Definition: WebInstaller.php:1225
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:430
wfIniGetBool
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
Definition: GlobalFunctions.php:2104
plain
either a plain
Definition: hooks.txt:2046
WebInstaller\endPageWrapper
endPageWrapper()
Output some stuff after a page is finished.
Definition: WebInstaller.php:622
WebInstaller\showError
showError( $msg)
Show an error message in a box.
Definition: WebInstaller.php:378
WebInstaller\getLocalSettingsLocation
getLocalSettingsLocation()
If the software package wants the LocalSettings.php file to be placed in a specific location,...
Definition: WebInstaller.php:1145
WebInstaller\getErrorBox
getErrorBox( $text)
Get HTML for an error box with an icon.
Definition: WebInstaller.php:637
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:41
WebInstaller\envPrepPath
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
Definition: WebInstaller.php:1170
WebInstaller\docLink
docLink( $linkText, $attribs, $parser)
Extension tag hook for a documentation link.
Definition: WebInstaller.php:1111
WebInstaller\envGetDefaultServer
envGetDefaultServer()
Definition: WebInstaller.php:1199
text
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
Definition: All_system_messages.txt:1267
$args
if( $line===false) $args
Definition: cdb.php:64
WebInstaller\getPhpErrors
getPhpErrors()
Definition: WebInstaller.php:1233
$path
$path
Definition: NoLocalSettings.php:25
as
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
WebInstaller\getDocUrl
getDocUrl( $page)
Helper for Installer::docLink()
Definition: WebInstaller.php:1092
WebRequest\detectServer
static detectServer()
Work out an appropriate URL prefix containing scheme and host, based on information detected from $_S...
Definition: WebRequest.php:200
Installer\disableTimeLimit
disableTimeLimit()
Disable the time limit for execution.
Definition: Installer.php:1813
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3053
WebInstaller\getTextBox
getTextBox( $params)
Get a labelled text box to configure a variable.
Definition: WebInstaller.php:779
Installer
Base installer class.
Definition: Installer.php:46
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:215
Xml\input
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:728
captcha-old.output
output
Definition: captcha-old.py:240
MediaWikiServices
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
Language\fetchLanguageNames
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:836
wfMessage
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
WebInstaller\getSession
getSession( $name, $default=null)
Get a session variable.
Definition: WebInstaller.php:462
$wgContLang
$wgContLang
Definition: Setup.php:790
WebInstaller\finish
finish()
Clean up from execute()
Definition: WebInstaller.php:404
$GLOBALS
$GLOBALS['IP']
Definition: ComposerHookHandler.php:6
WebInstaller\getUrl
getUrl( $query=[])
Get a URL for submission back to the same script.
Definition: WebInstaller.php:430
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:371