MediaWiki  master
SpecialBooksources.php
Go to the documentation of this file.
1 <?php
32  public function __construct() {
33  parent::__construct( 'Booksources' );
34  }
35 
41  public function execute( $isbn ) {
42  $out = $this->getOutput();
43 
44  $this->setHeaders();
45  $this->outputHeader();
46 
47  // User provided ISBN
48  $isbn = $isbn ?: $this->getRequest()->getText( 'isbn' );
49  $isbn = trim( $isbn );
50 
51  $this->buildForm( $isbn );
52 
53  if ( $isbn !== '' ) {
54  if ( !self::isValidISBN( $isbn ) ) {
55  $out->wrapWikiMsg(
56  "<div class=\"error\">\n$1\n</div>",
57  'booksources-invalid-isbn'
58  );
59  }
60 
61  $this->showList( $isbn );
62  }
63  }
64 
71  public static function isValidISBN( $isbn ) {
72  $isbn = self::cleanIsbn( $isbn );
73  $sum = 0;
74  if ( strlen( $isbn ) == 13 ) {
75  for ( $i = 0; $i < 12; $i++ ) {
76  if ( $isbn[$i] === 'X' ) {
77  return false;
78  } elseif ( $i % 2 == 0 ) {
79  $sum += $isbn[$i];
80  } else {
81  $sum += 3 * $isbn[$i];
82  }
83  }
84 
85  $check = ( 10 - ( $sum % 10 ) ) % 10;
86  if ( (string)$check === $isbn[12] ) {
87  return true;
88  }
89  } elseif ( strlen( $isbn ) == 10 ) {
90  for ( $i = 0; $i < 9; $i++ ) {
91  if ( $isbn[$i] === 'X' ) {
92  return false;
93  }
94  $sum += $isbn[$i] * ( $i + 1 );
95  }
96 
97  $check = $sum % 11;
98  if ( $check == 10 ) {
99  $check = "X";
100  }
101  if ( (string)$check === $isbn[9] ) {
102  return true;
103  }
104  }
105 
106  return false;
107  }
108 
115  private static function cleanIsbn( $isbn ) {
116  return trim( preg_replace( '![^0-9X]!', '', $isbn ) );
117  }
118 
124  private function buildForm( $isbn ) {
125  $formDescriptor = [
126  'isbn' => [
127  'type' => 'text',
128  'name' => 'isbn',
129  'label-message' => 'booksources-isbn',
130  'default' => $isbn,
131  'autofocus' => true,
132  'required' => true,
133  ],
134  ];
135 
136  $context = new DerivativeContext( $this->getContext() );
137  $context->setTitle( $this->getPageTitle() );
138  HTMLForm::factory( 'ooui', $formDescriptor, $context )
139  ->setWrapperLegendMsg( 'booksources-search-legend' )
140  ->setSubmitTextMsg( 'booksources-search' )
141  ->setMethod( 'get' )
142  ->prepareForm()
143  ->displayForm( false );
144  }
145 
154  private function showList( $isbn ) {
155  $out = $this->getOutput();
156 
158 
159  $isbn = self::cleanIsbn( $isbn );
160  # Hook to allow extensions to insert additional HTML,
161  # e.g. for API-interacting plugins and so on
162  Hooks::run( 'BookInformation', [ $isbn, $out ] );
163 
164  # Check for a local page such as Project:Book_sources and use that if available
165  $page = $this->msg( 'booksources' )->inContentLanguage()->text();
166  $title = Title::makeTitleSafe( NS_PROJECT, $page ); # Show list in content language
167  if ( is_object( $title ) && $title->exists() ) {
168  $rev = Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
169  $content = $rev->getContent();
170 
171  if ( $content instanceof TextContent ) {
172  // XXX: in the future, this could be stored as structured data, defining a list of book sources
173 
174  $text = $content->getNativeData();
175  $out->addWikiText( str_replace( 'MAGICNUMBER', $isbn, $text ) );
176 
177  return true;
178  } else {
179  throw new MWException( "Unexpected content type for book sources: " . $content->getModel() );
180  }
181  }
182 
183  # Fall back to the defaults given in the language file
184  $out->addWikiMsg( 'booksources-text' );
185  $out->addHTML( '<ul>' );
186  $items = $wgContLang->getBookstoreList();
187  foreach ( $items as $label => $url ) {
188  $out->addHTML( $this->makeListItem( $isbn, $label, $url ) );
189  }
190  $out->addHTML( '</ul>' );
191 
192  return true;
193  }
194 
203  private function makeListItem( $isbn, $label, $url ) {
204  $url = str_replace( '$1', $isbn, $url );
205 
206  return Html::rawElement( 'li', [],
207  Html::element( 'a', [ 'href' => $url, 'class' => 'external' ], $label )
208  );
209  }
210 
211  protected function getGroupName() {
212  return 'wiki';
213  }
214 }
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:806
$context
Definition: load.php:50
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:209
An IContextSource implementation which will inherit context from another source but allow individual ...
static factory($displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:276
null for the local wiki Added in
Definition: hooks.txt:1551
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:129
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:60
Content object implementation for representing flat text.
Definition: TextContent.php:35
makeListItem($isbn, $label, $url)
Format a book source list item.
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:535
buildForm($isbn)
Generate a form to allow users to enter an ISBN.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:957
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:1717
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
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:1050
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.
showList($isbn)
Determine where to get the list of book sources from, format and output them.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
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:2506
getPageTitle($subpage=false)
Get a self-referential title object.