* Some enhancements to live preview
[lhc/web/wiklou.git] / includes / SpecialBooksources.php
index bc35c85..58f25b4 100644 (file)
-<?
+<?php
 
-# ISBNs in wiki pages will create links to this page, with
-# the ISBN passed in via the query string.
+/**
+ * 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 Special pages
+ * @author Rob Church <robchur@gmail.com>
+ * @todo Validate ISBNs using the standard check-digit method
+ */
+class SpecialBookSources extends SpecialPage {
 
-function wfSpecialBooksources()
-{
-       $isbn = $_REQUEST["isbn"];
-
-       $bsl = new BookSourceList( $isbn );
-       $bsl->show();
-}
-
-class BookSourceList {
-
-       var $mIsbn;
-
-       function BookSourceList( $isbn )
-       {
-               $this->mIsbn = $isbn;
+       /**
+        * ISBN passed to the page, if any
+        */
+       private $isbn = '';
+       
+       /**
+        * Constructor
+        */
+       public function __construct() {
+               parent::__construct( 'Booksources' );
        }
-
-       function show()
-       {
-               global $wgOut, $wgUser, $wgLang;
-               global $ip, $wpBlockAddress, $wpBlockReason;
-               $fname="BookSourceList::show()";
-
-               $wgOut->setPagetitle( wfMsg( "booksources" ) );
-               $bstext=wfMsg( "booksourcetext" );
-
-               if($this->mIsbn) {
-                       $bstitle = Title::newFromText( wfmsg( "booksources" ) );
-                       $sql = "SELECT cur_text FROM cur " .
-                               "WHERE cur_namespace=4 and cur_title='" .
-                               wfStrencode( $bstitle->getDBkey() ) . "'";
-                       $res = wfQuery( $sql, $fname );
-                       if( ( $s = wfFetchObject( $res ) ) and ( $s->cur_text != "" ) ) {       
-                               $bstext = $s->cur_text;
-                               $bstext = str_replace( "WIKI-ISBN", $this->mIsbn, $bstext );
-                               $noautolist = 1;
-                       }
-               }
-
-               $wgOut->addWikiText( $bstext );
+       
+       /**
+        * Show the special page
+        *
+        * @param $isbn ISBN passed as a subpage parameter
+        */
+       public function execute( $isbn = false ) {
+               global $wgOut, $wgRequest;
+               $this->setHeaders();
+               $this->isbn = $this->cleanIsbn( $isbn ? $isbn : $wgRequest->getText( 'isbn' ) );
+               $wgOut->addWikiText( wfMsgNoTrans( '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;
                
-               # If ISBN is blank, just show a list of links to the
-               # home page of the various book sites.  Otherwise, show
-               # a list of links directly to the book.
-
-               if( !$noautolist ) { # only do this if we haven't already shown [[Wikipedia:Book sources]]
-                       $s = "<ul>\n";
-                       $bs = $wgLang->getBookstoreList() ;
-                       $bsn = array_keys ( $bs ) ;
-                       foreach ( $bsn as $name ) {
-                               $adr = $bs[$name] ;
-                               if ( ! $this->mIsbn ) {
-                                       $adr = explode ( ":" , $adr , 2 ) ;
-                                       $adr = explode ( "/" , $adr[1] ) ;
-                                       $a = "" ;
-                                       while ( $a == "" ) $a = array_shift ( $adr ) ;
-                                       $adr = "http://".$a ;
-                               } else {
-                                       $adr = str_replace ( "$1" , $this->mIsbn , $adr ) ;
-                               }
-                               $s .= "<li><a href=\"{$adr}\">{$name}</a></li>\n" ;
-                       }
-                       $s .= "</ul>\n";
-
-                       $wgOut->addHTML( $s );
+               # 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, wfMsg( 'booksources' ) ); # Should this be wfMsgForContent()? -- RC
+               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->addWikiText( wfMsgNoTrans( '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>';
+       }
+
 }
 
 ?>