Page MenuHomeWickedGov Phorge
Files F4143764

SpecialBookSources.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

SpecialBookSources.php
View Options

<?php
/**
* 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
*/
namespace MediaWiki\Specials;
use MediaWiki\Content\TextContent;
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\TitleFactory;
use UnexpectedValueException;
/**
* Information on citing a book with a particular ISBN.
*
* The parser can create automatic links to this special page when
* it sees an ISBN in wikitext.
*
* @author Rob Church <robchur@gmail.com>
* @ingroup SpecialPage
*/
class SpecialBookSources extends SpecialPage {
private RevisionLookup $revisionLookup;
private TitleFactory $titleFactory;
/**
* @param RevisionLookup $revisionLookup
* @param TitleFactory $titleFactory
*/
public function __construct(
RevisionLookup $revisionLookup,
TitleFactory $titleFactory
) {
parent::__construct( 'Booksources' );
$this->revisionLookup = $revisionLookup;
$this->titleFactory = $titleFactory;
}
/**
* @param string|null $isbn ISBN passed as a subpage parameter
*/
public function execute( $isbn ) {
$out = $this->getOutput();
$this->setHeaders();
$this->outputHeader();
// User provided ISBN
$isbn = $isbn ?: $this->getRequest()->getText( 'isbn' );
$isbn = trim( $isbn );
$this->buildForm( $isbn );
if ( $isbn !== '' ) {
if ( !self::isValidISBN( $isbn ) ) {
$out->wrapWikiMsg(
"<div class=\"error\">\n$1\n</div>",
'booksources-invalid-isbn'
);
}
$this->showList( $isbn );
}
}
/**
* Return whether a given ISBN (10 or 13) is valid.
*
* @param string $isbn ISBN passed for check
* @return bool
*/
public static function isValidISBN( $isbn ) {
$isbn = self::cleanIsbn( $isbn );
$sum = 0;
if ( strlen( $isbn ) == 13 ) {
for ( $i = 0; $i < 12; $i++ ) {
if ( $isbn[$i] === 'X' ) {
return false;
} elseif ( $i % 2 == 0 ) {
$sum += (int)$isbn[$i];
} else {
$sum += 3 * (int)$isbn[$i];
}
}
$check = ( 10 - ( $sum % 10 ) ) % 10;
if ( (string)$check === $isbn[12] ) {
return true;
}
} elseif ( strlen( $isbn ) == 10 ) {
for ( $i = 0; $i < 9; $i++ ) {
if ( $isbn[$i] === 'X' ) {
return false;
}
$sum += (int)$isbn[$i] * ( $i + 1 );
}
$check = $sum % 11;
if ( $check == 10 ) {
$check = "X";
}
if ( (string)$check === $isbn[9] ) {
return true;
}
}
return false;
}
/**
* Trim ISBN and remove characters which aren't required
*
* @param string $isbn Unclean ISBN
* @return string
*/
private static function cleanIsbn( $isbn ) {
return trim( preg_replace( '![^0-9X]!', '', $isbn ) );
}
/**
* Generate a form to allow users to enter an ISBN
*
* @param string $isbn
*/
private function buildForm( $isbn ) {
$formDescriptor = [
'isbn' => [
'type' => 'text',
'name' => 'isbn',
'label-message' => 'booksources-isbn',
'default' => $isbn,
'autofocus' => true,
'required' => true,
],
];
HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
->setTitle( $this->getPageTitle() )
->setWrapperLegendMsg( 'booksources-search-legend' )
->setSubmitTextMsg( 'booksources-search' )
->setMethod( 'get' )
->prepareForm()
->displayForm( false );
}
/**
* Determine where to get the list of book sources from,
* format and output them
*
* @param string $isbn
* @return bool
*/
private function showList( $isbn ) {
$out = $this->getOutput();
$isbn = self::cleanIsbn( $isbn );
# Hook to allow extensions to insert additional HTML,
# e.g. for API-interacting plugins and so on
$this->getHookRunner()->onBookInformation( $isbn, $out );
# Check for a local page such as Project:Book_sources and use that if available
$page = $this->msg( 'booksources' )->inContentLanguage()->text();
// Show list in content language
$title = $this->titleFactory->makeTitleSafe( NS_PROJECT, $page );
if ( is_object( $title ) && $title->exists() ) {
$rev = $this->revisionLookup->getRevisionByTitle( $title );
$content = $rev->getContent( SlotRecord::MAIN );
if ( $content instanceof TextContent ) {
// XXX: in the future, this could be stored as structured data, defining a list of book sources
$text = $content->getText();
$out->addWikiTextAsInterface( str_replace( 'MAGICNUMBER', $isbn, $text ) );
return true;
} else {
throw new UnexpectedValueException(
"Unexpected content type for book sources: " . $content->getModel()
);
}
}
# Fall back to the defaults given in the language file
$out->addWikiMsg( 'booksources-text' );
$out->addHTML( '<ul>' );
$items = $this->getContentLanguage()->getBookstoreList();
foreach ( $items as $label => $url ) {
$out->addHTML( $this->makeListItem( $isbn, $label, $url ) );
}
$out->addHTML( '</ul>' );
return true;
}
/**
* Format a book source list item
*
* @param string $isbn
* @param string $label Book source label
* @param string $url Book source URL
* @return string
*/
private function makeListItem( $isbn, $label, $url ) {
$url = str_replace( '$1', $isbn, $url );
return Html::rawElement( 'li', [],
Html::element( 'a', [ 'href' => $url, 'class' => 'external' ], $label )
);
}
protected function getGroupName() {
return 'wiki';
}
}
/** @deprecated class alias since 1.41 */
class_alias( SpecialBookSources::class, 'SpecialBookSources' );

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 16:57 (4 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a1/14/22620dcafad1e00a3575cdfa15d8
Default Alt Text
SpecialBookSources.php (6 KB)

Event Timeline