Merge "Add ss_active_users in SiteStats::isSane"
[mediawiki.git] / includes / installer / WebInstaller.php
blob10c7b96224183beaa2508228a4b2fa593a178956
1 <?php
2 /**
3 * Core installer web interface.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
21 * @ingroup Deployment
24 /**
25 * Class for the core installer web interface.
27 * @ingroup Deployment
28 * @since 1.17
30 class WebInstaller extends Installer {
32 /**
33 * @var WebInstallerOutput
35 public $output;
37 /**
38 * WebRequest object.
40 * @var WebRequest
42 public $request;
44 /**
45 * Cached session array.
47 * @var array
49 protected $session;
51 /**
52 * Captured PHP error text. Temporary.
53 * @var array
55 protected $phpErrors;
57 /**
58 * The main sequence of page names. These will be displayed in turn.
60 * To add a new installer page:
61 * * Add it to this WebInstaller::$pageSequence property
62 * * Add a "config-page-<name>" message
63 * * Add a "WebInstaller_<name>" class
64 * @var array
66 public $pageSequence = array(
67 'Language',
68 'ExistingWiki',
69 'Welcome',
70 'DBConnect',
71 'Upgrade',
72 'DBSettings',
73 'Name',
74 'Options',
75 'Install',
76 'Complete',
79 /**
80 * Out of sequence pages, selectable by the user at any time.
81 * @var array
83 protected $otherPages = array(
84 'Restart',
85 'Readme',
86 'ReleaseNotes',
87 'Copying',
88 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
91 /**
92 * Array of pages which have declared that they have been submitted, have validated
93 * their input, and need no further processing.
94 * @var array
96 protected $happyPages;
98 /**
99 * List of "skipped" pages. These are pages that will automatically continue
100 * to the next page on any GET request. To avoid breaking the "back" button,
101 * they need to be skipped during a back operation.
102 * @var array
104 protected $skippedPages;
107 * Flag indicating that session data may have been lost.
108 * @var bool
110 public $showSessionWarning = false;
113 * Numeric index of the page we're on
114 * @var int
116 protected $tabIndex = 1;
119 * Name of the page we're on
120 * @var string
122 protected $currentPageName;
125 * Constructor.
127 * @param $request WebRequest
129 public function __construct( WebRequest $request ) {
130 parent::__construct();
131 $this->output = new WebInstallerOutput( $this );
132 $this->request = $request;
134 // Add parser hooks
135 global $wgParser;
136 $wgParser->setHook( 'downloadlink', array( $this, 'downloadLinkHook' ) );
137 $wgParser->setHook( 'doclink', array( $this, 'docLink' ) );
141 * Main entry point.
143 * @param array $session initial session array
145 * @return Array: new session array
147 public function execute( array $session ) {
148 $this->session = $session;
150 if ( isset( $session['settings'] ) ) {
151 $this->settings = $session['settings'] + $this->settings;
154 $this->exportVars();
155 $this->setupLanguage();
157 if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
158 && $this->request->getVal( 'localsettings' ) )
160 $this->request->response()->header( 'Content-type: application/x-httpd-php' );
161 $this->request->response()->header(
162 'Content-Disposition: attachment; filename="LocalSettings.php"'
165 $ls = InstallerOverrides::getLocalSettingsGenerator( $this );
166 $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
167 foreach ( $rightsProfile as $group => $rightsArr ) {
168 $ls->setGroupRights( $group, $rightsArr );
170 echo $ls->getText();
171 return $this->session;
174 $cssDir = $this->request->getVal( 'css' );
175 if ( $cssDir ) {
176 $cssDir = ( $cssDir == 'rtl' ? 'rtl' : 'ltr' );
177 $this->request->response()->header( 'Content-type: text/css' );
178 echo $this->output->getCSS( $cssDir );
179 return $this->session;
182 if ( isset( $session['happyPages'] ) ) {
183 $this->happyPages = $session['happyPages'];
184 } else {
185 $this->happyPages = array();
188 if ( isset( $session['skippedPages'] ) ) {
189 $this->skippedPages = $session['skippedPages'];
190 } else {
191 $this->skippedPages = array();
194 $lowestUnhappy = $this->getLowestUnhappy();
196 # Special case for Creative Commons partner chooser box.
197 if ( $this->request->getVal( 'SubmitCC' ) ) {
198 $page = $this->getPageByName( 'Options' );
199 $this->output->useShortHeader();
200 $this->output->allowFrames();
201 $page->submitCC();
202 return $this->finish();
205 if ( $this->request->getVal( 'ShowCC' ) ) {
206 $page = $this->getPageByName( 'Options' );
207 $this->output->useShortHeader();
208 $this->output->allowFrames();
209 $this->output->addHTML( $page->getCCDoneBox() );
210 return $this->finish();
213 # Get the page name.
214 $pageName = $this->request->getVal( 'page' );
216 if ( in_array( $pageName, $this->otherPages ) ) {
217 # Out of sequence
218 $pageId = false;
219 $page = $this->getPageByName( $pageName );
220 } else {
221 # Main sequence
222 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
223 $pageId = $lowestUnhappy;
224 } else {
225 $pageId = array_search( $pageName, $this->pageSequence );
228 # If necessary, move back to the lowest-numbered unhappy page
229 if ( $pageId > $lowestUnhappy ) {
230 $pageId = $lowestUnhappy;
231 if ( $lowestUnhappy == 0 ) {
232 # Knocked back to start, possible loss of session data.
233 $this->showSessionWarning = true;
237 $pageName = $this->pageSequence[$pageId];
238 $page = $this->getPageByName( $pageName );
241 # If a back button was submitted, go back without submitting the form data.
242 if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
243 if ( $this->request->getVal( 'lastPage' ) ) {
244 $nextPage = $this->request->getVal( 'lastPage' );
245 } elseif ( $pageId !== false ) {
246 # Main sequence page
247 # Skip the skipped pages
248 $nextPageId = $pageId;
250 do {
251 $nextPageId--;
252 $nextPage = $this->pageSequence[$nextPageId];
253 } while ( isset( $this->skippedPages[$nextPage] ) );
254 } else {
255 $nextPage = $this->pageSequence[$lowestUnhappy];
258 $this->output->redirect( $this->getUrl( array( 'page' => $nextPage ) ) );
259 return $this->finish();
262 # Execute the page.
263 $this->currentPageName = $page->getName();
264 $this->startPageWrapper( $pageName );
266 if ( $page->isSlow() ) {
267 $this->disableTimeLimit();
270 $result = $page->execute();
272 $this->endPageWrapper();
274 if ( $result == 'skip' ) {
275 # Page skipped without explicit submission.
276 # Skip it when we click "back" so that we don't just go forward again.
277 $this->skippedPages[$pageName] = true;
278 $result = 'continue';
279 } else {
280 unset( $this->skippedPages[$pageName] );
283 # If it was posted, the page can request a continue to the next page.
284 if ( $result === 'continue' && !$this->output->headerDone() ) {
285 if ( $pageId !== false ) {
286 $this->happyPages[$pageId] = true;
289 $lowestUnhappy = $this->getLowestUnhappy();
291 if ( $this->request->getVal( 'lastPage' ) ) {
292 $nextPage = $this->request->getVal( 'lastPage' );
293 } elseif ( $pageId !== false ) {
294 $nextPage = $this->pageSequence[$pageId + 1];
295 } else {
296 $nextPage = $this->pageSequence[$lowestUnhappy];
299 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
300 $nextPage = $this->pageSequence[$lowestUnhappy];
303 $this->output->redirect( $this->getUrl( array( 'page' => $nextPage ) ) );
306 return $this->finish();
310 * Find the next page in sequence that hasn't been completed
311 * @return int
313 public function getLowestUnhappy() {
314 if ( count( $this->happyPages ) == 0 ) {
315 return 0;
316 } else {
317 return max( array_keys( $this->happyPages ) ) + 1;
322 * Start the PHP session. This may be called before execute() to start the PHP session.
324 * @return bool
326 public function startSession() {
327 if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
328 // Done already
329 return true;
332 $this->phpErrors = array();
333 set_error_handler( array( $this, 'errorHandler' ) );
334 session_start();
335 restore_error_handler();
337 if ( $this->phpErrors ) {
338 $this->showError( 'config-session-error', $this->phpErrors[0] );
339 return false;
342 return true;
346 * Get a hash of data identifying this MW installation.
348 * This is used by mw-config/index.php to prevent multiple installations of MW
349 * on the same cookie domain from interfering with each other.
351 * @return string
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];
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];
365 return md5( serialize( array(
366 'local path' => dirname( __DIR__ ),
367 'url' => $url,
368 'version' => $GLOBALS['wgVersion']
369 ) ) );
373 * Show an error message in a box. Parameters are like wfMessage().
374 * @param $msg
376 public function showError( $msg /*...*/ ) {
377 $args = func_get_args();
378 array_shift( $args );
379 $args = array_map( 'htmlspecialchars', $args );
380 $msg = wfMessage( $msg, $args )->useDatabase( false )->plain();
381 $this->output->addHTML( $this->getErrorBox( $msg ) );
385 * Temporary error handler for session start debugging.
386 * @param $errno
387 * @param $errstr string
389 public function errorHandler( $errno, $errstr ) {
390 $this->phpErrors[] = $errstr;
394 * Clean up from execute()
396 * @return array
398 public function finish() {
399 $this->output->output();
401 $this->session['happyPages'] = $this->happyPages;
402 $this->session['skippedPages'] = $this->skippedPages;
403 $this->session['settings'] = $this->settings;
405 return $this->session;
409 * We're restarting the installation, reset the session, happyPages, etc
411 public function reset() {
412 $this->session = array();
413 $this->happyPages = array();
414 $this->settings = array();
418 * Get a URL for submission back to the same script.
420 * @param $query array
421 * @return string
423 public function getUrl( $query = array() ) {
424 $url = $this->request->getRequestURL();
425 # Remove existing query
426 $url = preg_replace( '/\?.*$/', '', $url );
428 if ( $query ) {
429 $url .= '?' . wfArrayToCgi( $query );
432 return $url;
436 * Get a WebInstallerPage by name.
438 * @param $pageName String
439 * @return WebInstallerPage
441 public function getPageByName( $pageName ) {
442 $pageClass = 'WebInstaller_' . $pageName;
444 return new $pageClass( $this );
448 * Get a session variable.
450 * @param $name String
451 * @param $default
452 * @return null
454 public function getSession( $name, $default = null ) {
455 if ( !isset( $this->session[$name] ) ) {
456 return $default;
457 } else {
458 return $this->session[$name];
463 * Set a session variable.
464 * @param string $name key for the variable
465 * @param $value Mixed
467 public function setSession( $name, $value ) {
468 $this->session[$name] = $value;
472 * Get the next tabindex attribute value.
473 * @return int
475 public function nextTabIndex() {
476 return $this->tabIndex++;
480 * Initializes language-related variables.
482 public function setupLanguage() {
483 global $wgLang, $wgContLang, $wgLanguageCode;
485 if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
486 $wgLanguageCode = $this->getAcceptLanguage();
487 $wgLang = $wgContLang = Language::factory( $wgLanguageCode );
488 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
489 $this->setVar( '_UserLang', $wgLanguageCode );
490 } else {
491 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
492 $wgContLang = Language::factory( $wgLanguageCode );
497 * Retrieves MediaWiki language from Accept-Language HTTP header.
499 * @return string
501 public function getAcceptLanguage() {
502 global $wgLanguageCode, $wgRequest;
504 $mwLanguages = Language::fetchLanguageNames();
505 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
507 foreach ( $headerLanguages as $lang ) {
508 if ( isset( $mwLanguages[$lang] ) ) {
509 return $lang;
513 return $wgLanguageCode;
517 * Called by execute() before page output starts, to show a page list.
519 * @param $currentPageName String
521 private function startPageWrapper( $currentPageName ) {
522 $s = "<div class=\"config-page-wrapper\">\n";
523 $s .= "<div class=\"config-page\">\n";
524 $s .= "<div class=\"config-page-list\"><ul>\n";
525 $lastHappy = -1;
527 foreach ( $this->pageSequence as $id => $pageName ) {
528 $happy = !empty( $this->happyPages[$id] );
529 $s .= $this->getPageListItem(
530 $pageName,
531 $happy || $lastHappy == $id - 1,
532 $currentPageName
535 if ( $happy ) {
536 $lastHappy = $id;
540 $s .= "</ul><br/><ul>\n";
541 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
542 $s .= "</ul></div>\n"; // end list pane
543 $s .= Html::element( 'h2', array(),
544 wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
546 $this->output->addHTMLNoFlush( $s );
550 * Get a list item for the page list.
552 * @param $pageName String
553 * @param $enabled Boolean
554 * @param $currentPageName String
556 * @return string
558 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
559 $s = "<li class=\"config-page-list-item\">";
560 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
562 if ( $enabled ) {
563 $query = array( 'page' => $pageName );
565 if ( !in_array( $pageName, $this->pageSequence ) ) {
566 if ( in_array( $currentPageName, $this->pageSequence ) ) {
567 $query['lastPage'] = $currentPageName;
570 $link = Html::element( 'a',
571 array(
572 'href' => $this->getUrl( $query )
574 $name
576 } else {
577 $link = htmlspecialchars( $name );
580 if ( $pageName == $currentPageName ) {
581 $s .= "<span class=\"config-page-current\">$link</span>";
582 } else {
583 $s .= $link;
585 } else {
586 $s .= Html::element( 'span',
587 array(
588 'class' => 'config-page-disabled'
590 $name
594 $s .= "</li>\n";
596 return $s;
600 * Output some stuff after a page is finished.
602 private function endPageWrapper() {
603 $this->output->addHTMLNoFlush(
604 "<div class=\"visualClear\"></div>\n" .
605 "</div>\n" .
606 "<div class=\"visualClear\"></div>\n" .
607 "</div>" );
611 * Get HTML for an error box with an icon.
613 * @param string $text wikitext, get this with wfMessage()->plain()
615 * @return string
617 public function getErrorBox( $text ) {
618 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
622 * Get HTML for a warning box with an icon.
624 * @param string $text wikitext, get this with wfMessage()->plain()
626 * @return string
628 public function getWarningBox( $text ) {
629 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
633 * Get HTML for an info box with an icon.
635 * @param string $text wikitext, get this with wfMessage()->plain()
636 * @param string $icon icon name, file in skins/common/images
637 * @param string $class additional class name to add to the wrapper div
639 * @return string
641 public function getInfoBox( $text, $icon = false, $class = false ) {
642 $text = $this->parse( $text, true );
643 $icon = ( $icon == false ) ? '../skins/common/images/info-32.png' : '../skins/common/images/' . $icon;
644 $alt = wfMessage( 'config-information' )->text();
645 return Html::infoBox( $text, $icon, $alt, $class, false );
649 * Get small text indented help for a preceding form field.
650 * Parameters like wfMessage().
652 * @param $msg
653 * @return string
655 public function getHelpBox( $msg /*, ... */ ) {
656 $args = func_get_args();
657 array_shift( $args );
658 $args = array_map( 'htmlspecialchars', $args );
659 $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
660 $html = $this->parse( $text, true );
662 return "<div class=\"mw-help-field-container\">\n" .
663 "<span class=\"mw-help-field-hint\">" . wfMessage( 'config-help' )->escaped() .
664 "</span>\n" .
665 "<span class=\"mw-help-field-data\">" . $html . "</span>\n" .
666 "</div>\n";
670 * Output a help box.
671 * @param string $msg key for wfMessage()
673 public function showHelpBox( $msg /*, ... */ ) {
674 $args = func_get_args();
675 $html = call_user_func_array( array( $this, 'getHelpBox' ), $args );
676 $this->output->addHTML( $html );
680 * Show a short informational message.
681 * Output looks like a list.
683 * @param $msg string
685 public function showMessage( $msg /*, ... */ ) {
686 $args = func_get_args();
687 array_shift( $args );
688 $html = '<div class="config-message">' .
689 $this->parse( wfMessage( $msg, $args )->useDatabase( false )->plain() ) .
690 "</div>\n";
691 $this->output->addHTML( $html );
695 * @param $status Status
697 public function showStatusMessage( Status $status ) {
698 $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
699 foreach ( $errors as $error ) {
700 call_user_func_array( array( $this, 'showMessage' ), $error );
705 * Label a control by wrapping a config-input div around it and putting a
706 * label before it.
708 * @param $msg
709 * @param $forId
710 * @param $contents
711 * @param $helpData string
712 * @return string
714 public function label( $msg, $forId, $contents, $helpData = "" ) {
715 if ( strval( $msg ) == '' ) {
716 $labelText = '&#160;';
717 } else {
718 $labelText = wfMessage( $msg )->escaped();
721 $attributes = array( 'class' => 'config-label' );
723 if ( $forId ) {
724 $attributes['for'] = $forId;
727 return "<div class=\"config-block\">\n" .
728 " <div class=\"config-block-label\">\n" .
729 Xml::tags( 'label',
730 $attributes,
731 $labelText ) . "\n" .
732 $helpData .
733 " </div>\n" .
734 " <div class=\"config-block-elements\">\n" .
735 $contents .
736 " </div>\n" .
737 "</div>\n";
741 * Get a labelled text box to configure a variable.
743 * @param $params Array
744 * Parameters are:
745 * var: The variable to be configured (required)
746 * label: The message name for the label (required)
747 * attribs: Additional attributes for the input element (optional)
748 * controlName: The name for the input element (optional)
749 * value: The current value of the variable (optional)
750 * help: The html for the help text (optional)
752 * @return string
754 public function getTextBox( $params ) {
755 if ( !isset( $params['controlName'] ) ) {
756 $params['controlName'] = 'config_' . $params['var'];
759 if ( !isset( $params['value'] ) ) {
760 $params['value'] = $this->getVar( $params['var'] );
763 if ( !isset( $params['attribs'] ) ) {
764 $params['attribs'] = array();
766 if ( !isset( $params['help'] ) ) {
767 $params['help'] = "";
769 return $this->label(
770 $params['label'],
771 $params['controlName'],
772 Xml::input(
773 $params['controlName'],
774 30, // intended to be overridden by CSS
775 $params['value'],
776 $params['attribs'] + array(
777 'id' => $params['controlName'],
778 'class' => 'config-input-text',
779 'tabindex' => $this->nextTabIndex()
782 $params['help']
787 * Get a labelled textarea to configure a variable
789 * @param $params Array
790 * Parameters are:
791 * var: The variable to be configured (required)
792 * label: The message name for the label (required)
793 * attribs: Additional attributes for the input element (optional)
794 * controlName: The name for the input element (optional)
795 * value: The current value of the variable (optional)
796 * help: The html for the help text (optional)
798 * @return string
800 public function getTextArea( $params ) {
801 if ( !isset( $params['controlName'] ) ) {
802 $params['controlName'] = 'config_' . $params['var'];
805 if ( !isset( $params['value'] ) ) {
806 $params['value'] = $this->getVar( $params['var'] );
809 if ( !isset( $params['attribs'] ) ) {
810 $params['attribs'] = array();
812 if ( !isset( $params['help'] ) ) {
813 $params['help'] = "";
815 return $this->label(
816 $params['label'],
817 $params['controlName'],
818 Xml::textarea(
819 $params['controlName'],
820 $params['value'],
823 $params['attribs'] + array(
824 'id' => $params['controlName'],
825 'class' => 'config-input-text',
826 'tabindex' => $this->nextTabIndex()
829 $params['help']
834 * Get a labelled password box to configure a variable.
836 * Implements password hiding
837 * @param $params Array
838 * Parameters are:
839 * var: The variable to be configured (required)
840 * label: The message name for the label (required)
841 * attribs: Additional attributes for the input element (optional)
842 * controlName: The name for the input element (optional)
843 * value: The current value of the variable (optional)
844 * help: The html for the help text (optional)
846 * @return string
848 public function getPasswordBox( $params ) {
849 if ( !isset( $params['value'] ) ) {
850 $params['value'] = $this->getVar( $params['var'] );
853 if ( !isset( $params['attribs'] ) ) {
854 $params['attribs'] = array();
857 $params['value'] = $this->getFakePassword( $params['value'] );
858 $params['attribs']['type'] = 'password';
860 return $this->getTextBox( $params );
864 * Get a labelled checkbox to configure a boolean variable.
866 * @param $params Array
867 * Parameters are:
868 * var: The variable to be configured (required)
869 * label: The message name for the label (required)
870 * attribs: Additional attributes for the input element (optional)
871 * controlName: The name for the input element (optional)
872 * value: The current value of the variable (optional)
873 * help: The html for the help text (optional)
875 * @return string
877 public function getCheckBox( $params ) {
878 if ( !isset( $params['controlName'] ) ) {
879 $params['controlName'] = 'config_' . $params['var'];
882 if ( !isset( $params['value'] ) ) {
883 $params['value'] = $this->getVar( $params['var'] );
886 if ( !isset( $params['attribs'] ) ) {
887 $params['attribs'] = array();
889 if ( !isset( $params['help'] ) ) {
890 $params['help'] = "";
892 if ( isset( $params['rawtext'] ) ) {
893 $labelText = $params['rawtext'];
894 } else {
895 $labelText = $this->parse( wfMessage( $params['label'] )->text() );
898 return "<div class=\"config-input-check\">\n" .
899 $params['help'] .
900 "<label>\n" .
901 Xml::check(
902 $params['controlName'],
903 $params['value'],
904 $params['attribs'] + array(
905 'id' => $params['controlName'],
906 'tabindex' => $this->nextTabIndex(),
909 $labelText . "\n" .
910 "</label>\n" .
911 "</div>\n";
915 * Get a set of labelled radio buttons.
917 * @param $params Array
918 * Parameters are:
919 * var: The variable to be configured (required)
920 * label: The message name for the label (required)
921 * itemLabelPrefix: The message name prefix for the item labels (required)
922 * values: List of allowed values (required)
923 * itemAttribs Array of attribute arrays, outer key is the value name (optional)
924 * commonAttribs Attribute array applied to all items
925 * controlName: The name for the input element (optional)
926 * value: The current value of the variable (optional)
927 * help: The html for the help text (optional)
929 * @return string
931 public function getRadioSet( $params ) {
932 if ( !isset( $params['controlName'] ) ) {
933 $params['controlName'] = 'config_' . $params['var'];
936 if ( !isset( $params['value'] ) ) {
937 $params['value'] = $this->getVar( $params['var'] );
940 if ( !isset( $params['label'] ) ) {
941 $label = '';
942 } else {
943 $label = $params['label'];
945 if ( !isset( $params['help'] ) ) {
946 $params['help'] = "";
948 $s = "<ul>\n";
949 foreach ( $params['values'] as $value ) {
950 $itemAttribs = array();
952 if ( isset( $params['commonAttribs'] ) ) {
953 $itemAttribs = $params['commonAttribs'];
956 if ( isset( $params['itemAttribs'][$value] ) ) {
957 $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
960 $checked = $value == $params['value'];
961 $id = $params['controlName'] . '_' . $value;
962 $itemAttribs['id'] = $id;
963 $itemAttribs['tabindex'] = $this->nextTabIndex();
965 $s .=
966 '<li>' .
967 Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
968 '&#160;' .
969 Xml::tags( 'label', array( 'for' => $id ), $this->parse(
970 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
971 ) ) .
972 "</li>\n";
975 $s .= "</ul>\n";
977 return $this->label( $label, $params['controlName'], $s, $params['help'] );
981 * Output an error or warning box using a Status object.
983 * @param $status Status
985 public function showStatusBox( $status ) {
986 if ( !$status->isGood() ) {
987 $text = $status->getWikiText();
989 if ( $status->isOk() ) {
990 $box = $this->getWarningBox( $text );
991 } else {
992 $box = $this->getErrorBox( $text );
995 $this->output->addHTML( $box );
1000 * Convenience function to set variables based on form data.
1001 * Assumes that variables containing "password" in the name are (potentially
1002 * fake) passwords.
1004 * @param $varNames Array
1005 * @param string $prefix the prefix added to variables to obtain form names
1007 * @return array
1009 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1010 $newValues = array();
1012 foreach ( $varNames as $name ) {
1013 $value = trim( $this->request->getVal( $prefix . $name ) );
1014 $newValues[$name] = $value;
1016 if ( $value === null ) {
1017 // Checkbox?
1018 $this->setVar( $name, false );
1019 } else {
1020 if ( stripos( $name, 'password' ) !== false ) {
1021 $this->setPassword( $name, $value );
1022 } else {
1023 $this->setVar( $name, $value );
1028 return $newValues;
1032 * Helper for Installer::docLink()
1034 * @param $page
1035 * @return string
1037 protected function getDocUrl( $page ) {
1038 $url = "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1040 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1041 $url .= '&lastPage=' . urlencode( $this->currentPageName );
1044 return $url;
1048 * Extension tag hook for a documentation link.
1050 * @param $linkText
1051 * @param $attribs
1052 * @param $parser
1053 * @return string
1055 public function docLink( $linkText, $attribs, $parser ) {
1056 $url = $this->getDocUrl( $attribs['href'] );
1057 return '<a href="' . htmlspecialchars( $url ) . '">' .
1058 htmlspecialchars( $linkText ) .
1059 '</a>';
1063 * Helper for "Download LocalSettings" link on WebInstall_Complete
1065 * @param $text
1066 * @param $attribs
1067 * @param $parser
1068 * @return String Html for download link
1070 public function downloadLinkHook( $text, $attribs, $parser ) {
1071 $img = Html::element( 'img', array(
1072 'src' => '../skins/common/images/download-32.png',
1073 'width' => '32',
1074 'height' => '32',
1075 ) );
1076 $anchor = Html::rawElement( 'a',
1077 array( 'href' => $this->getURL( array( 'localsettings' => 1 ) ) ),
1078 $img . ' ' . wfMessage( 'config-download-localsettings' )->parse() );
1079 return Html::rawElement( 'div', array( 'class' => 'config-download-link' ), $anchor );
1083 * @return bool
1085 public function envCheckPath() {
1086 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1087 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1088 // to get the path to the current script... hopefully it's reliable. SIGH
1089 $path = false;
1090 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1091 $path = $_SERVER['PHP_SELF'];
1092 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1093 $path = $_SERVER['SCRIPT_NAME'];
1095 if ( $path !== false ) {
1096 $uri = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1097 $this->setVar( 'wgScriptPath', $uri );
1098 } else {
1099 $this->showError( 'config-no-uri' );
1100 return false;
1102 return parent::envCheckPath();
1105 protected function envGetDefaultServer() {
1106 return WebRequest::detectServer();