MediaWiki  master
SpecialBooksources.php
Go to the documentation of this file.
1 <?php
35  protected $isbn = '';
36 
37  public function __construct() {
38  parent::__construct( 'Booksources' );
39  }
40 
46  public function execute( $isbn ) {
47  $out = $this->getOutput();
48 
49  $this->setHeaders();
50  $this->outputHeader();
51 
52  $this->isbn = self::cleanIsbn( $isbn ?: $this->getRequest()->getText( 'isbn' ) );
53 
54  $this->buildForm();
55 
56  if ( $this->isbn !== '' ) {
57  if ( !self::isValidISBN( $this->isbn ) ) {
58  $out->wrapWikiMsg(
59  "<div class=\"error\">\n$1\n</div>",
60  'booksources-invalid-isbn'
61  );
62  }
63 
64  $this->showList();
65  }
66  }
67 
74  public static function isValidISBN( $isbn ) {
75  $isbn = self::cleanIsbn( $isbn );
76  $sum = 0;
77  if ( strlen( $isbn ) == 13 ) {
78  for ( $i = 0; $i < 12; $i++ ) {
79  if ( $isbn[$i] === 'X' ) {
80  return false;
81  } elseif ( $i % 2 == 0 ) {
82  $sum += $isbn[$i];
83  } else {
84  $sum += 3 * $isbn[$i];
85  }
86  }
87 
88  $check = ( 10 - ( $sum % 10 ) ) % 10;
89  if ( (string)$check === $isbn[12] ) {
90  return true;
91  }
92  } elseif ( strlen( $isbn ) == 10 ) {
93  for ( $i = 0; $i < 9; $i++ ) {
94  if ( $isbn[$i] === 'X' ) {
95  return false;
96  }
97  $sum += $isbn[$i] * ( $i + 1 );
98  }
99 
100  $check = $sum % 11;
101  if ( $check == 10 ) {
102  $check = "X";
103  }
104  if ( (string)$check === $isbn[9] ) {
105  return true;
106  }
107  }
108 
109  return false;
110  }
111 
118  private static function cleanIsbn( $isbn ) {
119  return trim( preg_replace( '![^0-9X]!', '', $isbn ) );
120  }
121 
125  private function buildForm() {
126  $formDescriptor = [
127  'isbn' => [
128  'type' => 'text',
129  'name' => 'isbn',
130  'label-message' => 'booksources-isbn',
131  'default' => $this->isbn,
132  'autofocus' => true,
133  'required' => true,
134  ],
135  ];
136 
137  $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
138  ->setWrapperLegendMsg( 'booksources-search-legend' )
139  ->setSubmitTextMsg( 'booksources-search' )
140  ->setMethod( 'get' )
141  ->prepareForm()
142  ->displayForm( false );
143  }
144 
152  private function showList() {
153  $out = $this->getOutput();
154 
156 
157  # Hook to allow extensions to insert additional HTML,
158  # e.g. for API-interacting plugins and so on
159  Hooks::run( 'BookInformation', [ $this->isbn, $out ] );
160 
161  # Check for a local page such as Project:Book_sources and use that if available
162  $page = $this->msg( 'booksources' )->inContentLanguage()->text();
163  $title = Title::makeTitleSafe( NS_PROJECT, $page ); # Show list in content language
164  if ( is_object( $title ) && $title->exists() ) {
165  $rev = Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
166  $content = $rev->getContent();
167 
168  if ( $content instanceof TextContent ) {
169  // XXX: in the future, this could be stored as structured data, defining a list of book sources
170 
171  $text = $content->getNativeData();
172  $out->addWikiText( str_replace( 'MAGICNUMBER', $this->isbn, $text ) );
173 
174  return true;
175  } else {
176  throw new MWException( "Unexpected content type for book sources: " . $content->getModel() );
177  }
178  }
179 
180  # Fall back to the defaults given in the language file
181  $out->addWikiMsg( 'booksources-text' );
182  $out->addHTML( '<ul>' );
183  $items = $wgContLang->getBookstoreList();
184  foreach ( $items as $label => $url ) {
185  $out->addHTML( $this->makeListItem( $label, $url ) );
186  }
187  $out->addHTML( '</ul>' );
188 
189  return true;
190  }
191 
199  private function makeListItem( $label, $url ) {
200  $url = str_replace( '$1', $this->isbn, $url );
201 
202  return Html::rawElement( 'li', [],
203  Html::element( 'a', [ 'href' => $url, 'class' => 'external' ], $label )
204  );
205  }
206 
207  protected function getGroupName() {
208  return 'wiki';
209  }
210 }
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:767
getContext()
Gets the context this SpecialPage is executed in.
per default it will return the text for text based content
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:210
static factory($displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:272
null for the local wiki Added in
Definition: hooks.txt:1508
msg()
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
static isValidISBN($isbn)
Return whether a given ISBN (10 or 13) is valid.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target...
Definition: Revision.php:117
buildForm()
Generate a form to allow users to enter an ISBN.
outputHeader($summaryMessageKey= '')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Parent class for all special pages.
Definition: SpecialPage.php:36
const NS_PROJECT
Definition: Defines.php:73
Content object implementation for representing flat text.
Definition: TextContent.php:35
MediaWiki exception.
Definition: MWException.php:26
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:527
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks conditions will AND in the final query as a Content object as a Content object $title
Definition: hooks.txt:302
execute($isbn)
Show the special page.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1674
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$isbn
ISBN passed to the page, if any.
static cleanIsbn($isbn)
Trim ISBN and remove characters which aren't required.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1011
showList()
Determine where to get the list of book sources from, format and output them.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
getRequest()
Get the WebRequest being used for this instance.
makeListItem($label, $url)
Format a book source list item.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:230
Special page outputs information on sourcing a book with a particular ISBN The parser creates links t...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2443