correct typo in r102393
[mediawiki.git] / includes / installer / WebInstaller.php
blob7427906e04d38c4fe550def413881fcb43f987c6
1 <?php
2 /**
3 * Core installer web interface.
5 * @file
6 * @ingroup Deployment
7 */
9 /**
10 * Class for the core installer web interface.
12 * @ingroup Deployment
13 * @since 1.17
15 class WebInstaller extends Installer {
17 /**
18 * @var WebInstallerOutput
20 public $output;
22 /**
23 * WebRequest object.
25 * @var WebRequest
27 public $request;
29 /**
30 * Cached session array.
32 * @var array
34 protected $session;
36 /**
37 * Captured PHP error text. Temporary.
38 * @var array
40 protected $phpErrors;
42 /**
43 * The main sequence of page names. These will be displayed in turn.
44 * To add one:
45 * * Add it here
46 * * Add a config-page-<name> message
47 * * Add a WebInstaller_<name> class
48 * @var array
50 public $pageSequence = array(
51 'Language',
52 'ExistingWiki',
53 'Welcome',
54 'DBConnect',
55 'Upgrade',
56 'DBSettings',
57 'Name',
58 'Options',
59 'Install',
60 'Complete',
63 /**
64 * Out of sequence pages, selectable by the user at any time.
65 * @var array
67 protected $otherPages = array(
68 'Restart',
69 'Readme',
70 'ReleaseNotes',
71 'Copying',
72 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
75 /**
76 * Array of pages which have declared that they have been submitted, have validated
77 * their input, and need no further processing.
78 * @var array
80 protected $happyPages;
82 /**
83 * List of "skipped" pages. These are pages that will automatically continue
84 * to the next page on any GET request. To avoid breaking the "back" button,
85 * they need to be skipped during a back operation.
86 * @var array
88 protected $skippedPages;
90 /**
91 * Flag indicating that session data may have been lost.
92 * @var bool
94 public $showSessionWarning = false;
96 /**
97 * Numeric index of the page we're on
98 * @var int
100 protected $tabIndex = 1;
103 * Name of the page we're on
104 * @var string
106 protected $currentPageName;
109 * Constructor.
111 * @param $request WebRequest
113 public function __construct( WebRequest $request ) {
114 parent::__construct();
115 $this->output = new WebInstallerOutput( $this );
116 $this->request = $request;
118 // Add parser hooks
119 global $wgParser;
120 $wgParser->setHook( 'downloadlink', array( $this, 'downloadLinkHook' ) );
121 $wgParser->setHook( 'doclink', array( $this, 'docLink' ) );
125 * Main entry point.
127 * @param $session Array: initial session array
129 * @return Array: new session array
131 public function execute( array $session ) {
132 $this->session = $session;
134 if ( isset( $session['settings'] ) ) {
135 $this->settings = $session['settings'] + $this->settings;
138 $this->exportVars();
139 $this->setupLanguage();
141 if( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
142 && $this->request->getVal( 'localsettings' ) )
144 $this->request->response()->header( 'Content-type: application/x-httpd-php' );
145 $this->request->response()->header(
146 'Content-Disposition: attachment; filename="LocalSettings.php"'
149 $ls = new LocalSettingsGenerator( $this );
150 $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
151 foreach( $rightsProfile as $group => $rightsArr ) {
152 $ls->setGroupRights( $group, $rightsArr );
154 echo $ls->getText();
155 return $this->session;
158 $cssDir = $this->request->getVal( 'css' );
159 if( $cssDir ) {
160 $cssDir = ( $cssDir == 'rtl' ? 'rtl' : 'ltr' );
161 $this->request->response()->header( 'Content-type: text/css' );
162 echo $this->output->getCSS( $cssDir );
163 return $this->session;
166 if ( isset( $session['happyPages'] ) ) {
167 $this->happyPages = $session['happyPages'];
168 } else {
169 $this->happyPages = array();
172 if ( isset( $session['skippedPages'] ) ) {
173 $this->skippedPages = $session['skippedPages'];
174 } else {
175 $this->skippedPages = array();
178 $lowestUnhappy = $this->getLowestUnhappy();
180 # Special case for Creative Commons partner chooser box.
181 if ( $this->request->getVal( 'SubmitCC' ) ) {
182 $page = $this->getPageByName( 'Options' );
183 $this->output->useShortHeader();
184 $this->output->allowFrames();
185 $page->submitCC();
186 return $this->finish();
189 if ( $this->request->getVal( 'ShowCC' ) ) {
190 $page = $this->getPageByName( 'Options' );
191 $this->output->useShortHeader();
192 $this->output->allowFrames();
193 $this->output->addHTML( $page->getCCDoneBox() );
194 return $this->finish();
197 # Get the page name.
198 $pageName = $this->request->getVal( 'page' );
200 if ( in_array( $pageName, $this->otherPages ) ) {
201 # Out of sequence
202 $pageId = false;
203 $page = $this->getPageByName( $pageName );
204 } else {
205 # Main sequence
206 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
207 $pageId = $lowestUnhappy;
208 } else {
209 $pageId = array_search( $pageName, $this->pageSequence );
212 # If necessary, move back to the lowest-numbered unhappy page
213 if ( $pageId > $lowestUnhappy ) {
214 $pageId = $lowestUnhappy;
215 if ( $lowestUnhappy == 0 ) {
216 # Knocked back to start, possible loss of session data.
217 $this->showSessionWarning = true;
221 $pageName = $this->pageSequence[$pageId];
222 $page = $this->getPageByName( $pageName );
225 # If a back button was submitted, go back without submitting the form data.
226 if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
227 if ( $this->request->getVal( 'lastPage' ) ) {
228 $nextPage = $this->request->getVal( 'lastPage' );
229 } elseif ( $pageId !== false ) {
230 # Main sequence page
231 # Skip the skipped pages
232 $nextPageId = $pageId;
234 do {
235 $nextPageId--;
236 $nextPage = $this->pageSequence[$nextPageId];
237 } while( isset( $this->skippedPages[$nextPage] ) );
238 } else {
239 $nextPage = $this->pageSequence[$lowestUnhappy];
242 $this->output->redirect( $this->getUrl( array( 'page' => $nextPage ) ) );
243 return $this->finish();
246 # Execute the page.
247 $this->currentPageName = $page->getName();
248 $this->startPageWrapper( $pageName );
250 if( $page->isSlow() ) {
251 $this->disableTimeLimit();
254 $result = $page->execute();
256 $this->endPageWrapper();
258 if ( $result == 'skip' ) {
259 # Page skipped without explicit submission.
260 # Skip it when we click "back" so that we don't just go forward again.
261 $this->skippedPages[$pageName] = true;
262 $result = 'continue';
263 } else {
264 unset( $this->skippedPages[$pageName] );
267 # If it was posted, the page can request a continue to the next page.
268 if ( $result === 'continue' && !$this->output->headerDone() ) {
269 if ( $pageId !== false ) {
270 $this->happyPages[$pageId] = true;
273 $lowestUnhappy = $this->getLowestUnhappy();
275 if ( $this->request->getVal( 'lastPage' ) ) {
276 $nextPage = $this->request->getVal( 'lastPage' );
277 } elseif ( $pageId !== false ) {
278 $nextPage = $this->pageSequence[$pageId + 1];
279 } else {
280 $nextPage = $this->pageSequence[$lowestUnhappy];
283 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
284 $nextPage = $this->pageSequence[$lowestUnhappy];
287 $this->output->redirect( $this->getUrl( array( 'page' => $nextPage ) ) );
290 return $this->finish();
294 * Find the next page in sequence that hasn't been completed
295 * @return int
297 public function getLowestUnhappy() {
298 if ( count( $this->happyPages ) == 0 ) {
299 return 0;
300 } else {
301 return max( array_keys( $this->happyPages ) ) + 1;
306 * Start the PHP session. This may be called before execute() to start the PHP session.
308 * @return bool
310 public function startSession() {
311 if( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
312 // Done already
313 return true;
316 $this->phpErrors = array();
317 set_error_handler( array( $this, 'errorHandler' ) );
318 session_start();
319 restore_error_handler();
321 if ( $this->phpErrors ) {
322 $this->showError( 'config-session-error', $this->phpErrors[0] );
323 return false;
326 return true;
330 * Get a hash of data identifying this MW installation.
332 * This is used by mw-config/index.php to prevent multiple installations of MW
333 * on the same cookie domain from interfering with each other.
335 * @return string
337 public function getFingerprint() {
338 // Get the base URL of the installation
339 $url = $this->request->getFullRequestURL();
340 if ( preg_match( '!^(.*\?)!', $url, $m) ) {
341 // Trim query string
342 $url = $m[1];
344 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
345 // This... seems to try to get the base path from
346 // the /mw-config/index.php. Kinda scary though?
347 $url = $m[1];
349 return md5( serialize( array(
350 'local path' => dirname( dirname( __FILE__ ) ),
351 'url' => $url,
352 'version' => $GLOBALS['wgVersion']
353 ) ) );
357 * Show an error message in a box. Parameters are like wfMsg().
358 * @param $msg
360 public function showError( $msg /*...*/ ) {
361 $args = func_get_args();
362 array_shift( $args );
363 $args = array_map( 'htmlspecialchars', $args );
364 $msg = wfMsgReal( $msg, $args, false, false, false );
365 $this->output->addHTML( $this->getErrorBox( $msg ) );
369 * Temporary error handler for session start debugging.
370 * @param $errno
371 * @param $errstr string
373 public function errorHandler( $errno, $errstr ) {
374 $this->phpErrors[] = $errstr;
378 * Clean up from execute()
380 * @return array
382 public function finish() {
383 $this->output->output();
385 $this->session['happyPages'] = $this->happyPages;
386 $this->session['skippedPages'] = $this->skippedPages;
387 $this->session['settings'] = $this->settings;
389 return $this->session;
393 * We're restarting the installation, reset the session, happyPages, etc
395 public function reset() {
396 $this->session = array();
397 $this->happyPages = array();
398 $this->settings = array();
402 * Get a URL for submission back to the same script.
404 * @param $query array
405 * @return string
407 public function getUrl( $query = array() ) {
408 $url = $this->request->getRequestURL();
409 # Remove existing query
410 $url = preg_replace( '/\?.*$/', '', $url );
412 if ( $query ) {
413 $url .= '?' . wfArrayToCGI( $query );
416 return $url;
420 * Get a WebInstallerPage by name.
422 * @param $pageName String
423 * @return WebInstallerPage
425 public function getPageByName( $pageName ) {
426 $pageClass = 'WebInstaller_' . $pageName;
428 return new $pageClass( $this );
432 * Get a session variable.
434 * @param $name String
435 * @param $default
437 public function getSession( $name, $default = null ) {
438 if ( !isset( $this->session[$name] ) ) {
439 return $default;
440 } else {
441 return $this->session[$name];
446 * Set a session variable.
447 * @param $name String key for the variable
448 * @param $value Mixed
450 public function setSession( $name, $value ) {
451 $this->session[$name] = $value;
455 * Get the next tabindex attribute value.
456 * @return int
458 public function nextTabIndex() {
459 return $this->tabIndex++;
463 * Initializes language-related variables.
465 public function setupLanguage() {
466 global $wgLang, $wgContLang, $wgLanguageCode;
468 if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
469 $wgLanguageCode = $this->getAcceptLanguage();
470 $wgLang = $wgContLang = Language::factory( $wgLanguageCode );
471 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
472 $this->setVar( '_UserLang', $wgLanguageCode );
473 } else {
474 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
475 $wgLang = Language::factory( $this->getVar( '_UserLang' ) );
476 $wgContLang = Language::factory( $wgLanguageCode );
481 * Retrieves MediaWiki language from Accept-Language HTTP header.
483 * @return string
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] ) ) {
493 return $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";
509 $lastHappy = -1;
511 foreach ( $this->pageSequence as $id => $pageName ) {
512 $happy = !empty( $this->happyPages[$id] );
513 $s .= $this->getPageListItem(
514 $pageName,
515 $happy || $lastHappy == $id - 1,
516 $currentPageName
519 if ( $happy ) {
520 $lastHappy = $id;
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
540 * @return string
542 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
543 $s = "<li class=\"config-page-list-item\">";
544 $name = wfMsg( 'config-page-' . strtolower( $pageName ) );
546 if ( $enabled ) {
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',
555 array(
556 'href' => $this->getUrl( $query )
558 $name
560 } else {
561 $link = htmlspecialchars( $name );
564 if ( $pageName == $currentPageName ) {
565 $s .= "<span class=\"config-page-current\">$link</span>";
566 } else {
567 $s .= $link;
569 } else {
570 $s .= Html::element( 'span',
571 array(
572 'class' => 'config-page-disabled'
574 $name
578 $s .= "</li>\n";
580 return $s;
584 * Output some stuff after a page is finished.
586 private function endPageWrapper() {
587 $this->output->addHTMLNoFlush(
588 "<div class=\"visualClear\"></div>\n" .
589 "</div>\n" .
590 "<div class=\"visualClear\"></div>\n" .
591 "</div>" );
595 * Get HTML for an error box with an icon.
597 * @param $text String: wikitext, get this with wfMsgNoTrans()
599 * @return string
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()
610 * @return string
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
623 * @return string
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().
636 * @param $msg
637 * @return string
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" .
649 "</div>\n";
653 * Output a help box.
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.
666 * @param $msg string
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 ) ) .
673 "</div>\n";
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" .
684 $text .
685 "</div>"
690 * Label a control by wrapping a config-input div around it and putting a
691 * label before it.
693 * @param $msg
694 * @param $forId
695 * @param $contents
696 * @param $helpData string
697 * @return string
699 public function label( $msg, $forId, $contents, $helpData = "" ) {
700 if ( strval( $msg ) == '' ) {
701 $labelText = '&#160;';
702 } else {
703 $labelText = wfMsgHtml( $msg );
706 $attributes = array( 'class' => 'config-label' );
708 if ( $forId ) {
709 $attributes['for'] = $forId;
712 return
713 "<div class=\"config-block\">\n" .
714 " <div class=\"config-block-label\">\n" .
715 Xml::tags( 'label',
716 $attributes,
717 $labelText ) . "\n" .
718 $helpData .
719 " </div>\n" .
720 " <div class=\"config-block-elements\">\n" .
721 $contents .
722 " </div>\n" .
723 "</div>\n";
727 * Get a labelled text box to configure a variable.
729 * @param $params Array
730 * Parameters are:
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)
738 * @return string
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'] = "";
755 return
756 $this->label(
757 $params['label'],
758 $params['controlName'],
759 Xml::input(
760 $params['controlName'],
761 30, // intended to be overridden by CSS
762 $params['value'],
763 $params['attribs'] + array(
764 'id' => $params['controlName'],
765 'class' => 'config-input-text',
766 'tabindex' => $this->nextTabIndex()
769 $params['help']
774 * Get a labelled textarea to configure a variable
776 * @param $params Array
777 * Parameters are:
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)
785 * @return string
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'] = "";
802 return
803 $this->label(
804 $params['label'],
805 $params['controlName'],
806 Xml::textarea(
807 $params['controlName'],
808 $params['value'],
811 $params['attribs'] + array(
812 'id' => $params['controlName'],
813 'class' => 'config-input-text',
814 'tabindex' => $this->nextTabIndex()
817 $params['help']
822 * Get a labelled password box to configure a variable.
824 * Implements password hiding
825 * @param $params Array
826 * Parameters are:
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)
834 * @return string
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
855 * Parameters are:
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)
863 * @return string
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'];
882 } else {
883 $labelText = $this->parse( wfMsg( $params['label'] ) );
886 return
887 "<div class=\"config-input-check\">\n" .
888 $params['help'] .
889 "<label>\n" .
890 Xml::check(
891 $params['controlName'],
892 $params['value'],
893 $params['attribs'] + array(
894 'id' => $params['controlName'],
895 'tabindex' => $this->nextTabIndex(),
898 $labelText . "\n" .
899 "</label>\n" .
900 "</div>\n";
904 * Get a set of labelled radio buttons.
906 * @param $params Array
907 * Parameters are:
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)
918 * @return string
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'] ) ) {
930 $label = '';
931 } else {
932 $label = $params['label'];
934 if ( !isset( $params['help'] ) ) {
935 $params['help'] = "";
937 $s = "<ul>\n";
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();
954 $s .=
955 '<li>' .
956 Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
957 '&#160;' .
958 Xml::tags( 'label', array( 'for' => $id ), $this->parse(
959 wfMsgNoTrans( $params['itemLabelPrefix'] . strtolower( $value ) )
960 ) ) .
961 "</li>\n";
964 $s .= "</ul>\n";
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 );
980 } else {
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
991 * fake) passwords.
993 * @param $varNames Array
994 * @param $prefix String: the prefix added to variables to obtain form names
996 * @return array
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 ) {
1006 // Checkbox?
1007 $this->setVar( $name, false );
1008 } else {
1009 if ( stripos( $name, 'password' ) !== false ) {
1010 $this->setPassword( $name, $value );
1011 } else {
1012 $this->setVar( $name, $value );
1017 return $newValues;
1021 * Helper for Installer::docLink()
1023 * @param $page
1024 * @return string
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 );
1033 return $url;
1037 * Extension tag hook for a documentation link.
1039 * @param $linkText
1040 * @param $attribs
1041 * @param $parser
1042 * @return string
1044 public function docLink( $linkText, $attribs, $parser ) {
1045 $url = $this->getDocUrl( $attribs['href'] );
1046 return '<a href="' . htmlspecialchars( $url ) . '">' .
1047 htmlspecialchars( $linkText ) .
1048 '</a>';
1052 * Helper for "Download LocalSettings" link on WebInstall_Complete
1054 * @param $text
1055 * @param $attribs
1056 * @param $parser
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',
1062 'width' => '32',
1063 'height' => '32',
1064 ) );
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
1075 $path = false;
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 );
1084 } else {
1085 $this->showError( 'config-no-uri' );
1086 return false;
1090 return parent::envCheckPath();