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         $version .= '_' . time();
 107     }
 108
 109     if ("" == $id) {
 110         echo "No identifier specified!";
 111         die(-1);
 112     }
 113
 114     $metaURL = BookReader::jsMetadataURL($server, $identifier, $mainDir, $subPrefix);
 115
 116 ?>
 117 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 118 <html>
 119 <head>
 120     <meta name="viewport" content="width=device-width, maximum-scale=1.0" />
 121     <meta name="apple-mobile-web-app-capable" content="yes" />
 122     <title><? echo $title; ?></title>
 123 <!--[if lte IE 6]>
 124     <meta http-equiv="refresh" content="2; URL=/bookreader/browserunsupported.php?id=<? echo($id); ?>">
 125 <![endif]-->
 126     <link rel="stylesheet" type="text/css" href="/bookreader/BookReader.css?v=<? echo($version); ?>">
 127 <? if ($uiMode == "embed") { ?>
 128     <link rel="stylesheet" type="text/css" href="/bookreader/BookReaderEmbed.css?v=<? echo($version); ?>">
 129 <? } elseif ($uiMode == "touch") { ?>
 130     <link rel="stylesheet" type="text/css" href="/bookreader/touch/BookReaderTouch.css?v=<? echo($version); ?>">
 131 <? } /* uiMode */ ?>
 132     <script src="/includes/jquery-1.4.2.min.js" type="text/javascript"></script>
 133     <script type="text/javascript" src="/bookreader/jquery-ui-1.8.5.custom.min.js?v=<? echo($version); ?>"></script>
 134     <script type="text/javascript" src="http://www.archive.org/includes/analytics.js?v=2"></script>
 135     <script type="text/javascript" src="/bookreader/dragscrollable.js?v=<? echo($version); ?>"></script>
 136     <script type="text/javascript" src="/bookreader/jquery.colorbox-min.js"></script>
 137     <script type="text/javascript" src="/bookreader/jquery.ui.ipad.js"></script>
 138      <!-- THIS ALLOWS BEAUTYTIPS TO WORK ON IE -->
 139         <!--[if lt IE 9]>
 140         <script type="text/javascript" src="/includes/excanvas.compiled.js"></script>
 141         <![endif]-->
 142     <script type="text/javascript" src="/bookreader/jquery.bt.min.js"></script>
 143     <script type="text/javascript" src="/bookreader/BookReader.js?v=<? echo($version); ?>"></script>
 144 <? if ( !preg_match("/mobile/i", $_SERVER['HTTP_USER_AGENT']) ) { ?>
 145     <script type="text/javascript" src="/bookreader/soundmanager/soundmanager2-ia.js?v=<? echo($version); ?>"></script>
 146     <script>
 147         soundManager.debugMode = false;
 148         soundManager.url = '/bookreader/soundmanager/swf/';
 149         soundManager.useHTML5Audio = true;
 150         soundManager.flashVersion = 9; //flash 8 version of swf is buggy when calling play() on a sound that is still loading
 151     </script>
 152 <? } /* mobile user agent */ ?>
 153 </head>
 154 <body style="background-color: ##939598;">
 155
 156 <?
 157 /*
 158 // <? if ($uiMode == 'full') { ?>
 159 // <div id="BookReader" style="left:10px; right:200px; top:10px; bottom:2em;">Internet Archive BookReader <noscript>requires JavaScript to be enabled.</noscript></div>
 160 // <? } else { ?>
 161 // <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>
 162 // <? } ?>
 163 */
 164 ?>
 165
 166 <div id="BookReader">Internet Archive BookReader <noscript>requires JavaScript to be enabled.</noscript></div>
 167
 168 <script type="text/javascript">
 169   // Set some config variables -- $$$ NB: Config object format has not been finalized
 170   var brConfig = {};
 171 <? if ($uiMode == 'embed') { ?>
 172   brConfig["mode"] = 1;
 173   brConfig["reduce"] = 8;
 174   brConfig["ui"] = "embed";
 175 <? } else { ?>
 176   brConfig["mode"] = 2;
 177 <? } ?>
 178 </script>
 179 <!-- The script included below is dynamically generated JavaScript that includes the book metadata and page image access functions -->
 180 <script type="text/javascript" src="<? echo($metaURL); ?>"></script>
 181
 182 <script type="text/javascript">
 183     // $$$ hack to workaround sizing bug when starting in two-up mode
 184     $(document).ready(function() {
 185         $(window).trigger('resize');
 186     });
 187
 188     // Usage stats
 189     if(window.archive_analytics) { window.archive_analytics.values['bookreader'] = 'open'};
 190 </script>
 191   <?
 192     exit;
 193   }
 194
 195   // Returns the user part of dev host from URL, or null
 196   public static function getDevHost($server)
 197   {
 198       if (preg_match("/^www-(\w+)/", $_SERVER["SERVER_NAME"], $match)) {
 199         return $match[1];
 200       }
 201
 202       return null;
 203   }
 204
 205
 206   public static function serverBaseURL($server)
 207   {
 208       // Check if we're on a dev vhost and point to JSIA in the user's public_html
 209       // on the datanode
 210       // $$$ the remapping isn't totally automatic yet and requires user to
 211       //     ln -s ~/petabox/www/datanode/BookReader ~/public_html/BookReader
 212       //     so we enable it only for known hosts
 213       $devhost = BookReader::getDevHost($server);
 214       $devhosts = array('mang', 'testflip', 'rkumar');
 215       if (in_array($devhost, $devhosts)) {
 216         $server = $server . "/~" . $devhost;
 217       }
 218       return $server;
 219   }
 220
 221
 222   public static function jsMetadataURL($server, $identifier, $mainDir, $subPrefix = '')
 223   {
 224     $serverBaseURL = BookReader::serverBaseURL($server);
 225
 226     $params = array( 'id' => $identifier, 'itemPath' => $mainDir, 'server' => $server );
 227     if ($subPrefix) {
 228         $params['subPrefix'] = $subPrefix;
 229     }
 230
 231     $keys = array_keys($params);
 232     $lastParam = end($keys);
 233     $url = "http://{$serverBaseURL}/BookReader/BookReaderJSIA.php?";
 234     foreach($params as $param=>$value) {
 235         $url .= $param . '=' . $value;
 236         if ($param != $lastParam) {
 237             $url .= '&';
 238         }
 239     }
 240
 241     return $url;
 242   }
 243
 244   // Return the URL for the requested /download/$path, or null
 245   public static function getURL($path, $item) {
 246     // $path should look like {itemId}/{operator}/{filename}
 247     // Other operators may be added
 248
 249     $urlParts = BookReader::parsePath($path);
 250
 251     // Check for non-handled cases
 252     $required = array('identifier', 'operator', 'operand');
 253     foreach ($required as $key) {
 254         if (!array_key_exists($key, $urlParts)) {
 255             return null;
 256         }
 257     }
 258
 259     $identifier = $urlParts['identifier'];
 260     $operator = $urlParts['operator'];
 261     $filename = $urlParts['operand'];
 262     $subPrefix = $urlParts['subPrefix'];
 263
 264     $serverBaseURL = BookReader::serverBaseURL($item->getServer());
 265
 266     // Baseline query params
 267     $query = array(
 268         'id' => $identifier,
 269         'itemPath' => $item->getMainDir(),
 270         'server' => $serverBaseURL
 271     );
 272     if ($subPrefix) {
 273         $query['subPrefix'] = $subPrefix;
 274     }
 275
 276     switch ($operator) {
 277         case 'page':
 278
 279             // Look for old-style preview request - e.g. {identifier}_cover.jpg
 280             if (preg_match('/^(.*)_((cover|title|preview).*)/', $filename, $matches) === 1) {
 281                 // Serve preview image
 282                 $page = $matches[2];
 283                 $query['page'] = $page;
 284                 return 'http://' . $serverBaseURL . '/BookReader/BookReaderPreview.php?' . http_build_query($query, '', '&');
 285             }
 286
 287             // New-style preview request - e.g. cover_thumb.jpg
 288             if (preg_match('/^(cover|title|preview)/', $filename, $matches) === 1) {
 289                 $query['page'] = $filename;
 290                 return 'http://' . $serverBaseURL . '/BookReader/BookReaderPreview.php?' . http_build_query($query, '', '&');
 291             }
 292
 293             // Asking for a non-preview page
 294             $query['page'] = $filename;
 295             return 'http://' . $serverBaseURL . '/BookReader/BookReaderImages.php?' . http_build_query($query, '', '&');
 296
 297         default:
 298             // Unknown operator
 299             return null;
 300     }
 301
 302     return null; // was not handled
 303   }
 304
 305   public static function browserFromUserAgent($userAgent) {
 306       $browserPatterns = array(
 307           'ipad' => '/iPad/',
 308           'iphone' => '/iPhone/', // Also cover iPod Touch
 309           'android' => '/Android/',
 310       );
 311
 312       foreach ($browserPatterns as $browser => $pattern) {
 313           if (preg_match($pattern, $userAgent)) {
 314               return $browser;
 315           }
 316       }
 317       return null;
 318   }
 319
 320
 321   // $$$ Ideally we will not rely on user agent, but for the moment we do
 322   public static function paramsFromUserAgent($userAgent) {
 323       // $$$ using 'embed' here for devices with assumed small screens -- really should just use CSS3 media queries
 324       $browserParams = array(
 325           'ipad' => array( 'ui' => 'touch' ),
 326           'iphone' => array( 'ui' => 'embed', 'mode' => '1up' ),
 327           'android' => array( 'ui' => 'embed', 'mode' => '1up' ),
 328       );
 329
 330       $browser = BookReader::browserFromUserAgent($userAgent);
 331       if ($browser) {
 332           return $browserParams[$browser];
 333       }
 334       return array();
 335   }
 336
 337   public static function parsePath($path) {
 338     // Parse the BookReader path and return the parts
 339     // e.g. itemid/some/sub/dir/page/cover.jpg -> array( 'identifier' => 'itemid', 'subPrefix' => 'some/sub/dir',
 340     //            'operator' => 'page', 'filename' => 'cover.jpg')
 341
 342     $parts = array();
 343
 344     // Pull off query, e.g. ?foo=bar
 345     if (preg_match('#(.*?)(\?.*)#', $path, $matches) === 1) {
 346         $parts['query'] = $matches[2];
 347         $path = $matches[1];
 348     }
 349
 350     // Pull off identifier
 351     if (preg_match('#[^/&?]+#', $path, $matches) === 0) {
 352         // no match
 353         return $parts;
 354     }
 355     $parts['identifier'] = $matches[0];
 356     $path = substr($path, strlen($matches[0]));
 357
 358     // Look for operators
 359     // The sub-prefix can be arbitrary, so we match up until the first operator
 360     $operators = '(' . join('|', self::$downloadOperators) . ')';
 361     $pattern = '#(?P<subPrefix>.*?)/(?P<operator>' . $operators . ')/(?P<operand>.*)#';
 362     if (preg_match($pattern, $path, $matches) === 1) {
 363         $parts['subPrefix'] = substr($matches['subPrefix'], 1); // remove leading '/'
 364         $parts['operator'] = $matches['operator'];
 365         $parts['operand'] = $matches['operand'];
 366     } else {
 367         $parts['subPrefix'] = $path;
 368     }
 369
 370     return $parts;
 371   }
 372
 373 }
 374
 375 ?>