BookReaderIA/inc/BookReader.inc

   1 <?
   2
   3 class BookReader
   4 {
   5
   6   // Returns true if can display the book in item with a given prefix (typically the item identifier)
   7   public static function canDisplay($item, $prefix, $checkOldScandata = false)
   8   {
   9
  10     // A "book" is an image stack and scandata.
  11     // 1. Old items may have scandata.xml or scandata.zip and itemid_{imageformat}.{zip,tar}
  12     // 2. Newer items may have multiple {arbitraryname}_scandata.xml and {arbitraryname}_{imageformat}.{zip,tar}
  13
  14     $foundScandata = false;
  15     $foundImageStack = false;
  16
  17     $targetScandata = $prefix . "_scandata.xml";
  18
  19     // $$$ TODO add support for jpg and tar stacks
  20     // https://bugs.edge.launchpad.net/gnubook/+bug/323003
  21     // https://bugs.edge.launchpad.net/gnubook/+bug/385397
  22     $imageFormatRegex = '@' . preg_quote($prefix, '@') . '_(jp2|tif|jpg)\.(zip|tar)$@';
  23
  24     $baseLength = strlen($item->metadataGrabber->mainDir . '/');
  25     foreach ($item->getFiles() as $location => $fileInfo) {
  26         $filename = substr($location, $baseLength);
  27
  28         if ($checkOldScandata) {
  29             if ($filename == 'scandata.xml' || $filename == 'scandata.zip') {
  30                 $foundScandata = $filename;
  31             }
  32         }
  33
  34         if ($filename == $targetScandata) {
  35             $foundScandata = $filename;
  36         }
  37
  38         if (preg_match($imageFormatRegex, $filename)) {
  39             $foundImageStack = $filename;
  40         }
  41     }
  42
  43     if ($foundScandata && $foundImageStack) {
  44         return true;
  45     }
  46
  47     return false;
  48   }
  49
  50   // Finds the prefix to use for the book given the part of the URL trailing after /stream/
  51   public static function findPrefix($urlPortion)
  52   {
  53     if (!preg_match('#[^/&?]+#', $urlPortion, $matches)) {
  54         return false;
  55     }
  56
  57     $prefix = $matches[0]; // identifier
  58
  59     // $$$ Currently swallows the rest of the URL.
  60     //     If we want to support e.g. /stream/itemid/subdir/prefix/page/23 will need to adjust.
  61     if (preg_match('#[^/&?]+/([^&?]+)#', $urlPortion, $matches)) {
  62         $prefix = $matches[1]; // sub prefix
  63     }
  64
  65     return $prefix;
  66   }
  67
  68   // $$$ would be cleaner to use different templates instead of the uiMode param
  69   //
  70   // @param subprefix Optional prefix to display a book inside an item (e.g. if does not match identifier)
  71   public static function draw($server, $mainDir, $identifier, $subPrefix, $title,
  72                               $coverLeaf=null, $titleStart='Internet Archive', $uiMode='full')
  73   {
  74     // Set title to default if not set
  75     if (!$title) {
  76         $title = 'BookReader';
  77     }
  78
  79     $id = $identifier;
  80
  81     // manually update with Launchpad version number at each checkin so that browsers
  82     // do not use old cached version
  83     // see https://bugs.launchpad.net/gnubook/+bug/330748
  84     $version = "r25";
  85
  86     if (BookReader::getDevHost($server)) {
  87         // on dev host - add time to force reload
  88         $version .= '_' . time();
  89     }
  90
  91     if ("" == $id) {
  92         echo "No identifier specified!";
  93         die(-1);
  94     }
  95
  96     $metaURL = BookReader::jsMetadataURL($server, $identifier, $mainDir, $subPrefix);
  97
  98 ?>
  99 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 100 <html>
 101 <head>
 102     <meta name="viewport" content="width=device-width, maximum-scale=1.0" />
 103     <title><? echo $title; ?></title>
 104 <!--[if lte IE 6]>
 105     <meta http-equiv="refresh" content="2; URL=/bookreader/browserunsupported.php?id=<? echo($id); ?>">
 106 <![endif]-->
 107     <link rel="stylesheet" type="text/css" href="/bookreader/BookReader.css?v=<? echo($version); ?>">
 108 <? if ($uiMode == "embed") { ?>
 109     <link rel="stylesheet" type="text/css" href="/bookreader/BookReaderEmbed.css?v=<? echo($version); ?>">
 110 <? } elseif ($uiMode == "touch") { ?>
 111     <link rel="stylesheet" type="text/css" href="/bookreader/touch/BookReaderTouch.css?v=<? echo($version); ?>">
 112 <? } /* uiMode */ ?>
 113     <script src="/includes/jquery-1.4.2.min.js" type="text/javascript"></script>
 114     <script type="text/javascript" src="/bookreader/jquery-ui-1.8.1.custom.min.js"></script>
 115     <script type="text/javascript" src="/bookreader/dragscrollable.js"></script>
 116     <script type="text/javascript" src="/bookreader/BookReader.js?v=<? echo($version); ?>"></script>
 117 </head>
 118 <body style="background-color: #FFFFFF;">
 119
 120 <? if ($uiMode == 'full') { ?>
 121 <div id="BookReader" style="left:10px; right:200px; top:10px; bottom:2em;">Internet Archive BookReader <noscript>requires JavaScript to be enabled.</noscript></div>
 122 <? } else { ?>
 123 <div id="BookReader" style="left:0; right:0; top:0; bottom:0; border:0">Internet Archive Bookreader <noscript>requires JavaScript to be enabled.</noscript></div>
 124 <? } /* uiMode*/ ?>
 125
 126 <script type="text/javascript">
 127   // Set some config variables -- $$$ NB: Config object format has not been finalized
 128   var brConfig = {};
 129 <? if ($uiMode == 'embed') { ?>
 130   brConfig["mode"] = 1;
 131   brConfig["reduce"] = 8;
 132   brConfig["ui"] = "embed";
 133 <? } else { ?>
 134   brConfig["mode"] = 2;
 135 <? } ?>
 136 </script>
 137 <!-- The script included below is dynamically generated JavaScript that includes the book metadata and page image access functions -->
 138 <script type="text/javascript" src="<? echo($metaURL); ?>"></script>
 139
 140 <? if ($uiMode == 'full') { ?>
 141 <div id="BookReaderSearch" style="width:190px; right:0px; top:10px; bottom:2em;">
 142     <form action='javascript:' onsubmit="br.search($('#BookReaderSearchBox').val());">
 143         <p style="display: inline">
 144             <input id="BookReaderSearchBox" type="text" size="20" value="search..." onfocus="if('search...'==this.value)this.value='';" /><input type="submit" value="go" />
 145         </p>
 146     </form>
 147     <div id="BookReaderSearchResults">
 148         Search results
 149     </div>
 150 </div>
 151
 152
 153 <div id="BRfooter">
 154     <div class="BRlogotype">
 155         <a href="http://archive.org/" class="BRblack">Internet Archive</a>
 156     </div>
 157     <div class="BRnavlinks">
 158         <!-- <a class="BRblack" href="http://openlibrary.org/dev/docs/bookreader">About the Bookreader</a> | -->
 159         <a class="BRblack" href="http://www.archive.org/about/faqs.php#Report_Item">Content Problems</a> |
 160         <a class="BRblack" href="https://bugs.launchpad.net/bookreader/+filebug">Report Bugs</a> |
 161         <a class="BRblack" href="http://www.archive.org/details/texts">Texts Collection</a> |
 162         <a class="BRblack" href="http://www.archive.org/about/contact.php">Contact Us</a>
 163     </div>
 164 </div>
 165 <? } /* uiMode */ ?>
 166
 167 <script type="text/javascript">
 168     // $$$ hack to workaround sizing bug when starting in two-up mode
 169     $(document).ready(function() {
 170         $(window).trigger('resize');
 171     });
 172 </script>
 173   <?
 174     exit;
 175   }
 176
 177   // Returns the user part of dev host from URL, or null
 178   public static function getDevHost($server)
 179   {
 180       if (preg_match("/^www-(\w+)/", $_SERVER["SERVER_NAME"], $match)) {
 181         return $match[1];
 182       }
 183
 184       return null;
 185   }
 186
 187
 188   public static function serverBaseURL($server)
 189   {
 190       // Check if we're on a dev vhost and point to JSIA in the user's public_html
 191       // on the datanode
 192       // $$$ the remapping isn't totally automatic yet and requires user to
 193       //     ln -s ~/petabox/www/datanode/BookReader ~/public_html/BookReader
 194       //     so we enable it only for known hosts
 195       $devhost = BookReader::getDevHost($server);
 196       $devhosts = array('mang', 'testflip', 'rkumar');
 197       if (in_array($devhost, $devhosts)) {
 198         $server = $server . "/~" . $devhost;
 199       }
 200       return $server;
 201   }
 202
 203
 204   public static function jsMetadataURL($server, $identifier, $mainDir, $subPrefix = '')
 205   {
 206     $serverBaseURL = BookReader::serverBaseURL($server);
 207
 208     $params = array( 'id' => $identifier, 'itemPath' => $mainDir, 'server' => $server );
 209     if ($subPrefix) {
 210         $params['subPrefix'] = $subPrefix;
 211     }
 212
 213     $keys = array_keys($params);
 214     $lastParam = end($keys);
 215     $url = "http://{$serverBaseURL}/BookReader/BookReaderJSIA.php?";
 216     foreach($params as $param=>$value) {
 217         $url .= $param . '=' . $value;
 218         if ($param != $lastParam) {
 219             $url .= '&';
 220         }
 221     }
 222
 223     return $url;
 224   }
 225
 226   // Return the URL for the requested /download/$path, or null
 227   public static function getURL($path, $item) {
 228     // $path should look like {itemId}/{operator}/{filename}
 229     // Other operators may be added
 230
 231     $parts = preg_split('#/#', $path, 3);
 232     if (count($parts) != 3) {
 233         return null;
 234     }
 235     $identifier = $parts[0];
 236     $operator = $parts[1];
 237     $filename = $parts[2];
 238
 239     $serverBaseURL = BookReader::serverBaseURL($item->getServer());
 240
 241     switch ($operator) {
 242         case 'page':
 243             // Find bookId and which page was requested
 244             $pathParts = pathinfo($filename);
 245
 246             // Look for preview request
 247             if (preg_match('/^(.*)_(cover|title|preview)$/', $pathParts['filename'], $matches) === 0) {
 248                 return null;
 249             }
 250             $bookId = $matches[1];
 251             $page = $matches[2];
 252             $query = array(
 253                 'id' => $identifier,
 254                 'bookId' => $bookId,
 255                 'itemPath' => $item->getMainDir(),
 256                 'server' => $serverBaseURL,
 257                 'page' => $page,
 258             );
 259             return 'http://' . $serverBaseURL . '/BookReader/BookReaderPreview.php?' . http_build_query($query, '', '&');
 260
 261         default:
 262             return null;
 263     }
 264
 265     return null; // was not handled
 266   }
 267
 268 }
 269
 270 ?>