BookReaderIA/inc/BookReader.inc

   1 <?
   2
   3 /*
   4  * Copyright(c) 2008-2010 Internet Archive. Software license AGPL version 3.
   5  *
   6  * This file is part of BookReader.  The full source code can be found at GitHub:
   7  * http://github.com/openlibrary/bookreader
   8  *
   9  * Note: Edits to this file must pass through github.  To submit a patch to this
  10  *       file please contact mang via http://github.com/mangtronix or mang at archive dot org
  11  *       Direct changes to this file may get clobbered when the code is synchronized
  12  *       from github.
  13  */
  14
  15 class BookReader
  16 {
  17
  18   // Operators recognized in BookReader download URLs
  19   public static $downloadOperators = array('page');
  20
  21   // Returns true if can display the book in item with a given prefix (typically the item identifier)
  22   public static function canDisplay($item, $prefix, $checkOldScandata = false)
  23   {
  24
  25     // A "book" is an image stack and scandata.
  26     // 1. Old items may have scandata.xml or scandata.zip and itemid_{imageformat}.{zip,tar}
  27     // 2. Newer items may have multiple {arbitraryname}_scandata.xml and {arbitraryname}_{imageformat}.{zip,tar}
  28
  29     $foundScandata = false;
  30     $foundImageStack = false;
  31
  32     $targetScandata = $prefix . "_scandata.xml";
  33
  34     // $$$ TODO add support for jpg and tar stacks
  35     // https://bugs.edge.launchpad.net/gnubook/+bug/323003
  36     // https://bugs.edge.launchpad.net/gnubook/+bug/385397
  37     $imageFormatRegex = '@' . preg_quote($prefix, '@') . '_(jp2|tif|jpg)\.(zip|tar)$@';
  38
  39     $baseLength = strlen($item->metadataGrabber->mainDir . '/');
  40     foreach ($item->getFiles() as $location => $fileInfo) {
  41         $filename = substr($location, $baseLength);
  42
  43         if ($checkOldScandata) {
  44             if ($filename == 'scandata.xml' || $filename == 'scandata.zip') {
  45                 $foundScandata = $filename;
  46             }
  47         }
  48
  49         if ($filename == $targetScandata) {
  50             $foundScandata = $filename;
  51         }
  52
  53         if (preg_match($imageFormatRegex, $filename)) {
  54             $foundImageStack = $filename;
  55         }
  56     }
  57
  58     if ($foundScandata && $foundImageStack) {
  59         return true;
  60     }
  61
  62     return false;
  63   }
  64
  65   // Finds the prefix to use for the book given the part of the URL trailing after /stream/
  66   public static function findPrefix($urlPortion)
  67   {
  68     if (!preg_match('#[^/&?]+#', $urlPortion, $matches)) {
  69         // URL portion was empty or started with /, &, or ? -- no item identifier
  70         return false;
  71     }
  72
  73     $prefix = $matches[0]; // item identifier
  74
  75     // $$$ Currently swallows the rest of the URL.
  76     //     If we want to support e.g. /stream/itemid/subdir/prefix/page/23 will need to adjust.
  77     if (preg_match('#[^/&?]+/([^&?]+)#', $urlPortion, $matches)) {
  78         // Match is everything after item identifier and slash, up to end or ? or &
  79         // e.g. itemid/{match/these/parts}?foo=bar
  80         $prefix = $matches[1]; // sub prefix --
  81     }
  82
  83     return $prefix;
  84   }
  85
  86   // $$$ would be cleaner to use different templates instead of the uiMode param
  87   //
  88   // @param subprefix Optional prefix to display a book inside an item (e.g. if does not match identifier)
  89   public static function draw($server, $mainDir, $identifier, $subPrefix, $title,
  90                               $coverLeaf=null, $titleStart='Internet Archive', $uiMode='full')
  91   {
  92     // Set title to default if not set
  93     if (!$title) {
  94         $title = 'BookReader';
  95     }
  96
  97     $id = $identifier;
  98
  99     // manually update with Launchpad version number at each checkin so that browsers
 100     // do not use old cached version
 101     // see https://bugs.launchpad.net/gnubook/+bug/330748
 102     $version = "r28";
 103
 104     if (BookReader::getDevHost($server)) {
 105         // On dev host - add time to force reload
 106         // If debugging on IE, remove this line otherwise breakpoints will be invalid after reload
 107         $version .= '_' . time();
 108     }
 109
 110     if ("" == $id) {
 111         echo "No identifier specified!";
 112         die(-1);
 113     }
 114
 115     $metaURL = BookReader::jsMetadataURL($server, $identifier, $mainDir, $subPrefix);
 116
 117 ?>
 118 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 119 <html>
 120 <head>
 121     <meta name="viewport" content="width=device-width, maximum-scale=1.0" />
 122     <meta name="apple-mobile-web-app-capable" content="yes" />
 123     <title><? echo $title; ?></title>
 124 <!--[if lte IE 6]>
 125     <meta http-equiv="refresh" content="2; URL=/bookreader/browserunsupported.php?id=<? echo($id); ?>">
 126 <![endif]-->
 127     <link rel="stylesheet" type="text/css" href="/bookreader/BookReader.css?v=<? echo($version); ?>">
 128 <? if ($uiMode == "embed") { ?>
 129     <link rel="stylesheet" type="text/css" href="/bookreader/BookReaderEmbed.css?v=<? echo($version); ?>">
 130 <? } elseif ($uiMode == "touch") { ?>
 131     <link rel="stylesheet" type="text/css" href="/bookreader/touch/BookReaderTouch.css?v=<? echo($version); ?>">
 132 <? } /* uiMode */ ?>
 133     <script src="/includes/jquery-1.4.2.min.js" type="text/javascript"></script>
 134     <script type="text/javascript" src="/bookreader/jquery-ui-1.8.5.custom.min.js?v=<? echo($version); ?>"></script>
 135     <script type="text/javascript" src="http://www.archive.org/includes/analytics.js?v=2"></script>
 136     <script type="text/javascript" src="/bookreader/dragscrollable.js?v=<? echo($version); ?>"></script>
 137     <script type="text/javascript" src="/bookreader/jquery.colorbox-min.js"></script>
 138     <script type="text/javascript" src="/bookreader/jquery.ui.ipad.js"></script>
 139      <!-- THIS ALLOWS BEAUTYTIPS TO WORK ON IE -->
 140         <!--[if lt IE 9]>
 141         <script type="text/javascript" src="/includes/excanvas.compiled.js"></script>
 142         <![endif]-->
 143     <script type="text/javascript" src="/bookreader/jquery.bt.min.js"></script>
 144     <script type="text/javascript" src="/bookreader/BookReader.js?v=<? echo($version); ?>"></script>
 145 <? if ( !preg_match("/mobile/i", $_SERVER['HTTP_USER_AGENT']) ) { ?>
 146     <script type="text/javascript" src="/bookreader/soundmanager/soundmanager2-ia.js?v=<? echo($version); ?>"></script>
 147     <script>
 148         soundManager.debugMode = false;
 149         soundManager.url = '/bookreader/soundmanager/swf/';
 150         soundManager.useHTML5Audio = true;
 151         soundManager.flashVersion = 9; //flash 8 version of swf is buggy when calling play() on a sound that is still loading
 152     </script>
 153 <? } /* mobile user agent */ ?>
 154 </head>
 155 <body style="background-color: ##939598;">
 156
 157 <?
 158 /*
 159 // <? if ($uiMode == 'full') { ?>
 160 // <div id="BookReader" style="left:10px; right:200px; top:10px; bottom:2em;">Internet Archive BookReader <noscript>requires JavaScript to be enabled.</noscript></div>
 161 // <? } else { ?>
 162 // <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>
 163 // <? } ?>
 164 */
 165 ?>
 166
 167 <div id="BookReader">Internet Archive BookReader <noscript>requires JavaScript to be enabled.</noscript></div>
 168
 169 <script type="text/javascript">
 170   // Set some config variables -- $$$ NB: Config object format has not been finalized
 171   var brConfig = {};
 172 <? if ($uiMode == 'embed') { ?>
 173   brConfig["mode"] = 1;
 174   brConfig["reduce"] = 8;
 175   brConfig["ui"] = "embed";
 176 <? } else { ?>
 177   brConfig["mode"] = 2;
 178 <? } ?>
 179 </script>
 180 <!-- The script included below is dynamically generated JavaScript that includes the book metadata and page image access functions -->
 181 <script type="text/javascript" src="<? echo($metaURL); ?>"></script>
 182     // Usage stats
 183     if(window.archive_analytics) { window.archive_analytics.values['bookreader'] = 'open'};
 184 </script>
 185   <?
 186     exit;
 187   }
 188
 189   // Returns the user part of dev host from URL, or null
 190   public static function getDevHost($server)
 191   {
 192       if (preg_match("/^www-(\w+)/", $_SERVER["SERVER_NAME"], $match)) {
 193         return $match[1];
 194       }
 195
 196       return null;
 197   }
 198
 199
 200   public static function serverBaseURL($server)
 201   {
 202       // Check if we're on a dev vhost and point to JSIA in the user's public_html
 203       // on the datanode
 204       // $$$ the remapping isn't totally automatic yet and requires user to
 205       //     ln -s ~/petabox/www/datanode/BookReader ~/public_html/BookReader
 206       //     so we enable it only for known hosts
 207       $devhost = BookReader::getDevHost($server);
 208       $devhosts = array('mang', 'testflip', 'rkumar');
 209       if (in_array($devhost, $devhosts)) {
 210         $server = $server . "/~" . $devhost;
 211       }
 212       return $server;
 213   }
 214
 215
 216   public static function jsMetadataURL($server, $identifier, $mainDir, $subPrefix = '')
 217   {
 218     $serverBaseURL = BookReader::serverBaseURL($server);
 219
 220     $params = array( 'id' => $identifier, 'itemPath' => $mainDir, 'server' => $server );
 221     if ($subPrefix) {
 222         $params['subPrefix'] = $subPrefix;
 223     }
 224
 225     $keys = array_keys($params);
 226     $lastParam = end($keys);
 227     $url = "http://{$serverBaseURL}/BookReader/BookReaderJSIA.php?";
 228     foreach($params as $param=>$value) {
 229         $url .= $param . '=' . $value;
 230         if ($param != $lastParam) {
 231             $url .= '&';
 232         }
 233     }
 234
 235     return $url;
 236   }
 237
 238   // Return the URL for the requested /download/$path, or null
 239   public static function getURL($path, $item) {
 240     // $path should look like {itemId}/{operator}/{filename}
 241     // Other operators may be added
 242
 243     $urlParts = BookReader::parsePath($path);
 244
 245     // Check for non-handled cases
 246     $required = array('identifier', 'operator', 'operand');
 247     foreach ($required as $key) {
 248         if (!array_key_exists($key, $urlParts)) {
 249             return null;
 250         }
 251     }
 252
 253     $identifier = $urlParts['identifier'];
 254     $operator = $urlParts['operator'];
 255     $filename = $urlParts['operand'];
 256     $subPrefix = $urlParts['subPrefix'];
 257
 258     $serverBaseURL = BookReader::serverBaseURL($item->getServer());
 259
 260     // Baseline query params
 261     $query = array(
 262         'id' => $identifier,
 263         'itemPath' => $item->getMainDir(),
 264         'server' => $serverBaseURL
 265     );
 266     if ($subPrefix) {
 267         $query['subPrefix'] = $subPrefix;
 268     }
 269
 270     switch ($operator) {
 271         case 'page':
 272
 273             // Look for old-style preview request - e.g. {identifier}_cover.jpg
 274             if (preg_match('/^(.*)_((cover|title|preview).*)/', $filename, $matches) === 1) {
 275                 // Serve preview image
 276                 $page = $matches[2];
 277                 $query['page'] = $page;
 278                 return 'http://' . $serverBaseURL . '/BookReader/BookReaderPreview.php?' . http_build_query($query, '', '&');
 279             }
 280
 281             // New-style preview request - e.g. cover_thumb.jpg
 282             if (preg_match('/^(cover|title|preview)/', $filename, $matches) === 1) {
 283                 $query['page'] = $filename;
 284                 return 'http://' . $serverBaseURL . '/BookReader/BookReaderPreview.php?' . http_build_query($query, '', '&');
 285             }
 286
 287             // Asking for a non-preview page
 288             $query['page'] = $filename;
 289             return 'http://' . $serverBaseURL . '/BookReader/BookReaderImages.php?' . http_build_query($query, '', '&');
 290
 291         default:
 292             // Unknown operator
 293             return null;
 294     }
 295
 296     return null; // was not handled
 297   }
 298
 299   public static function browserFromUserAgent($userAgent) {
 300       $browserPatterns = array(
 301           'ipad' => '/iPad/',
 302           'iphone' => '/iPhone/', // Also cover iPod Touch
 303           'android' => '/Android/',
 304       );
 305
 306       foreach ($browserPatterns as $browser => $pattern) {
 307           if (preg_match($pattern, $userAgent)) {
 308               return $browser;
 309           }
 310       }
 311       return null;
 312   }
 313
 314
 315   // $$$ Ideally we will not rely on user agent, but for the moment we do
 316   public static function paramsFromUserAgent($userAgent) {
 317       // $$$ using 'embed' here for devices with assumed small screens -- really should just use CSS3 media queries
 318       $browserParams = array(
 319           'ipad' => array( 'ui' => 'touch' ),
 320           'iphone' => array( 'ui' => 'embed', 'mode' => '1up' ),
 321           'android' => array( 'ui' => 'embed', 'mode' => '1up' ),
 322       );
 323
 324       $browser = BookReader::browserFromUserAgent($userAgent);
 325       if ($browser) {
 326           return $browserParams[$browser];
 327       }
 328       return array();
 329   }
 330
 331   public static function parsePath($path) {
 332     // Parse the BookReader path and return the parts
 333     // e.g. itemid/some/sub/dir/page/cover.jpg -> array( 'identifier' => 'itemid', 'subPrefix' => 'some/sub/dir',
 334     //            'operator' => 'page', 'filename' => 'cover.jpg')
 335
 336     $parts = array();
 337
 338     // Pull off query, e.g. ?foo=bar
 339     if (preg_match('#(.*?)(\?.*)#', $path, $matches) === 1) {
 340         $parts['query'] = $matches[2];
 341         $path = $matches[1];
 342     }
 343
 344     // Pull off identifier
 345     if (preg_match('#[^/&?]+#', $path, $matches) === 0) {
 346         // no match
 347         return $parts;
 348     }
 349     $parts['identifier'] = $matches[0];
 350     $path = substr($path, strlen($matches[0]));
 351
 352     // Look for operators
 353     // The sub-prefix can be arbitrary, so we match up until the first operator
 354     $operators = '(' . join('|', self::$downloadOperators) . ')';
 355     $pattern = '#(?P<subPrefix>.*?)/(?P<operator>' . $operators . ')/(?P<operand>.*)#';
 356     if (preg_match($pattern, $path, $matches) === 1) {
 357         $parts['subPrefix'] = substr($matches['subPrefix'], 1); // remove leading '/'
 358         $parts['operator'] = $matches['operator'];
 359         $parts['operand'] = $matches['operand'];
 360     } else {
 361         $parts['subPrefix'] = $path;
 362     }
 363
 364     return $parts;
 365   }
 366
 367 }
 368
 369 ?>