BookReaderIA/datanode/BookReaderJSIA.php

   1 <?
   2 /*
   3 Copyright(c)2008 Internet Archive. Software license AGPL version 3.
   4
   5 This file is part of BookReader.
   6
   7     BookReader is free software: you can redistribute it and/or modify
   8     it under the terms of the GNU Affero General Public License as published by
   9     the Free Software Foundation, either version 3 of the License, or
  10     (at your option) any later version.
  11
  12     BookReader is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU Affero General Public License for more details.
  16
  17     You should have received a copy of the GNU Affero General Public License
  18     along with BookReader.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 $id = $_REQUEST['id'];
  22 $itemPath = $_REQUEST['itemPath'];
  23 $subPrefix = $_REQUEST['subPrefix'];
  24 $server = $_REQUEST['server'];
  25
  26 // $$$mang this code has been refactored into BookReaderMeta.inc.php for use e.g. by
  27 //         BookReaderPreview.php and BookReaderImages.php.  The code below should be
  28 //         taken out and replaced by calls into BookReaderMeta
  29
  30 // Check if we're on a dev vhost and point to JSIA in the user's public_html on the datanode
  31
  32 // $$$ TODO consolidate this logic
  33 if (strpos($_SERVER["REQUEST_URI"], "/~mang") === 0) { // Serving out of home dir
  34     $server .= ':80/~mang';
  35 } else if (strpos($_SERVER["REQUEST_URI"], "/~rkumar") === 0) { // Serving out of home dir
  36     $server .= ':80/~rkumar';
  37 } else if (strpos($_SERVER["REQUEST_URI"], "/~testflip") === 0) { // Serving out of home dir
  38     $server .= ':80/~testflip';
  39 } else if (strpos($_SERVER["REQUEST_URI"], "/~mccabe") === 0) { // Serving out of home dir
  40     $server .= ':80/~mccabe';
  41 }
  42
  43 if (! $subPrefix) {
  44     $subPrefix = $id;
  45 }
  46 $subItemPath = $itemPath . '/' . $subPrefix;
  47
  48 if ("" == $id) {
  49     BRFatal("No identifier specified!");
  50 }
  51
  52 if ("" == $itemPath) {
  53     BRFatal("No itemPath specified!");
  54 }
  55
  56 if ("" == $server) {
  57     BRFatal("No server specified!");
  58 }
  59
  60 if (!preg_match("|^/\d+/items/{$id}$|", $itemPath)) {
  61     BRFatal("Bad id!");
  62 }
  63
  64 // XXX check here that subitem is okay
  65
  66 $filesDataFile = "$itemPath/${id}_files.xml";
  67
  68 if (file_exists($filesDataFile)) {
  69     $filesData = simplexml_load_file("$itemPath/${id}_files.xml");
  70 } else {
  71     BRfatal("File metadata not found!");
  72 }
  73
  74 $imageStackInfo = findImageStack($subPrefix, $filesData);
  75 if ($imageStackInfo['imageFormat'] == 'unknown') {
  76     BRfatal('Couldn\'t find image stack');
  77 }
  78
  79 $imageFormat = $imageStackInfo['imageFormat'];
  80 $archiveFormat = $imageStackInfo['archiveFormat'];
  81 $imageStackFile = $itemPath . "/" . $imageStackInfo['imageStackFile'];
  82
  83 if ("unknown" == $imageFormat) {
  84   BRfatal("Unknown image format");
  85 }
  86
  87 if ("unknown" == $archiveFormat) {
  88   BRfatal("Unknown archive format");
  89 }
  90
  91
  92 $scanDataFile = "${subItemPath}_scandata.xml";
  93 $scanDataZip  = "$itemPath/scandata.zip";
  94 if (file_exists($scanDataFile)) {
  95     $scanData = simplexml_load_file($scanDataFile);
  96 } else if (file_exists($scanDataZip)) {
  97     $cmd  = 'unzip -p ' . escapeshellarg($scanDataZip) . ' scandata.xml';
  98     exec($cmd, $output, $retval);
  99     if ($retval != 0) BRFatal("Could not unzip ScanData!");
 100
 101     $dump = join("\n", $output);
 102     $scanData = simplexml_load_string($dump);
 103 } else if (file_exists("$itemPath/scandata.xml")) {
 104     // For e.g. Scribe v.0 books!
 105     $scanData = simplexml_load_file("$itemPath/scandata.xml");
 106 } else {
 107     BRFatal("ScanData file not found!");
 108 }
 109
 110 $metaDataFile = "$itemPath/{$id}_meta.xml";
 111 if (!file_exists($metaDataFile)) {
 112     BRFatal("MetaData file not found!");
 113 }
 114
 115
 116 $metaData = simplexml_load_file($metaDataFile);
 117
 118 //$firstLeaf = $scanData->pageData->page[0]['leafNum'];
 119 ?>
 120
 121 br = new BookReader();
 122
 123 <?
 124 /* Output title leaf if marked */
 125 $titleLeaf = '';
 126 foreach ($scanData->pageData->page as $page) {
 127     if (("Title Page" == $page->pageType) || ("Title" == $page->pageType)) {
 128         $titleLeaf = "{$page['leafNum']}";
 129         break;
 130     }
 131 }
 132
 133 if ('' != $titleLeaf) {
 134     printf("br.titleLeaf = %d;\n", $titleLeaf);
 135 }
 136 ?>
 137
 138 br.getPageWidth = function(index) {
 139     return this.pageW[index];
 140 }
 141
 142 br.getPageHeight = function(index) {
 143     return this.pageH[index];
 144 }
 145
 146 // Returns true if page image is available rotated
 147 br.canRotatePage = function(index) {
 148     return 'jp2' == this.imageFormat; // Assume single format for now
 149 }
 150
 151 // reduce defaults to 1 (no reduction)
 152 // rotate defaults to 0 (no rotation)
 153 br.getPageURI = function(index, reduce, rotate) {
 154     var _reduce;
 155     var _rotate;
 156
 157     if ('undefined' == typeof(reduce)) {
 158         _reduce = 1;
 159     } else {
 160         _reduce = reduce;
 161     }
 162     if ('undefined' == typeof(rotate)) {
 163         _rotate = 0;
 164     } else {
 165         _rotate = rotate;
 166     }
 167
 168     var file = this._getPageFile(index);
 169
 170     // $$$ add more image stack formats here
 171     return 'http://'+this.server+'/BookReader/BookReaderImages.php?zip='+this.zip+'&file='+file+'&scale='+_reduce+'&rotate='+_rotate;
 172 }
 173
 174 br._getPageFile = function(index) {
 175     var leafStr = '0000';
 176     var imgStr = this.leafMap[index].toString();
 177     var re = new RegExp("0{"+imgStr.length+"}$");
 178
 179     var insideZipPrefix = this.subPrefix.match('[^/]+$');
 180     var file = insideZipPrefix + '_' + this.imageFormat + '/' + insideZipPrefix + '_' + leafStr.replace(re, imgStr) + '.' + this.imageFormat;
 181
 182     return file;
 183 }
 184
 185 br.getPageSide = function(index) {
 186     //assume the book starts with a cover (right-hand leaf)
 187     //we should really get handside from scandata.xml
 188
 189     <? // Use special function if we should infer the page sides based off the title page index
 190     if (preg_match('/goog$/', $id) && ('' != $titleLeaf)) {
 191     ?>
 192     // assume page side based on title pagex
 193     var titleIndex = br.leafNumToIndex(br.titleLeaf);
 194     // assume title page is RHS
 195     var delta = titleIndex - index;
 196     if (0 == (delta & 0x1)) {
 197         // even delta
 198         return 'R';
 199     } else {
 200         return 'L';
 201     }
 202     <?
 203     }
 204     ?>
 205
 206     // $$$ we should get this from scandata instead of assuming the accessible
 207     //     leafs are contiguous
 208     if ('rl' != this.pageProgression) {
 209         // If pageProgression is not set RTL we assume it is LTR
 210         if (0 == (index & 0x1)) {
 211             // Even-numbered page
 212             return 'R';
 213         } else {
 214             // Odd-numbered page
 215             return 'L';
 216         }
 217     } else {
 218         // RTL
 219         if (0 == (index & 0x1)) {
 220             return 'L';
 221         } else {
 222             return 'R';
 223         }
 224     }
 225 }
 226
 227 br.getPageNum = function(index) {
 228     var pageNum = this.pageNums[index];
 229     if (pageNum) {
 230         return pageNum;
 231     } else {
 232         return 'n' + index;
 233     }
 234 }
 235
 236 // Single images in the Internet Archive scandata.xml metadata are (somewhat incorrectly)
 237 // given a "leaf" number.  Some of these images from the scanning process should not
 238 // be displayed in the BookReader (for example colour calibration cards).  Since some
 239 // of the scanned images will not be displayed in the BookReader (those marked with
 240 // addToAccessFormats false in the scandata.xml) leaf numbers and BookReader page
 241 // indexes are generally not the same.  This function returns the BookReader page
 242 // index given a scanned leaf number.
 243 //
 244 // This function is used, for example, to map between search results (that use the
 245 // leaf numbers) and the displayed pages in the BookReader.
 246 br.leafNumToIndex = function(leafNum) {
 247     for (var index = 0; index < this.leafMap.length; index++) {
 248         if (this.leafMap[index] == leafNum) {
 249             return index;
 250         }
 251     }
 252
 253     return null;
 254 }
 255
 256 // This function returns the left and right indices for the user-visible
 257 // spread that contains the given index.  The return values may be
 258 // null if there is no facing page or the index is invalid.
 259 br.getSpreadIndices = function(pindex) {
 260     // $$$ we could make a separate function for the RTL case and
 261     //      only bind it if necessary instead of always checking
 262     // $$$ we currently assume there are no gaps
 263
 264     var spreadIndices = [null, null];
 265     if ('rl' == this.pageProgression) {
 266         // Right to Left
 267         if (this.getPageSide(pindex) == 'R') {
 268             spreadIndices[1] = pindex;
 269             spreadIndices[0] = pindex + 1;
 270         } else {
 271             // Given index was LHS
 272             spreadIndices[0] = pindex;
 273             spreadIndices[1] = pindex - 1;
 274         }
 275     } else {
 276         // Left to right
 277         if (this.getPageSide(pindex) == 'L') {
 278             spreadIndices[0] = pindex;
 279             spreadIndices[1] = pindex + 1;
 280         } else {
 281             // Given index was RHS
 282             spreadIndices[1] = pindex;
 283             spreadIndices[0] = pindex - 1;
 284         }
 285     }
 286
 287     //console.log("   index %d mapped to spread %d,%d", pindex, spreadIndices[0], spreadIndices[1]);
 288
 289     return spreadIndices;
 290 }
 291
 292 // Remove the page number assertions for all but the highest index page with
 293 // a given assertion.  Ensures there is only a single page "{pagenum}"
 294 // e.g. the last page asserted as page 5 retains that assertion.
 295 br.uniquifyPageNums = function() {
 296     var seen = {};
 297
 298     for (var i = br.pageNums.length - 1; i--; i >= 0) {
 299         var pageNum = br.pageNums[i];
 300         if ( !seen[pageNum] ) {
 301             seen[pageNum] = true;
 302         } else {
 303             br.pageNums[i] = null;
 304         }
 305     }
 306
 307 }
 308
 309 br.cleanupMetadata = function() {
 310     br.uniquifyPageNums();
 311 }
 312
 313 // getEmbedURL
 314 //________
 315 // Returns a URL for an embedded version of the current book
 316 br.getEmbedURL = function() {
 317     // We could generate a URL hash fragment here but for now we just leave at defaults
 318     var url = 'http://' + window.location.host + '/stream/'+this.bookId;
 319     if (this.subPrefix != this.bookId) { // Only include if needed
 320         url += '/' + this.subPrefix;
 321     }
 322     url += '?ui=embed';
 323     return url;
 324 }
 325
 326 // getEmbedCode
 327 //________
 328 // Returns the embed code HTML fragment suitable for copy and paste
 329 br.getEmbedCode = function() {
 330     return "<iframe src='" + this.getEmbedURL() + "' width='480px' height='430px'></iframe>";
 331 }
 332
 333 br.pageW =  [
 334             <?
 335             $i=0;
 336             foreach ($scanData->pageData->page as $page) {
 337                 if (shouldAddPage($page)) {
 338                     if(0 != $i) echo ",";   //stupid IE
 339                     echo "{$page->cropBox->w}";
 340                     $i++;
 341                 }
 342             }
 343             ?>
 344             ];
 345
 346 br.pageH =  [
 347             <?
 348             $totalHeight = 0;
 349             $i=0;
 350             foreach ($scanData->pageData->page as $page) {
 351                 if (shouldAddPage($page)) {
 352                     if(0 != $i) echo ",";   //stupid IE
 353                     echo "{$page->cropBox->h}";
 354                     $totalHeight += intval($page->cropBox->h/4) + 10;
 355                     $i++;
 356                 }
 357             }
 358             ?>
 359             ];
 360 br.leafMap = [
 361             <?
 362             $i=0;
 363             foreach ($scanData->pageData->page as $page) {
 364                 if (shouldAddPage($page)) {
 365                     if(0 != $i) echo ",";   //stupid IE
 366                     echo "{$page['leafNum']}";
 367                     $i++;
 368                 }
 369             }
 370             ?>
 371             ];
 372
 373 br.pageNums = [
 374             <?
 375             $i=0;
 376             foreach ($scanData->pageData->page as $page) {
 377                 if (shouldAddPage($page)) {
 378                     if(0 != $i) echo ",";   //stupid IE
 379                     if (array_key_exists('pageNumber', $page) && ('' != $page->pageNumber)) {
 380                         echo "'{$page->pageNumber}'";
 381                     } else {
 382                         echo "null";
 383                     }
 384                     $i++;
 385                 }
 386             }
 387             ?>
 388             ];
 389
 390
 391 br.numLeafs = br.pageW.length;
 392
 393 br.bookId   = '<?echo $id;?>';
 394 br.zip      = '<?echo $imageStackFile;?>';
 395 br.subPrefix = '<?echo $subPrefix;?>';
 396 br.server   = '<?echo $server;?>';
 397 br.bookTitle= '<?echo preg_replace("/\'/", "\\'", $metaData->title);?>';
 398 br.bookPath = '<?echo $subItemPath;?>';
 399 br.bookUrl  = '<?echo "http://www.archive.org/details/$id";?>';
 400 br.imageFormat = '<?echo $imageFormat;?>';
 401 br.archiveFormat = '<?echo $archiveFormat;?>';
 402
 403 <?
 404
 405 # Load some values from meta.xml
 406 if ('' != $metaData->{'page-progression'}) {
 407   echo "br.pageProgression = '" . $metaData->{"page-progression"} . "';";
 408 } else {
 409   // Assume page progression is Left To Right
 410   echo "br.pageProgression = 'lr';";
 411 }
 412
 413 # Special cases
 414 if ('bandersnatchhsye00scarrich' == $id) {
 415     echo "br.mode     = 2;\n";
 416     echo "br.auto     = true;\n";
 417 }
 418
 419 ?>
 420
 421 // Check for config object
 422 // $$$ change this to use the newer params object
 423 if (typeof(brConfig) != 'undefined') {
 424     if (typeof(brConfig["ui"]) != 'undefined') {
 425         br.ui = brConfig["ui"];
 426     }
 427
 428     if (brConfig['mode'] == 1) {
 429         br.mode = 1;
 430         if (typeof(brConfig['reduce'] != 'undefined')) {
 431             br.reduce = brConfig['reduce'];
 432         }
 433     } else if (brConfig['mode'] == 2) {
 434         br.mode = 2;
 435
 436 <?
 437         //$$$mang hack to override request for 2up for books with attribution page
 438         //   as first page until we can display that page in 2up
 439         $needle = 'goog';
 440         if (strrpos($id, $needle) === strlen($id)-strlen($needle)) {
 441             print "// override for books with attribution page\n";
 442             print "br.mode = 1;\n";
 443         }
 444 ?>
 445     }
 446 } // brConfig
 447
 448 br.cleanupMetadata();
 449 br.init();
 450
 451 <?
 452
 453
 454 function BRFatal($string) {
 455     // $$$ TODO log error
 456     echo "alert('$string')\n";
 457     die(-1);
 458 }
 459
 460 // Returns true if a page should be added based on it's information in
 461 // the metadata
 462 function shouldAddPage($page) {
 463     // Return false only if the page is marked addToAccessFormats false.
 464     // If there is no assertion we assume it should be added.
 465     if (isset($page->addToAccessFormats)) {
 466         if ("false" == strtolower(trim($page->addToAccessFormats))) {
 467             return false;
 468         }
 469     }
 470
 471     return true;
 472 }
 473
 474 // Returns { 'imageFormat' => , 'archiveFormat' => '} given a sub-item prefix and loaded xml data
 475 function findImageStack($subPrefix, $filesData) {
 476
 477     // $$$ The order of the image formats determines which will be returned first
 478     $imageFormats = array('JP2' => 'jp2', 'TIFF' => 'tif', 'JPEG' => 'jpg');
 479     $archiveFormats = array('ZIP' => 'zip', 'Tar' => 'tar');
 480     $imageGroup = implode('|', array_keys($imageFormats));
 481     $archiveGroup = implode('|', array_keys($archiveFormats));
 482     // $$$ Currently only return processed images
 483     $imageStackRegex = "/Single Page (Processed) (${imageGroup}) (${archiveGroup})/";
 484
 485     foreach ($filesData->file as $file) {
 486         if (strpos($file['name'], $subPrefix) === 0) { // subprefix matches beginning
 487             if (preg_match($imageStackRegex, $file->format, $matches)) {
 488
 489                 // Make sure we have a regular image stack
 490                 $imageFormat = $imageFormats[$matches[2]];
 491                 if (strpos($file['name'], $subPrefix . '_' . $imageFormat) === 0) {
 492                     return array('imageFormat' => $imageFormat,
 493                                  'archiveFormat' => $archiveFormats[$matches[3]],
 494                                  'imageStackFile' => $file['name']);
 495                 }
 496             }
 497         }
 498     }
 499
 500     return array('imageFormat' => 'unknown', 'archiveFormat' => 'unknown', 'imageStackFile' => 'unknown');
 501
 502 }
 503
 504 ?>