(bug 26690) Value of the 'Name of wiki' field is not retain after two subsequent...
[lhc/web/wiklou.git] / includes / installer / WebInstallerPage.php
1 <?php
2 /**
3 * Base code for web installer pages.
4 *
5 * @file
6 * @ingroup Deployment
7 */
8
9 /**
10 * Abstract class to define pages for the web installer.
11 *
12 * @ingroup Deployment
13 * @since 1.17
14 */
15 abstract class WebInstallerPage {
16
17 /**
18 * The WebInstaller object this WebInstallerPage belongs to.
19 *
20 * @var WebInstaller
21 */
22 public $parent;
23
24 public abstract function execute();
25
26 /**
27 * Constructor.
28 *
29 * @param $parent WebInstaller
30 */
31 public function __construct( WebInstaller $parent ) {
32 $this->parent = $parent;
33 }
34
35 public function addHTML( $html ) {
36 $this->parent->output->addHTML( $html );
37 }
38
39 public function startForm() {
40 $this->addHTML(
41 "<div class=\"config-section\">\n" .
42 Html::openElement(
43 'form',
44 array(
45 'method' => 'post',
46 'action' => $this->parent->getUrl( array( 'page' => $this->getName() ) )
47 )
48 ) . "\n"
49 );
50 }
51
52 public function endForm( $continue = 'continue', $back = 'back' ) {
53 $s = "<div class=\"config-submit\">\n";
54 $id = $this->getId();
55
56 if ( $id === false ) {
57 $s .= Html::hidden( 'lastPage', $this->parent->request->getVal( 'lastPage' ) );
58 }
59
60 if ( $continue ) {
61 // Fake submit button for enter keypress (bug 26267)
62 $s .= Xml::submitButton( wfMsg( "config-$continue" ),
63 array( 'name' => "enter-$continue", 'style' => 'visibility:hidden;overflow:hidden;width:1px;margin:0' ) ) . "\n";
64 }
65
66 if ( $back ) {
67 $s .= Xml::submitButton( wfMsg( "config-$back" ),
68 array(
69 'name' => "submit-$back",
70 'tabindex' => $this->parent->nextTabIndex()
71 ) ) . "\n";
72 }
73
74 if ( $continue ) {
75 $s .= Xml::submitButton( wfMsg( "config-$continue" ),
76 array(
77 'name' => "submit-$continue",
78 'tabindex' => $this->parent->nextTabIndex(),
79 ) ) . "\n";
80 }
81
82 $s .= "</div></form></div>\n";
83 $this->addHTML( $s );
84 }
85
86 public function getName() {
87 return str_replace( 'WebInstaller_', '', get_class( $this ) );
88 }
89
90 protected function getId() {
91 return array_search( $this->getName(), $this->parent->pageSequence );
92 }
93
94 public function getVar( $var ) {
95 return $this->parent->getVar( $var );
96 }
97
98 public function setVar( $name, $value ) {
99 $this->parent->setVar( $name, $value );
100 }
101
102 /**
103 * Get the starting tags of a fieldset.
104 *
105 * @param $legend String: message name
106 */
107 protected function getFieldsetStart( $legend ) {
108 return "\n<fieldset><legend>" . wfMsgHtml( $legend ) . "</legend>\n";
109 }
110
111 /**
112 * Get the end tag of a fieldset.
113 */
114 protected function getFieldsetEnd() {
115 return "</fieldset>\n";
116 }
117 }
118
119 class WebInstaller_Language extends WebInstallerPage {
120
121 public function execute() {
122 global $wgLang;
123 $r = $this->parent->request;
124 $userLang = $r->getVal( 'UserLang' );
125 $contLang = $r->getVal( 'ContLang' );
126
127 $lifetime = intval( ini_get( 'session.gc_maxlifetime' ) );
128 if ( !$lifetime ) {
129 $lifetime = 1440; // PHP default
130 }
131
132 if ( $r->wasPosted() ) {
133 # Do session test
134 if ( $this->parent->getSession( 'test' ) === null ) {
135 $requestTime = $r->getVal( 'LanguageRequestTime' );
136 if ( !$requestTime ) {
137 // The most likely explanation is that the user was knocked back
138 // from another page on POST due to session expiry
139 $msg = 'config-session-expired';
140 } elseif ( time() - $requestTime > $lifetime ) {
141 $msg = 'config-session-expired';
142 } else {
143 $msg = 'config-no-session';
144 }
145 $this->parent->showError( $msg, $wgLang->formatTimePeriod( $lifetime ) );
146 } else {
147 $languages = Language::getLanguageNames();
148 if ( isset( $languages[$userLang] ) ) {
149 $this->setVar( '_UserLang', $userLang );
150 }
151 if ( isset( $languages[$contLang] ) ) {
152 $this->setVar( 'wgLanguageCode', $contLang );
153 }
154 return 'continue';
155 }
156 } elseif ( $this->parent->showSessionWarning ) {
157 # The user was knocked back from another page to the start
158 # This probably indicates a session expiry
159 $this->parent->showError( 'config-session-expired', $wgLang->formatTimePeriod( $lifetime ) );
160 }
161
162 $this->parent->setSession( 'test', true );
163
164 if ( !isset( $languages[$userLang] ) ) {
165 $userLang = $this->getVar( '_UserLang', 'en' );
166 }
167 if ( !isset( $languages[$contLang] ) ) {
168 $contLang = $this->getVar( 'wgLanguageCode', 'en' );
169 }
170 $this->startForm();
171 $s = Html::hidden( 'LanguageRequestTime', time() ) .
172 $this->getLanguageSelector( 'UserLang', 'config-your-language', $userLang, $this->parent->getHelpBox( 'config-your-language-help' ) ) .
173 $this->getLanguageSelector( 'ContLang', 'config-wiki-language', $contLang, $this->parent->getHelpBox( 'config-wiki-language-help' ) );
174 $this->addHTML( $s );
175 $this->endForm( 'continue', false );
176 }
177
178 /**
179 * Get a <select> for selecting languages.
180 */
181 public function getLanguageSelector( $name, $label, $selectedCode ) {
182 global $wgDummyLanguageCodes;
183 $s = Html::openElement( 'select', array( 'id' => $name, 'name' => $name ) ) . "\n";
184
185 $languages = Language::getLanguageNames();
186 ksort( $languages );
187 $dummies = array_flip( $wgDummyLanguageCodes );
188 foreach ( $languages as $code => $lang ) {
189 if ( isset( $dummies[$code] ) ) continue;
190 $s .= "\n" . Xml::option( "$code - $lang", $code, $code == $selectedCode );
191 }
192 $s .= "\n</select>\n";
193 return $this->parent->label( $label, $name, $s );
194 }
195
196 }
197
198 class WebInstaller_ExistingWiki extends WebInstallerPage {
199 public function execute() {
200 // If there is no LocalSettings.php, continue to the installer welcome page
201 $vars = $this->parent->getExistingLocalSettings();
202 if ( !$vars ) {
203 return 'skip';
204 }
205
206 // Check if the upgrade key supplied to the user has appeared in LocalSettings.php
207 if ( $vars['wgUpgradeKey'] !== false
208 && $this->getVar( '_UpgradeKeySupplied' )
209 && $this->getVar( 'wgUpgradeKey' ) === $vars['wgUpgradeKey'] )
210 {
211 // It's there, so the user is authorized
212 $status = $this->handleExistingUpgrade( $vars );
213 if ( $status->isOK() ) {
214 return 'skip';
215 } else {
216 $this->startForm();
217 $this->parent->showStatusBox( $status );
218 $this->endForm( 'continue' );
219 return 'output';
220 }
221 }
222
223 // If there is no $wgUpgradeKey, tell the user to add one to LocalSettings.php
224 if ( $vars['wgUpgradeKey'] === false ) {
225 if ( $this->getVar( 'wgUpgradeKey', false ) === false ) {
226 $this->parent->generateUpgradeKey();
227 $this->setVar( '_UpgradeKeySupplied', true );
228 }
229 $this->startForm();
230 $this->addHTML( $this->parent->getInfoBox(
231 wfMsgNoTrans( 'config-upgrade-key-missing',
232 "<pre>\$wgUpgradeKey = '" . $this->getVar( 'wgUpgradeKey' ) . "';</pre>" )
233 ) );
234 $this->endForm( 'continue' );
235 return 'output';
236 }
237
238 // If there is an upgrade key, but it wasn't supplied, prompt the user to enter it
239
240 $r = $this->parent->request;
241 if ( $r->wasPosted() ) {
242 $key = $r->getText( 'config_wgUpgradeKey' );
243 if( !$key || $key !== $vars['wgUpgradeKey'] ) {
244 $this->parent->showError( 'config-localsettings-badkey' );
245 $this->showKeyForm();
246 return 'output';
247 }
248 // Key was OK
249 $status = $this->handleExistingUpgrade( $vars );
250 if ( $status->isOK() ) {
251 return 'continue';
252 } else {
253 $this->parent->showStatusBox( $status );
254 $this->showKeyForm();
255 return 'output';
256 }
257 } else {
258 $this->showKeyForm();
259 return 'output';
260 }
261 }
262
263 /**
264 * Show the "enter key" form
265 */
266 protected function showKeyForm() {
267 $this->startForm();
268 $this->addHTML(
269 $this->parent->getInfoBox( wfMsgNoTrans( 'config-localsettings-upgrade' ) ).
270 '<br />' .
271 $this->parent->getTextBox( array(
272 'var' => 'wgUpgradeKey',
273 'label' => 'config-localsettings-key',
274 'attribs' => array( 'autocomplete' => 'off' ),
275 ) )
276 );
277 $this->endForm( 'continue' );
278 }
279
280 protected function importVariables( $names, $vars ) {
281 $status = Status::newGood();
282 foreach ( $names as $name ) {
283 if ( !isset( $vars[$name] ) ) {
284 $status->fatal( 'config-localsettings-incomplete', $name );
285 }
286 $this->setVar( $name, $vars[$name] );
287 }
288 return $status;
289 }
290
291 /**
292 * Initiate an upgrade of the existing database
293 * @param $vars Variables from LocalSettings.php and AdminSettings.php
294 * @return Status
295 */
296 protected function handleExistingUpgrade( $vars ) {
297 // Check $wgDBtype
298 if ( !isset( $vars['wgDBtype'] ) || !in_array( $vars['wgDBtype'], Installer::getDBTypes() ) ) {
299 return Status::newFatal( 'config-localsettings-connection-error', '' );
300 }
301
302 // Set the relevant variables from LocalSettings.php
303 $requiredVars = array( 'wgDBtype' );
304 $status = $this->importVariables( $requiredVars , $vars );
305 $installer = $this->parent->getDBInstaller();
306 $status->merge( $this->importVariables( $installer->getGlobalNames(), $vars ) );
307 if ( !$status->isOK() ) {
308 return $status;
309 }
310
311 if ( isset( $vars['wgDBadminuser'] ) ) {
312 $this->setVar( '_InstallUser', $vars['wgDBadminuser'] );
313 } else {
314 $this->setVar( '_InstallUser', $vars['wgDBuser'] );
315 }
316 if ( isset( $vars['wgDBadminpassword'] ) ) {
317 $this->setVar( '_InstallPassword', $vars['wgDBadminpassword'] );
318 } else {
319 $this->setVar( '_InstallPassword', $vars['wgDBpassword'] );
320 }
321
322 // Test the database connection
323 $status = $installer->getConnection();
324 if ( !$status->isOK() ) {
325 // Adjust the error message to explain things correctly
326 $status->replaceMessage( 'config-connection-error',
327 'config-localsettings-connection-error' );
328 return $status;
329 }
330
331 // All good
332 $this->setVar( '_ExistingDBSettings', true );
333 return $status;
334 }
335 }
336
337 class WebInstaller_Welcome extends WebInstallerPage {
338
339 public function execute() {
340 if ( $this->parent->request->wasPosted() ) {
341 if ( $this->getVar( '_Environment' ) ) {
342 return 'continue';
343 }
344 }
345 $this->parent->output->addWikiText( wfMsgNoTrans( 'config-welcome' ) );
346 $status = $this->parent->doEnvironmentChecks();
347 if ( $status->isGood() ) {
348 $this->parent->output->addHTML( '<span class="success-message">' .
349 wfMsgHtml( 'config-env-good' ) . '</span>' );
350 $this->parent->output->addWikiText( wfMsgNoTrans( 'config-copyright',
351 SpecialVersion::getCopyrightAndAuthorList() ) );
352 $this->startForm();
353 $this->endForm();
354 } else {
355 $this->parent->showStatusMessage( $status );
356 }
357 }
358
359 }
360
361 class WebInstaller_DBConnect extends WebInstallerPage {
362
363 public function execute() {
364 if ( $this->getVar( '_ExistingDBSettings' ) ) {
365 return 'skip';
366 }
367
368 $r = $this->parent->request;
369 if ( $r->wasPosted() ) {
370 $status = $this->submit();
371
372 if ( $status->isGood() ) {
373 $this->setVar( '_UpgradeDone', false );
374 return 'continue';
375 } else {
376 $this->parent->showStatusBox( $status );
377 }
378 }
379
380 $this->startForm();
381
382 $types = "<ul class=\"config-settings-block\">\n";
383 $settings = '';
384 $defaultType = $this->getVar( 'wgDBtype' );
385
386 $dbSupport = '';
387 foreach( $this->parent->getDBTypes() as $type ) {
388 $link = DatabaseBase::newFromType( $type )->getSoftwareLink();
389 $dbSupport .= wfMsgNoTrans( "config-support-$type", $link ) . "\n";
390 }
391 $this->addHTML( $this->parent->getInfoBox(
392 wfMsg( 'config-support-info', $dbSupport ) ) );
393
394 foreach ( $this->parent->getVar( '_CompiledDBs' ) as $type ) {
395 $installer = $this->parent->getDBInstaller( $type );
396 $types .=
397 '<li>' .
398 Xml::radioLabel(
399 $installer->getReadableName(),
400 'DBType',
401 $type,
402 "DBType_$type",
403 $type == $defaultType,
404 array( 'class' => 'dbRadio', 'rel' => "DB_wrapper_$type" )
405 ) .
406 "</li>\n";
407
408 $settings .=
409 Html::openElement( 'div', array( 'id' => 'DB_wrapper_' . $type, 'class' => 'dbWrapper' ) ) .
410 Html::element( 'h3', array(), wfMsg( 'config-header-' . $type ) ) .
411 $installer->getConnectForm() .
412 "</div>\n";
413 }
414 $types .= "</ul><br clear=\"left\"/>\n";
415
416 $this->addHTML(
417 $this->parent->label( 'config-db-type', false, $types ) .
418 $settings
419 );
420
421 $this->endForm();
422 }
423
424 public function submit() {
425 $r = $this->parent->request;
426 $type = $r->getVal( 'DBType' );
427 $this->setVar( 'wgDBtype', $type );
428 $installer = $this->parent->getDBInstaller( $type );
429 if ( !$installer ) {
430 return Status::newFatal( 'config-invalid-db-type' );
431 }
432 return $installer->submitConnectForm();
433 }
434
435 }
436
437 class WebInstaller_Upgrade extends WebInstallerPage {
438
439 public function execute() {
440 if ( $this->getVar( '_UpgradeDone' ) ) {
441 // Allow regeneration of LocalSettings.php, unless we are working
442 // from a pre-existing LocalSettings.php file and we want to avoid
443 // leaking its contents
444 if ( $this->parent->request->wasPosted() && !$this->getVar( '_ExistingDBSettings' ) ) {
445 // Done message acknowledged
446 return 'continue';
447 } else {
448 // Back button click
449 // Show the done message again
450 // Make them click back again if they want to do the upgrade again
451 $this->showDoneMessage();
452 return 'output';
453 }
454 }
455
456 // wgDBtype is generally valid here because otherwise the previous page
457 // (connect) wouldn't have declared its happiness
458 $type = $this->getVar( 'wgDBtype' );
459 $installer = $this->parent->getDBInstaller( $type );
460
461 if ( !$installer->needsUpgrade() ) {
462 return 'skip';
463 }
464
465 if ( $this->parent->request->wasPosted() ) {
466 $installer->preUpgrade();
467 $this->addHTML(
468 '<div id="config-spinner" style="display:none;"><img src="../skins/common/images/ajax-loader.gif" /></div>' .
469 '<script>jQuery( "#config-spinner" )[0].style.display = "block";</script>' .
470 '<textarea id="config-update-log" name="UpdateLog" rows="10" readonly="readonly">'
471 );
472 $this->parent->output->flush();
473 $result = $installer->doUpgrade();
474 $this->addHTML( '</textarea>
475 <script>jQuery( "#config-spinner" )[0].style.display = "none";</script>' );
476 $this->parent->output->flush();
477 if ( $result ) {
478 $this->setVar( '_UpgradeDone', true );
479 $this->showDoneMessage();
480 return 'output';
481 }
482 }
483
484 $this->startForm();
485 $this->addHTML( $this->parent->getInfoBox(
486 wfMsgNoTrans( 'config-can-upgrade', $GLOBALS['wgVersion'] ) ) );
487 $this->endForm();
488 }
489
490 public function showDoneMessage() {
491 $this->startForm();
492 $regenerate = !$this->getVar( '_ExistingDBSettings' );
493 if ( $regenerate ) {
494 $msg = 'config-upgrade-done';
495 } else {
496 $msg = 'config-upgrade-done-no-regenerate';
497 }
498 $this->parent->disableLinkPopups();
499 $this->addHTML(
500 $this->parent->getInfoBox(
501 wfMsgNoTrans( $msg,
502 $GLOBALS['wgServer'] .
503 $this->getVar( 'wgScriptPath' ) . '/index' .
504 $this->getVar( 'wgScriptExtension' )
505 ), 'tick-32.png'
506 )
507 );
508 $this->parent->restoreLinkPopups();
509 $this->endForm( $regenerate ? 'regenerate' : false, false );
510 }
511
512 }
513
514 class WebInstaller_DBSettings extends WebInstallerPage {
515
516 public function execute() {
517 $installer = $this->parent->getDBInstaller( $this->getVar( 'wgDBtype' ) );
518
519 $r = $this->parent->request;
520 if ( $r->wasPosted() ) {
521 $status = $installer->submitSettingsForm();
522 if ( $status === false ) {
523 return 'skip';
524 } elseif ( $status->isGood() ) {
525 return 'continue';
526 } else {
527 $this->parent->showStatusBox( $status );
528 }
529 }
530
531 $form = $installer->getSettingsForm();
532 if ( $form === false ) {
533 return 'skip';
534 }
535
536 $this->startForm();
537 $this->addHTML( $form );
538 $this->endForm();
539 }
540
541 }
542
543 class WebInstaller_Name extends WebInstallerPage {
544
545 public function execute() {
546 $r = $this->parent->request;
547 if ( $r->wasPosted() ) {
548 if ( $this->submit() ) {
549 return 'continue';
550 }
551 }
552
553 $this->startForm();
554
555 // Encourage people to not name their site 'MediaWiki' by blanking the
556 // field. I think that was the intent with the original $GLOBALS['wgSitename']
557 // but these two always were the same so had the effect of making the
558 // installer forget $wgSitename when navigating back to this page.
559 if ( $this->getVar( 'wgSitename' ) == 'MediaWiki' ) {
560 $this->setVar( 'wgSitename', '' );
561 }
562
563 // Set wgMetaNamespace to something valid before we show the form.
564 // $wgMetaNamespace defaults to $wgSiteName which is 'MediaWiki'
565 $metaNS = $this->getVar( 'wgMetaNamespace' );
566 $this->setVar( 'wgMetaNamespace', wfMsgForContent( 'config-ns-other-default' ) );
567
568 $this->addHTML(
569 $this->parent->getTextBox( array(
570 'var' => 'wgSitename',
571 'label' => 'config-site-name',
572 'help' => $this->parent->getHelpBox( 'config-site-name-help' )
573 ) ) .
574 $this->parent->getRadioSet( array(
575 'var' => '_NamespaceType',
576 'label' => 'config-project-namespace',
577 'itemLabelPrefix' => 'config-ns-',
578 'values' => array( 'site-name', 'generic', 'other' ),
579 'commonAttribs' => array( 'class' => 'enableForOther', 'rel' => 'config_wgMetaNamespace' ),
580 'help' => $this->parent->getHelpBox( 'config-project-namespace-help' )
581 ) ) .
582 $this->parent->getTextBox( array(
583 'var' => 'wgMetaNamespace',
584 'label' => '', //TODO: Needs a label?
585 'attribs' => array( 'readonly' => 'readonly', 'class' => 'enabledByOther' ),
586
587 ) ) .
588 $this->getFieldSetStart( 'config-admin-box' ) .
589 $this->parent->getTextBox( array(
590 'var' => '_AdminName',
591 'label' => 'config-admin-name',
592 'help' => $this->parent->getHelpBox( 'config-admin-help' )
593 ) ) .
594 $this->parent->getPasswordBox( array(
595 'var' => '_AdminPassword',
596 'label' => 'config-admin-password',
597 ) ) .
598 $this->parent->getPasswordBox( array(
599 'var' => '_AdminPassword2',
600 'label' => 'config-admin-password-confirm'
601 ) ) .
602 $this->parent->getTextBox( array(
603 'var' => '_AdminEmail',
604 'label' => 'config-admin-email',
605 'help' => $this->parent->getHelpBox( 'config-admin-email-help' )
606 ) ) .
607 $this->parent->getCheckBox( array(
608 'var' => '_Subscribe',
609 'label' => 'config-subscribe',
610 'help' => $this->parent->getHelpBox( 'config-subscribe-help' )
611 ) ) .
612 $this->getFieldSetEnd() .
613 $this->parent->getInfoBox( wfMsg( 'config-almost-done' ) ) .
614 $this->parent->getRadioSet( array(
615 'var' => '_SkipOptional',
616 'itemLabelPrefix' => 'config-optional-',
617 'values' => array( 'continue', 'skip' )
618 ) )
619 );
620
621 // Restore the default value
622 $this->setVar( 'wgMetaNamespace', $metaNS );
623
624 $this->endForm();
625 return 'output';
626 }
627
628 public function submit() {
629 $retVal = true;
630 $this->parent->setVarsFromRequest( array( 'wgSitename', '_NamespaceType',
631 '_AdminName', '_AdminPassword', '_AdminPassword2', '_AdminEmail',
632 '_Subscribe', '_SkipOptional', 'wgMetaNamespace' ) );
633
634 // Validate site name
635 if ( strval( $this->getVar( 'wgSitename' ) ) === '' ) {
636 $this->parent->showError( 'config-site-name-blank' );
637 $retVal = false;
638 }
639
640 // Fetch namespace
641 $nsType = $this->getVar( '_NamespaceType' );
642 if ( $nsType == 'site-name' ) {
643 $name = $this->getVar( 'wgSitename' );
644 // Sanitize for namespace
645 // This algorithm should match the JS one in WebInstallerOutput.php
646 $name = preg_replace( '/[\[\]\{\}|#<>%+? ]/', '_', $name );
647 $name = str_replace( '&', '&amp;', $name );
648 $name = preg_replace( '/__+/', '_', $name );
649 $name = ucfirst( trim( $name, '_' ) );
650 } elseif ( $nsType == 'generic' ) {
651 $name = wfMsg( 'config-ns-generic' );
652 } else { // other
653 $name = $this->getVar( 'wgMetaNamespace' );
654 }
655
656 // Validate namespace
657 if ( strpos( $name, ':' ) !== false ) {
658 $good = false;
659 } else {
660 // Title-style validation
661 $title = Title::newFromText( $name );
662 if ( !$title ) {
663 $good = $nsType == 'site-name';
664 } else {
665 $name = $title->getDBkey();
666 $good = true;
667 }
668 }
669 if ( !$good ) {
670 $this->parent->showError( 'config-ns-invalid', $name );
671 $retVal = false;
672 }
673
674 // Make sure it won't conflict with any existing namespaces
675 global $wgContLang;
676 $nsIndex = $wgContLang->getNsIndex( $name );
677 if( $nsIndex !== false && $nsIndex !== NS_PROJECT ) {
678 $this->parent->showError( 'config-ns-conflict', $name );
679 $retVal = false;
680 }
681
682 $this->setVar( 'wgMetaNamespace', $name );
683
684 // Validate username for creation
685 $name = $this->getVar( '_AdminName' );
686 if ( strval( $name ) === '' ) {
687 $this->parent->showError( 'config-admin-name-blank' );
688 $cname = $name;
689 $retVal = false;
690 } else {
691 $cname = User::getCanonicalName( $name, 'creatable' );
692 if ( $cname === false ) {
693 $this->parent->showError( 'config-admin-name-invalid', $name );
694 $retVal = false;
695 } else {
696 $this->setVar( '_AdminName', $cname );
697 }
698 }
699
700 // Validate password
701 $msg = false;
702 $valid = false;
703 $pwd = $this->getVar( '_AdminPassword' );
704 $user = User::newFromName( $cname );
705 $valid = $user && $user->getPasswordValidity( $pwd );
706 if ( strval( $pwd ) === '' ) {
707 # $user->getPasswordValidity just checks for $wgMinimalPasswordLength.
708 # This message is more specific and helpful.
709 $msg = 'config-admin-password-blank';
710 } elseif ( $pwd !== $this->getVar( '_AdminPassword2' ) ) {
711 $msg = 'config-admin-password-mismatch';
712 } elseif ( $valid !== true ) {
713 # As of writing this will only catch the username being e.g. 'FOO' and
714 # the password 'foo'
715 $msg = $valid;
716 }
717 if ( $msg !== false ) {
718 call_user_func_array( array( $this->parent, 'showError' ), (array)$msg );
719 $this->setVar( '_AdminPassword', '' );
720 $this->setVar( '_AdminPassword2', '' );
721 $retVal = false;
722 }
723
724 // Validate e-mail if provided
725 $email = $this->getVar( '_AdminEmail' );
726 if( $email && !User::isValidEmailAddr( $email ) ) {
727 $this->parent->showError( 'config-admin-error-bademail' );
728 $retVal = false;
729 }
730
731 return $retVal;
732 }
733
734 }
735
736 class WebInstaller_Options extends WebInstallerPage {
737
738 public function execute() {
739 if ( $this->getVar( '_SkipOptional' ) == 'skip' ) {
740 return 'skip';
741 }
742 if ( $this->parent->request->wasPosted() ) {
743 if ( $this->submit() ) {
744 return 'continue';
745 }
746 }
747
748 $this->startForm();
749 $this->addHTML(
750 # User Rights
751 $this->parent->getRadioSet( array(
752 'var' => '_RightsProfile',
753 'label' => 'config-profile',
754 'itemLabelPrefix' => 'config-profile-',
755 'values' => array_keys( $this->parent->rightsProfiles ),
756 ) ) .
757 $this->parent->getInfoBox( wfMsgNoTrans( 'config-profile-help' ) ) .
758
759 # Licensing
760 $this->parent->getRadioSet( array(
761 'var' => '_LicenseCode',
762 'label' => 'config-license',
763 'itemLabelPrefix' => 'config-license-',
764 'values' => array_keys( $this->parent->licenses ),
765 'commonAttribs' => array( 'class' => 'licenseRadio' ),
766 ) ) .
767 $this->getCCChooser() .
768 $this->parent->getHelpBox( 'config-license-help' ) .
769
770 # E-mail
771 $this->getFieldSetStart( 'config-email-settings' ) .
772 $this->parent->getCheckBox( array(
773 'var' => 'wgEnableEmail',
774 'label' => 'config-enable-email',
775 'attribs' => array( 'class' => 'showHideRadio', 'rel' => 'emailwrapper' ),
776 ) ) .
777 $this->parent->getHelpBox( 'config-enable-email-help' ) .
778 "<div id=\"emailwrapper\">" .
779 $this->parent->getTextBox( array(
780 'var' => 'wgPasswordSender',
781 'label' => 'config-email-sender'
782 ) ) .
783 $this->parent->getHelpBox( 'config-email-sender-help' ) .
784 $this->parent->getCheckBox( array(
785 'var' => 'wgEnableUserEmail',
786 'label' => 'config-email-user',
787 ) ) .
788 $this->parent->getHelpBox( 'config-email-user-help' ) .
789 $this->parent->getCheckBox( array(
790 'var' => 'wgEnotifUserTalk',
791 'label' => 'config-email-usertalk',
792 ) ) .
793 $this->parent->getHelpBox( 'config-email-usertalk-help' ) .
794 $this->parent->getCheckBox( array(
795 'var' => 'wgEnotifWatchlist',
796 'label' => 'config-email-watchlist',
797 ) ) .
798 $this->parent->getHelpBox( 'config-email-watchlist-help' ) .
799 $this->parent->getCheckBox( array(
800 'var' => 'wgEmailAuthentication',
801 'label' => 'config-email-auth',
802 ) ) .
803 $this->parent->getHelpBox( 'config-email-auth-help' ) .
804 "</div>" .
805 $this->getFieldSetEnd()
806 );
807
808 $extensions = $this->parent->findExtensions();
809
810 if( $extensions ) {
811 $extHtml = $this->getFieldSetStart( 'config-extensions' );
812
813 foreach( $extensions as $ext ) {
814 $extHtml .= $this->parent->getCheckBox( array(
815 'var' => "ext-$ext",
816 'rawtext' => $ext,
817 ) );
818 }
819
820 $extHtml .= $this->parent->getHelpBox( 'config-extensions-help' ) .
821 $this->getFieldSetEnd();
822 $this->addHTML( $extHtml );
823 }
824
825 // Having / in paths in Windows looks funny :)
826 $this->setVar( 'wgDeletedDirectory',
827 str_replace(
828 '/', DIRECTORY_SEPARATOR,
829 $this->getVar( 'wgDeletedDirectory' )
830 )
831 );
832
833 $this->addHTML(
834 # Uploading
835 $this->getFieldSetStart( 'config-upload-settings' ) .
836 $this->parent->getCheckBox( array(
837 'var' => 'wgEnableUploads',
838 'label' => 'config-upload-enable',
839 'attribs' => array( 'class' => 'showHideRadio', 'rel' => 'uploadwrapper' ),
840 'help' => $this->parent->getHelpBox( 'config-upload-help' )
841 ) ) .
842 '<div id="uploadwrapper" style="display: none;">' .
843 $this->parent->getTextBox( array(
844 'var' => 'wgDeletedDirectory',
845 'label' => 'config-upload-deleted',
846 'help' => $this->parent->getHelpBox( 'config-upload-deleted-help' )
847 ) ) .
848 '</div>' .
849 $this->parent->getTextBox( array(
850 'var' => 'wgLogo',
851 'label' => 'config-logo',
852 'help' => $this->parent->getHelpBox( 'config-logo-help' )
853 ) )
854 );
855 $this->addHTML(
856 $this->parent->getCheckBox( array(
857 'var' => 'wgUseInstantCommons',
858 'label' => 'config-instantcommons',
859 'help' => $this->parent->getHelpBox( 'config-instantcommons-help' )
860 ) ) .
861 $this->getFieldSetEnd()
862 );
863
864 $caches = array( 'none' );
865 if( count( $this->getVar( '_Caches' ) ) ) {
866 $caches[] = 'accel';
867 }
868 $caches[] = 'memcached';
869
870 $this->addHTML(
871 # Advanced settings
872 $this->getFieldSetStart( 'config-advanced-settings' ) .
873 # Object cache settings
874 $this->parent->getRadioSet( array(
875 'var' => 'wgMainCacheType',
876 'label' => 'config-cache-options',
877 'itemLabelPrefix' => 'config-cache-',
878 'values' => $caches,
879 'value' => 'none',
880 ) ) .
881 $this->parent->getHelpBox( 'config-cache-help' ) .
882 '<div id="config-memcachewrapper">' .
883 $this->parent->getTextArea( array(
884 'var' => '_MemCachedServers',
885 'label' => 'config-memcached-servers',
886 'help' => $this->parent->getHelpBox( 'config-memcached-help' )
887 ) ) .
888 '</div>' .
889 $this->getFieldSetEnd()
890 );
891 $this->endForm();
892 }
893
894 public function getCCPartnerUrl() {
895 global $wgServer;
896 $exitUrl = $wgServer . $this->parent->getUrl( array(
897 'page' => 'Options',
898 'SubmitCC' => 'indeed',
899 'config__LicenseCode' => 'cc',
900 'config_wgRightsUrl' => '[license_url]',
901 'config_wgRightsText' => '[license_name]',
902 'config_wgRightsIcon' => '[license_button]',
903 ) );
904 $styleUrl = $wgServer . dirname( dirname( $this->parent->getUrl() ) ) .
905 '/skins/common/config-cc.css';
906 $iframeUrl = 'http://creativecommons.org/license/?' .
907 wfArrayToCGI( array(
908 'partner' => 'MediaWiki',
909 'exit_url' => $exitUrl,
910 'lang' => $this->getVar( '_UserLang' ),
911 'stylesheet' => $styleUrl,
912 ) );
913 return $iframeUrl;
914 }
915
916 public function getCCChooser() {
917 $iframeAttribs = array(
918 'class' => 'config-cc-iframe',
919 'name' => 'config-cc-iframe',
920 'id' => 'config-cc-iframe',
921 'frameborder' => 0,
922 'width' => '100%',
923 'height' => '100%',
924 );
925 if ( $this->getVar( '_CCDone' ) ) {
926 $iframeAttribs['src'] = $this->parent->getUrl( array( 'ShowCC' => 'yes' ) );
927 } else {
928 $iframeAttribs['src'] = $this->getCCPartnerUrl();
929 }
930
931 return
932 "<div class=\"config-cc-wrapper\" id=\"config-cc-wrapper\" style=\"display: none;\">\n" .
933 Html::element( 'iframe', $iframeAttribs, '', false /* not short */ ) .
934 "</div>\n";
935 }
936
937 public function getCCDoneBox() {
938 $js = "parent.document.getElementById('config-cc-wrapper').style.height = '$1';";
939 // If you change this height, also change it in config.css
940 $expandJs = str_replace( '$1', '54em', $js );
941 $reduceJs = str_replace( '$1', '70px', $js );
942 return
943 '<p>'.
944 Html::element( 'img', array( 'src' => $this->getVar( 'wgRightsIcon' ) ) ) .
945 '&#160;&#160;' .
946 htmlspecialchars( $this->getVar( 'wgRightsText' ) ) .
947 "</p>\n" .
948 "<p style=\"text-align: center\">" .
949 Html::element( 'a',
950 array(
951 'href' => $this->getCCPartnerUrl(),
952 'onclick' => $expandJs,
953 ),
954 wfMsg( 'config-cc-again' )
955 ) .
956 "</p>\n" .
957 "<script type=\"text/javascript\">\n" .
958 # Reduce the wrapper div height
959 htmlspecialchars( $reduceJs ) .
960 "\n" .
961 "</script>\n";
962 }
963
964 public function submitCC() {
965 $newValues = $this->parent->setVarsFromRequest(
966 array( 'wgRightsUrl', 'wgRightsText', 'wgRightsIcon' ) );
967 if ( count( $newValues ) != 3 ) {
968 $this->parent->showError( 'config-cc-error' );
969 return;
970 }
971 $this->setVar( '_CCDone', true );
972 $this->addHTML( $this->getCCDoneBox() );
973 }
974
975 public function submit() {
976 $this->parent->setVarsFromRequest( array( '_RightsProfile', '_LicenseCode',
977 'wgEnableEmail', 'wgPasswordSender', 'wgEnableUploads', 'wgLogo',
978 'wgEnableUserEmail', 'wgEnotifUserTalk', 'wgEnotifWatchlist',
979 'wgEmailAuthentication', 'wgMainCacheType', '_MemCachedServers',
980 'wgUseInstantCommons' ) );
981
982 if ( !in_array( $this->getVar( '_RightsProfile' ),
983 array_keys( $this->parent->rightsProfiles ) ) )
984 {
985 reset( $this->parent->rightsProfiles );
986 $this->setVar( '_RightsProfile', key( $this->parent->rightsProfiles ) );
987 }
988
989 $code = $this->getVar( '_LicenseCode' );
990 if ( $code == 'cc-choose' ) {
991 if ( !$this->getVar( '_CCDone' ) ) {
992 $this->parent->showError( 'config-cc-not-chosen' );
993 return false;
994 }
995 } elseif ( in_array( $code, array_keys( $this->parent->licenses ) ) ) {
996 $entry = $this->parent->licenses[$code];
997 if ( isset( $entry['text'] ) ) {
998 $this->setVar( 'wgRightsText', $entry['text'] );
999 } else {
1000 $this->setVar( 'wgRightsText', wfMsg( 'config-license-' . $code ) );
1001 }
1002 $this->setVar( 'wgRightsUrl', $entry['url'] );
1003 $this->setVar( 'wgRightsIcon', $entry['icon'] );
1004 } else {
1005 $this->setVar( 'wgRightsText', '' );
1006 $this->setVar( 'wgRightsUrl', '' );
1007 $this->setVar( 'wgRightsIcon', '' );
1008 }
1009
1010 $extsAvailable = $this->parent->findExtensions();
1011 $extsToInstall = array();
1012 foreach( $extsAvailable as $ext ) {
1013 if( $this->parent->request->getCheck( 'config_ext-' . $ext ) ) {
1014 $extsToInstall[] = $ext;
1015 }
1016 }
1017 $this->parent->setVar( '_Extensions', $extsToInstall );
1018
1019 if( $this->getVar( 'wgMainCacheType' ) == 'memcached' ) {
1020 $memcServers = explode( "\n", $this->getVar( '_MemCachedServers' ) );
1021 if( !$memcServers ) {
1022 $this->parent->showError( 'config-memcache-needservers' );
1023 return false;
1024 }
1025
1026 foreach( $memcServers as $server ) {
1027 $memcParts = explode( ":", $server );
1028 if( !IP::isValid( $memcParts[0] ) ) {
1029 $this->parent->showError( 'config-memcache-badip', $memcParts[0] );
1030 return false;
1031 } elseif( !isset( $memcParts[1] ) ) {
1032 $this->parent->showError( 'config-memcache-noport', $memcParts[0] );
1033 return false;
1034 } elseif( $memcParts[1] < 1 || $memcParts[1] > 65535 ) {
1035 $this->parent->showError( 'config-memcache-badport', 1, 65535 );
1036 return false;
1037 }
1038 }
1039 }
1040 return true;
1041 }
1042
1043 }
1044
1045 class WebInstaller_Install extends WebInstallerPage {
1046
1047 public function execute() {
1048 if( $this->getVar( '_UpgradeDone' ) ) {
1049 return 'skip';
1050 } elseif( $this->getVar( '_InstallDone' ) ) {
1051 return 'continue';
1052 } elseif( $this->parent->request->wasPosted() ) {
1053 $this->startForm();
1054 $this->addHTML("<ul>");
1055 $results = $this->parent->performInstallation(
1056 array( $this, 'startStage'),
1057 array( $this, 'endStage' )
1058 );
1059 $this->addHTML("</ul>");
1060 // PerformInstallation bails on a fatal, so make sure the last item
1061 // completed before giving 'next.' Likewise, only provide back on failure
1062 $lastStep = end( $results );
1063 $continue = $lastStep->isOK() ? 'continue' : false;
1064 $back = $lastStep->isOK() ? false : 'back';
1065 $this->endForm( $continue, $back );
1066 } else {
1067 $this->startForm();
1068 $this->addHTML( $this->parent->getInfoBox( wfMsgNoTrans( 'config-install-begin' ) ) );
1069 $this->endForm();
1070 }
1071 return true;
1072 }
1073
1074 public function startStage( $step ) {
1075 $this->addHTML( "<li>" . wfMsgHtml( "config-install-$step" ) . wfMsg( 'ellipsis') );
1076 }
1077
1078 public function endStage( $step, $status ) {
1079 $msg = $status->isOk() ? 'config-install-step-done' : 'config-install-step-failed';
1080 $html = wfMsgHtml( 'word-separator' ) . wfMsgHtml( $msg );
1081 if ( !$status->isOk() ) {
1082 $html = "<span class=\"error\">$html</span>";
1083 }
1084 $this->addHTML( $html . "</li>\n" );
1085 if( !$status->isGood() ) {
1086 $this->parent->showStatusBox( $status );
1087 }
1088 }
1089
1090 }
1091
1092 class WebInstaller_Complete extends WebInstallerPage {
1093
1094 public function execute() {
1095 // Pop up a dialog box, to make it difficult for the user to forget
1096 // to download the file
1097 $lsUrl = $GLOBALS['wgServer'] . $this->parent->getURL( array( 'localsettings' => 1 ) );
1098 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && strpos( $_SERVER['HTTP_USER_AGENT'], 'MSIE' ) !== false ) {
1099 // JS appears the only method that works consistently with IE7+
1100 $this->addHtml( "\n<script type=\"" . $GLOBALS['wgJsMimeType'] . '">jQuery( document ).ready( function() { document.location='
1101 . Xml::encodeJsVar( $lsUrl) . "; } );</script>\n" );
1102 } else {
1103 $this->parent->request->response()->header( "Refresh: 0;url=$lsUrl" );
1104 }
1105
1106 $this->startForm();
1107 $this->parent->disableLinkPopups();
1108 $this->addHTML(
1109 $this->parent->getInfoBox(
1110 wfMsgNoTrans( 'config-install-done',
1111 $lsUrl,
1112 $GLOBALS['wgServer'] .
1113 $this->getVar( 'wgScriptPath' ) . '/index' .
1114 $this->getVar( 'wgScriptExtension' ),
1115 '<downloadlink/>'
1116 ), 'tick-32.png'
1117 )
1118 );
1119 $this->parent->restoreLinkPopups();
1120 $this->endForm( false, false );
1121 }
1122 }
1123
1124 class WebInstaller_Restart extends WebInstallerPage {
1125
1126 public function execute() {
1127 $r = $this->parent->request;
1128 if ( $r->wasPosted() ) {
1129 $really = $r->getVal( 'submit-restart' );
1130 if ( $really ) {
1131 $this->parent->reset();
1132 }
1133 return 'continue';
1134 }
1135
1136 $this->startForm();
1137 $s = $this->parent->getWarningBox( wfMsgNoTrans( 'config-help-restart' ) );
1138 $this->addHTML( $s );
1139 $this->endForm( 'restart' );
1140 }
1141
1142 }
1143
1144 abstract class WebInstaller_Document extends WebInstallerPage {
1145
1146 protected abstract function getFileName();
1147
1148 public function execute() {
1149 $text = $this->getFileContents();
1150 $text = $this->formatTextFile( $text );
1151 $this->parent->output->addWikiText( $text );
1152 $this->startForm();
1153 $this->endForm( false );
1154 }
1155
1156 public function getFileContents() {
1157 return file_get_contents( dirname( __FILE__ ) . '/../../' . $this->getFileName() );
1158 }
1159
1160 protected function formatTextFile( $text ) {
1161 // Use Unix line endings, escape some wikitext stuff
1162 $text = str_replace( array( '<', '{{', '[[', "\r" ),
1163 array( '&lt;', '&#123;&#123;', '&#91;&#91;', '' ), $text );
1164 // join word-wrapped lines into one
1165 do {
1166 $prev = $text;
1167 $text = preg_replace( "/\n([\\*#\t])([^\n]*?)\n([^\n#\\*:]+)/", "\n\\1\\2 \\3", $text );
1168 } while ( $text != $prev );
1169 // Replace tab indents with colons
1170 $text = preg_replace( '/^\t\t/m', '::', $text );
1171 $text = preg_replace( '/^\t/m', ':', $text );
1172 // turn (bug nnnn) into links
1173 $text = preg_replace_callback('/bug (\d+)/', array( $this, 'replaceBugLinks' ), $text );
1174 // add links to manual to every global variable mentioned
1175 $text = preg_replace_callback('/(\$wg[a-z0-9_]+)/i', array( $this, 'replaceConfigLinks' ), $text );
1176 return $text;
1177 }
1178
1179 private function replaceBugLinks( $matches ) {
1180 return '<span class="config-plainlink">[https://bugzilla.wikimedia.org/' .
1181 $matches[1] . ' bug ' . $matches[1] . ']</span>';
1182 }
1183
1184 private function replaceConfigLinks( $matches ) {
1185 return '<span class="config-plainlink">[http://www.mediawiki.org/wiki/Manual:' .
1186 $matches[1] . ' ' . $matches[1] . ']</span>';
1187 }
1188
1189 }
1190
1191 class WebInstaller_Readme extends WebInstaller_Document {
1192 protected function getFileName() { return 'README'; }
1193 }
1194
1195 class WebInstaller_ReleaseNotes extends WebInstaller_Document {
1196 protected function getFileName() { return 'RELEASE-NOTES'; }
1197 }
1198
1199 class WebInstaller_UpgradeDoc extends WebInstaller_Document {
1200 protected function getFileName() { return 'UPGRADE'; }
1201 }
1202
1203 class WebInstaller_Copying extends WebInstaller_Document {
1204 protected function getFileName() { return 'COPYING'; }
1205 }
1206