wiki.techinc.nl/includes/SpecialBooksources.php
Tim Starling 377561cd1e * Introduced OutputPage::addWikiMsg() and OutputPage::wrapWikiMsg(), to make it easier to avoid double-parsing. Double-parsing introduces differences between the old and new parsers.
* Used the new functions in the relevant places throughout the core. Where this was not possible, used wfMsgNoTrans() to avoid double-parsing.
* Calling wfEscapeWikiText() on a title before passing it to a message is unnecessary and causes bugs. The best idea is to let the message do its own escaping. Removed wfEscapeWikiText() from the caller of addedwatchtext, removedwatchtext, deletedtext, protect-text, nosuchusershort and movepage-moved. Updated all message files to use <nowiki>$1</nowiki> where appropriate in these messages. 
* Removed unnecessary empty message handling from semiprotectedpagewarning
* Removed nonsense warning about the output of wfMsg() not being safe for inclusion in HTML. 
* Changed wfShellExec() to use passthru/ob_get_contents instead of exec(). This avoids corruption of whitespace in the response. 
* Added $wgValidateAllHtml feature, to optionally validate HTML on output. 
* Fixed missing newline in cascadeprotected in MessagesEn.php
* Belatedly updated addedwatchtext to take account of the new "monobook" skin. No unwatch link in the sidebar anymore.
2008-02-18 07:25:35 +00:00

113 lines
3.2 KiB
PHP

<?php
/**
* Special page outputs information on sourcing a book with a particular ISBN
* The parser creates links to this page when dealing with ISBNs in wikitext
*
* @addtogroup SpecialPage
* @author Rob Church <robchur@gmail.com>
* @todo Validate ISBNs using the standard check-digit method
*/
class SpecialBookSources extends SpecialPage {
/**
* ISBN passed to the page, if any
*/
private $isbn = '';
/**
* Constructor
*/
public function __construct() {
parent::__construct( 'Booksources' );
}
/**
* Show the special page
*
* @param $isbn ISBN passed as a subpage parameter
*/
public function execute( $isbn ) {
global $wgOut, $wgRequest;
$this->setHeaders();
$this->isbn = $this->cleanIsbn( $isbn ? $isbn : $wgRequest->getText( 'isbn' ) );
$wgOut->addWikiMsg( 'booksources-summary' );
$wgOut->addHtml( $this->makeForm() );
if( strlen( $this->isbn ) > 0 )
$this->showList();
}
/**
* Trim ISBN and remove characters which aren't required
*
* @param $isbn Unclean ISBN
* @return string
*/
private function cleanIsbn( $isbn ) {
return trim( preg_replace( '![^0-9X]!', '', $isbn ) );
}
/**
* Generate a form to allow users to enter an ISBN
*
* @return string
*/
private function makeForm() {
global $wgScript;
$title = self::getTitleFor( 'Booksources' );
$form = '<fieldset><legend>' . wfMsgHtml( 'booksources-search-legend' ) . '</legend>';
$form .= Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) );
$form .= Xml::hidden( 'title', $title->getPrefixedText() );
$form .= '<p>' . Xml::inputLabel( wfMsg( 'booksources-isbn' ), 'isbn', 'isbn', 20, $this->isbn );
$form .= '&nbsp;' . Xml::submitButton( wfMsg( 'booksources-go' ) ) . '</p>';
$form .= Xml::closeElement( 'form' );
$form .= '</fieldset>';
return $form;
}
/**
* Determine where to get the list of book sources from,
* format and output them
*
* @return string
*/
private function showList() {
global $wgOut, $wgContLang;
# Hook to allow extensions to insert additional HTML,
# e.g. for API-interacting plugins and so on
wfRunHooks( 'BookInformation', array( $this->isbn, &$wgOut ) );
# Check for a local page such as Project:Book_sources and use that if available
$title = Title::makeTitleSafe( NS_PROJECT, wfMsgForContent( 'booksources' ) ); # Show list in content language
if( is_object( $title ) && $title->exists() ) {
$rev = Revision::newFromTitle( $title );
$wgOut->addWikiText( str_replace( 'MAGICNUMBER', $this->isbn, $rev->getText() ) );
return true;
}
# Fall back to the defaults given in the language file
$wgOut->addWikiMsg( 'booksources-text' );
$wgOut->addHtml( '<ul>' );
$items = $wgContLang->getBookstoreList();
foreach( $items as $label => $url )
$wgOut->addHtml( $this->makeListItem( $label, $url ) );
$wgOut->addHtml( '</ul>' );
return true;
}
/**
* Format a book source list item
*
* @param $label Book source label
* @param $url Book source URL
* @return string
*/
private function makeListItem( $label, $url ) {
$url = str_replace( '$1', $this->isbn, $url );
return '<li><a href="' . htmlspecialchars( $url ) . '">' . htmlspecialchars( $label ) . '</a></li>';
}
}