3 * Core installer web interface.
10 * Class for the core installer web interface.
16 WebInstaller
extends Installer
{
19 * @var WebInstallerOutput
31 * Cached session array.
38 * Captured PHP error text. Temporary.
44 * The main sequence of page names. These will be displayed in turn.
47 * * Add a config-page-<name> message
48 * * Add a WebInstaller_<name> class
51 public $pageSequence = array(
65 * Out of sequence pages, selectable by the user at any time.
68 protected $otherPages = array(
73 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
77 * Array of pages which have declared that they have been submitted, have validated
78 * their input, and need no further processing.
81 protected $happyPages;
84 * List of "skipped" pages. These are pages that will automatically continue
85 * to the next page on any GET request. To avoid breaking the "back" button,
86 * they need to be skipped during a back operation.
89 protected $skippedPages;
92 * Flag indicating that session data may have been lost.
95 public $showSessionWarning = false;
98 * Numeric index of the page we're on
101 protected $tabIndex = 1;
104 * Name of the page we're on
107 protected $currentPageName;
112 * @param $request WebRequest
114 public function __construct( WebRequest
$request ) {
115 parent
::__construct();
116 $this->output
= new WebInstallerOutput( $this );
117 $this->request
= $request;
121 $wgParser->setHook( 'downloadlink', array( $this, 'downloadLinkHook' ) );
122 $wgParser->setHook( 'doclink', array( $this, 'docLink' ) );
128 * @param $session Array: initial session array
130 * @return Array: new session array
132 public function execute( array $session ) {
133 $this->session
= $session;
135 if ( isset( $session['settings'] ) ) {
136 $this->settings
= $session['settings'] +
$this->settings
;
140 $this->setupLanguage();
142 if( ( $this->getVar( '_InstallDone' ) ||
$this->getVar( '_UpgradeDone' ) )
143 && $this->request
->getVal( 'localsettings' ) )
145 $this->request
->response()->header( 'Content-type: application/x-httpd-php' );
146 $this->request
->response()->header(
147 'Content-Disposition: attachment; filename="LocalSettings.php"'
150 $ls = new LocalSettingsGenerator( $this );
151 $rightsProfile = $this->rightsProfiles
[$this->getVar( '_RightsProfile' )];
152 foreach( $rightsProfile as $group => $rightsArr ) {
153 $ls->setGroupRights( $group, $rightsArr );
156 return $this->session
;
159 $cssDir = $this->request
->getVal( 'css' );
161 $cssDir = ( $cssDir == 'rtl' ?
'rtl' : 'ltr' );
162 $this->request
->response()->header( 'Content-type: text/css' );
163 echo $this->output
->getCSS( $cssDir );
164 return $this->session
;
167 if ( isset( $session['happyPages'] ) ) {
168 $this->happyPages
= $session['happyPages'];
170 $this->happyPages
= array();
173 if ( isset( $session['skippedPages'] ) ) {
174 $this->skippedPages
= $session['skippedPages'];
176 $this->skippedPages
= array();
179 $lowestUnhappy = $this->getLowestUnhappy();
181 # Special case for Creative Commons partner chooser box.
182 if ( $this->request
->getVal( 'SubmitCC' ) ) {
183 $page = $this->getPageByName( 'Options' );
184 $this->output
->useShortHeader();
185 $this->output
->allowFrames();
187 return $this->finish();
190 if ( $this->request
->getVal( 'ShowCC' ) ) {
191 $page = $this->getPageByName( 'Options' );
192 $this->output
->useShortHeader();
193 $this->output
->allowFrames();
194 $this->output
->addHTML( $page->getCCDoneBox() );
195 return $this->finish();
199 $pageName = $this->request
->getVal( 'page' );
201 if ( in_array( $pageName, $this->otherPages
) ) {
204 $page = $this->getPageByName( $pageName );
207 if ( !$pageName ||
!in_array( $pageName, $this->pageSequence
) ) {
208 $pageId = $lowestUnhappy;
210 $pageId = array_search( $pageName, $this->pageSequence
);
213 # If necessary, move back to the lowest-numbered unhappy page
214 if ( $pageId > $lowestUnhappy ) {
215 $pageId = $lowestUnhappy;
216 if ( $lowestUnhappy == 0 ) {
217 # Knocked back to start, possible loss of session data.
218 $this->showSessionWarning
= true;
222 $pageName = $this->pageSequence
[$pageId];
223 $page = $this->getPageByName( $pageName );
226 # If a back button was submitted, go back without submitting the form data.
227 if ( $this->request
->wasPosted() && $this->request
->getBool( 'submit-back' ) ) {
228 if ( $this->request
->getVal( 'lastPage' ) ) {
229 $nextPage = $this->request
->getVal( 'lastPage' );
230 } elseif ( $pageId !== false ) {
232 # Skip the skipped pages
233 $nextPageId = $pageId;
237 $nextPage = $this->pageSequence
[$nextPageId];
238 } while( isset( $this->skippedPages
[$nextPage] ) );
240 $nextPage = $this->pageSequence
[$lowestUnhappy];
243 $this->output
->redirect( $this->getUrl( array( 'page' => $nextPage ) ) );
244 return $this->finish();
248 $this->currentPageName
= $page->getName();
249 $this->startPageWrapper( $pageName );
251 if( $page->isSlow() ) {
252 $this->disableTimeLimit();
255 $result = $page->execute();
257 $this->endPageWrapper();
259 if ( $result == 'skip' ) {
260 # Page skipped without explicit submission.
261 # Skip it when we click "back" so that we don't just go forward again.
262 $this->skippedPages
[$pageName] = true;
263 $result = 'continue';
265 unset( $this->skippedPages
[$pageName] );
268 # If it was posted, the page can request a continue to the next page.
269 if ( $result === 'continue' && !$this->output
->headerDone() ) {
270 if ( $pageId !== false ) {
271 $this->happyPages
[$pageId] = true;
274 $lowestUnhappy = $this->getLowestUnhappy();
276 if ( $this->request
->getVal( 'lastPage' ) ) {
277 $nextPage = $this->request
->getVal( 'lastPage' );
278 } elseif ( $pageId !== false ) {
279 $nextPage = $this->pageSequence
[$pageId +
1];
281 $nextPage = $this->pageSequence
[$lowestUnhappy];
284 if ( array_search( $nextPage, $this->pageSequence
) > $lowestUnhappy ) {
285 $nextPage = $this->pageSequence
[$lowestUnhappy];
288 $this->output
->redirect( $this->getUrl( array( 'page' => $nextPage ) ) );
291 return $this->finish();
295 * Find the next page in sequence that hasn't been completed
298 public function getLowestUnhappy() {
299 if ( count( $this->happyPages
) == 0 ) {
302 return max( array_keys( $this->happyPages
) ) +
1;
307 * Start the PHP session. This may be called before execute() to start the PHP session.
311 public function startSession() {
312 if( wfIniGetBool( 'session.auto_start' ) ||
session_id() ) {
317 $this->phpErrors
= array();
318 set_error_handler( array( $this, 'errorHandler' ) );
320 restore_error_handler();
322 if ( $this->phpErrors
) {
323 $this->showError( 'config-session-error', $this->phpErrors
[0] );
331 * Get a hash of data identifying this MW installation.
333 * This is used by mw-config/index.php to prevent multiple installations of MW
334 * on the same cookie domain from interfering with each other.
338 public function getFingerprint() {
339 // Get the base URL of the installation
340 $url = $this->request
->getFullRequestURL();
341 if ( preg_match( '!^(.*\?)!', $url, $m) ) {
345 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
346 // This... seems to try to get the base path from
347 // the /mw-config/index.php. Kinda scary though?
350 return md5( serialize( array(
351 'local path' => dirname( dirname( __FILE__
) ),
353 'version' => $GLOBALS['wgVersion']
358 * Show an error message in a box. Parameters are like wfMsg().
361 public function showError( $msg /*...*/ ) {
362 $args = func_get_args();
363 array_shift( $args );
364 $args = array_map( 'htmlspecialchars', $args );
365 $msg = wfMsgReal( $msg, $args, false, false, false );
366 $this->output
->addHTML( $this->getErrorBox( $msg ) );
370 * Temporary error handler for session start debugging.
372 * @param $errstr string
374 public function errorHandler( $errno, $errstr ) {
375 $this->phpErrors
[] = $errstr;
379 * Clean up from execute()
383 public function finish() {
384 $this->output
->output();
386 $this->session
['happyPages'] = $this->happyPages
;
387 $this->session
['skippedPages'] = $this->skippedPages
;
388 $this->session
['settings'] = $this->settings
;
390 return $this->session
;
394 * We're restarting the installation, reset the session, happyPages, etc
396 public function reset() {
397 $this->session
= array();
398 $this->happyPages
= array();
399 $this->settings
= array();
403 * Get a URL for submission back to the same script.
405 * @param $query array
408 public function getUrl( $query = array() ) {
409 $url = $this->request
->getRequestURL();
410 # Remove existing query
411 $url = preg_replace( '/\?.*$/', '', $url );
414 $url .= '?' . wfArrayToCGI( $query );
421 * Get a WebInstallerPage by name.
423 * @param $pageName String
424 * @return WebInstallerPage
426 public function getPageByName( $pageName ) {
427 $pageClass = 'WebInstaller_' . $pageName;
429 return new $pageClass( $this );
433 * Get a session variable.
435 * @param $name String
438 public function getSession( $name, $default = null ) {
439 if ( !isset( $this->session
[$name] ) ) {
442 return $this->session
[$name];
447 * Set a session variable.
448 * @param $name String key for the variable
449 * @param $value Mixed
451 public function setSession( $name, $value ) {
452 $this->session
[$name] = $value;
456 * Get the next tabindex attribute value.
459 public function nextTabIndex() {
460 return $this->tabIndex++
;
464 * Initializes language-related variables.
466 public function setupLanguage() {
467 global $wgLang, $wgContLang, $wgLanguageCode;
469 if ( $this->getSession( 'test' ) === null && !$this->request
->wasPosted() ) {
470 $wgLanguageCode = $this->getAcceptLanguage();
471 $wgLang = $wgContLang = Language
::factory( $wgLanguageCode );
472 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
473 $this->setVar( '_UserLang', $wgLanguageCode );
475 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
476 $wgContLang = Language
::factory( $wgLanguageCode );
481 * Retrieves MediaWiki language from Accept-Language HTTP header.
485 public function getAcceptLanguage() {
486 global $wgLanguageCode, $wgRequest;
488 $mwLanguages = Language
::getLanguageNames();
489 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
491 foreach ( $headerLanguages as $lang ) {
492 if ( isset( $mwLanguages[$lang] ) ) {
497 return $wgLanguageCode;
501 * Called by execute() before page output starts, to show a page list.
503 * @param $currentPageName String
505 private function startPageWrapper( $currentPageName ) {
506 $s = "<div class=\"config-page-wrapper\">\n";
507 $s .= "<div class=\"config-page\">\n";
508 $s .= "<div class=\"config-page-list\"><ul>\n";
511 foreach ( $this->pageSequence
as $id => $pageName ) {
512 $happy = !empty( $this->happyPages
[$id] );
513 $s .= $this->getPageListItem(
515 $happy ||
$lastHappy == $id - 1,
524 $s .= "</ul><br/><ul>\n";
525 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
526 $s .= "</ul></div>\n"; // end list pane
527 $s .= Html
::element( 'h2', array(),
528 wfMsg( 'config-page-' . strtolower( $currentPageName ) ) );
530 $this->output
->addHTMLNoFlush( $s );
534 * Get a list item for the page list.
536 * @param $pageName String
537 * @param $enabled Boolean
538 * @param $currentPageName String
542 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
543 $s = "<li class=\"config-page-list-item\">";
544 $name = wfMsg( 'config-page-' . strtolower( $pageName ) );
547 $query = array( 'page' => $pageName );
549 if ( !in_array( $pageName, $this->pageSequence
) ) {
550 if ( in_array( $currentPageName, $this->pageSequence
) ) {
551 $query['lastPage'] = $currentPageName;
554 $link = Html
::element( 'a',
556 'href' => $this->getUrl( $query )
561 $link = htmlspecialchars( $name );
564 if ( $pageName == $currentPageName ) {
565 $s .= "<span class=\"config-page-current\">$link</span>";
570 $s .= Html
::element( 'span',
572 'class' => 'config-page-disabled'
584 * Output some stuff after a page is finished.
586 private function endPageWrapper() {
587 $this->output
->addHTMLNoFlush(
588 "<div class=\"visualClear\"></div>\n" .
590 "<div class=\"visualClear\"></div>\n" .
595 * Get HTML for an error box with an icon.
597 * @param $text String: wikitext, get this with wfMsgNoTrans()
601 public function getErrorBox( $text ) {
602 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
606 * Get HTML for a warning box with an icon.
608 * @param $text String: wikitext, get this with wfMsgNoTrans()
612 public function getWarningBox( $text ) {
613 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
617 * Get HTML for an info box with an icon.
619 * @param $text String: wikitext, get this with wfMsgNoTrans()
620 * @param $icon String: icon name, file in skins/common/images
621 * @param $class String: additional class name to add to the wrapper div
625 public function getInfoBox( $text, $icon = false, $class = false ) {
626 $text = $this->parse( $text, true );
627 $icon = ( $icon == false ) ?
'../skins/common/images/info-32.png' : '../skins/common/images/'.$icon;
628 $alt = wfMsg( 'config-information' );
629 return Html
::infoBox( $text, $icon, $alt, $class, false );
633 * Get small text indented help for a preceding form field.
634 * Parameters like wfMsg().
639 public function getHelpBox( $msg /*, ... */ ) {
640 $args = func_get_args();
641 array_shift( $args );
642 $args = array_map( 'htmlspecialchars', $args );
643 $text = wfMsgReal( $msg, $args, false, false, false );
644 $html = $this->parse( $text, true );
646 return "<div class=\"mw-help-field-container\">\n" .
647 "<span class=\"mw-help-field-hint\">" . wfMsgHtml( 'config-help' ) . "</span>\n" .
648 "<span class=\"mw-help-field-data\">" . $html . "</span>\n" .
654 * @param $msg String key for wfMsg()
656 public function showHelpBox( $msg /*, ... */ ) {
657 $args = func_get_args();
658 $html = call_user_func_array( array( $this, 'getHelpBox' ), $args );
659 $this->output
->addHTML( $html );
663 * Show a short informational message.
664 * Output looks like a list.
668 public function showMessage( $msg /*, ... */ ) {
669 $args = func_get_args();
670 array_shift( $args );
671 $html = '<div class="config-message">' .
672 $this->parse( wfMsgReal( $msg, $args, false, false, false ) ) .
674 $this->output
->addHTML( $html );
678 * @param $status Status
680 public function showStatusMessage( Status
$status ) {
681 $text = $status->getWikiText();
682 $this->output
->addWikiText(
683 "<div class=\"config-message\">\n" .
690 * Label a control by wrapping a config-input div around it and putting a
696 * @param $helpData string
699 public function label( $msg, $forId, $contents, $helpData = "" ) {
700 if ( strval( $msg ) == '' ) {
701 $labelText = ' ';
703 $labelText = wfMsgHtml( $msg );
706 $attributes = array( 'class' => 'config-label' );
709 $attributes['for'] = $forId;
713 "<div class=\"config-block\">\n" .
714 " <div class=\"config-block-label\">\n" .
717 $labelText ) . "\n" .
720 " <div class=\"config-block-elements\">\n" .
727 * Get a labelled text box to configure a variable.
729 * @param $params Array
731 * var: The variable to be configured (required)
732 * label: The message name for the label (required)
733 * attribs: Additional attributes for the input element (optional)
734 * controlName: The name for the input element (optional)
735 * value: The current value of the variable (optional)
736 * help: The html for the help text (optional)
740 public function getTextBox( $params ) {
741 if ( !isset( $params['controlName'] ) ) {
742 $params['controlName'] = 'config_' . $params['var'];
745 if ( !isset( $params['value'] ) ) {
746 $params['value'] = $this->getVar( $params['var'] );
749 if ( !isset( $params['attribs'] ) ) {
750 $params['attribs'] = array();
752 if ( !isset( $params['help'] ) ) {
753 $params['help'] = "";
758 $params['controlName'],
760 $params['controlName'],
761 30, // intended to be overridden by CSS
763 $params['attribs'] +
array(
764 'id' => $params['controlName'],
765 'class' => 'config-input-text',
766 'tabindex' => $this->nextTabIndex()
774 * Get a labelled textarea to configure a variable
776 * @param $params Array
778 * var: The variable to be configured (required)
779 * label: The message name for the label (required)
780 * attribs: Additional attributes for the input element (optional)
781 * controlName: The name for the input element (optional)
782 * value: The current value of the variable (optional)
783 * help: The html for the help text (optional)
787 public function getTextArea( $params ) {
788 if ( !isset( $params['controlName'] ) ) {
789 $params['controlName'] = 'config_' . $params['var'];
792 if ( !isset( $params['value'] ) ) {
793 $params['value'] = $this->getVar( $params['var'] );
796 if ( !isset( $params['attribs'] ) ) {
797 $params['attribs'] = array();
799 if ( !isset( $params['help'] ) ) {
800 $params['help'] = "";
805 $params['controlName'],
807 $params['controlName'],
811 $params['attribs'] +
array(
812 'id' => $params['controlName'],
813 'class' => 'config-input-text',
814 'tabindex' => $this->nextTabIndex()
822 * Get a labelled password box to configure a variable.
824 * Implements password hiding
825 * @param $params Array
827 * var: The variable to be configured (required)
828 * label: The message name for the label (required)
829 * attribs: Additional attributes for the input element (optional)
830 * controlName: The name for the input element (optional)
831 * value: The current value of the variable (optional)
832 * help: The html for the help text (optional)
836 public function getPasswordBox( $params ) {
837 if ( !isset( $params['value'] ) ) {
838 $params['value'] = $this->getVar( $params['var'] );
841 if ( !isset( $params['attribs'] ) ) {
842 $params['attribs'] = array();
845 $params['value'] = $this->getFakePassword( $params['value'] );
846 $params['attribs']['type'] = 'password';
848 return $this->getTextBox( $params );
852 * Get a labelled checkbox to configure a boolean variable.
854 * @param $params Array
856 * var: The variable to be configured (required)
857 * label: The message name for the label (required)
858 * attribs: Additional attributes for the input element (optional)
859 * controlName: The name for the input element (optional)
860 * value: The current value of the variable (optional)
861 * help: The html for the help text (optional)
865 public function getCheckBox( $params ) {
866 if ( !isset( $params['controlName'] ) ) {
867 $params['controlName'] = 'config_' . $params['var'];
870 if ( !isset( $params['value'] ) ) {
871 $params['value'] = $this->getVar( $params['var'] );
874 if ( !isset( $params['attribs'] ) ) {
875 $params['attribs'] = array();
877 if ( !isset( $params['help'] ) ) {
878 $params['help'] = "";
880 if( isset( $params['rawtext'] ) ) {
881 $labelText = $params['rawtext'];
883 $labelText = $this->parse( wfMsg( $params['label'] ) );
887 "<div class=\"config-input-check\">\n" .
891 $params['controlName'],
893 $params['attribs'] +
array(
894 'id' => $params['controlName'],
895 'tabindex' => $this->nextTabIndex(),
904 * Get a set of labelled radio buttons.
906 * @param $params Array
908 * var: The variable to be configured (required)
909 * label: The message name for the label (required)
910 * itemLabelPrefix: The message name prefix for the item labels (required)
911 * values: List of allowed values (required)
912 * itemAttribs Array of attribute arrays, outer key is the value name (optional)
913 * commonAttribs Attribute array applied to all items
914 * controlName: The name for the input element (optional)
915 * value: The current value of the variable (optional)
916 * help: The html for the help text (optional)
920 public function getRadioSet( $params ) {
921 if ( !isset( $params['controlName'] ) ) {
922 $params['controlName'] = 'config_' . $params['var'];
925 if ( !isset( $params['value'] ) ) {
926 $params['value'] = $this->getVar( $params['var'] );
929 if ( !isset( $params['label'] ) ) {
932 $label = $params['label'];
934 if ( !isset( $params['help'] ) ) {
935 $params['help'] = "";
938 foreach ( $params['values'] as $value ) {
939 $itemAttribs = array();
941 if ( isset( $params['commonAttribs'] ) ) {
942 $itemAttribs = $params['commonAttribs'];
945 if ( isset( $params['itemAttribs'][$value] ) ) {
946 $itemAttribs = $params['itemAttribs'][$value] +
$itemAttribs;
949 $checked = $value == $params['value'];
950 $id = $params['controlName'] . '_' . $value;
951 $itemAttribs['id'] = $id;
952 $itemAttribs['tabindex'] = $this->nextTabIndex();
956 Xml
::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
958 Xml
::tags( 'label', array( 'for' => $id ), $this->parse(
959 wfMsgNoTrans( $params['itemLabelPrefix'] . strtolower( $value ) )
966 return $this->label( $label, $params['controlName'], $s, $params['help'] );
970 * Output an error or warning box using a Status object.
972 * @param $status Status
974 public function showStatusBox( $status ) {
975 if( !$status->isGood() ) {
976 $text = $status->getWikiText();
978 if( $status->isOk() ) {
979 $box = $this->getWarningBox( $text );
981 $box = $this->getErrorBox( $text );
984 $this->output
->addHTML( $box );
989 * Convenience function to set variables based on form data.
990 * Assumes that variables containing "password" in the name are (potentially
993 * @param $varNames Array
994 * @param $prefix String: the prefix added to variables to obtain form names
998 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
999 $newValues = array();
1001 foreach ( $varNames as $name ) {
1002 $value = trim( $this->request
->getVal( $prefix . $name ) );
1003 $newValues[$name] = $value;
1005 if ( $value === null ) {
1007 $this->setVar( $name, false );
1009 if ( stripos( $name, 'password' ) !== false ) {
1010 $this->setPassword( $name, $value );
1012 $this->setVar( $name, $value );
1021 * Helper for Installer::docLink()
1026 protected function getDocUrl( $page ) {
1027 $url = "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1029 if ( in_array( $this->currentPageName
, $this->pageSequence
) ) {
1030 $url .= '&lastPage=' . urlencode( $this->currentPageName
);
1037 * Extension tag hook for a documentation link.
1044 public function docLink( $linkText, $attribs, $parser ) {
1045 $url = $this->getDocUrl( $attribs['href'] );
1046 return '<a href="' . htmlspecialchars( $url ) . '">' .
1047 htmlspecialchars( $linkText ) .
1052 * Helper for "Download LocalSettings" link on WebInstall_Complete
1057 * @return String Html for download link
1059 public function downloadLinkHook( $text, $attribs, $parser ) {
1060 $img = Html
::element( 'img', array(
1061 'src' => '../skins/common/images/download-32.png',
1065 $anchor = Html
::rawElement( 'a',
1066 array( 'href' => $this->getURL( array( 'localsettings' => 1 ) ) ),
1067 $img . ' ' . wfMsgHtml( 'config-download-localsettings' ) );
1068 return Html
::rawElement( 'div', array( 'class' => 'config-download-link' ), $anchor );
1071 public function envCheckPath( ) {
1072 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1073 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1074 // to get the path to the current script... hopefully it's reliable. SIGH
1076 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1077 $path = $_SERVER['PHP_SELF'];
1078 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1079 $path = $_SERVER['SCRIPT_NAME'];
1081 if ($path !== false) {
1082 $uri = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1083 $this->setVar( 'wgScriptPath', $uri );
1085 $this->showError( 'config-no-uri' );
1090 return parent
::envCheckPath();