includes/installer/WebInstallerPage.php

   1 <?php
   2 /**
   3  * Base code for web installer pages.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Installer
  22  */
  23
  24 use MediaWiki\Html\Html;
  25
  26 /**
  27  * Abstract class to define pages for the web installer.
  28  *
  29  * @ingroup Installer
  30  * @since 1.17
  31  */
  32 abstract class WebInstallerPage {
  33
  34         /**
  35          * The WebInstaller object this WebInstallerPage belongs to.
  36          *
  37          * @var WebInstaller
  38          */
  39         public $parent;
  40
  41         /**
  42          * @return string
  43          */
  44         abstract public function execute();
  45
  46         /**
  47          * @param WebInstaller $parent
  48          */
  49         public function __construct( WebInstaller $parent ) {
  50                 $this->parent = $parent;
  51         }
  52
  53         /**
  54          * Is this a slow-running page in the installer? If so, WebInstaller will
  55          * set_time_limit(0) before calling execute(). Right now this only applies
  56          * to Install and Upgrade pages
  57          *
  58          * @return bool Always false in this default implementation.
  59          */
  60         public function isSlow() {
  61                 return false;
  62         }
  63
  64         /**
  65          * @param string $html
  66          */
  67         public function addHTML( $html ) {
  68                 $this->parent->output->addHTML( $html );
  69         }
  70
  71         public function startForm() {
  72                 $this->addHTML(
  73                         "<div class=\"config-section\">\n" .
  74                         Html::openElement(
  75                                 'form',
  76                                 [
  77                                         'method' => 'post',
  78                                         'action' => $this->parent->getUrl( [ 'page' => $this->getName() ] )
  79                                 ]
  80                         ) . "\n"
  81                 );
  82         }
  83
  84         /**
  85          * @param string|bool $continue
  86          * @param string|bool $back
  87          */
  88         public function endForm( $continue = 'continue', $back = 'back' ) {
  89                 $s = "<div class=\"config-submit\">\n";
  90                 $id = $this->getId();
  91
  92                 if ( $id === false ) {
  93                         $s .= Html::hidden( 'lastPage', $this->parent->request->getVal( 'lastPage' ) );
  94                 }
  95
  96                 if ( $continue ) {
  97                         // Fake submit button for enter keypress (T28267)
  98                         // Messages: config-continue, config-restart, config-regenerate
  99                         $s .= Xml::submitButton(
 100                                 wfMessage( "config-$continue" )->text(),
 101                                 [
 102                                         'name' => "enter-$continue",
 103                                         'style' => 'width:0;border:0;height:0;padding:0'
 104                                 ]
 105                         ) . "\n";
 106                 }
 107
 108                 if ( $back ) {
 109                         // Message: config-back
 110                         $s .= Xml::submitButton(
 111                                 wfMessage( "config-$back" )->text(),
 112                                 [
 113                                         'name' => "submit-$back",
 114                                         'tabindex' => $this->parent->nextTabIndex()
 115                                 ]
 116                         ) . "\n";
 117                 }
 118
 119                 if ( $continue ) {
 120                         // Messages: config-continue, config-restart, config-regenerate
 121                         $s .= Xml::submitButton(
 122                                 wfMessage( "config-$continue" )->text(),
 123                                 [
 124                                         'name' => "submit-$continue",
 125                                         'tabindex' => $this->parent->nextTabIndex(),
 126                                 ]
 127                         ) . "\n";
 128                 }
 129
 130                 $s .= "</div></form></div>\n";
 131                 $this->addHTML( $s );
 132         }
 133
 134         /**
 135          * @return string
 136          */
 137         public function getName() {
 138                 return str_replace( 'WebInstaller', '', static::class );
 139         }
 140
 141         /**
 142          * @return string
 143          */
 144         protected function getId() {
 145                 return array_search( $this->getName(), $this->parent->pageSequence );
 146         }
 147
 148         /**
 149          * @param string $var
 150          * @param mixed|null $default
 151          *
 152          * @return mixed
 153          */
 154         public function getVar( $var, $default = null ) {
 155                 return $this->parent->getVar( $var, $default );
 156         }
 157
 158         /**
 159          * @param string $name
 160          * @param mixed $value
 161          */
 162         public function setVar( $name, $value ) {
 163                 $this->parent->setVar( $name, $value );
 164         }
 165
 166         /**
 167          * Get the starting tags of a fieldset.
 168          *
 169          * @param string $legend Message name
 170          *
 171          * @return string
 172          */
 173         protected function getFieldsetStart( $legend ) {
 174                 return "\n<fieldset><legend>" . wfMessage( $legend )->escaped() . "</legend>\n";
 175         }
 176
 177         /**
 178          * Get the end tag of a fieldset.
 179          *
 180          * @return string
 181          */
 182         protected function getFieldsetEnd() {
 183                 return "</fieldset>\n";
 184         }
 185
 186         /**
 187          * Opens a textarea used to display the progress of a long operation
 188          */
 189         protected function startLiveBox() {
 190                 $this->addHTML(
 191                         '<div id="config-spinner" style="display:none;">' .
 192                         '<img src="images/ajax-loader.gif" /></div>' .
 193                         '<script>jQuery( "#config-spinner" ).show();</script>' .
 194                         '<div id="config-live-log">' .
 195                         '<textarea name="LiveLog" rows="10" cols="30" readonly="readonly">'
 196                 );
 197                 $this->parent->output->flush();
 198         }
 199
 200         /**
 201          * Opposite to WebInstallerPage::startLiveBox
 202          */
 203         protected function endLiveBox() {
 204                 $this->addHTML( '</textarea></div>
 205 <script>jQuery( "#config-spinner" ).hide()</script>' );
 206                 $this->parent->output->flush();
 207         }
 208
 209 }