BookReaderIA/inc/BookReader.inc

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