mediawiki-extensions-Interwiki/Interwiki_body.php
Amir E. Aharoni 5f632390a8 (bug 36900) Message functions fixing
* Improving comments.
* Improving message escaping.

Change-Id: Iacda23bb46569022f317474e7fa8cfddd8d2da8c
2012-05-21 00:44:27 +03:00

356 lines
13 KiB
PHP

<?php
/**
* Implements Special:Interwiki
* @ingroup SpecialPage
*/
class SpecialInterwiki extends SpecialPage {
/**
* Constructor - sets up the new special page
*/
public function __construct() {
parent::__construct( 'Interwiki' );
}
/**
* Different description will be shown on Special:SpecialPage depending on
* whether the user can modify the data.
*/
function getDescription() {
return $this->msg( $this->canModify() ?
'interwiki' : 'interwiki-title-norights' )->plain();
}
/**
* Show the special page
*
* @param $par Mixed: parameter passed to the page or null
*/
public function execute( $par ) {
$this->setHeaders();
$this->outputHeader();
$out = $this->getOutput();
$request = $this->getRequest();
$out->addModuleStyles( 'SpecialInterwiki' );
$action = $par ? $par : $request->getVal( 'action', $par );
$return = $this->getTitle();
switch( $action ) {
case 'delete':
case 'edit':
case 'add':
if ( $this->canModify( $out ) ) {
$out->addHTML( $this->showForm( $action ) );
}
$out->returnToMain( false, $return );
break;
case 'submit':
if ( !$this->canModify( $out ) ) {
# Error msg added by canModify()
} elseif ( !$request->wasPosted() || !$this->getUser()->matchEditToken( $request->getVal( 'wpEditToken' ) ) ) {
// Prevent cross-site request forgeries
$out->addWikiMsg( 'sessionfailure' );
} else {
$this->doSubmit();
}
$out->returnToMain( false, $return );
break;
default:
$this->showList();
break;
}
}
/**
* Returns boolean whether the user can modify the data.
* @param $out If $wgOut object given, it adds the respective error message.
* @return Boolean
*/
public function canModify( $out = false ) {
global $wgInterwikiCache;
if ( !$this->getUser()->isAllowed( 'interwiki' ) ) {
# Check permissions
if ( $out ) {
throw new PermissionsError( 'interwiki' );
}
return false;
} elseif ( $wgInterwikiCache ) {
# Editing the interwiki cache is not supported
if ( $out ) {
$out->addWikiMsg( 'interwiki-cached' );
}
return false;
} elseif ( wfReadOnly() ) {
# Is the database in read-only mode?
if ( $out ) {
$out->readOnlyPage();
}
return false;
}
return true;
}
function showForm( $action ) {
$request = $this->getRequest();
$prefix = $request->getVal( 'prefix' );
$wpPrefix = '';
$label = array( 'class' => 'mw-label' );
$input = array( 'class' => 'mw-input' );
if ( $action === 'delete' ) {
$topmessage = $this->msg( 'interwiki_delquestion', $prefix )->text();
$intromessage = $this->msg( 'interwiki_deleting', $prefix )->escaped();
$wpPrefix = Html::hidden( 'wpInterwikiPrefix', $prefix );
$button = 'delete';
$formContent = '';
} elseif ( $action === 'edit' ) {
$dbr = wfGetDB( DB_SLAVE );
$row = $dbr->selectRow( 'interwiki', '*', array( 'iw_prefix' => $prefix ), __METHOD__ );
if ( !$row ) {
$this->error( 'interwiki_editerror', $prefix );
return;
}
$prefix = $row->iw_prefix;
$defaulturl = $row->iw_url;
$trans = $row->iw_trans;
$local = $row->iw_local;
$wpPrefix = Html::hidden( 'wpInterwikiPrefix', $row->iw_prefix );
$topmessage = $this->msg( 'interwiki_edittext' )->text();
$intromessage = $this->msg( 'interwiki_editintro' )->escaped();
$button = 'edit';
} elseif ( $action === 'add' ) {
$prefix = $request->getVal( 'wpInterwikiPrefix', $request->getVal( 'prefix' ) );
$prefix = Xml::input( 'wpInterwikiPrefix', 20, $prefix,
array( 'tabindex' => 1, 'id' => 'mw-interwiki-prefix', 'maxlength' => 20 ) );
$local = $request->getCheck( 'wpInterwikiLocal' );
$trans = $request->getCheck( 'wpInterwikiTrans' );
$defaulturl = $request->getVal( 'wpInterwikiURL', $this->msg( 'interwiki-defaulturl' )->text() );
$topmessage = $this->msg( 'interwiki_addtext' )->text();
$intromessage = $this->msg( 'interwiki_addintro' )->escaped();
$button = 'interwiki_addbutton';
}
if ( $action === 'add' || $action === 'edit' ) {
$formContent = Html::rawElement( 'tr', null,
Html::element( 'td', $label, $this->msg( 'interwiki-prefix-label' )->text() ) .
Html::rawElement( 'td', null, '<tt>' . $prefix . '</tt>' )
) . Html::rawElement( 'tr', null,
Html::rawElement( 'td', $label, Xml::label( $this->msg( 'interwiki-local-label' )->text(), 'mw-interwiki-local' ) ) .
Html::rawElement( 'td', $input, Xml::check( 'wpInterwikiLocal', $local, array( 'id' => 'mw-interwiki-local' ) ) )
) . Html::rawElement( 'tr', null,
Html::rawElement( 'td', $label, Xml::label( $this->msg( 'interwiki-trans-label' )->text(), 'mw-interwiki-trans' ) ) .
Html::rawElement( 'td', $input, Xml::check( 'wpInterwikiTrans', $trans, array( 'id' => 'mw-interwiki-trans' ) ) )
) . Html::rawElement( 'tr', null,
Html::rawElement( 'td', $label, Xml::label( $this->msg( 'interwiki-url-label' )->text(), 'mw-interwiki-url' ) ) .
Html::rawElement( 'td', $input, Xml::input( 'wpInterwikiURL', 60, $defaulturl,
array( 'tabindex' => 1, 'maxlength' => 200, 'id' => 'mw-interwiki-url' ) ) )
);
}
return Xml::fieldset( $topmessage, Html::rawElement( 'form',
array( 'id' => "mw-interwiki-{$action}form", 'method' => 'post',
'action' => $this->getTitle()->getLocalURL( 'action=submit' ) ),
Html::rawElement( 'p', null, $intromessage ) .
Html::rawElement( 'table', array( 'id' => "mw-interwiki-{$action}" ),
$formContent . Html::rawElement( 'tr', null,
Html::rawElement( 'td', $label, Xml::label( $this->msg( 'interwiki_reasonfield' )->text(),
"mw-interwiki-{$action}reason" ) ) .
Html::rawElement( 'td', $input, Xml::input( 'wpInterwikiReason', 60, '',
array( 'tabindex' => 1, 'id' => "mw-interwiki-{$action}reason", 'maxlength' => 200 ) ) )
) . Html::rawElement( 'tr', null,
Html::rawElement( 'td', null, '' ) .
Html::rawElement( 'td', array( 'class' => 'mw-submit' ),
Xml::submitButton( $this->msg( $button )->text(), array( 'id' => 'mw-interwiki-submit' ) ) )
) . $wpPrefix .
Html::hidden( 'wpEditToken', $this->getUser()->editToken() ) .
Html::hidden( 'wpInterwikiAction', $action )
)
) );
}
function doSubmit() {
global $wgContLang, $wgMemc;
$request = $this->getRequest();
$prefix = $request->getVal( 'wpInterwikiPrefix' );
$do = $request->getVal( 'wpInterwikiAction' );
// Show an error if the prefix is invalid (only when adding one).
// Invalid characters are ':', '&', '=' and whitespace.
if ( preg_match( '/[\s:&=]/', $prefix ) && $do === 'add' ) {
$this->error( 'interwiki-badprefix', htmlspecialchars( $prefix ) );
$this->showForm( $do );
return;
}
$reason = $request->getText( 'wpInterwikiReason' );
$selfTitle = $this->getTitle();
$dbw = wfGetDB( DB_MASTER );
switch( $do ) {
case 'delete':
$dbw->delete( 'interwiki', array( 'iw_prefix' => $prefix ), __METHOD__ );
if ( $dbw->affectedRows() === 0 ) {
$this->error( 'interwiki_delfailed', $prefix );
$this->showForm( $do );
} else {
$this->getOutput()->addWikiMsg( 'interwiki_deleted', $prefix );
$log = new LogPage( 'interwiki' );
$log->addEntry( 'iw_delete', $selfTitle, $reason, array( $prefix ) );
$wgMemc->delete( wfMemcKey( 'interwiki', $prefix ) );
}
break;
case 'add':
$prefix = $wgContLang->lc( $prefix );
// N.B.: no break!
case 'edit':
$theurl = $request->getVal( 'wpInterwikiURL' );
$local = $request->getCheck( 'wpInterwikiLocal' ) ? 1 : 0;
$trans = $request->getCheck( 'wpInterwikiTrans' ) ? 1 : 0;
$data = array(
'iw_prefix' => $prefix,
'iw_url' => $theurl,
'iw_local' => $local,
'iw_trans' => $trans
);
if ( $prefix === '' || $theurl === '' ) {
$this->error( 'interwiki-submit-empty' );
$this->showForm( $do );
return;
}
if ( $do === 'add' ) {
$dbw->insert( 'interwiki', $data, __METHOD__, 'IGNORE' );
} else { // $do === 'edit'
$dbw->update( 'interwiki', $data, array( 'iw_prefix' => $prefix ), __METHOD__, 'IGNORE' );
}
// used here: interwiki_addfailed, interwiki_added, interwiki_edited
if ( $dbw->affectedRows() === 0 ) {
$this->error( "interwiki_{$do}failed", $prefix );
$this->showForm( $do );
} else {
$this->getOutput()->addWikiMsg( "interwiki_{$do}ed", $prefix );
$log = new LogPage( 'interwiki' );
$log->addEntry( 'iw_' . $do, $selfTitle, $reason, array( $prefix, $theurl, $trans, $local ) );
$wgMemc->delete( wfMemcKey( 'interwiki', $prefix ) );
}
break;
}
}
function showList() {
$canModify = $this->canModify();
$this->getOutput()->addWikiMsg( 'interwiki_intro' );
$this->getOutput()->addHTML(
Html::rawElement( 'table', array( 'class' => 'mw-interwikitable wikitable intro' ),
self::addInfoRow( 'start', 'interwiki_prefix', 'interwiki_prefix_intro' ) .
self::addInfoRow( 'start', 'interwiki_url', 'interwiki_url_intro' ) .
self::addInfoRow( 'start', 'interwiki_local', 'interwiki_local_intro' ) .
self::addInfoRow( 'end', 'interwiki_0', 'interwiki_local_0_intro' ) .
self::addInfoRow( 'end', 'interwiki_1', 'interwiki_local_1_intro' ) .
self::addInfoRow( 'start', 'interwiki_trans', 'interwiki_trans_intro' ) .
self::addInfoRow( 'end', 'interwiki_0', 'interwiki_trans_0_intro' ) .
self::addInfoRow( 'end', 'interwiki_1', 'interwiki_trans_1_intro' )
) . "\n"
);
if ( $canModify ) {
$this->getOutput()->addWikiMsg( 'interwiki_intro_footer' );
$addtext = $this->msg( 'interwiki_addtext' )->escaped();
$addlink = Linker::linkKnown( $this->getTitle( 'add' ), $addtext );
$this->getOutput()->addHTML( '<p class="mw-interwiki-addlink">' . $addlink . '</p>' );
}
if ( !method_exists( 'Interwiki', 'getAllPrefixes' ) ) {
# version 2.0 is not backwards compatible (but still display nice error)
$this->error( 'interwiki_error' );
return;
}
$iwPrefixes = Interwiki::getAllPrefixes( null );
if ( !is_array( $iwPrefixes ) || count( $iwPrefixes ) === 0 ) {
# If the interwiki table is empty, display an error message
$this->error( 'interwiki_error' );
return;
}
$out = '';
# Output the existing Interwiki prefixes table header
$out .= Html::openElement( 'table', array( 'class' => 'mw-interwikitable wikitable sortable body' ) ) . "\n";
$out .= Html::openElement( 'tr', array( 'id' => 'interwikitable-header' ) ) .
Html::element( 'th', null, $this->msg( 'interwiki_prefix' )->text() ) .
Html::element( 'th', null, $this->msg( 'interwiki_url' )->text() ) .
Html::element( 'th', null, $this->msg( 'interwiki_local' )->text() ) .
Html::element( 'th', null, $this->msg( 'interwiki_trans' )->text() ) .
( $canModify ? Html::element( 'th', array( 'class' => 'unsortable' ), $this->msg( 'interwiki_edit' )->text() ) : '' );
$out .= Html::closeElement( 'tr' ) . "\n";
$selfTitle = $this->getTitle();
# Output the existing Interwiki prefixes table rows
foreach ( $iwPrefixes as $i => $iwPrefix ) {
$out .= Html::openElement( 'tr', array( 'class' => 'mw-interwikitable-row' ) );
$out .= Html::element( 'td', array( 'class' => 'mw-interwikitable-prefix' ),
$iwPrefix['iw_prefix'] );
$out .= Html::element( 'td', array( 'class' => 'mw-interwikitable-url' ), $iwPrefix['iw_url'] );
// The messages interwiki_0 and interwiki_1 are used here.
$out .= Html::element( 'td', array( 'class' => 'mw-interwikitable-local' ),
( isset( $iwPrefix['iw_local'] ) ? $this->msg( 'interwiki_' . $iwPrefix['iw_local'] )->text() : '-' ) );
$out .= Html::element( 'td', array( 'class' => 'mw-interwikitable-trans' ),
( isset( $iwPrefix['iw_trans'] ) ? $this->msg( 'interwiki_' . $iwPrefix['iw_trans'] )->text() : '-' ) );
if ( $canModify ) {
$out .= Html::rawElement( 'td', array( 'class' => 'mw-interwikitable-modify' ),
Linker::linkKnown( $selfTitle, $this->msg( 'edit' )->escaped(), array(),
array( 'action' => 'edit', 'prefix' => $iwPrefix['iw_prefix'] ) ) .
$this->msg( 'comma-separator' ) .
Linker::linkKnown( $selfTitle, $this->msg( 'delete' )->escaped(), array(),
array( 'action' => 'delete', 'prefix' => $iwPrefix['iw_prefix'] ) )
);
}
$out .= Html::closeElement( 'tr' ) . "\n";
}
$out .= Html::closeElement( 'table' );
$this->getOutput()->addHTML( $out );
}
/**
* Adds a row to the documentation table on the top of Special:Interwiki.
*/
static function addInfoRow( $align = 'start', $title, $text ) {
return Html::rawElement( 'tr', null,
// The classes mw-align-start and mw-align-end are used here.
Html::rawElement( 'th', array( 'class' => 'mw-align-' . $align ), wfMessage( $title )->escaped() ) .
// This message is expected to have wiki syntax
Html::rawElement( 'td', null, wfMessage( $text )->parse() )
);
}
function error() {
$args = func_get_args();
$this->getOutput()->wrapWikiMsg( "<p class='error'>$1</p>", $args );
}
}
/**
* Needed to pass the URL as a raw parameter, because it contains $1
*/
class InterwikiLogFormatter extends LogFormatter {
protected function getMessageParameters() {
$params = parent::getMessageParameters();
if ( isset( $params[4] ) ) {
$params[4] = Message::rawParam( htmlspecialchars( $params[4] ) );
}
return $params;
}
}