GnuBook/GnuBook.js

   1 /*
   2 Copyright(c)2008-2009 Internet Archive. Software license AGPL version 3.
   3
   4 This file is part of GnuBook.
   5
   6     GnuBook is free software: you can redistribute it and/or modify
   7     it under the terms of the GNU Affero General Public License as published by
   8     the Free Software Foundation, either version 3 of the License, or
   9     (at your option) any later version.
  10
  11     GnuBook is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU Affero General Public License for more details.
  15
  16     You should have received a copy of the GNU Affero General Public License
  17     along with GnuBook.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     The GnuBook source is hosted at http://github.com/openlibrary/bookreader/
  20
  21     archive.org cvs $Revision: 1.2 $ $Date: 2009-06-22 18:42:51 $
  22 */
  23
  24 // GnuBook()
  25 //______________________________________________________________________________
  26 // After you instantiate this object, you must supply the following
  27 // book-specific functions, before calling init():
  28 //  - getPageWidth()
  29 //  - getPageHeight()
  30 //  - getPageURI()
  31 // You must also add a numLeafs property before calling init().
  32
  33 //XXX
  34 if (typeof(console) == 'undefined') {
  35     console = { log: function(msg) { } };
  36 }
  37
  38 function GnuBook() {
  39     this.reduce  = 4;
  40     this.padding = 10;
  41     this.mode    = 1; //1 or 2
  42     this.ui = 'full'; // UI mode
  43
  44     this.displayedIndices = [];
  45     //this.indicesToDisplay = [];
  46     this.imgs = {};
  47     this.prefetchedImgs = {}; //an object with numeric keys cooresponding to page index
  48
  49     this.timer     = null;
  50     this.animating = false;
  51     this.auto      = false;
  52     this.autoTimer = null;
  53     this.flipSpeed = 'fast';
  54
  55     this.twoPagePopUp = null;
  56     this.leafEdgeTmp  = null;
  57     this.embedPopup = null;
  58
  59     this.searchResults = {};
  60
  61     this.firstIndex = null;
  62
  63     this.lastDisplayableIndex2up = null;
  64
  65     // We link to index.php to avoid redirect which breaks back button
  66     this.logoURL = 'http://www.archive.org/index.php';
  67
  68     // Base URL for images
  69     this.imagesBaseURL = '/bookreader/images/';
  70
  71     // Mode constants
  72     this.constMode1up = 1;
  73     this.constMode2up = 2;
  74
  75     // Object to hold parameters related to 2up mode
  76     this.twoPage = {
  77         coverInternalPadding: 10, // Width of cover
  78         coverExternalPadding: 10, // Padding outside of cover
  79         bookSpineDivWidth: 30,    // Width of book spine  $$$ consider sizing based on book length
  80         autofit: true
  81     };
  82 };
  83
  84 // init()
  85 //______________________________________________________________________________
  86 GnuBook.prototype.init = function() {
  87
  88     var startIndex = undefined;
  89
  90     // Find start index and mode if set in location hash
  91     var params = this.paramsFromFragment(window.location.hash);
  92
  93     if ('undefined' != typeof(params.index)) {
  94         startIndex = params.index;
  95     } else if ('undefined' != typeof(params.page)) {
  96         startIndex = this.getPageIndex(params.page);
  97     }
  98
  99     if ('undefined' == typeof(startIndex)) {
 100         if ('undefined' != typeof(this.titleLeaf)) {
 101             startIndex = this.leafNumToIndex(this.titleLeaf);
 102         }
 103     }
 104
 105     if ('undefined' == typeof(startIndex)) {
 106         startIndex = 0;
 107     }
 108
 109     if ('undefined' != typeof(params.mode)) {
 110         this.mode = params.mode;
 111     }
 112
 113     // Set document title -- may have already been set in enclosing html for
 114     // search engine visibility
 115     document.title = this.shortTitle(50);
 116
 117     // Sanitize parameters
 118     if ( !this.canSwitchToMode( this.mode ) ) {
 119         this.mode = this.constMode1up;
 120     }
 121
 122     $("#GnuBook").empty();
 123     this.initToolbar(this.mode, this.ui); // Build inside of toolbar div
 124     $("#GnuBook").append("<div id='GBcontainer'></div>");
 125     $("#GBcontainer").append("<div id='GBpageview'></div>");
 126
 127     $("#GBcontainer").bind('scroll', this, function(e) {
 128         e.data.loadLeafs();
 129     });
 130
 131     this.setupKeyListeners();
 132     this.startLocationPolling();
 133
 134     $(window).bind('resize', this, function(e) {
 135         //console.log('resize!');
 136         if (1 == e.data.mode) {
 137             //console.log('centering 1page view');
 138             e.data.centerPageView();
 139             $('#GBpageview').empty()
 140             e.data.displayedIndices = [];
 141             e.data.updateSearchHilites(); //deletes hilights but does not call remove()
 142             e.data.loadLeafs();
 143         } else {
 144             //console.log('drawing 2 page view');
 145             e.data.prepareTwoPageView();
 146         }
 147     });
 148
 149     $('.GBpagediv1up').bind('mousedown', this, function(e) {
 150         //console.log('mousedown!');
 151     });
 152
 153     if (1 == this.mode) {
 154         this.resizePageView();
 155         this.firstIndex = startIndex;
 156         this.jumpToIndex(startIndex);
 157     } else {
 158         //this.resizePageView();
 159
 160         this.displayedIndices=[0];
 161         this.firstIndex = startIndex;
 162         this.displayedIndices = [this.firstIndex];
 163         //console.log('titleLeaf: %d', this.titleLeaf);
 164         //console.log('displayedIndices: %s', this.displayedIndices);
 165         this.prepareTwoPageView();
 166         //if (this.auto) this.nextPage();
 167     }
 168
 169     // Enact other parts of initial params
 170     this.updateFromParams(params);
 171 }
 172
 173 GnuBook.prototype.setupKeyListeners = function() {
 174     var self = this;
 175
 176     var KEY_PGUP = 33;
 177     var KEY_PGDOWN = 34;
 178     var KEY_END = 35;
 179     var KEY_HOME = 36;
 180
 181     var KEY_LEFT = 37;
 182     var KEY_UP = 38;
 183     var KEY_RIGHT = 39;
 184     var KEY_DOWN = 40;
 185
 186     // We use document here instead of window to avoid a bug in jQuery on IE7
 187     $(document).keydown(function(e) {
 188
 189         // Keyboard navigation
 190         switch(e.keyCode) {
 191             case KEY_PGUP:
 192             case KEY_UP:
 193                 // In 1up mode page scrolling is handled by browser
 194                 if (2 == self.mode) {
 195                     self.prev();
 196                 }
 197                 break;
 198             case KEY_DOWN:
 199             case KEY_PGDOWN:
 200                 if (2 == self.mode) {
 201                     self.next();
 202                 }
 203                 break;
 204             case KEY_END:
 205                 self.last();
 206                 break;
 207             case KEY_HOME:
 208                 self.first();
 209                 break;
 210             case KEY_LEFT:
 211                 if (self.keyboardNavigationIsDisabled(e)) {
 212                     break;
 213                 }
 214                 if (2 == self.mode) {
 215                     self.left();
 216                 }
 217                 break;
 218             case KEY_RIGHT:
 219                 if (self.keyboardNavigationIsDisabled(e)) {
 220                     break;
 221                 }
 222                 if (2 == self.mode) {
 223                     self.right();
 224                 }
 225                 break;
 226         }
 227     });
 228 }
 229
 230 // drawLeafs()
 231 //______________________________________________________________________________
 232 GnuBook.prototype.drawLeafs = function() {
 233     if (1 == this.mode) {
 234         this.drawLeafsOnePage();
 235     } else {
 236         this.drawLeafsTwoPage();
 237     }
 238 }
 239
 240 // setDragHandler1up()
 241 //______________________________________________________________________________
 242 GnuBook.prototype.setDragHandler1up = function(div) {
 243     div.dragging = false;
 244
 245     $(div).bind('mousedown', function(e) {
 246         //console.log('mousedown at ' + e.pageY);
 247
 248         this.dragging = true;
 249         this.prevMouseX = e.pageX;
 250         this.prevMouseY = e.pageY;
 251
 252         var startX    = e.pageX;
 253         var startY    = e.pageY;
 254         var startTop  = $('#GBcontainer').attr('scrollTop');
 255         var startLeft =  $('#GBcontainer').attr('scrollLeft');
 256
 257         return false;
 258     });
 259
 260     $(div).bind('mousemove', function(ee) {
 261         //console.log('mousemove ' + startY);
 262
 263         var offsetX = ee.pageX - this.prevMouseX;
 264         var offsetY = ee.pageY - this.prevMouseY;
 265
 266         if (this.dragging) {
 267             $('#GBcontainer').attr('scrollTop', $('#GBcontainer').attr('scrollTop') - offsetY);
 268             $('#GBcontainer').attr('scrollLeft', $('#GBcontainer').attr('scrollLeft') - offsetX);
 269         }
 270
 271         this.prevMouseX = ee.pageX;
 272         this.prevMouseY = ee.pageY;
 273
 274         return false;
 275     });
 276
 277     $(div).bind('mouseup', function(ee) {
 278         //console.log('mouseup');
 279
 280         this.dragging = false;
 281         return false;
 282     });
 283
 284     $(div).bind('mouseleave', function(e) {
 285         //console.log('mouseleave');
 286
 287         //$(this).unbind('mousemove mouseup');
 288         this.dragging = false;
 289
 290     });
 291 }
 292
 293 // drawLeafsOnePage()
 294 //______________________________________________________________________________
 295 GnuBook.prototype.drawLeafsOnePage = function() {
 296     //alert('drawing leafs!');
 297     this.timer = null;
 298
 299
 300     var scrollTop = $('#GBcontainer').attr('scrollTop');
 301     var scrollBottom = scrollTop + $('#GBcontainer').height();
 302     //console.log('top=' + scrollTop + ' bottom='+scrollBottom);
 303
 304     var indicesToDisplay = [];
 305
 306     var i;
 307     var leafTop = 0;
 308     var leafBottom = 0;
 309     for (i=0; i<this.numLeafs; i++) {
 310         var height  = parseInt(this.getPageHeight(i)/this.reduce);
 311
 312         leafBottom += height;
 313         //console.log('leafTop = '+leafTop+ ' pageH = ' + this.pageH[i] + 'leafTop>=scrollTop=' + (leafTop>=scrollTop));
 314         var topInView    = (leafTop >= scrollTop) && (leafTop <= scrollBottom);
 315         var bottomInView = (leafBottom >= scrollTop) && (leafBottom <= scrollBottom);
 316         var middleInView = (leafTop <=scrollTop) && (leafBottom>=scrollBottom);
 317         if (topInView | bottomInView | middleInView) {
 318             //console.log('displayed: ' + this.displayedIndices);
 319             //console.log('to display: ' + i);
 320             indicesToDisplay.push(i);
 321         }
 322         leafTop += height +10;
 323         leafBottom += 10;
 324     }
 325
 326     var firstIndexToDraw  = indicesToDisplay[0];
 327     this.firstIndex      = firstIndexToDraw;
 328
 329     // Update hash, but only if we're currently displaying a leaf
 330     // Hack that fixes #365790
 331     if (this.displayedIndices.length > 0) {
 332         this.updateLocationHash();
 333     }
 334
 335     if ((0 != firstIndexToDraw) && (1 < this.reduce)) {
 336         firstIndexToDraw--;
 337         indicesToDisplay.unshift(firstIndexToDraw);
 338     }
 339
 340     var lastIndexToDraw = indicesToDisplay[indicesToDisplay.length-1];
 341     if ( ((this.numLeafs-1) != lastIndexToDraw) && (1 < this.reduce) ) {
 342         indicesToDisplay.push(lastIndexToDraw+1);
 343     }
 344
 345     leafTop = 0;
 346     var i;
 347     for (i=0; i<firstIndexToDraw; i++) {
 348         leafTop += parseInt(this.getPageHeight(i)/this.reduce) +10;
 349     }
 350
 351     //var viewWidth = $('#GBpageview').width(); //includes scroll bar width
 352     var viewWidth = $('#GBcontainer').attr('scrollWidth');
 353
 354
 355     for (i=0; i<indicesToDisplay.length; i++) {
 356         var index = indicesToDisplay[i];
 357         var height  = parseInt(this.getPageHeight(index)/this.reduce);
 358
 359         if(-1 == jQuery.inArray(indicesToDisplay[i], this.displayedIndices)) {
 360             var width   = parseInt(this.getPageWidth(index)/this.reduce);
 361             //console.log("displaying leaf " + indicesToDisplay[i] + ' leafTop=' +leafTop);
 362             var div = document.createElement("div");
 363             div.className = 'GBpagediv1up';
 364             div.id = 'pagediv'+index;
 365             div.style.position = "absolute";
 366             $(div).css('top', leafTop + 'px');
 367             var left = (viewWidth-width)>>1;
 368             if (left<0) left = 0;
 369             $(div).css('left', left+'px');
 370             $(div).css('width', width+'px');
 371             $(div).css('height', height+'px');
 372             //$(div).text('loading...');
 373
 374             this.setDragHandler1up(div);
 375
 376             $('#GBpageview').append(div);
 377
 378             var img = document.createElement("img");
 379             img.src = this.getPageURI(index);
 380             $(img).css('width', width+'px');
 381             $(img).css('height', height+'px');
 382             $(div).append(img);
 383
 384         } else {
 385             //console.log("not displaying " + indicesToDisplay[i] + ' score=' + jQuery.inArray(indicesToDisplay[i], this.displayedIndices));
 386         }
 387
 388         leafTop += height +10;
 389
 390     }
 391
 392     for (i=0; i<this.displayedIndices.length; i++) {
 393         if (-1 == jQuery.inArray(this.displayedIndices[i], indicesToDisplay)) {
 394             var index = this.displayedIndices[i];
 395             //console.log('Removing leaf ' + index);
 396             //console.log('id='+'#pagediv'+index+ ' top = ' +$('#pagediv'+index).css('top'));
 397             $('#pagediv'+index).remove();
 398         } else {
 399             //console.log('NOT Removing leaf ' + this.displayedIndices[i]);
 400         }
 401     }
 402
 403     this.displayedIndices = indicesToDisplay.slice();
 404     this.updateSearchHilites();
 405
 406     if (null != this.getPageNum(firstIndexToDraw))  {
 407         $("#GBpagenum").val(this.getPageNum(this.currentIndex()));
 408     } else {
 409         $("#GBpagenum").val('');
 410     }
 411
 412     this.updateToolbarZoom(this.reduce);
 413
 414 }
 415
 416 // drawLeafsTwoPage()
 417 //______________________________________________________________________________
 418 GnuBook.prototype.drawLeafsTwoPage = function() {
 419     console.log('drawing two leafs!'); // XXX
 420
 421     var scrollTop = $('#GBtwopageview').attr('scrollTop');
 422     var scrollBottom = scrollTop + $('#GBtwopageview').height();
 423
 424     console.log('drawLeafsTwoPage: this.currrentLeafL ' + this.twoPage.currentIndexL); // XXX
 425
 426     var indexL = this.twoPage.currentIndexL;
 427     var heightL  = this.getPageHeight(indexL);
 428     var widthL   = this.getPageWidth(indexL);
 429
 430     var leafEdgeWidthL = this.leafEdgeWidth(indexL);
 431     var leafEdgeWidthR = this.twoPage.edgeWidth - leafEdgeWidthL;
 432     //var bookCoverDivWidth = this.twoPage.width*2 + 20 + this.twoPage.edgeWidth; // $$$ hardcoded cover width
 433     var bookCoverDivWidth = this.twoPage.bookCoverDivWidth;
 434     //console.log(leafEdgeWidthL);
 435
 436     var middle = this.twoPage.middle; // $$$ getter instead?
 437     var top = this.twoPageTop();
 438     var bookCoverDivLeft = this.twoPage.bookCoverDivLeft;
 439
 440     // $$$ should get getwidth2up?
 441     //var scaledWL = parseInt(this.twoPage.height*widthL/heightL);
 442     var scaledWL = this.getPageWidth2UP(indexL);
 443     var gutter = this.twoPageGutter();
 444
 445     this.prefetchImg(indexL);
 446     $(this.prefetchedImgs[indexL]).css({
 447         position: 'absolute',
 448         left: gutter-scaledWL+'px',
 449         right: '',
 450         top:    top+'px',
 451         backgroundColor: 'rgb(234, 226, 205)',
 452         height: this.twoPage.height +'px', // $$$ height forced the same for both pages
 453         width:  scaledWL + 'px',
 454         borderRight: '1px solid black',
 455         zIndex: 2
 456     }).appendTo('#GBtwopageview');
 457
 458
 459     var indexR = this.twoPage.currentIndexR;
 460     var heightR  = this.getPageHeight(indexR);
 461     var widthR   = this.getPageWidth(indexR);
 462
 463     // $$$ should use getwidth2up?
 464     //var scaledWR = this.twoPage.height*widthR/heightR;
 465     var scaledWR = this.getPageWidth2UP(indexR);
 466     this.prefetchImg(indexR);
 467     $(this.prefetchedImgs[indexR]).css({
 468         position: 'absolute',
 469         left:   gutter+'px',
 470         right: '',
 471         top:    top+'px',
 472         backgroundColor: 'rgb(234, 226, 205)',
 473         height: this.twoPage.height + 'px', // $$$ height forced the same for both pages
 474         width:  scaledWR + 'px',
 475         borderLeft: '1px solid black',
 476         zIndex: 2
 477     }).appendTo('#GBtwopageview');
 478
 479
 480     this.displayedIndices = [this.twoPage.currentIndexL, this.twoPage.currentIndexR];
 481     this.setClickHandlers();
 482
 483     this.updatePageNumBox2UP();
 484     this.updateToolbarZoom(this.reduce);
 485 }
 486
 487 // updatePageNumBox2UP
 488 //______________________________________________________________________________
 489 GnuBook.prototype.updatePageNumBox2UP = function() {
 490     if (null != this.getPageNum(this.twoPage.currentIndexL))  {
 491         $("#GBpagenum").val(this.getPageNum(this.twoPage.currentIndexL));
 492     } else {
 493         $("#GBpagenum").val('');
 494     }
 495     this.updateLocationHash();
 496 }
 497
 498 // loadLeafs()
 499 //______________________________________________________________________________
 500 GnuBook.prototype.loadLeafs = function() {
 501
 502
 503     var self = this;
 504     if (null == this.timer) {
 505         this.timer=setTimeout(function(){self.drawLeafs()},250);
 506     } else {
 507         clearTimeout(this.timer);
 508         this.timer=setTimeout(function(){self.drawLeafs()},250);
 509     }
 510 }
 511
 512 // zoom(direction)
 513 //
 514 // Pass 1 to zoom in, anything else to zoom out
 515 //______________________________________________________________________________
 516 GnuBook.prototype.zoom = function(direction) {
 517     switch (this.mode) {
 518         case this.constMode1up:
 519             return this.zoom1up(direction);
 520         case this.constMode2up:
 521             return this.zoom2up(direction);
 522     }
 523 }
 524
 525 // zoom1up(dir)
 526 //______________________________________________________________________________
 527 GnuBook.prototype.zoom1up = function(dir) {
 528     if (2 == this.mode) {     //can only zoom in 1-page mode
 529         this.switchMode(1);
 530         return;
 531     }
 532
 533     // $$$ with flexible zoom we could "snap" to /2 page reductions
 534     //     for better scaling
 535     if (1 == dir) {
 536         if (this.reduce <= 0.5) return;
 537         this.reduce*=0.5;           //zoom in
 538     } else {
 539         if (this.reduce >= 8) return;
 540         this.reduce*=2;             //zoom out
 541     }
 542
 543     this.resizePageView();
 544
 545     $('#GBpageview').empty()
 546     this.displayedIndices = [];
 547     this.loadLeafs();
 548
 549     this.updateToolbarZoom(this.reduce);
 550 }
 551
 552 // resizePageView()
 553 //______________________________________________________________________________
 554 GnuBook.prototype.resizePageView = function() {
 555     var i;
 556     var viewHeight = 0;
 557     //var viewWidth  = $('#GBcontainer').width(); //includes scrollBar
 558     var viewWidth  = $('#GBcontainer').attr('clientWidth');
 559
 560     var oldScrollTop  = $('#GBcontainer').attr('scrollTop');
 561     var oldScrollLeft = $('#GBcontainer').attr('scrollLeft');
 562     var oldPageViewHeight = $('#GBpageview').height();
 563     var oldPageViewWidth = $('#GBpageview').width();
 564
 565     var oldCenterY = this.centerY1up();
 566     var oldCenterX = this.centerX1up();
 567
 568     if (0 != oldPageViewHeight) {
 569         var scrollRatio = oldCenterY / oldPageViewHeight;
 570     } else {
 571         var scrollRatio = 0;
 572     }
 573
 574     for (i=0; i<this.numLeafs; i++) {
 575         viewHeight += parseInt(this.getPageHeight(i)/this.reduce) + this.padding;
 576         var width = parseInt(this.getPageWidth(i)/this.reduce);
 577         if (width>viewWidth) viewWidth=width;
 578     }
 579     $('#GBpageview').height(viewHeight);
 580     $('#GBpageview').width(viewWidth);
 581
 582     var newCenterY = scrollRatio*viewHeight;
 583     var newTop = Math.max(0, Math.floor( newCenterY - $('#GBcontainer').height()/2 ));
 584     $('#GBcontainer').attr('scrollTop', newTop);
 585
 586     // We use clientWidth here to avoid miscalculating due to scroll bar
 587     var newCenterX = oldCenterX * (viewWidth / oldPageViewWidth);
 588     var newLeft = newCenterX - $('#GBcontainer').attr('clientWidth') / 2;
 589     newLeft = Math.max(newLeft, 0);
 590     $('#GBcontainer').attr('scrollLeft', newLeft);
 591     //console.log('oldCenterX ' + oldCenterX + ' newCenterX ' + newCenterX + ' newLeft ' + newLeft);
 592
 593     //this.centerPageView();
 594     this.loadLeafs();
 595
 596 }
 597
 598 // centerX1up()
 599 //______________________________________________________________________________
 600 // Returns the current offset of the viewport center in scaled document coordinates.
 601 GnuBook.prototype.centerX1up = function() {
 602     var centerX;
 603     if ($('#GBpageview').width() < $('#GBcontainer').attr('clientWidth')) { // fully shown
 604         centerX = $('#GBpageview').width();
 605     } else {
 606         centerX = $('#GBcontainer').attr('scrollLeft') + $('#GBcontainer').attr('clientWidth') / 2;
 607     }
 608     centerX = Math.floor(centerX);
 609     return centerX;
 610 }
 611
 612 // centerY1up()
 613 //______________________________________________________________________________
 614 // Returns the current offset of the viewport center in scaled document coordinates.
 615 GnuBook.prototype.centerY1up = function() {
 616     var centerY = $('#GBcontainer').attr('scrollTop') + $('#GBcontainer').height() / 2;
 617     return Math.floor(centerY);
 618 }
 619
 620 // centerPageView()
 621 //______________________________________________________________________________
 622 GnuBook.prototype.centerPageView = function() {
 623
 624     var scrollWidth  = $('#GBcontainer').attr('scrollWidth');
 625     var clientWidth  =  $('#GBcontainer').attr('clientWidth');
 626     //console.log('sW='+scrollWidth+' cW='+clientWidth);
 627     if (scrollWidth > clientWidth) {
 628         $('#GBcontainer').attr('scrollLeft', (scrollWidth-clientWidth)/2);
 629     }
 630
 631 }
 632
 633 // zoom2up(direction)
 634 //______________________________________________________________________________
 635 GnuBook.prototype.zoom2up = function(direction) {
 636     // $$$ this is where we can e.g. snap to %2 sizes
 637     if (0 == direction) { // autofit mode
 638         this.twoPage.autofit = true;;
 639     } else if (1 == direction) {
 640         if (this.reduce <= 0.5) return;
 641         this.reduce*=0.5;           //zoom in
 642         this.twoPage.autofit = false;
 643     } else {
 644         if (this.reduce >= 8) return;
 645         this.reduce *= 2; // zoom out
 646         this.twoPage.autofit = false;
 647     }
 648
 649     this.prepareTwoPageView();
 650 }
 651
 652 // jumpToPage()
 653 //______________________________________________________________________________
 654 // Attempts to jump to page.  Returns true if page could be found, false otherwise.
 655 GnuBook.prototype.jumpToPage = function(pageNum) {
 656
 657     var pageIndex = this.getPageIndex(pageNum);
 658
 659     if ('undefined' != typeof(pageIndex)) {
 660         var leafTop = 0;
 661         var h;
 662         this.jumpToIndex(pageIndex);
 663         $('#GBcontainer').attr('scrollTop', leafTop);
 664         return true;
 665     }
 666
 667     // Page not found
 668     return false;
 669 }
 670
 671 // jumpToIndex()
 672 //______________________________________________________________________________
 673 GnuBook.prototype.jumpToIndex = function(index) {
 674
 675     if (2 == this.mode) {
 676         this.autoStop();
 677
 678         // By checking against min/max we do nothing if requested index
 679         // is current
 680         if (index < Math.min(this.twoPage.currentIndexL, this.twoPage.currentIndexR)) {
 681             this.flipBackToIndex(index);
 682         } else if (index > Math.max(this.twoPage.currentIndexL, this.twoPage.currentIndexR)) {
 683             this.flipFwdToIndex(index);
 684         }
 685
 686     } else {
 687         var i;
 688         var leafTop = 0;
 689         var h;
 690         for (i=0; i<index; i++) {
 691             h = parseInt(this.getPageHeight(i)/this.reduce);
 692             leafTop += h + this.padding;
 693         }
 694         //$('#GBcontainer').attr('scrollTop', leafTop);
 695         $('#GBcontainer').animate({scrollTop: leafTop },'fast');
 696     }
 697 }
 698
 699
 700
 701 // switchMode()
 702 //______________________________________________________________________________
 703 GnuBook.prototype.switchMode = function(mode) {
 704
 705     //console.log('  asked to switch to mode ' + mode + ' from ' + this.mode);
 706
 707     if (mode == this.mode) return;
 708
 709     if (!this.canSwitchToMode(mode)) {
 710         return;
 711     }
 712
 713     this.autoStop();
 714     this.removeSearchHilites();
 715
 716     this.mode = mode;
 717
 718     this.switchToolbarMode(mode);
 719
 720     if (1 == mode) {
 721         this.prepareOnePageView();
 722     } else {
 723         this.prepareTwoPageView();
 724     }
 725
 726 }
 727
 728 //prepareOnePageView()
 729 //______________________________________________________________________________
 730 GnuBook.prototype.prepareOnePageView = function() {
 731
 732     // var startLeaf = this.displayedIndices[0];
 733     var startLeaf = this.currentIndex();
 734
 735     $('#GBcontainer').empty();
 736     $('#GBcontainer').css({
 737         overflowY: 'scroll',
 738         overflowX: 'auto'
 739     });
 740
 741     var gbPageView = $("#GBcontainer").append("<div id='GBpageview'></div>");
 742
 743     this.resizePageView();
 744
 745     this.jumpToIndex(startLeaf);
 746     this.displayedIndices = [];
 747
 748     this.drawLeafsOnePage();
 749
 750     // Bind mouse handlers
 751     // Disable mouse click to avoid selected/highlighted page images - bug 354239
 752     gbPageView.bind('mousedown', function(e) {
 753         return false;
 754     })
 755     // Special hack for IE7
 756     gbPageView[0].onselectstart = function(e) { return false; };
 757 }
 758
 759 // prepareTwoPageView()
 760 //______________________________________________________________________________
 761 // Some decisions about two page view:
 762 //
 763 // Both pages will be displayed at the same height, even if they were different physical/scanned
 764 // sizes.  This simplifies the animation (from a design as well as technical standpoint).  We
 765 // examine the page aspect ratios (in calculateSpreadSize) and use the page with the most "normal"
 766 // aspect ratio to determine the height.
 767 //
 768 // The two page view div is resized to keep the middle of the book in the middle of the div
 769 // even as the page sizes change.  To e.g. keep the middle of the book in the middle of the GBcontent
 770 // div requires adjusting the offset of GBtwpageview and/or scrolling in GBcontent.
 771 GnuBook.prototype.prepareTwoPageView = function() {
 772     $('#GBcontainer').empty();
 773     $('#GBcontainer').css('overflow', 'auto');
 774
 775     // Add the two page view
 776     $('#GBcontainer').append('<div id="GBtwopageview"></div>');
 777     // Explicitly set sizes the same
 778     // $$$ calculate first then set
 779     $('#GBtwopageview').css( {
 780         height: $('#GBcontainer').height(),
 781         width: $('#GBcontainer').width(),
 782         position: 'absolute'
 783         });
 784
 785     // We want to display two facing pages.  We may be missing
 786     // one side of the spread because it is the first/last leaf,
 787     // foldouts, missing pages, etc
 788
 789     //var targetLeaf = this.displayedIndices[0];
 790     var targetLeaf = this.firstIndex;
 791
 792     if (targetLeaf < this.firstDisplayableIndex()) {
 793         targetLeaf = this.firstDisplayableIndex();
 794     }
 795
 796     if (targetLeaf > this.lastDisplayableIndex()) {
 797         targetLeaf = this.lastDisplayableIndex();
 798     }
 799
 800     this.twoPage.currentIndexL = null;
 801     this.twoPage.currentIndexR = null;
 802     this.pruneUnusedImgs();
 803
 804     var currentSpreadIndices = this.getSpreadIndices(targetLeaf);
 805     this.twoPage.currentIndexL = currentSpreadIndices[0];
 806     this.twoPage.currentIndexR = currentSpreadIndices[1];
 807     this.firstIndex = this.twoPage.currentIndexL;
 808
 809     this.calculateSpreadSize(); //sets twoPage.width, twoPage.height, and twoPage.ratio
 810
 811     $('#GBtwopageview').width(this.twoPage.totalWidth).height(this.twoPage.totalHeight);
 812
 813     this.twoPageDiv = document.createElement('div');
 814     $(this.twoPageDiv).attr('id', 'GBbookcover').css({
 815         border: '1px solid rgb(68, 25, 17)',
 816         width:  this.twoPage.bookCoverDivWidth + 'px',
 817         height: this.twoPage.bookCoverDivHeight+'px',
 818         visibility: 'visible',
 819         position: 'absolute',
 820         backgroundColor: '#663929',
 821         left: this.twoPage.bookCoverDivLeft + 'px',
 822         top: this.twoPage.bookCoverDivTop+'px',
 823         MozBorderRadiusTopleft: '7px',
 824         MozBorderRadiusTopright: '7px',
 825         MozBorderRadiusBottomright: '7px',
 826         MozBorderRadiusBottomleft: '7px'
 827     }).appendTo('#GBtwopageview');
 828
 829     this.leafEdgeR = document.createElement('div');
 830     this.leafEdgeR.className = 'leafEdgeR'; // $$$ the static CSS should be moved into the .css file
 831     $(this.leafEdgeR).css({
 832         borderStyle: 'solid solid solid none',
 833         borderColor: 'rgb(51, 51, 34)',
 834         borderWidth: '1px 1px 1px 0px',
 835         background: 'transparent url(' + this.imagesBaseURL + 'right_edges.png) repeat scroll 0% 0%',
 836         width: this.twoPage.leafEdgeWidthR + 'px',
 837         height: this.twoPage.height-1 + 'px',
 838         /*right: '10px',*/
 839         left: this.twoPage.gutter+this.twoPage.scaledWR+'px',
 840         top: this.twoPage.bookCoverDivTop+this.twoPage.coverInternalPadding+'px',
 841         position: 'absolute'
 842     }).appendTo('#GBtwopageview');
 843
 844     this.leafEdgeL = document.createElement('div');
 845     this.leafEdgeL.className = 'leafEdgeL';
 846     $(this.leafEdgeL).css({ // $$$ static CSS should be moved to file
 847         borderStyle: 'solid none solid solid',
 848         borderColor: 'rgb(51, 51, 34)',
 849         borderWidth: '1px 0px 1px 1px',
 850         background: 'transparent url(' + this.imagesBaseURL + 'left_edges.png) repeat scroll 0% 0%',
 851         width: this.twoPage.leafEdgeWidthL + 'px',
 852         height: this.twoPage.height-1 + 'px',
 853         left: this.twoPage.bookCoverDivLeft+this.twoPage.coverInternalPadding+'px',
 854         top: this.twoPage.bookCoverDivTop+this.twoPage.coverInternalPadding+'px',
 855         position: 'absolute'
 856     }).appendTo('#GBtwopageview');
 857
 858     div = document.createElement('div');
 859     $(div).attr('id', 'GBbookspine').css({
 860         border:          '1px solid rgb(68, 25, 17)',
 861         width:           this.twoPage.bookSpineDivWidth+'px',
 862         height:          this.twoPage.bookSpineDivHeight+'px',
 863         position:        'absolute',
 864         backgroundColor: 'rgb(68, 25, 17)',
 865         left:            this.twoPage.bookSpineDivLeft+'px',
 866         top:             this.twoPage.bookSpineDivTop+'px'
 867     }).appendTo('#GBtwopageview');
 868
 869     this.prepareTwoPagePopUp();
 870
 871     this.displayedIndices = [];
 872
 873     //this.indicesToDisplay=[firstLeaf, firstLeaf+1];
 874     //console.log('indicesToDisplay: ' + this.indicesToDisplay[0] + ' ' + this.indicesToDisplay[1]);
 875
 876     this.drawLeafsTwoPage();
 877     this.updateSearchHilites2UP();
 878     this.updateToolbarZoom(this.reduce);
 879
 880     this.prefetch();
 881 }
 882
 883 // prepareTwoPagePopUp()
 884 //
 885 // This function prepares the "View Page n" popup that shows while the mouse is
 886 // over the left/right "stack of sheets" edges.  It also binds the mouse
 887 // events for these divs.
 888 //______________________________________________________________________________
 889 GnuBook.prototype.prepareTwoPagePopUp = function() {
 890
 891     this.twoPagePopUp = document.createElement('div');
 892     $(this.twoPagePopUp).css({
 893         border: '1px solid black',
 894         padding: '2px 6px',
 895         position: 'absolute',
 896         fontFamily: 'sans-serif',
 897         fontSize: '14px',
 898         zIndex: '1000',
 899         backgroundColor: 'rgb(255, 255, 238)',
 900         opacity: 0.85
 901     }).appendTo('#GBcontainer');
 902     $(this.twoPagePopUp).hide();
 903
 904     $(this.leafEdgeL).add(this.leafEdgeR).bind('mouseenter', this, function(e) {
 905         $(e.data.twoPagePopUp).show();
 906     });
 907
 908     $(this.leafEdgeL).add(this.leafEdgeR).bind('mouseleave', this, function(e) {
 909         $(e.data.twoPagePopUp).hide();
 910     });
 911
 912     $(this.leafEdgeL).bind('click', this, function(e) {
 913         e.data.autoStop();
 914         var jumpIndex = e.data.jumpIndexForLeftEdgePageX(e.pageX);
 915         e.data.jumpToIndex(jumpIndex);
 916     });
 917
 918     $(this.leafEdgeR).bind('click', this, function(e) {
 919         e.data.autoStop();
 920         var jumpIndex = e.data.jumpIndexForRightEdgePageX(e.pageX);
 921         e.data.jumpToIndex(jumpIndex);
 922     });
 923
 924     $(this.leafEdgeR).bind('mousemove', this, function(e) {
 925
 926         var jumpIndex = e.data.jumpIndexForRightEdgePageX(e.pageX);
 927         $(e.data.twoPagePopUp).text('View ' + e.data.getPageName(jumpIndex));
 928
 929         // $$$ TODO: Make sure popup is positioned so that it is in view
 930         // (https://bugs.edge.launchpad.net/gnubook/+bug/327456)
 931         $(e.data.twoPagePopUp).css({
 932             left: e.pageX- $('#GBcontainer').offset().left + $('#GBcontainer').scrollLeft() + 20 + 'px',
 933             top: e.pageY - $('#GBcontainer').offset().top + $('#GBcontainer').scrollTop() + 'px'
 934         });
 935     });
 936
 937     $(this.leafEdgeL).bind('mousemove', this, function(e) {
 938
 939         var jumpIndex = e.data.jumpIndexForLeftEdgePageX(e.pageX);
 940         $(e.data.twoPagePopUp).text('View '+ e.data.getPageName(jumpIndex));
 941
 942         // $$$ TODO: Make sure popup is positioned so that it is in view
 943         //           (https://bugs.edge.launchpad.net/gnubook/+bug/327456)
 944         $(e.data.twoPagePopUp).css({
 945             left: e.pageX - $('#GBcontainer').offset().left + $('#GBcontainer').scrollLeft() - $(e.data.twoPagePopUp).width() - 25 + 'px',
 946             top: e.pageY-$('#GBcontainer').offset().top + $('#GBcontainer').scrollTop() + 'px'
 947         });
 948     });
 949 }
 950
 951 // calculateSpreadSize()
 952 //______________________________________________________________________________
 953 // Calculates 2-page spread dimensions based on this.twoPage.currentIndexL and
 954 // this.twoPage.currentIndexR
 955 // This function sets this.twoPage.height, twoPage.width, and twoPage.ratio
 956
 957 GnuBook.prototype.calculateSpreadSize = function() {
 958     console.log('calculateSpreadSize ' + this.twoPage.currentIndexL); // XXX
 959
 960     // $$$ TODO Calculate the spread size based on the reduction factor.  If we are using
 961     // fit mode we recalculate the reduction factor based on the current page sizes
 962     // and display size first.
 963
 964     var firstIndex  = this.twoPage.currentIndexL;
 965     var secondIndex = this.twoPage.currentIndexR;
 966     //console.log('first page is ' + firstIndex);
 967
 968     var spreadSize;
 969     if ( this.twoPage.autofit) {
 970         spreadSize = this.getIdealSpreadSize(firstIndex, secondIndex);
 971     } else {
 972         // set based on reduction factor
 973         spreadSize = this.getSpreadSizeFromReduce(firstIndex, secondIndex, this.reduce);
 974     }
 975
 976     this.twoPage.height = spreadSize.height;
 977     this.twoPage.width = spreadSize.width;
 978     this.twoPage.ratio = spreadSize.ratio;
 979     this.twoPage.edgeWidth = spreadSize.totalLeafEdgeWidth; // The combined width of both edges
 980
 981     this.twoPage.scaledWL = this.getPageWidth2UP(firstIndex);
 982     this.twoPage.scaledWR = this.getPageWidth2UP(secondIndex);
 983     this.twoPage.leafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
 984     this.twoPage.leafEdgeWidthR = this.twoPage.edgeWidth - this.twoPage.leafEdgeWidthL;
 985
 986     // The width of the book cover div.  The combined width of both pages, twice the width
 987     // of the book cover internal padding (2*10) and the page edges
 988     this.twoPage.bookCoverDivWidth = this.twoPage.scaledWL + this.twoPage.scaledWR + 2 * this.twoPage.coverInternalPadding + this.twoPage.edgeWidth;
 989
 990     // The height of the book cover div
 991     this.twoPage.bookCoverDivHeight = this.twoPage.height + 2 * this.twoPage.coverInternalPadding;
 992
 993     // Total height and width -- makes the spine middle centered
 994     var leftGutterOffset = this.gutterOffsetForIndex(firstIndex);
 995     var largestWidthFromCenter = Math.max( (this.twoPage.scaledWL + leftGutterOffset), (this.twoPage.scaledWR - leftGutterOffset));
 996     this.twoPage.totalWidth = 2 * (largestWidthFromCenter + this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding);
 997     this.twoPage.totalHeight = this.twoPage.height + 2 * (this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding);
 998
 999     // We want to minimize the unused space in two-up mode (maximize the amount of page
1000     // shown).  We give width to the leaf edges and these widths change (though the sum
1001     // of the two remains constant) as we flip through the book.  With the book
1002     // cover centered and fixed in the GBcontainer div the page images will meet
1003     // at the "gutter" which is generally offset from the center.
1004     this.twoPage.middle = this.twoPage.totalWidth >> 1;
1005     this.twoPage.gutter = this.twoPage.middle + this.gutterOffsetForIndex(firstIndex);
1006
1007     this.twoPage.bookCoverDivLeft = this.twoPage.coverExternalPadding; // $$$ Account for border?
1008     this.twoPage.bookCoverDivTop = this.twoPage.coverExternalPadding; // $$$ Account for border?
1009
1010     this.twoPage.bookSpineDivHeight = this.twoPage.height + 2*this.twoPage.coverInternalPadding;
1011     this.twoPage.bookSpineDivLeft = this.twoPage.middle - (this.twoPage.bookSpineDivWidth >> 1);
1012     this.twoPage.bookSpineDivTop = this.twoPage.bookCoverDivTop;
1013
1014
1015     this.reduce = spreadSize.reduce; // $$$ really set this here?
1016 }
1017
1018 GnuBook.prototype.getIdealSpreadSize = function(firstIndex, secondIndex) {
1019     var ideal = {};
1020
1021     // We check which page is closest to a "normal" page and use that to set the height
1022     // for both pages.  This means that foldouts and other odd size pages will be displayed
1023     // smaller than the nominal zoom amount.
1024     var canon5Dratio = 1.5;
1025
1026     var first = {
1027         height: this.getPageHeight(firstIndex),
1028         width: this.getPageWidth(firstIndex)
1029     }
1030
1031     var second = {
1032         height: this.getPageHeight(secondIndex),
1033         width: this.getPageWidth(secondIndex)
1034     }
1035
1036     var firstIndexRatio  = first.height / first.width;
1037     var secondIndexRatio = second.height / second.width;
1038     //console.log('firstIndexRatio = ' + firstIndexRatio + ' secondIndexRatio = ' + secondIndexRatio);
1039
1040     if (Math.abs(firstIndexRatio - canon5Dratio) < Math.abs(secondIndexRatio - canon5Dratio)) {
1041         ideal.ratio = firstIndexRatio;
1042         //console.log('using firstIndexRatio ' + ratio);
1043     } else {
1044         ideal.ratio = secondIndexRatio;
1045         //console.log('using secondIndexRatio ' + ratio);
1046     }
1047
1048     var totalLeafEdgeWidth = parseInt(this.numLeafs * 0.1);
1049     var maxLeafEdgeWidth   = parseInt($('#GBcontainer').attr('clientWidth') * 0.1);
1050     ideal.totalLeafEdgeWidth     = Math.min(totalLeafEdgeWidth, maxLeafEdgeWidth);
1051
1052     ideal.width  = ($('#GBcontainer').attr('clientWidth') - 30 - ideal.totalLeafEdgeWidth)>>1;
1053     ideal.height = $('#GBcontainer').height() - 30;  // $$$ why - 30?  book edge width?
1054     //console.log('init idealWidth='+idealWidth+' idealHeight='+idealHeight + ' ratio='+ratio);
1055
1056     if (ideal.height/ideal.ratio <= ideal.width) {
1057         //use height
1058         ideal.width = parseInt(ideal.height/ideal.ratio);
1059     } else {
1060         //use width
1061         ideal.height = parseInt(ideal.width*ideal.ratio);
1062     }
1063
1064     // XXX check this logic with large spreads
1065     ideal.reduce = ((first.height + second.height) / 2) / ideal.height;
1066
1067     return ideal;
1068 }
1069
1070 GnuBook.prototype.getSpreadSizeFromReduce = function(firstIndex, secondIndex, reduce) {
1071     var spreadSize = {};
1072     // $$$ Scale this based on reduce?
1073     var totalLeafEdgeWidth = parseInt(this.numLeafs * 0.1);
1074     var maxLeafEdgeWidth   = parseInt($('#GBcontainer').attr('clientWidth') * 0.1);
1075     spreadSize.totalLeafEdgeWidth     = Math.min(totalLeafEdgeWidth, maxLeafEdgeWidth);
1076
1077     // $$$ this isn't quite right when the pages are different sizes
1078     var nativeWidth = this.getPageWidth(firstIndex) + this.getPageWidth(secondIndex);
1079     var nativeHeight = this.getPageHeight(firstIndex) + this.getPageHeight(secondIndex);
1080     spreadSize.height = parseInt( (nativeHeight / 2) / this.reduce );
1081     spreadSize.width = parseInt( (nativeWidth / 2) / this.reduce );
1082     spreadSize.reduce = reduce;
1083
1084     // XXX
1085     console.log('spread size: ' + firstIndex + ',' + secondIndex + ',' + reduce);
1086
1087     return spreadSize;
1088 }
1089
1090 // currentIndex()
1091 //______________________________________________________________________________
1092 // Returns the currently active index.
1093 GnuBook.prototype.currentIndex = function() {
1094     // $$$ we should be cleaner with our idea of which index is active in 1up/2up
1095     if (this.mode == this.constMode1up || this.mode == this.constMode2up) {
1096         return this.firstIndex;
1097     } else {
1098         throw 'currentIndex called for unimplemented mode ' + this.mode;
1099     }
1100 }
1101
1102 // right()
1103 //______________________________________________________________________________
1104 // Flip the right page over onto the left
1105 GnuBook.prototype.right = function() {
1106     if ('rl' != this.pageProgression) {
1107         // LTR
1108         gb.next();
1109     } else {
1110         // RTL
1111         gb.prev();
1112     }
1113 }
1114
1115 // rightmost()
1116 //______________________________________________________________________________
1117 // Flip to the rightmost page
1118 GnuBook.prototype.rightmost = function() {
1119     if ('rl' != this.pageProgression) {
1120         gb.last();
1121     } else {
1122         gb.first();
1123     }
1124 }
1125
1126 // left()
1127 //______________________________________________________________________________
1128 // Flip the left page over onto the right.
1129 GnuBook.prototype.left = function() {
1130     if ('rl' != this.pageProgression) {
1131         // LTR
1132         gb.prev();
1133     } else {
1134         // RTL
1135         gb.next();
1136     }
1137 }
1138
1139 // leftmost()
1140 //______________________________________________________________________________
1141 // Flip to the leftmost page
1142 GnuBook.prototype.leftmost = function() {
1143     if ('rl' != this.pageProgression) {
1144         gb.first();
1145     } else {
1146         gb.last();
1147     }
1148 }
1149
1150 // next()
1151 //______________________________________________________________________________
1152 GnuBook.prototype.next = function() {
1153     if (2 == this.mode) {
1154         this.autoStop();
1155         this.flipFwdToIndex(null);
1156     } else {
1157         if (this.firstIndex < this.lastDisplayableIndex()) {
1158             this.jumpToIndex(this.firstIndex+1);
1159         }
1160     }
1161 }
1162
1163 // prev()
1164 //______________________________________________________________________________
1165 GnuBook.prototype.prev = function() {
1166     if (2 == this.mode) {
1167         this.autoStop();
1168         this.flipBackToIndex(null);
1169     } else {
1170         if (this.firstIndex >= 1) {
1171             this.jumpToIndex(this.firstIndex-1);
1172         }
1173     }
1174 }
1175
1176 GnuBook.prototype.first = function() {
1177     if (2 == this.mode) {
1178         this.jumpToIndex(2);
1179     }
1180     else {
1181         this.jumpToIndex(0);
1182     }
1183 }
1184
1185 GnuBook.prototype.last = function() {
1186     if (2 == this.mode) {
1187         this.jumpToIndex(this.lastDisplayableIndex());
1188     }
1189     else {
1190         this.jumpToIndex(this.lastDisplayableIndex());
1191     }
1192 }
1193
1194 // flipBackToIndex()
1195 //______________________________________________________________________________
1196 // to flip back one spread, pass index=null
1197 GnuBook.prototype.flipBackToIndex = function(index) {
1198     if (1 == this.mode) return;
1199
1200     var leftIndex = this.twoPage.currentIndexL;
1201
1202     // $$$ Need to change this to be able to see first spread.
1203     //     See https://bugs.launchpad.net/gnubook/+bug/296788
1204     if (leftIndex <= 2) return;
1205     if (this.animating) return;
1206
1207     if (null != this.leafEdgeTmp) {
1208         alert('error: leafEdgeTmp should be null!');
1209         return;
1210     }
1211
1212     if (null == index) {
1213         index = leftIndex-2;
1214     }
1215     //if (index<0) return;
1216
1217     var previousIndices = this.getSpreadIndices(index);
1218
1219     if (previousIndices[0] < 0 || previousIndices[1] < 0) {
1220         return;
1221     }
1222
1223     //console.log("flipping back to " + previousIndices[0] + ',' + previousIndices[1]);
1224
1225     this.animating = true;
1226
1227     if ('rl' != this.pageProgression) {
1228         // Assume LTR and we are going backward
1229         var gutter = this.prepareFlipLeftToRight(previousIndices[0], previousIndices[1]);
1230         this.flipLeftToRight(previousIndices[0], previousIndices[1], gutter);
1231
1232     } else {
1233         // RTL and going backward
1234         var gutter = this.prepareFlipRightToLeft(previousIndices[0], previousIndices[1]);
1235         this.flipRightToLeft(previousIndices[0], previousIndices[1], gutter);
1236     }
1237 }
1238
1239 // flipLeftToRight()
1240 //______________________________________________________________________________
1241 // Flips the page on the left towards the page on the right
1242 GnuBook.prototype.flipLeftToRight = function(newIndexL, newIndexR, gutter) {
1243
1244     var leftLeaf = this.twoPage.currentIndexL;
1245
1246     var oldLeafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
1247     var newLeafEdgeWidthL = this.leafEdgeWidth(newIndexL);
1248     var leafEdgeTmpW = oldLeafEdgeWidthL - newLeafEdgeWidthL;
1249
1250     var currWidthL   = this.getPageWidth2UP(leftLeaf);
1251     var newWidthL    = this.getPageWidth2UP(newIndexL);
1252     var newWidthR    = this.getPageWidth2UP(newIndexR);
1253
1254     var top  = this.twoPageTop();
1255     var gutter = this.twoPageGutter();
1256
1257     //console.log('leftEdgeTmpW ' + leafEdgeTmpW);
1258     //console.log('  gutter ' + gutter + ', scaledWL ' + scaledWL + ', newLeafEdgeWL ' + newLeafEdgeWidthL);
1259
1260     //animation strategy:
1261     // 0. remove search highlight, if any.
1262     // 1. create a new div, called leafEdgeTmp to represent the leaf edge between the leftmost edge
1263     //    of the left leaf and where the user clicked in the leaf edge.
1264     //    Note that if this function was triggered by left() and not a
1265     //    mouse click, the width of leafEdgeTmp is very small (zero px).
1266     // 2. animate both leafEdgeTmp to the gutter (without changing its width) and animate
1267     //    leftLeaf to width=0.
1268     // 3. When step 2 is finished, animate leafEdgeTmp to right-hand side of new right leaf
1269     //    (left=gutter+newWidthR) while also animating the new right leaf from width=0 to
1270     //    its new full width.
1271     // 4. After step 3 is finished, do the following:
1272     //      - remove leafEdgeTmp from the dom.
1273     //      - resize and move the right leaf edge (leafEdgeR) to left=gutter+newWidthR
1274     //          and width=twoPage.edgeWidth-newLeafEdgeWidthL.
1275     //      - resize and move the left leaf edge (leafEdgeL) to left=gutter-newWidthL-newLeafEdgeWidthL
1276     //          and width=newLeafEdgeWidthL.
1277     //      - resize the back cover (twoPageDiv) to left=gutter-newWidthL-newLeafEdgeWidthL-10
1278     //          and width=newWidthL+newWidthR+twoPage.edgeWidth+20
1279     //      - move new left leaf (newIndexL) forward to zindex=2 so it can receive clicks.
1280     //      - remove old left and right leafs from the dom [pruneUnusedImgs()].
1281     //      - prefetch new adjacent leafs.
1282     //      - set up click handlers for both new left and right leafs.
1283     //      - redraw the search highlight.
1284     //      - update the pagenum box and the url.
1285
1286
1287     var leftEdgeTmpLeft = gutter - currWidthL - leafEdgeTmpW;
1288
1289     this.leafEdgeTmp = document.createElement('div');
1290     $(this.leafEdgeTmp).css({
1291         borderStyle: 'solid none solid solid',
1292         borderColor: 'rgb(51, 51, 34)',
1293         borderWidth: '1px 0px 1px 1px',
1294         background: 'transparent url(' + this.imagesBaseURL + 'left_edges.png) repeat scroll 0% 0%',
1295         width: leafEdgeTmpW + 'px',
1296         height: this.twoPage.height-1 + 'px',
1297         left: leftEdgeTmpLeft + 'px',
1298         top: top+'px',
1299         position: 'absolute',
1300         zIndex:1000
1301     }).appendTo('#GBtwopageview');
1302
1303     //$(this.leafEdgeL).css('width', newLeafEdgeWidthL+'px');
1304     $(this.leafEdgeL).css({
1305         width: newLeafEdgeWidthL+'px',
1306         left: gutter-currWidthL-newLeafEdgeWidthL+'px'
1307     });
1308
1309     // Left gets the offset of the current left leaf from the document
1310     var left = $(this.prefetchedImgs[leftLeaf]).offset().left;
1311     // $$$ This seems very similar to the gutter.  May be able to consolidate the logic.
1312     // XXX need to recalc
1313     var right = $('#GBtwopageview').attr('clientWidth')-left-$(this.prefetchedImgs[leftLeaf]).width()+$('#GBtwopageview').offset().left-2+'px';
1314     // We change the left leaf to right positioning
1315     $(this.prefetchedImgs[leftLeaf]).css({
1316         right: right,
1317         left: ''
1318     });
1319
1320      left = $(this.prefetchedImgs[leftLeaf]).offset().left - $('#book_div_1').offset().left;
1321
1322      right = left+$(this.prefetchedImgs[leftLeaf]).width()+'px';
1323
1324     $(this.leafEdgeTmp).animate({left: gutter}, this.flipSpeed, 'easeInSine');
1325     //$(this.prefetchedImgs[leftLeaf]).animate({width: '0px'}, 'slow', 'easeInSine');
1326
1327     var self = this;
1328
1329     this.removeSearchHilites();
1330
1331     //console.log('animating leafLeaf ' + leftLeaf + ' to 0px');
1332     $(this.prefetchedImgs[leftLeaf]).animate({width: '0px'}, self.flipSpeed, 'easeInSine', function() {
1333
1334         //console.log('     and now leafEdgeTmp to left: gutter+newWidthR ' + (gutter + newWidthR));
1335         $(self.leafEdgeTmp).animate({left: gutter+newWidthR+'px'}, self.flipSpeed, 'easeOutSine');
1336
1337         //console.log('  animating newIndexR ' + newIndexR + ' to ' + newWidthR + ' from ' + $(self.prefetchedImgs[newIndexR]).width());
1338         $(self.prefetchedImgs[newIndexR]).animate({width: newWidthR+'px'}, self.flipSpeed, 'easeOutSine', function() {
1339             $(self.prefetchedImgs[newIndexL]).css('zIndex', 2);
1340
1341             $(self.leafEdgeR).css({
1342                 // Moves the right leaf edge
1343                 width: self.twoPage.edgeWidth-newLeafEdgeWidthL+'px',
1344                 left:  gutter+newWidthR+'px'
1345             });
1346
1347             $(self.leafEdgeL).css({
1348                 // Moves and resizes the left leaf edge
1349                 width: newLeafEdgeWidthL+'px',
1350                 left:  gutter-newWidthL-newLeafEdgeWidthL+'px'
1351             });
1352
1353
1354             $(self.twoPageDiv).css({
1355                 // Resizes the brown border div
1356                 width: newWidthL+newWidthR+self.twoPage.edgeWidth+20+'px',
1357                 left: gutter-newWidthL-newLeafEdgeWidthL-10+'px'
1358             });
1359
1360             $(self.leafEdgeTmp).remove();
1361             self.leafEdgeTmp = null;
1362
1363             self.twoPage.currentIndexL = newIndexL;
1364             self.twoPage.currentIndexR = newIndexR;
1365             self.firstIndex = self.twoPage.currentIndexL;
1366             self.displayedIndices = [newIndexL, newIndexR];
1367             self.setClickHandlers();
1368             self.pruneUnusedImgs();
1369             self.prefetch();
1370             self.animating = false;
1371
1372             self.updateSearchHilites2UP();
1373             self.updatePageNumBox2UP();
1374
1375             if (self.animationFinishedCallback) {
1376                 self.animationFinishedCallback();
1377                 self.animationFinishedCallback = null;
1378             }
1379         });
1380     });
1381
1382 }
1383
1384 // flipFwdToIndex()
1385 //______________________________________________________________________________
1386 // Whether we flip left or right is dependent on the page progression
1387 // to flip forward one spread, pass index=null
1388 GnuBook.prototype.flipFwdToIndex = function(index) {
1389
1390     if (this.animating) return;
1391
1392     if (null != this.leafEdgeTmp) {
1393         alert('error: leafEdgeTmp should be null!');
1394         return;
1395     }
1396
1397     if (null == index) {
1398         index = this.twoPage.currentIndexR+2; // $$$ assumes indices are continuous
1399     }
1400     if (index > this.lastDisplayableIndex()) return;
1401
1402     this.animating = true;
1403
1404     var nextIndices = this.getSpreadIndices(index);
1405
1406     //console.log('flipfwd to indices ' + nextIndices[0] + ',' + nextIndices[1]);
1407
1408     if ('rl' != this.pageProgression) {
1409         // We did not specify RTL
1410         var gutter = this.prepareFlipRightToLeft(nextIndices[0], nextIndices[1]);
1411         this.flipRightToLeft(nextIndices[0], nextIndices[1], gutter);
1412     } else {
1413         // RTL
1414         var gutter = this.prepareFlipLeftToRight(nextIndices[0], nextIndices[1]);
1415         this.flipLeftToRight(nextIndices[0], nextIndices[1], gutter);
1416     }
1417 }
1418
1419 // flipRightToLeft(nextL, nextR, gutter)
1420 // $$$ better not to have to pass gutter in
1421 //______________________________________________________________________________
1422 // Flip from left to right and show the nextL and nextR indices on those sides
1423 GnuBook.prototype.flipRightToLeft = function(newIndexL, newIndexR, gutter) {
1424     var oldLeafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
1425     var oldLeafEdgeWidthR = this.twoPage.edgeWidth-oldLeafEdgeWidthL;
1426     var newLeafEdgeWidthL = this.leafEdgeWidth(newIndexL);
1427     var newLeafEdgeWidthR = this.twoPage.edgeWidth-newLeafEdgeWidthL;
1428
1429     var leafEdgeTmpW = oldLeafEdgeWidthR - newLeafEdgeWidthR;
1430
1431     var top  = ($('#GBtwopageview').height() - this.twoPage.height) >> 1;
1432
1433     var scaledW = this.getPageWidth2UP(this.twoPage.currentIndexR);
1434
1435     var middle     = ($('#GBtwopageview').attr('clientWidth') >> 1);
1436     var currGutter = middle + this.gutterOffsetForIndex(this.twoPage.currentIndexL);
1437
1438     // XXX
1439     console.log('R->L middle(' + middle +') currGutter(' + currGutter + ') gutter(' + gutter + ')');
1440
1441     this.leafEdgeTmp = document.createElement('div');
1442     $(this.leafEdgeTmp).css({
1443         borderStyle: 'solid none solid solid',
1444         borderColor: 'rgb(51, 51, 34)',
1445         borderWidth: '1px 0px 1px 1px',
1446         background: 'transparent url(' + this.imagesBaseURL + 'left_edges.png) repeat scroll 0% 0%',
1447         width: leafEdgeTmpW + 'px',
1448         height: this.twoPage.height-1 + 'px',
1449         left: currGutter+scaledW+'px',
1450         top: top+'px',
1451         position: 'absolute',
1452         zIndex:1000
1453     }).appendTo('#GBtwopageview');
1454
1455     //var scaledWR = this.getPageWidth2UP(newIndexR); // $$$ should be current instead?
1456     //var scaledWL = this.getPageWidth2UP(newIndexL); // $$$ should be current instead?
1457
1458     var currWidthL = this.getPageWidth2UP(this.twoPage.currentIndexL);
1459     var currWidthR = this.getPageWidth2UP(this.twoPage.currentIndexR);
1460     var newWidthL = this.getPageWidth2UP(newIndexL);
1461     var newWidthR = this.getPageWidth2UP(newIndexR);
1462
1463     $(this.leafEdgeR).css({width: newLeafEdgeWidthR+'px', left: gutter+newWidthR+'px' });
1464
1465     var self = this; // closure-tastic!
1466
1467     var speed = this.flipSpeed;
1468
1469     this.removeSearchHilites();
1470
1471     $(this.leafEdgeTmp).animate({left: gutter}, speed, 'easeInSine');
1472     $(this.prefetchedImgs[this.twoPage.currentIndexR]).animate({width: '0px'}, speed, 'easeInSine', function() {
1473         $(self.leafEdgeTmp).animate({left: gutter-newWidthL-leafEdgeTmpW+'px'}, speed, 'easeOutSine');
1474         $(self.prefetchedImgs[newIndexL]).animate({width: newWidthL+'px'}, speed, 'easeOutSine', function() {
1475             $(self.prefetchedImgs[newIndexR]).css('zIndex', 2);
1476
1477             $(self.leafEdgeL).css({
1478                 width: newLeafEdgeWidthL+'px',
1479                 left: gutter-newWidthL-newLeafEdgeWidthL+'px'
1480             });
1481
1482             $(self.twoPageDiv).css({
1483                 width: newWidthL+newWidthR+self.twoPage.edgeWidth+20+'px',
1484                 left: gutter-newWidthL-newLeafEdgeWidthL-10+'px'
1485             });
1486
1487             $(self.leafEdgeTmp).remove();
1488             self.leafEdgeTmp = null;
1489
1490             self.twoPage.currentIndexL = newIndexL;
1491             self.twoPage.currentIndexR = newIndexR;
1492             self.firstIndex = self.twoPage.currentIndexL;
1493             self.displayedIndices = [newIndexL, newIndexR];
1494             self.setClickHandlers();
1495             self.pruneUnusedImgs();
1496             self.prefetch();
1497             self.animating = false;
1498
1499
1500             self.updateSearchHilites2UP();
1501             self.updatePageNumBox2UP();
1502
1503             if (self.animationFinishedCallback) {
1504                 self.animationFinishedCallback();
1505                 self.animationFinishedCallback = null;
1506             }
1507         });
1508     });
1509 }
1510
1511 // setClickHandlers
1512 //______________________________________________________________________________
1513 GnuBook.prototype.setClickHandlers = function() {
1514     var self = this;
1515     // $$$ TODO don't set again if already set
1516     $(this.prefetchedImgs[this.twoPage.currentIndexL]).click(function() {
1517         //self.prevPage();
1518         self.autoStop();
1519         self.left();
1520     });
1521     $(this.prefetchedImgs[this.twoPage.currentIndexR]).click(function() {
1522         //self.nextPage();'
1523         self.autoStop();
1524         self.right();
1525     });
1526 }
1527
1528 // prefetchImg()
1529 //______________________________________________________________________________
1530 GnuBook.prototype.prefetchImg = function(index) {
1531     if (undefined == this.prefetchedImgs[index]) {
1532         //console.log('prefetching ' + index);
1533         var img = document.createElement("img");
1534         img.src = this.getPageURI(index);
1535         this.prefetchedImgs[index] = img;
1536     }
1537 }
1538
1539
1540 // prepareFlipLeftToRight()
1541 //
1542 //______________________________________________________________________________
1543 //
1544 // Prepare to flip the left page towards the right.  This corresponds to moving
1545 // backward when the page progression is left to right.
1546 GnuBook.prototype.prepareFlipLeftToRight = function(prevL, prevR) {
1547
1548     //console.log('  preparing left->right for ' + prevL + ',' + prevR);
1549
1550     this.prefetchImg(prevL);
1551     this.prefetchImg(prevR);
1552
1553     var height  = this.getPageHeight(prevL);
1554     var width   = this.getPageWidth(prevL);
1555     var middle = ($('#GBtwopageview').attr('clientWidth') >> 1);
1556     var top  = ($('#GBtwopageview').height() - this.twoPage.height) >> 1;
1557     var scaledW = this.twoPage.height*width/height;
1558
1559     // The gutter is the dividing line between the left and right pages.
1560     // It is offset from the middle to create the illusion of thickness to the pages
1561     var gutter = middle + this.gutterOffsetForIndex(prevL);
1562
1563     // XXX
1564     console.log('    gutter for ' + prevL + ' is ' + gutter);
1565     //console.log('    prevL.left: ' + (gutter - scaledW) + 'px');
1566     //console.log('    changing prevL ' + prevL + ' to left: ' + (gutter-scaledW) + ' width: ' + scaledW);
1567
1568     $(this.prefetchedImgs[prevL]).css({
1569         position: 'absolute',
1570         /*right:   middle+'px',*/
1571         left: gutter-scaledW+'px',
1572         right: '',
1573         top:    top+'px',
1574         backgroundColor: 'rgb(234, 226, 205)',
1575         height: this.twoPage.height,
1576         width:  scaledW+'px',
1577         borderRight: '1px solid black',
1578         zIndex: 1
1579     });
1580
1581     $('#GBtwopageview').append(this.prefetchedImgs[prevL]);
1582
1583     //console.log('    changing prevR ' + prevR + ' to left: ' + gutter + ' width: 0');
1584
1585     $(this.prefetchedImgs[prevR]).css({
1586         position: 'absolute',
1587         left:   gutter+'px',
1588         right: '',
1589         top:    top+'px',
1590         backgroundColor: 'rgb(234, 226, 205)',
1591         height: this.twoPage.height,
1592         width:  '0px',
1593         borderLeft: '1px solid black',
1594         zIndex: 2
1595     });
1596
1597     $('#GBtwopageview').append(this.prefetchedImgs[prevR]);
1598
1599
1600     return gutter;
1601
1602 }
1603
1604 // XXXmang we're adding an extra pixel in the middle
1605 // prepareFlipRightToLeft()
1606 //______________________________________________________________________________
1607 GnuBook.prototype.prepareFlipRightToLeft = function(nextL, nextR) {
1608
1609     //console.log('  preparing left<-right for ' + nextL + ',' + nextR);
1610
1611     this.prefetchImg(nextL);
1612     this.prefetchImg(nextR);
1613
1614     var height  = this.getPageHeight(nextR);
1615     var width   = this.getPageWidth(nextR);
1616     var middle = ($('#GBtwopageview').attr('clientWidth') >> 1);
1617     var top  = ($('#GBtwopageview').height() - this.twoPage.height) >> 1;
1618     var scaledW = this.twoPage.height*width/height;
1619
1620     var gutter = middle + this.gutterOffsetForIndex(nextL);
1621
1622     console.log('right to left to %d gutter is %d', nextL, gutter); // XXX
1623
1624     //console.log(' prepareRTL changing nextR ' + nextR + ' to left: ' + gutter);
1625     $(this.prefetchedImgs[nextR]).css({
1626         position: 'absolute',
1627         left:   gutter+'px',
1628         top:    top+'px',
1629         backgroundColor: 'rgb(234, 226, 205)',
1630         height: this.twoPage.height,
1631         width:  scaledW+'px',
1632         borderLeft: '1px solid black',
1633         zIndex: 1
1634     });
1635
1636     $('#GBtwopageview').append(this.prefetchedImgs[nextR]);
1637
1638     height  = this.getPageHeight(nextL);
1639     width   = this.getPageWidth(nextL);
1640     scaledW = this.twoPage.height*width/height;
1641
1642     //console.log(' prepareRTL changing nextL ' + nextL + ' to right: ' + $('#GBcontainer').width()-gutter);
1643     $(this.prefetchedImgs[nextL]).css({
1644         position: 'absolute',
1645         right:   $('#GBtwopageview').attr('clientWidth')-gutter+'px',
1646         top:    top+'px',
1647         backgroundColor: 'rgb(234, 226, 205)',
1648         height: this.twoPage.height,
1649         width:  0+'px',
1650         borderRight: '1px solid black',
1651         zIndex: 2
1652     });
1653
1654     $('#GBtwopageview').append(this.prefetchedImgs[nextL]);
1655
1656     return gutter;
1657
1658 }
1659
1660 // getNextLeafs() -- NOT RTL AWARE
1661 //______________________________________________________________________________
1662 // GnuBook.prototype.getNextLeafs = function(o) {
1663 //     //TODO: we might have two left or two right leafs in a row (damaged book)
1664 //     //For now, assume that leafs are contiguous.
1665 //
1666 //     //return [this.twoPage.currentIndexL+2, this.twoPage.currentIndexL+3];
1667 //     o.L = this.twoPage.currentIndexL+2;
1668 //     o.R = this.twoPage.currentIndexL+3;
1669 // }
1670
1671 // getprevLeafs() -- NOT RTL AWARE
1672 //______________________________________________________________________________
1673 // GnuBook.prototype.getPrevLeafs = function(o) {
1674 //     //TODO: we might have two left or two right leafs in a row (damaged book)
1675 //     //For now, assume that leafs are contiguous.
1676 //
1677 //     //return [this.twoPage.currentIndexL-2, this.twoPage.currentIndexL-1];
1678 //     o.L = this.twoPage.currentIndexL-2;
1679 //     o.R = this.twoPage.currentIndexL-1;
1680 // }
1681
1682 // pruneUnusedImgs()
1683 //______________________________________________________________________________
1684 GnuBook.prototype.pruneUnusedImgs = function() {
1685     //console.log('current: ' + this.twoPage.currentIndexL + ' ' + this.twoPage.currentIndexR);
1686     for (var key in this.prefetchedImgs) {
1687         //console.log('key is ' + key);
1688         if ((key != this.twoPage.currentIndexL) && (key != this.twoPage.currentIndexR)) {
1689             //console.log('removing key '+ key);
1690             $(this.prefetchedImgs[key]).remove();
1691         }
1692         if ((key < this.twoPage.currentIndexL-4) || (key > this.twoPage.currentIndexR+4)) {
1693             //console.log('deleting key '+ key);
1694             delete this.prefetchedImgs[key];
1695         }
1696     }
1697 }
1698
1699 // prefetch()
1700 //______________________________________________________________________________
1701 GnuBook.prototype.prefetch = function() {
1702
1703     var lim = this.twoPage.currentIndexL-4;
1704     var i;
1705     lim = Math.max(lim, 0);
1706     for (i = lim; i < this.twoPage.currentIndexL; i++) {
1707         this.prefetchImg(i);
1708     }
1709
1710     if (this.numLeafs > (this.twoPage.currentIndexR+1)) {
1711         lim = Math.min(this.twoPage.currentIndexR+4, this.numLeafs-1);
1712         for (i=this.twoPage.currentIndexR+1; i<=lim; i++) {
1713             this.prefetchImg(i);
1714         }
1715     }
1716 }
1717
1718 // getPageWidth2UP()
1719 //______________________________________________________________________________
1720 GnuBook.prototype.getPageWidth2UP = function(index) {
1721     // We return the width based on the dominant height
1722     var height  = this.getPageHeight(index);
1723     var width   = this.getPageWidth(index);
1724     return Math.floor(this.twoPage.height*width/height); // $$$ we assume width is relative to current spread
1725 }
1726
1727 // search()
1728 //______________________________________________________________________________
1729 GnuBook.prototype.search = function(term) {
1730     $('#GnuBookSearchScript').remove();
1731         var script  = document.createElement("script");
1732         script.setAttribute('id', 'GnuBookSearchScript');
1733         script.setAttribute("type", "text/javascript");
1734         script.setAttribute("src", 'http://'+this.server+'/GnuBook/flipbook_search_gb.php?url='+escape(this.bookPath + '_djvu.xml')+'&term='+term+'&format=XML&callback=gb.GBSearchCallback');
1735         document.getElementsByTagName('head')[0].appendChild(script);
1736         $('#GnuBookSearchResults').html('Searching...');
1737 }
1738
1739 // GBSearchCallback()
1740 //______________________________________________________________________________
1741 GnuBook.prototype.GBSearchCallback = function(txt) {
1742     //alert(txt);
1743     if (jQuery.browser.msie) {
1744         var dom=new ActiveXObject("Microsoft.XMLDOM");
1745         dom.async="false";
1746         dom.loadXML(txt);
1747     } else {
1748         var parser = new DOMParser();
1749         var dom = parser.parseFromString(txt, "text/xml");
1750     }
1751
1752     $('#GnuBookSearchResults').empty();
1753     $('#GnuBookSearchResults').append('<ul>');
1754
1755     for (var key in this.searchResults) {
1756         if (null != this.searchResults[key].div) {
1757             $(this.searchResults[key].div).remove();
1758         }
1759         delete this.searchResults[key];
1760     }
1761
1762     var pages = dom.getElementsByTagName('PAGE');
1763
1764     if (0 == pages.length) {
1765         // $$$ it would be nice to echo the (sanitized) search result here
1766         $('#GnuBookSearchResults').append('<li>No search results found</li>');
1767     } else {
1768         for (var i = 0; i < pages.length; i++){
1769             //console.log(pages[i].getAttribute('file').substr(1) +'-'+ parseInt(pages[i].getAttribute('file').substr(1), 10));
1770
1771
1772             var re = new RegExp (/_(\d{4})/);
1773             var reMatch = re.exec(pages[i].getAttribute('file'));
1774             var index = parseInt(reMatch[1], 10);
1775             //var index = parseInt(pages[i].getAttribute('file').substr(1), 10);
1776
1777             var children = pages[i].childNodes;
1778             var context = '';
1779             for (var j=0; j<children.length; j++) {
1780                 //console.log(j + ' - ' + children[j].nodeName);
1781                 //console.log(children[j].firstChild.nodeValue);
1782                 if ('CONTEXT' == children[j].nodeName) {
1783                     context += children[j].firstChild.nodeValue;
1784                 } else if ('WORD' == children[j].nodeName) {
1785                     context += '<b>'+children[j].firstChild.nodeValue+'</b>';
1786
1787                     var index = this.leafNumToIndex(index);
1788                     if (null != index) {
1789                         //coordinates are [left, bottom, right, top, [baseline]]
1790                         //we'll skip baseline for now...
1791                         var coords = children[j].getAttribute('coords').split(',',4);
1792                         if (4 == coords.length) {
1793                             this.searchResults[index] = {'l':coords[0], 'b':coords[1], 'r':coords[2], 't':coords[3], 'div':null};
1794                         }
1795                     }
1796                 }
1797             }
1798             var pageName = this.getPageName(index);
1799             //TODO: remove hardcoded instance name
1800             $('#GnuBookSearchResults').append('<li><b><a href="javascript:gb.jumpToIndex('+index+');">' + pageName + '</a></b> - ' + context + '</li>');
1801         }
1802     }
1803     $('#GnuBookSearchResults').append('</ul>');
1804
1805     this.updateSearchHilites();
1806 }
1807
1808 // updateSearchHilites()
1809 //______________________________________________________________________________
1810 GnuBook.prototype.updateSearchHilites = function() {
1811     if (2 == this.mode) {
1812         this.updateSearchHilites2UP();
1813     } else {
1814         this.updateSearchHilites1UP();
1815     }
1816 }
1817
1818 // showSearchHilites1UP()
1819 //______________________________________________________________________________
1820 GnuBook.prototype.updateSearchHilites1UP = function() {
1821
1822     for (var key in this.searchResults) {
1823
1824         if (-1 != jQuery.inArray(parseInt(key), this.displayedIndices)) {
1825             var result = this.searchResults[key];
1826             if(null == result.div) {
1827                 result.div = document.createElement('div');
1828                 $(result.div).attr('className', 'GnuBookSearchHilite').appendTo('#pagediv'+key);
1829                 //console.log('appending ' + key);
1830             }
1831             $(result.div).css({
1832                 width:  (result.r-result.l)/this.reduce + 'px',
1833                 height: (result.b-result.t)/this.reduce + 'px',
1834                 left:   (result.l)/this.reduce + 'px',
1835                 top:    (result.t)/this.reduce +'px'
1836             });
1837
1838         } else {
1839             //console.log(key + ' not displayed');
1840             this.searchResults[key].div=null;
1841         }
1842     }
1843 }
1844
1845 // XXX move, clean up, use everywhere
1846 GnuBook.prototype.twoPageGutter = function() {
1847     var middle = ($('#GBtwopageview').width() >> 1);
1848     return middle + this.gutterOffsetForIndex(this.twoPage.currentIndexL);
1849 }
1850
1851 // XXX move, clean up, use everywhere
1852 GnuBook.prototype.twoPageTop = function() {
1853     return this.twoPage.coverExternalPadding + this.twoPage.coverInternalPadding; // $$$ + border?
1854 }
1855
1856 // showSearchHilites2UP()
1857 //______________________________________________________________________________
1858 GnuBook.prototype.updateSearchHilites2UP = function() {
1859
1860     for (var key in this.searchResults) {
1861         key = parseInt(key, 10);
1862         if (-1 != jQuery.inArray(key, this.displayedIndices)) {
1863             var result = this.searchResults[key];
1864             if(null == result.div) {
1865                 result.div = document.createElement('div');
1866                 $(result.div).attr('className', 'GnuBookSearchHilite').css('zIndex', 3).appendTo('#GBtwopageview');
1867                 //console.log('appending ' + key);
1868             }
1869
1870             // We calculate the reduction factor for the specific page because it can be different
1871             // for each page in the spread
1872             var height = this.getPageHeight(key);
1873             var width  = this.getPageWidth(key)
1874             var reduce = this.twoPage.height/height;
1875             var scaledW = parseInt(width*reduce);
1876
1877             var gutter = this.twoPageGutter();
1878             var pageL;
1879             if ('L' == this.getPageSide(key)) {
1880                 pageL = gutter-scaledW;
1881             } else {
1882                 pageL = gutter;
1883             }
1884             var pageT  = this.twoPageTop();
1885
1886             $(result.div).css({
1887                 width:  (result.r-result.l)*reduce + 'px',
1888                 height: (result.b-result.t)*reduce + 'px',
1889                 left:   pageL+(result.l)*reduce + 'px',
1890                 top:    pageT+(result.t)*reduce +'px'
1891             });
1892
1893         } else {
1894             //console.log(key + ' not displayed');
1895             if (null != this.searchResults[key].div) {
1896                 //console.log('removing ' + key);
1897                 $(this.searchResults[key].div).remove();
1898             }
1899             this.searchResults[key].div=null;
1900         }
1901     }
1902 }
1903
1904 // removeSearchHilites()
1905 //______________________________________________________________________________
1906 GnuBook.prototype.removeSearchHilites = function() {
1907     for (var key in this.searchResults) {
1908         if (null != this.searchResults[key].div) {
1909             $(this.searchResults[key].div).remove();
1910             this.searchResults[key].div=null;
1911         }
1912     }
1913 }
1914
1915 // showEmbedCode()
1916 //______________________________________________________________________________
1917 GnuBook.prototype.showEmbedCode = function() {
1918     if (null != this.embedPopup) { // check if already showing
1919         return;
1920     }
1921     this.autoStop();
1922     this.embedPopup = document.createElement("div");
1923     $(this.embedPopup).css({
1924         position: 'absolute',
1925         top:      '20px',
1926         left:     ($('#GBcontainer').attr('clientWidth')-400)/2 + 'px',
1927         width:    '400px',
1928         padding:  "20px",
1929         border:   "3px double #999999",
1930         zIndex:   3,
1931         backgroundColor: "#fff"
1932     }).appendTo('#GnuBook');
1933
1934     htmlStr =  '<p style="text-align:center;"><b>Embed Bookreader in your blog!</b></p>';
1935     htmlStr += '<p>The bookreader uses iframes for embedding. It will not work on web hosts that block iframes. The embed feature has been tested on blogspot.com blogs as well as self-hosted Wordpress blogs. This feature will NOT work on wordpress.com blogs.</p>';
1936     htmlStr += '<p>Embed Code: <input type="text" size="40" value="' + this.getEmbedCode() + '"></p>';
1937     htmlStr += '<p style="text-align:center;"><a href="" onclick="gb.embedPopup = null; $(this.parentNode.parentNode).remove(); return false">Close popup</a></p>';
1938
1939     this.embedPopup.innerHTML = htmlStr;
1940     $(this.embedPopup).find('input').bind('click', function() {
1941         this.select();
1942     })
1943 }
1944
1945 // autoToggle()
1946 //______________________________________________________________________________
1947 GnuBook.prototype.autoToggle = function() {
1948
1949     var bComingFrom1up = false;
1950     if (2 != this.mode) {
1951         bComingFrom1up = true;
1952         this.switchMode(2);
1953     }
1954
1955     var self = this;
1956     if (null == this.autoTimer) {
1957         this.flipSpeed = 2000;
1958
1959         // $$$ Draw events currently cause layout problems when they occur during animation.
1960         //     There is a specific problem when changing from 1-up immediately to autoplay in RTL so
1961         //     we workaround for now by not triggering immediate animation in that case.
1962         //     See https://bugs.launchpad.net/gnubook/+bug/328327
1963         if (('rl' == this.pageProgression) && bComingFrom1up) {
1964             // don't flip immediately -- wait until timer fires
1965         } else {
1966             // flip immediately
1967             this.flipFwdToIndex();
1968         }
1969
1970         $('#GBtoolbar .play').hide();
1971         $('#GBtoolbar .pause').show();
1972         this.autoTimer=setInterval(function(){
1973             if (self.animating) {return;}
1974
1975             if (Math.max(self.twoPage.currentIndexL, self.twoPage.currentIndexR) >= self.lastDisplayableIndex()) {
1976                 self.flipBackToIndex(1); // $$$ really what we want?
1977             } else {
1978                 self.flipFwdToIndex();
1979             }
1980         },5000);
1981     } else {
1982         this.autoStop();
1983     }
1984 }
1985
1986 // autoStop()
1987 //______________________________________________________________________________
1988 GnuBook.prototype.autoStop = function() {
1989     if (null != this.autoTimer) {
1990         clearInterval(this.autoTimer);
1991         this.flipSpeed = 'fast';
1992         $('#GBtoolbar .pause').hide();
1993         $('#GBtoolbar .play').show();
1994         this.autoTimer = null;
1995     }
1996 }
1997
1998 // keyboardNavigationIsDisabled(event)
1999 //   - returns true if keyboard navigation should be disabled for the event
2000 //______________________________________________________________________________
2001 GnuBook.prototype.keyboardNavigationIsDisabled = function(event) {
2002     if (event.target.tagName == "INPUT") {
2003         return true;
2004     }
2005     return false;
2006 }
2007
2008 // gutterOffsetForIndex
2009 //______________________________________________________________________________
2010 //
2011 // Returns the gutter offset for the spread containing the given index.
2012 // This function supports RTL
2013 GnuBook.prototype.gutterOffsetForIndex = function(pindex) {
2014
2015     // To find the offset of the gutter from the middle we calculate our percentage distance
2016     // through the book (0..1), remap to (-0.5..0.5) and multiply by the total page edge width
2017     var offset = parseInt(((pindex / this.numLeafs) - 0.5) * this.twoPage.edgeWidth);
2018
2019     // But then again for RTL it's the opposite
2020     if ('rl' == this.pageProgression) {
2021         offset = -offset;
2022     }
2023
2024     return offset;
2025 }
2026
2027 // leafEdgeWidth
2028 //______________________________________________________________________________
2029 // Returns the width of the leaf edge div for the page with index given
2030 GnuBook.prototype.leafEdgeWidth = function(pindex) {
2031     // $$$ could there be single pixel rounding errors for L vs R?
2032     if ((this.getPageSide(pindex) == 'L') && (this.pageProgression != 'rl')) {
2033         return parseInt( (pindex/this.numLeafs) * this.twoPage.edgeWidth + 0.5);
2034     } else {
2035         return parseInt( (1 - pindex/this.numLeafs) * this.twoPage.edgeWidth + 0.5);
2036     }
2037 }
2038
2039 // jumpIndexForLeftEdgePageX
2040 //______________________________________________________________________________
2041 // Returns the target jump leaf given a page coordinate (inside the left page edge div)
2042 GnuBook.prototype.jumpIndexForLeftEdgePageX = function(pageX) {
2043     if ('rl' != this.pageProgression) {
2044         // LTR - flipping backward
2045         var jumpIndex = this.twoPage.currentIndexL - ($(this.leafEdgeL).offset().left + $(this.leafEdgeL).width() - pageX) * 10;
2046
2047         // browser may have resized the div due to font size change -- see https://bugs.launchpad.net/gnubook/+bug/333570
2048         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.firstDisplayableIndex(), this.twoPage.currentIndexL - 2);
2049         return jumpIndex;
2050
2051     } else {
2052         var jumpIndex = this.twoPage.currentIndexL + ($(this.leafEdgeL).offset().left + $(this.leafEdgeL).width() - pageX) * 10;
2053         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.twoPage.currentIndexL + 2, this.lastDisplayableIndex());
2054         return jumpIndex;
2055     }
2056 }
2057
2058 // jumpIndexForRightEdgePageX
2059 //______________________________________________________________________________
2060 // Returns the target jump leaf given a page coordinate (inside the right page edge div)
2061 GnuBook.prototype.jumpIndexForRightEdgePageX = function(pageX) {
2062     if ('rl' != this.pageProgression) {
2063         // LTR
2064         var jumpIndex = this.twoPage.currentIndexR + (pageX - $(this.leafEdgeR).offset().left) * 10;
2065         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.twoPage.currentIndexR + 2, this.lastDisplayableIndex());
2066         return jumpIndex;
2067     } else {
2068         var jumpIndex = this.twoPage.currentIndexR - (pageX - $(this.leafEdgeR).offset().left) * 10;
2069         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.firstDisplayableIndex(), this.twoPage.currentIndexR - 2);
2070         return jumpIndex;
2071     }
2072 }
2073
2074 GnuBook.prototype.initToolbar = function(mode, ui) {
2075
2076     $("#GnuBook").append("<div id='GBtoolbar'><span style='float:left;'>"
2077         + "<a class='GBicon logo rollover' href='" + this.logoURL + "'>&nbsp;</a>"
2078         + " <button class='GBicon rollover zoom_out' onclick='gb.zoom(-1); return false;'/>"
2079         + "<button class='GBicon rollover zoom_in' onclick='gb.zoom(1); return false;'/>"
2080         + " <span class='label'>Zoom: <span id='GBzoom'>"+parseInt(100/this.reduce)+"</span>%</span>"
2081         + " <button class='GBicon rollover one_page_mode' onclick='gb.switchMode(1); return false;'/>"
2082         + " <button class='GBicon rollover two_page_mode' onclick='gb.switchMode(2); return false;'/>"
2083         + "&nbsp;&nbsp;<a class='GBblack title' href='"+this.bookUrl+"' target='_blank'>"+this.shortTitle(50)+"</a>"
2084         + "</span></div>");
2085
2086     if (ui == "embed") {
2087         $("#GnuBook a.logo").attr("target","_blank");
2088     }
2089
2090     // $$$ turn this into a member variable
2091     var jToolbar = $('#GBtoolbar'); // j prefix indicates jQuery object
2092
2093     // We build in mode 2
2094     jToolbar.append("<span id='GBtoolbarbuttons' style='float: right'>"
2095         + "<button class='GBicon rollover embed' />"
2096         + "<form class='GBpageform' action='javascript:' onsubmit='gb.jumpToPage(this.elements[0].value)'> <span class='label'>Page:<input id='GBpagenum' type='text' size='3' onfocus='gb.autoStop();'></input></span></form>"
2097         + "<div class='GBtoolbarmode2' style='display: none'><button class='GBicon rollover book_leftmost' /><button class='GBicon rollover book_left' /><button class='GBicon rollover book_right' /><button class='GBicon rollover book_rightmost' /></div>"
2098         + "<div class='GBtoolbarmode1' style='display: none'><button class='GBicon rollover book_top' /><button class='GBicon rollover book_up' /> <button class='GBicon rollover book_down' /><button class='GBicon rollover book_bottom' /></div>"
2099         + "<button class='GBicon rollover play' /><button class='GBicon rollover pause' style='display: none' /></span>");
2100
2101     this.bindToolbarNavHandlers(jToolbar);
2102
2103     // Setup tooltips -- later we could load these from a file for i18n
2104     var titles = { '.logo': 'Go to Archive.org',
2105                    '.zoom_in': 'Zoom in',
2106                    '.zoom_out': 'Zoom out',
2107                    '.one_page_mode': 'One-page view',
2108                    '.two_page_mode': 'Two-page view',
2109                    '.embed': 'Embed bookreader',
2110                    '.book_left': 'Flip left',
2111                    '.book_right': 'Flip right',
2112                    '.book_up': 'Page up',
2113                    '.book_down': 'Page down',
2114                    '.play': 'Play',
2115                    '.pause': 'Pause',
2116                    '.book_top': 'First page',
2117                    '.book_bottom': 'Last page'
2118                   };
2119     if ('rl' == this.pageProgression) {
2120         titles['.book_leftmost'] = 'Last page';
2121         titles['.book_rightmost'] = 'First page';
2122     } else { // LTR
2123         titles['.book_leftmost'] = 'First page';
2124         titles['.book_rightmost'] = 'Last page';
2125     }
2126
2127     for (var icon in titles) {
2128         jToolbar.find(icon).attr('title', titles[icon]);
2129     }
2130
2131     // Hide mode buttons and autoplay if 2up is not available
2132     // $$$ if we end up with more than two modes we should show the applicable buttons
2133     if ( !this.canSwitchToMode(this.constMode2up) ) {
2134         jToolbar.find('.one_page_mode, .two_page_mode, .play, .pause').hide();
2135     }
2136
2137     // Switch to requested mode -- binds other click handlers
2138     this.switchToolbarMode(mode);
2139
2140 }
2141
2142
2143 // switchToolbarMode
2144 //______________________________________________________________________________
2145 // Update the toolbar for the given mode (changes navigation buttons)
2146 // $$$ we should soon split the toolbar out into its own module
2147 GnuBook.prototype.switchToolbarMode = function(mode) {
2148     if (1 == mode) {
2149         // 1-up
2150         $('#GBtoolbar .GBtoolbarmode2').hide();
2151         $('#GBtoolbar .GBtoolbarmode1').show().css('display', 'inline');
2152     } else {
2153         // 2-up
2154         $('#GBtoolbar .GBtoolbarmode1').hide();
2155         $('#GBtoolbar .GBtoolbarmode2').show().css('display', 'inline');
2156     }
2157 }
2158
2159 // bindToolbarNavHandlers
2160 //______________________________________________________________________________
2161 // Binds the toolbar handlers
2162 GnuBook.prototype.bindToolbarNavHandlers = function(jToolbar) {
2163
2164     jToolbar.find('.book_left').bind('click', function(e) {
2165         gb.left();
2166         return false;
2167     });
2168
2169     jToolbar.find('.book_right').bind('click', function(e) {
2170         gb.right();
2171         return false;
2172     });
2173
2174     jToolbar.find('.book_up').bind('click', function(e) {
2175         gb.prev();
2176         return false;
2177     });
2178
2179     jToolbar.find('.book_down').bind('click', function(e) {
2180         gb.next();
2181         return false;
2182     });
2183
2184     jToolbar.find('.embed').bind('click', function(e) {
2185         gb.showEmbedCode();
2186         return false;
2187     });
2188
2189     jToolbar.find('.play').bind('click', function(e) {
2190         gb.autoToggle();
2191         return false;
2192     });
2193
2194     jToolbar.find('.pause').bind('click', function(e) {
2195         gb.autoToggle();
2196         return false;
2197     });
2198
2199     jToolbar.find('.book_top').bind('click', function(e) {
2200         gb.first();
2201         return false;
2202     });
2203
2204     jToolbar.find('.book_bottom').bind('click', function(e) {
2205         gb.last();
2206         return false;
2207     });
2208
2209     jToolbar.find('.book_leftmost').bind('click', function(e) {
2210         gb.leftmost();
2211         return false;
2212     });
2213
2214     jToolbar.find('.book_rightmost').bind('click', function(e) {
2215         gb.rightmost();
2216         return false;
2217     });
2218 }
2219
2220 // updateToolbarZoom(reduce)
2221 //______________________________________________________________________________
2222 // Update the displayed zoom factor based on reduction factor
2223 GnuBook.prototype.updateToolbarZoom = function(reduce) {
2224     // $$$ TODO: Move toolbar to it's own object/plugin
2225     $('#GBzoom').text(parseInt(100/reduce));
2226 }
2227
2228 // firstDisplayableIndex
2229 //______________________________________________________________________________
2230 // Returns the index of the first visible page, dependent on the mode.
2231 // $$$ Currently we cannot display the front/back cover in 2-up and will need to update
2232 // this function when we can as part of https://bugs.launchpad.net/gnubook/+bug/296788
2233 GnuBook.prototype.firstDisplayableIndex = function() {
2234     if (this.mode == 0) {
2235         return 0;
2236     } else {
2237         return 1; // $$$ we assume there are enough pages... we need logic for very short books
2238     }
2239 }
2240
2241 // lastDisplayableIndex
2242 //______________________________________________________________________________
2243 // Returns the index of the last visible page, dependent on the mode.
2244 // $$$ Currently we cannot display the front/back cover in 2-up and will need to update
2245 // this function when we can as pa  rt of https://bugs.launchpad.net/gnubook/+bug/296788
2246 GnuBook.prototype.lastDisplayableIndex = function() {
2247     if (this.mode == 2) {
2248         if (this.lastDisplayableIndex2up === null) {
2249             // Calculate and cache
2250             var candidate = this.numLeafs - 1;
2251             for ( ; candidate >= 0; candidate--) {
2252                 var spreadIndices = this.getSpreadIndices(candidate);
2253                 if (Math.max(spreadIndices[0], spreadIndices[1]) < (this.numLeafs - 1)) {
2254                     break;
2255                 }
2256             }
2257             this.lastDisplayableIndex2up = candidate;
2258         }
2259         return this.lastDisplayableIndex2up;
2260     } else {
2261         return this.numLeafs - 1;
2262     }
2263 }
2264
2265 // shortTitle(maximumCharacters)
2266 //________
2267 // Returns a shortened version of the title with the maximum number of characters
2268 GnuBook.prototype.shortTitle = function(maximumCharacters) {
2269     if (this.bookTitle.length < maximumCharacters) {
2270         return this.bookTitle;
2271     }
2272
2273     var title = this.bookTitle.substr(0, maximumCharacters - 3);
2274     title += '...';
2275     return title;
2276 }
2277
2278
2279
2280 // Parameter related functions
2281
2282 // updateFromParams(params)
2283 //________
2284 // Update ourselves from the params object.
2285 //
2286 // e.g. this.updateFromParams(this.paramsFromFragment(window.location.hash))
2287 GnuBook.prototype.updateFromParams = function(params) {
2288     if ('undefined' != typeof(params.mode)) {
2289         this.switchMode(params.mode);
2290     }
2291
2292     // $$$ process /search
2293     // $$$ process /zoom
2294
2295     // We only respect page if index is not set
2296     if ('undefined' != typeof(params.index)) {
2297         if (params.index != this.currentIndex()) {
2298             this.jumpToIndex(params.index);
2299         }
2300     } else if ('undefined' != typeof(params.page)) {
2301         // $$$ this assumes page numbers are unique
2302         if (params.page != this.getPageNum(this.currentIndex())) {
2303             this.jumpToPage(params.page);
2304         }
2305     }
2306
2307     // $$$ process /region
2308     // $$$ process /highlight
2309 }
2310
2311 // paramsFromFragment(urlFragment)
2312 //________
2313 // Returns a object with configuration parametes from a URL fragment.
2314 //
2315 // E.g paramsFromFragment(window.location.hash)
2316 GnuBook.prototype.paramsFromFragment = function(urlFragment) {
2317     // URL fragment syntax specification: http://openlibrary.org/dev/docs/bookurls
2318
2319     var params = {};
2320
2321     // For convenience we allow an initial # character (as from window.location.hash)
2322     // but don't require it
2323     if (urlFragment.substr(0,1) == '#') {
2324         urlFragment = urlFragment.substr(1);
2325     }
2326
2327     // Simple #nn syntax
2328     var oldStyleLeafNum = parseInt( /^\d+$/.exec(urlFragment) );
2329     if ( !isNaN(oldStyleLeafNum) ) {
2330         params.index = oldStyleLeafNum;
2331
2332         // Done processing if using old-style syntax
2333         return params;
2334     }
2335
2336     // Split into key-value pairs
2337     var urlArray = urlFragment.split('/');
2338     var urlHash = {};
2339     for (var i = 0; i < urlArray.length; i += 2) {
2340         urlHash[urlArray[i]] = urlArray[i+1];
2341     }
2342
2343     // Mode
2344     if ('1up' == urlHash['mode']) {
2345         params.mode = this.constMode1up;
2346     } else if ('2up' == urlHash['mode']) {
2347         params.mode = this.constMode2up;
2348     }
2349
2350     // Index and page
2351     if ('undefined' != typeof(urlHash['page'])) {
2352         // page was set -- may not be int
2353         params.page = urlHash['page'];
2354     }
2355
2356     // $$$ process /region
2357     // $$$ process /search
2358     // $$$ process /highlight
2359
2360     return params;
2361 }
2362
2363 // paramsFromCurrent()
2364 //________
2365 // Create a params object from the current parameters.
2366 GnuBook.prototype.paramsFromCurrent = function() {
2367
2368     var params = {};
2369
2370     var pageNum = this.getPageNum(this.currentIndex());
2371     if ((pageNum === 0) || pageNum) {
2372         params.page = pageNum;
2373     }
2374
2375     params.index = this.currentIndex();
2376     params.mode = this.mode;
2377
2378     // $$$ highlight
2379     // $$$ region
2380     // $$$ search
2381
2382     return params;
2383 }
2384
2385 // fragmentFromParams(params)
2386 //________
2387 // Create a fragment string from the params object.
2388 // See http://openlibrary.org/dev/docs/bookurls for an explanation of the fragment syntax.
2389 GnuBook.prototype.fragmentFromParams = function(params) {
2390     var separator = '/';
2391
2392     var fragments = [];
2393
2394     if ('undefined' != typeof(params.page)) {
2395         fragments.push('page', params.page);
2396     } else {
2397         // Don't have page numbering -- use index instead
2398         fragments.push('page', 'n' + params.index);
2399     }
2400
2401     // $$$ highlight
2402     // $$$ region
2403     // $$$ search
2404
2405     // mode
2406     if ('undefined' != typeof(params.mode)) {
2407         if (params.mode == this.constMode1up) {
2408             fragments.push('mode', '1up');
2409         } else if (params.mode == this.constMode2up) {
2410             fragments.push('mode', '2up');
2411         } else {
2412             throw 'fragmentFromParams called with unknown mode ' + params.mode;
2413         }
2414     }
2415
2416     return fragments.join(separator);
2417 }
2418
2419 // getPageIndex(pageNum)
2420 //________
2421 // Returns the *highest* index the given page number, or undefined
2422 GnuBook.prototype.getPageIndex = function(pageNum) {
2423     var pageIndices = this.getPageIndices(pageNum);
2424
2425     if (pageIndices.length > 0) {
2426         return pageIndices[pageIndices.length - 1];
2427     }
2428
2429     return undefined;
2430 }
2431
2432 // getPageIndices(pageNum)
2433 //________
2434 // Returns an array (possibly empty) of the indices with the given page number
2435 GnuBook.prototype.getPageIndices = function(pageNum) {
2436     var indices = [];
2437
2438     // Check for special "nXX" page number
2439     if (pageNum.slice(0,1) == 'n') {
2440         try {
2441             var pageIntStr = pageNum.slice(1, pageNum.length);
2442             var pageIndex = parseInt(pageIntStr);
2443             indices.append(pageIndex);
2444             return indices;
2445         } catch(err) {
2446             // Do nothing... will run through page names and see if one matches
2447         }
2448     }
2449
2450     var i;
2451     for (i=0; i<this.numLeafs; i++) {
2452         if (this.getPageNum(i) == pageNum) {
2453             indices.push(i);
2454         }
2455     }
2456
2457     return indices;
2458 }
2459
2460 // getPageName(index)
2461 //________
2462 // Returns the name of the page as it should be displayed in the user interface
2463 GnuBook.prototype.getPageName = function(index) {
2464     return 'Page ' + this.getPageNum(index);
2465 }
2466
2467 // updateLocationHash
2468 //________
2469 // Update the location hash from the current parameters.  Call this instead of manually
2470 // using window.location.replace
2471 GnuBook.prototype.updateLocationHash = function() {
2472     var newHash = '#' + this.fragmentFromParams(this.paramsFromCurrent());
2473     window.location.replace(newHash);
2474
2475     // This is the variable checked in the timer.  Only user-generated changes
2476     // to the URL will trigger the event.
2477     this.oldLocationHash = newHash;
2478 }
2479
2480 // startLocationPolling
2481 //________
2482 // Starts polling of window.location to see hash fragment changes
2483 GnuBook.prototype.startLocationPolling = function() {
2484     var self = this; // remember who I am
2485     self.oldLocationHash = window.location.hash;
2486
2487     if (this.locationPollId) {
2488         clearInterval(this.locationPollID);
2489         this.locationPollId = null;
2490     }
2491
2492     this.locationPollId = setInterval(function() {
2493         var newHash = window.location.hash;
2494         if (newHash != self.oldLocationHash) {
2495             if (newHash != self.oldUserHash) { // Only process new user hash once
2496                 //console.log('url change detected ' + self.oldLocationHash + " -> " + newHash);
2497
2498                 // Queue change if animating
2499                 if (self.animating) {
2500                     self.autoStop();
2501                     self.animationFinishedCallback = function() {
2502                         self.updateFromParams(self.paramsFromFragment(newHash));
2503                     }
2504                 } else { // update immediately
2505                     self.updateFromParams(self.paramsFromFragment(newHash));
2506                 }
2507                 self.oldUserHash = newHash;
2508             }
2509         }
2510     }, 500);
2511 }
2512
2513 // getEmbedURL
2514 //________
2515 // Returns a URL for an embedded version of the current book
2516 GnuBook.prototype.getEmbedURL = function() {
2517     // We could generate a URL hash fragment here but for now we just leave at defaults
2518     return 'http://' + window.location.host + '/stream/'+this.bookId + '?ui=embed';
2519 }
2520
2521 // getEmbedCode
2522 //________
2523 // Returns the embed code HTML fragment suitable for copy and paste
2524 GnuBook.prototype.getEmbedCode = function() {
2525     return "<iframe src='" + this.getEmbedURL() + "' width='480px' height='430px'></iframe>";
2526 }
2527
2528 // canSwitchToMode
2529 //________
2530 // Returns true if we can switch to the requested mode
2531 GnuBook.prototype.canSwitchToMode = function(mode) {
2532     if (mode == this.constMode2up) {
2533         // check there are enough pages to display
2534         // $$$ this is a workaround for the mis-feature that we can't display
2535         //     short books in 2up mode
2536         if (this.numLeafs < 6) {
2537             return false;
2538         }
2539     }
2540
2541     return true;
2542 }
2543
2544 // Library functions
2545 GnuBook.util = {
2546     clamp: function(value, min, max) {
2547         return Math.min(Math.max(value, min), max);
2548     }
2549 }