BookReaderIA/inc/BookReader.inc

   1 <?
   2
   3 class BookReader
   4 {
   5
   6   // Returns true if can display the book in item with a given prefix (typically the item identifier)
   7   public static function canDisplay($item, $prefix, $checkOldScandata = false)
   8   {
   9
  10     // A "book" is an image stack and scandata.
  11     // 1. Old items may have scandata.xml or scandata.zip and itemid_{imageformat}.{zip,tar}
  12     // 2. Newer items may have multiple {arbitraryname}_scandata.xml and {arbitraryname}_{imageformat}.{zip,tar}
  13
  14     $foundScandata = false;
  15     $foundImageStack = false;
  16
  17     $targetScandata = $prefix . "_scandata.xml";
  18
  19     // $$$ TODO add support for jpg and tar stacks
  20     // https://bugs.edge.launchpad.net/gnubook/+bug/323003
  21     // https://bugs.edge.launchpad.net/gnubook/+bug/385397
  22     $imageFormatRegex = '@' . preg_quote($prefix, '@') . '_(jp2|tif|jpg)\.(zip|tar)$@';
  23
  24     $baseLength = strlen($item->metadataGrabber->mainDir . '/');
  25     foreach ($item->getFiles() as $location => $fileInfo) {
  26         $filename = substr($location, $baseLength);
  27
  28         if ($checkOldScandata) {
  29             if ($filename == 'scandata.xml' || $filename == 'scandata.zip') {
  30                 $foundScandata = $filename;
  31             }
  32         }
  33
  34         if ($filename == $targetScandata) {
  35             $foundScandata = $filename;
  36         }
  37
  38         if (preg_match($imageFormatRegex, $filename)) {
  39             $foundImageStack = $filename;
  40         }
  41     }
  42
  43     if ($foundScandata && $foundImageStack) {
  44         return true;
  45     }
  46
  47     return false;
  48   }
  49
  50   // Finds the prefix to use for the book given the part of the URL trailing after /stream/
  51   public static function findPrefix($urlPortion)
  52   {
  53     if (!preg_match('#[^/&?]+#', $urlPortion, $matches)) {
  54         return false;
  55     }
  56
  57     $prefix = $matches[0]; // identifier
  58
  59     // $$$ Currently swallows the rest of the URL.
  60     //     If we want to support e.g. /stream/itemid/subdir/prefix/page/23 will need to adjust.
  61     if (preg_match('#[^/&?]+/([^&?]+)#', $urlPortion, $matches)) {
  62         $prefix = $matches[1]; // sub prefix
  63     }
  64
  65     return $prefix;
  66   }
  67
  68   // $$$ would be cleaner to use different templates instead of the uiMode param
  69   //
  70   // @param subprefix Optional prefix to display a book inside an item (e.g. if does not match identifier)
  71   public static function draw($server, $mainDir, $identifier, $subPrefix, $title,
  72                               $coverLeaf=null, $titleStart='Internet Archive', $uiMode='full')
  73   {
  74     // Set title to default if not set
  75     if (!$title) {
  76         $title = 'Bookreader';
  77     }
  78
  79     $id = $identifier;
  80
  81     // manually update with Launchpad version number at each checkin so that browsers
  82     // do not use old cached version
  83     // see https://bugs.launchpad.net/gnubook/+bug/330748
  84     $version = "0.9.21";
  85
  86     if ("" == $id) {
  87         echo "No identifier specified!";
  88         die(-1);
  89     }
  90
  91     $metaURL = BookReader::jsMetadataURL($server, $identifier, $mainDir, $subPrefix);
  92
  93 ?>
  94 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  95 <html>
  96 <head>
  97     <title><? echo $title; ?></title>
  98 <!--[if lte IE 6]>
  99     <meta http-equiv="refresh" content="2; URL=/bookreader/browserunsupported.php?id=<? echo($id); ?>">
 100 <![endif]-->
 101     <link rel="stylesheet" type="text/css" href="/bookreader/BookReader.css?v=<? echo($version); ?>">
 102 <? if ($uiMode == "embed") { ?>
 103     <link rel="stylesheet" type="text/css" href="/bookreader/BookReaderEmbed.css?v=<? echo($version); ?>">
 104 <? } /* uiMode */ ?>
 105     <script src="/includes/jquery-1.3.2.min.js" type="text/javascript"></script>
 106         <script type="text/javascript" src="/bookreader/BookReader.js?v=<? echo($version); ?>"></script>
 107     <script type="text/javascript" src="/bookreader/jquery.easing.1.3.js"></script>
 108 </head>
 109 <body style="background-color: #FFFFFF;">
 110
 111 <? if ($uiMode == 'full') { ?>
 112 <div id="BookReader" style="left:10px; right:200px; top:10px; bottom:2em;">Internet Archive BookReader <noscript>requires JavaScript to be enabled.</noscript></div>
 113 <? } else { ?>
 114 <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>
 115 <? } /* uiMode*/ ?>
 116
 117 <script type="text/javascript">
 118   // Set some config variables -- $$$ NB: Config object format has not been finalized
 119   var brConfig = {};
 120 <? if ($uiMode == 'embed') { ?>
 121   brConfig["mode"] = 1;
 122   brConfig["reduce"] = 8;
 123   brConfig["ui"] = "embed";
 124 <? } else { ?>
 125   brConfig["mode"] = 2;
 126 <? } ?>
 127 </script>
 128 <script type="text/javascript" src="<? echo($metaURL); ?>"></script>
 129
 130 <? if ($uiMode == 'full') { ?>
 131 <div id="BookReaderSearch" style="width:190px; right:0px; top:10px; bottom:2em;">
 132     <form action='javascript:' onsubmit="br.search($('#BookReaderSearchBox').val());">
 133         <p style="display: inline">
 134             <input id="BookReaderSearchBox" type="text" size="20" value="search..." onfocus="if('search...'==this.value)this.value='';" /><input type="submit" value="go" />
 135         </p>
 136     </form>
 137     <div id="BookReaderSearchResults">
 138         Search results
 139     </div>
 140 </div>
 141
 142
 143 <div id="BRfooter">
 144     <div class="BRlogotype">
 145         <a href="http://archive.org/" class="BRblack">Internet Archive</a>
 146     </div>
 147     <div class="BRnavlinks">
 148         <!-- <a class="BRblack" href="http://openlibrary.org/dev/docs/bookreader">About the Bookreader</a> | -->
 149         <a class="BRblack" href="http://www.archive.org/about/faqs.php#Report_Item">Content Problems</a> |
 150         <a class="BRblack" href="https://bugs.launchpad.net/bookreader/+filebug">Report Bugs</a> |
 151         <a class="BRblack" href="http://www.archive.org/details/texts">Texts Collection</a> |
 152         <a class="BRblack" href="http://www.archive.org/about/contact.php">Contact Us</a>
 153     </div>
 154 </div>
 155 <? } /* uiMode */ ?>
 156
 157 <script type="text/javascript">
 158     // $$$ hack to workaround sizing bug when starting in two-up mode
 159     $(document).ready(function() {
 160         $(window).trigger('resize');
 161     });
 162 </script>
 163   <?
 164     exit;
 165   }
 166
 167
 168   public static function serverBaseURL($server)
 169   {
 170     // Check if we're on a dev vhost and point to JSIA in the user's public_html
 171     // on the datanode
 172     if (preg_match("/^www-(\w+)/", $_SERVER["SERVER_NAME"], $match)) {
 173       // $$$ the remapping isn't totally automatic yet and requires user to
 174       //     ln -s ~/petabox/www/datanode/BookReader ~/public_html/BookReader
 175       //     so we enable it only for known hosts
 176       $devhosts = array('mang', 'testflip', 'rkumar');
 177       if (in_array($match[1], $devhosts)) {
 178         $server = $server . "/~" . $match[1];
 179       }
 180     }
 181     return $server;
 182   }
 183
 184
 185   public static function jsMetadataURL($server, $identifier, $mainDir, $subPrefix = '')
 186   {
 187     $serverBaseURL = BookReader::serverBaseURL($server);
 188
 189     $params = array( 'id' => $identifier, 'itemPath' => $mainDir, 'server' => $server );
 190     if ($subPrefix) {
 191         $params['subPrefix'] = $subPrefix;
 192     }
 193
 194     $keys = array_keys($params);
 195     $lastParam = end($keys);
 196     $url = "http://{$serverBaseURL}/BookReader/BookReaderJSIA.php?";
 197     foreach($params as $param=>$value) {
 198         $url .= $param . '=' . $value;
 199         if ($param != $lastParam) {
 200             $url .= '&';
 201         }
 202     }
 203
 204     return $url;
 205   }
 206
 207 }
 208   ?>