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