Merge "Added result properties to action=paraminfo"
[lhc/web/wiklou.git] / includes / installer / WebInstaller.php
index 84ba806..4f31195 100644 (file)
@@ -2,6 +2,21 @@
 /**
  * Core installer web interface.
  *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup Deployment
  */
@@ -12,7 +27,7 @@
  * @ingroup Deployment
  * @since 1.17
  */
-class WebInstaller extends CoreInstaller {
+class WebInstaller extends Installer {
 
        /**
         * @var WebInstallerOutput
@@ -31,12 +46,13 @@ class WebInstaller extends CoreInstaller {
         *
         * @var array
         */
-       public $session;
+       protected $session;
 
        /**
         * Captured PHP error text. Temporary.
+        * @var array
         */
-       public $phpErrors;
+       protected $phpErrors;
 
        /**
         * The main sequence of page names. These will be displayed in turn.
@@ -44,9 +60,11 @@ class WebInstaller extends CoreInstaller {
         *    * Add it here
         *    * Add a config-page-<name> message
         *    * Add a WebInstaller_<name> class
+        * @var array
         */
        public $pageSequence = array(
                'Language',
+               'ExistingWiki',
                'Welcome',
                'DBConnect',
                'Upgrade',
@@ -59,8 +77,9 @@ class WebInstaller extends CoreInstaller {
 
        /**
         * Out of sequence pages, selectable by the user at any time.
+        * @var array
         */
-       public $otherPages = array(
+       protected $otherPages = array(
                'Restart',
                'Readme',
                'ReleaseNotes',
@@ -71,24 +90,35 @@ class WebInstaller extends CoreInstaller {
        /**
         * Array of pages which have declared that they have been submitted, have validated
         * their input, and need no further processing.
+        * @var array
         */
-       public $happyPages;
+       protected $happyPages;
 
        /**
         * List of "skipped" pages. These are pages that will automatically continue
         * to the next page on any GET request. To avoid breaking the "back" button,
         * they need to be skipped during a back operation.
+        * @var array
         */
-       public $skippedPages;
+       protected $skippedPages;
 
        /**
         * Flag indicating that session data may have been lost.
+        * @var bool
         */
        public $showSessionWarning = false;
 
-       public $tabIndex = 1;
+       /**
+        * Numeric index of the page we're on
+        * @var int
+        */
+       protected $tabIndex = 1;
 
-       public $currentPageName;
+       /**
+        * Name of the page we're on
+        * @var string
+        */
+       protected $currentPageName;
 
        /**
         * Constructor.
@@ -99,6 +129,11 @@ class WebInstaller extends CoreInstaller {
                parent::__construct();
                $this->output = new WebInstallerOutput( $this );
                $this->request = $request;
+
+               // Add parser hooks
+               global $wgParser;
+               $wgParser->setHook( 'downloadlink', array( $this, 'downloadLinkHook' ) );
+               $wgParser->setHook( 'doclink', array( $this, 'docLink' ) );
        }
 
        /**
@@ -121,12 +156,16 @@ class WebInstaller extends CoreInstaller {
                if( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
                        && $this->request->getVal( 'localsettings' ) )
                {
-                       $this->request->response()->header( 'Content-type: text/plain' );
+                       $this->request->response()->header( 'Content-type: application/x-httpd-php' );
                        $this->request->response()->header(
                                'Content-Disposition: attachment; filename="LocalSettings.php"'
                        );
 
-                       $ls = new LocalSettingsGenerator( $this );
+                       $ls = InstallerOverrides::getLocalSettingsGenerator( $this );
+                       $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
+                       foreach( $rightsProfile as $group => $rightsArr ) {
+                               $ls->setGroupRights( $group, $rightsArr );
+                       }
                        echo $ls->getText();
                        return $this->session;
                }
@@ -157,6 +196,7 @@ class WebInstaller extends CoreInstaller {
                if ( $this->request->getVal( 'SubmitCC' ) ) {
                        $page = $this->getPageByName( 'Options' );
                        $this->output->useShortHeader();
+                       $this->output->allowFrames();
                        $page->submitCC();
                        return $this->finish();
                }
@@ -164,6 +204,7 @@ class WebInstaller extends CoreInstaller {
                if ( $this->request->getVal( 'ShowCC' ) ) {
                        $page = $this->getPageByName( 'Options' );
                        $this->output->useShortHeader();
+                       $this->output->allowFrames();
                        $this->output->addHTML( $page->getCCDoneBox() );
                        return $this->finish();
                }
@@ -171,15 +212,7 @@ class WebInstaller extends CoreInstaller {
                # Get the page name.
                $pageName = $this->request->getVal( 'page' );
 
-               # Check LocalSettings status
-               $localSettings = $this->getLocalSettingsStatus();
-
-               if( !$localSettings->isGood() && $this->getVar( '_LocalSettingsLocked' ) ) {
-                       $pageName = 'Locked';
-                       $pageId = false;
-                       $page = $this->getPageByName( $pageName );
-                       $page->setLocalSettingsStatus( $localSettings );
-               } elseif ( in_array( $pageName, $this->otherPages ) ) {
+               if ( in_array( $pageName, $this->otherPages ) ) {
                        # Out of sequence
                        $pageId = false;
                        $page = $this->getPageByName( $pageName );
@@ -229,6 +262,10 @@ class WebInstaller extends CoreInstaller {
                $this->currentPageName = $page->getName();
                $this->startPageWrapper( $pageName );
 
+               if( $page->isSlow() ) {
+                       $this->disableTimeLimit();
+               }
+
                $result = $page->execute();
 
                $this->endPageWrapper();
@@ -268,6 +305,10 @@ class WebInstaller extends CoreInstaller {
                return $this->finish();
        }
 
+       /**
+        * Find the next page in sequence that hasn't been completed
+        * @return int
+        */
        public function getLowestUnhappy() {
                if ( count( $this->happyPages ) == 0 ) {
                        return 0;
@@ -278,24 +319,10 @@ class WebInstaller extends CoreInstaller {
 
        /**
         * Start the PHP session. This may be called before execute() to start the PHP session.
+        *
+        * @return bool
         */
        public function startSession() {
-               $sessPath = $this->getSessionSavePath();
-
-               if( $sessPath != '' ) {
-                       if( strval( ini_get( 'open_basedir' ) ) != '' ) {
-                               // we need to skip the following check when open_basedir is on.
-                               // The session path probably *wont* be writable by the current
-                               // user, and telling them to change it is bad. Bug 23021.
-                       } elseif( !is_dir( $sessPath ) || !is_writeable( $sessPath ) ) {
-                               $this->showError( 'config-session-path-bad', $sessPath );
-                               return false;
-                       }
-               } else {
-                       // If the path is unset it'll default to some system bit, which *probably* is ok...
-                       // not sure how to actually get what will be used.
-               }
-
                if( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
                        // Done already
                        return true;
@@ -315,24 +342,35 @@ class WebInstaller extends CoreInstaller {
        }
 
        /**
-        * Get the value of session.save_path
+        * Get a hash of data identifying this MW installation.
         *
-        * Per http://www.php.net/manual/en/session.configuration.php#ini.session.save-path,
-        * this may have an initial integer value to indicate the depth of session
-        * storage (eg /tmp/a/b/c). Explode on ; and check and see if this part is
-        * there or not. Should also allow paths with semicolons in them (if you
-        * really wanted your session files stored in /tmp/some;dir) which PHP
-        * supposedly supports.
+        * This is used by mw-config/index.php to prevent multiple installations of MW
+        * on the same cookie domain from interfering with each other.
         *
-        * @return String
+        * @return string
         */
-       private function getSessionSavePath() {
-               $parts = explode( ';', ini_get( 'session.save_path' ), 2 );
-               return count( $parts ) == 1 ? $parts[0] : $parts[1];
+       public function getFingerprint() {
+               // Get the base URL of the installation
+               $url = $this->request->getFullRequestURL();
+               if ( preg_match( '!^(.*\?)!', $url, $m) ) {
+                       // Trim query string
+                       $url = $m[1];
+               }
+               if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
+                       // This... seems to try to get the base path from
+                       // the /mw-config/index.php. Kinda scary though?
+                       $url = $m[1];
+               }
+               return md5( serialize( array(
+                       'local path' => dirname( dirname( __FILE__ ) ),
+                       'url' => $url,
+                       'version' => $GLOBALS['wgVersion']
+               ) ) );
        }
 
        /**
         * Show an error message in a box. Parameters are like wfMsg().
+        * @param $msg
         */
        public function showError( $msg /*...*/ ) {
                $args = func_get_args();
@@ -344,6 +382,8 @@ class WebInstaller extends CoreInstaller {
 
        /**
         * Temporary error handler for session start debugging.
+        * @param $errno
+        * @param $errstr string
         */
        public function errorHandler( $errno, $errstr ) {
                $this->phpErrors[] = $errstr;
@@ -364,10 +404,20 @@ class WebInstaller extends CoreInstaller {
                return $this->session;
        }
 
+       /**
+        * We're restarting the installation, reset the session, happyPages, etc
+        */
+       public function reset() {
+               $this->session = array();
+               $this->happyPages = array();
+               $this->settings = array();
+       }
+
        /**
         * Get a URL for submission back to the same script.
         *
-        * @param $query: Array
+        * @param $query array
+        * @return string
         */
        public function getUrl( $query = array() ) {
                $url = $this->request->getRequestURL();
@@ -385,13 +435,9 @@ class WebInstaller extends CoreInstaller {
         * Get a WebInstallerPage by name.
         *
         * @param $pageName String
-        *
         * @return WebInstallerPage
         */
        public function getPageByName( $pageName ) {
-               // Totally lame way to force autoload of WebInstallerPage.php
-               class_exists( 'WebInstallerPage' );
-
                $pageClass = 'WebInstaller_' . $pageName;
 
                return new $pageClass( $this );
@@ -402,6 +448,7 @@ class WebInstaller extends CoreInstaller {
         *
         * @param $name String
         * @param $default
+        * @return null
         */
        public function getSession( $name, $default = null ) {
                if ( !isset( $this->session[$name] ) ) {
@@ -413,6 +460,8 @@ class WebInstaller extends CoreInstaller {
 
        /**
         * Set a session variable.
+        * @param $name String key for the variable
+        * @param $value Mixed
         */
        public function setSession( $name, $value ) {
                $this->session[$name] = $value;
@@ -420,6 +469,7 @@ class WebInstaller extends CoreInstaller {
 
        /**
         * Get the next tabindex attribute value.
+        * @return int
         */
        public function nextTabIndex() {
                return $this->tabIndex++;
@@ -438,7 +488,6 @@ class WebInstaller extends CoreInstaller {
                        $this->setVar( '_UserLang', $wgLanguageCode );
                } else {
                        $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
-                       $wgLang = Language::factory( $this->getVar( '_UserLang' ) );
                        $wgContLang = Language::factory( $wgLanguageCode );
                }
        }
@@ -451,7 +500,7 @@ class WebInstaller extends CoreInstaller {
        public function getAcceptLanguage() {
                global $wgLanguageCode, $wgRequest;
 
-               $mwLanguages = Language::getLanguageNames();
+               $mwLanguages = Language::fetchLanguageNames();
                $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
 
                foreach ( $headerLanguages as $lang ) {
@@ -488,11 +537,7 @@ class WebInstaller extends CoreInstaller {
                }
 
                $s .= "</ul><br/><ul>\n";
-
-               foreach ( $this->otherPages as $pageName ) {
-                       $s .= $this->getPageListItem( $pageName, true, $currentPageName );
-               }
-
+               $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
                $s .= "</ul></div>\n"; // end list pane
                $s .= Html::element( 'h2', array(),
                                wfMsg( 'config-page-' . strtolower( $currentPageName ) ) );
@@ -555,8 +600,9 @@ class WebInstaller extends CoreInstaller {
         */
        private function endPageWrapper() {
                $this->output->addHTMLNoFlush(
-                       "</div>\n" .
-                       "<br style=\"clear:both\"/>\n" .
+                                       "<div class=\"visualClear\"></div>\n" .
+                               "</div>\n" .
+                               "<div class=\"visualClear\"></div>\n" .
                        "</div>" );
        }
 
@@ -564,6 +610,8 @@ class WebInstaller extends CoreInstaller {
         * Get HTML for an error box with an icon.
         *
         * @param $text String: wikitext, get this with wfMsgNoTrans()
+        *
+        * @return string
         */
        public function getErrorBox( $text ) {
                return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
@@ -573,6 +621,8 @@ class WebInstaller extends CoreInstaller {
         * Get HTML for a warning box with an icon.
         *
         * @param $text String: wikitext, get this with wfMsgNoTrans()
+        *
+        * @return string
         */
        public function getWarningBox( $text ) {
                return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
@@ -584,45 +634,39 @@ class WebInstaller extends CoreInstaller {
         * @param $text String: wikitext, get this with wfMsgNoTrans()
         * @param $icon String: icon name, file in skins/common/images
         * @param $class String: additional class name to add to the wrapper div
+        *
+        * @return string
         */
-       public function getInfoBox( $text, $icon = 'info-32.png', $class = false ) {
-               $s =
-                       "<div class=\"config-info $class\">\n" .
-                               "<div class=\"config-info-left\">\n" .
-                               Html::element( 'img',
-                                       array(
-                                               'src' => '../skins/common/images/' . $icon,
-                                               'alt' => wfMsg( 'config-information' ),
-                                       )
-                               ) . "\n" .
-                               "</div>\n" .
-                               "<div class=\"config-info-right\">\n" .
-                                       $this->parse( $text ) . "\n" .
-                               "</div>\n" .
-                               "<div style=\"clear: left;\"></div>\n" .
-                       "</div>\n";
-               return $s;
+       public function getInfoBox( $text, $icon = false, $class = false ) {
+               $text = $this->parse( $text, true );
+               $icon = ( $icon == false ) ? '../skins/common/images/info-32.png' : '../skins/common/images/'.$icon;
+               $alt = wfMsg( 'config-information' );
+               return Html::infoBox( $text, $icon, $alt, $class, false );
        }
 
        /**
         * Get small text indented help for a preceding form field.
         * Parameters like wfMsg().
+        *
+        * @param $msg
+        * @return string
         */
        public function getHelpBox( $msg /*, ... */ ) {
                $args = func_get_args();
                array_shift( $args );
                $args = array_map( 'htmlspecialchars', $args );
                $text = wfMsgReal( $msg, $args, false, false, false );
-               //$html = $this->parse( $text, true );
-    $html = $text;
-               return
-            "<span class=\"mw-help-field-hint\"\n" .
-           "     title=\"" . $html . "\"\n" .
-           "     original-title=\"" . $html . "\"></span>\n";
+               $html = $this->parse( $text, true );
+
+               return "<div class=\"mw-help-field-container\">\n" .
+                       "<span class=\"mw-help-field-hint\">" . wfMsgHtml( 'config-help' ) . "</span>\n" .
+                       "<span class=\"mw-help-field-data\">" . $html . "</span>\n" .
+                       "</div>\n";
        }
 
        /**
         * Output a help box.
+        * @param $msg String key for wfMsg()
         */
        public function showHelpBox( $msg /*, ... */ ) {
                $args = func_get_args();
@@ -649,17 +693,21 @@ class WebInstaller extends CoreInstaller {
         * @param $status Status
         */
        public function showStatusMessage( Status $status ) {
-               $text = $status->getWikiText();
-               $this->output->addWikiText(
-                       "<div class=\"config-message\">\n" .
-                       $text .
-                       "</div>"
-               );
+               $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
+               foreach ( $errors as $error ) {
+                       call_user_func_array( array( $this, 'showMessage' ), $error );
+               }
        }
 
        /**
         * Label a control by wrapping a config-input div around it and putting a
         * label before it.
+        *
+        * @param $msg
+        * @param $forId
+        * @param $contents
+        * @param $helpData string
+        * @return string
         */
        public function label( $msg, $forId, $contents, $helpData = "" ) {
                if ( strval( $msg ) == '' ) {
@@ -676,14 +724,14 @@ class WebInstaller extends CoreInstaller {
 
                return
                        "<div class=\"config-block\">\n" .
-                   "  <div class=\"config-block-label\">\n" .
+                       "  <div class=\"config-block-label\">\n" .
                        Xml::tags( 'label',
                                $attributes,
                                $labelText ) . "\n" .
-                           $helpData .
+                               $helpData .
                        "  </div>\n" .
-                   "  <div class=\"config-block-elements\">\n" .
-                           $contents .
+                       "  <div class=\"config-block-elements\">\n" .
+                               $contents .
                        "  </div>\n" .
                        "</div>\n";
        }
@@ -699,6 +747,8 @@ class WebInstaller extends CoreInstaller {
         *      controlName: The name for the input element (optional)
         *      value:      The current value of the variable (optional)
         *      help:           The html for the help text (optional)
+        *
+        * @return string
         */
        public function getTextBox( $params ) {
                if ( !isset( $params['controlName'] ) ) {
@@ -733,6 +783,54 @@ class WebInstaller extends CoreInstaller {
                        );
        }
 
+       /**
+        * Get a labelled textarea to configure a variable
+        *
+        * @param $params Array
+        *    Parameters are:
+        *      var:        The variable to be configured (required)
+        *      label:      The message name for the label (required)
+        *      attribs:    Additional attributes for the input element (optional)
+        *      controlName: The name for the input element (optional)
+        *      value:      The current value of the variable (optional)
+        *      help:           The html for the help text (optional)
+        *
+        * @return string
+        */
+       public function getTextArea( $params ) {
+               if ( !isset( $params['controlName'] ) ) {
+                       $params['controlName'] = 'config_' . $params['var'];
+               }
+
+               if ( !isset( $params['value'] ) ) {
+                       $params['value'] = $this->getVar( $params['var'] );
+               }
+
+               if ( !isset( $params['attribs'] ) ) {
+                       $params['attribs'] = array();
+               }
+               if ( !isset( $params['help'] ) ) {
+                       $params['help'] = "";
+               }
+               return
+                       $this->label(
+                               $params['label'],
+                               $params['controlName'],
+                               Xml::textarea(
+                                       $params['controlName'],
+                                       $params['value'],
+                                       30,
+                                       5,
+                                       $params['attribs'] + array(
+                                               'id' => $params['controlName'],
+                                               'class' => 'config-input-text',
+                                               'tabindex' => $this->nextTabIndex()
+                                       )
+                               ),
+                               $params['help']
+                       );
+       }
+
        /**
         * Get a labelled password box to configure a variable.
         *
@@ -745,6 +843,8 @@ class WebInstaller extends CoreInstaller {
         *      controlName: The name for the input element (optional)
         *      value:      The current value of the variable (optional)
         *      help:           The html for the help text (optional)
+        *
+        * @return string
         */
        public function getPasswordBox( $params ) {
                if ( !isset( $params['value'] ) ) {
@@ -772,6 +872,8 @@ class WebInstaller extends CoreInstaller {
         *      controlName: The name for the input element (optional)
         *      value:      The current value of the variable (optional)
         *      help:           The html for the help text (optional)
+        *
+        * @return string
         */
        public function getCheckBox( $params ) {
                if ( !isset( $params['controlName'] ) ) {
@@ -796,6 +898,7 @@ class WebInstaller extends CoreInstaller {
 
                return
                        "<div class=\"config-input-check\">\n" .
+                       $params['help'] .
                        "<label>\n" .
                        Xml::check(
                                $params['controlName'],
@@ -807,7 +910,6 @@ class WebInstaller extends CoreInstaller {
                        ) .
                        $labelText . "\n" .
                        "</label>\n" .
-                       $params['help'] .
                        "</div>\n";
        }
 
@@ -825,6 +927,8 @@ class WebInstaller extends CoreInstaller {
         *      controlName:    The name for the input element (optional)
         *      value:          The current value of the variable (optional)
         *      help:           The html for the help text (optional)
+        *
+        * @return string
         */
        public function getRadioSet( $params ) {
                if ( !isset( $params['controlName']  ) ) {
@@ -877,6 +981,8 @@ class WebInstaller extends CoreInstaller {
 
        /**
         * Output an error or warning box using a Status object.
+        *
+        * @param $status Status
         */
        public function showStatusBox( $status ) {
                if( !$status->isGood() ) {
@@ -899,6 +1005,8 @@ class WebInstaller extends CoreInstaller {
         *
         * @param $varNames Array
         * @param $prefix String: the prefix added to variables to obtain form names
+        *
+        * @return array
         */
        public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
                $newValues = array();
@@ -924,6 +1032,9 @@ class WebInstaller extends CoreInstaller {
 
        /**
         * Helper for Installer::docLink()
+        *
+        * @param $page
+        * @return string
         */
        protected function getDocUrl( $page ) {
                $url = "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
@@ -935,4 +1046,65 @@ class WebInstaller extends CoreInstaller {
                return $url;
        }
 
-}
\ No newline at end of file
+       /**
+        * Extension tag hook for a documentation link.
+        *
+        * @param $linkText
+        * @param $attribs
+        * @param $parser
+        * @return string
+        */
+       public function docLink( $linkText, $attribs, $parser ) {
+               $url = $this->getDocUrl( $attribs['href'] );
+               return '<a href="' . htmlspecialchars( $url ) . '">' .
+                       htmlspecialchars( $linkText ) .
+                       '</a>';
+       }
+
+       /**
+        * Helper for "Download LocalSettings" link on WebInstall_Complete
+        *
+        * @param $text
+        * @param $attribs
+        * @param $parser
+        * @return String Html for download link
+        */
+       public function downloadLinkHook( $text, $attribs, $parser  ) {
+               $img = Html::element( 'img', array(
+                       'src' => '../skins/common/images/download-32.png',
+                       'width' => '32',
+                       'height' => '32',
+               ) );
+               $anchor = Html::rawElement( 'a',
+                       array( 'href' => $this->getURL( array( 'localsettings' => 1 ) ) ),
+                       $img . ' ' . wfMsgHtml( 'config-download-localsettings' ) );
+               return Html::rawElement( 'div', array( 'class' => 'config-download-link' ), $anchor );
+       }
+
+       /**
+        * @return bool
+        */
+       public function envCheckPath( ) {
+               // PHP_SELF isn't available sometimes, such as when PHP is CGI but
+               // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
+               // to get the path to the current script... hopefully it's reliable. SIGH
+               $path = false;
+               if ( !empty( $_SERVER['PHP_SELF'] ) ) {
+                       $path = $_SERVER['PHP_SELF'];
+               } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
+                       $path = $_SERVER['SCRIPT_NAME'];
+               }
+               if ($path !== false) {
+                       $uri = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
+                       $this->setVar( 'wgScriptPath', $uri );
+               } else {
+                       $this->showError( 'config-no-uri' );
+                       return false;
+               }
+               return parent::envCheckPath();
+       }
+
+       protected function envGetDefaultServer() {
+               return WebRequest::detectServer();
+       }
+}