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     console.dir(this.twoPage); // XXX
 812
 813     $('#GBtwopageview').width(this.twoPage.totalWidth).height(this.twoPage.totalHeight);
 814
 815     this.twoPage.coverDiv = document.createElement('div');
 816     $(this.twoPage.coverDiv).attr('id', 'GBbookcover').css({
 817         border: '1px solid rgb(68, 25, 17)',
 818         width:  this.twoPage.bookCoverDivWidth + 'px',
 819         height: this.twoPage.bookCoverDivHeight+'px',
 820         visibility: 'visible',
 821         position: 'absolute',
 822         backgroundColor: '#663929',
 823         left: this.twoPage.bookCoverDivLeft + 'px',
 824         top: this.twoPage.bookCoverDivTop+'px',
 825         MozBorderRadiusTopleft: '7px',
 826         MozBorderRadiusTopright: '7px',
 827         MozBorderRadiusBottomright: '7px',
 828         MozBorderRadiusBottomleft: '7px'
 829     }).appendTo('#GBtwopageview');
 830
 831     this.leafEdgeR = document.createElement('div');
 832     this.leafEdgeR.className = 'leafEdgeR'; // $$$ the static CSS should be moved into the .css file
 833     $(this.leafEdgeR).css({
 834         borderStyle: 'solid solid solid none',
 835         borderColor: 'rgb(51, 51, 34)',
 836         borderWidth: '1px 1px 1px 0px',
 837         background: 'transparent url(' + this.imagesBaseURL + 'right_edges.png) repeat scroll 0% 0%',
 838         width: this.twoPage.leafEdgeWidthR + 'px',
 839         height: this.twoPage.height-1 + 'px',
 840         /*right: '10px',*/
 841         left: this.twoPage.gutter+this.twoPage.scaledWR+'px',
 842         top: this.twoPage.bookCoverDivTop+this.twoPage.coverInternalPadding+'px',
 843         position: 'absolute'
 844     }).appendTo('#GBtwopageview');
 845
 846     this.leafEdgeL = document.createElement('div');
 847     this.leafEdgeL.className = 'leafEdgeL';
 848     $(this.leafEdgeL).css({ // $$$ static CSS should be moved to file
 849         borderStyle: 'solid none solid solid',
 850         borderColor: 'rgb(51, 51, 34)',
 851         borderWidth: '1px 0px 1px 1px',
 852         background: 'transparent url(' + this.imagesBaseURL + 'left_edges.png) repeat scroll 0% 0%',
 853         width: this.twoPage.leafEdgeWidthL + 'px',
 854         height: this.twoPage.height-1 + 'px',
 855         left: this.twoPage.bookCoverDivLeft+this.twoPage.coverInternalPadding+'px',
 856         top: this.twoPage.bookCoverDivTop+this.twoPage.coverInternalPadding+'px',
 857         position: 'absolute'
 858     }).appendTo('#GBtwopageview');
 859
 860     div = document.createElement('div');
 861     $(div).attr('id', 'GBbookspine').css({
 862         border:          '1px solid rgb(68, 25, 17)',
 863         width:           this.twoPage.bookSpineDivWidth+'px',
 864         height:          this.twoPage.bookSpineDivHeight+'px',
 865         position:        'absolute',
 866         backgroundColor: 'rgb(68, 25, 17)',
 867         left:            this.twoPage.bookSpineDivLeft+'px',
 868         top:             this.twoPage.bookSpineDivTop+'px'
 869     }).appendTo('#GBtwopageview');
 870
 871     this.prepareTwoPagePopUp();
 872
 873     this.displayedIndices = [];
 874
 875     //this.indicesToDisplay=[firstLeaf, firstLeaf+1];
 876     //console.log('indicesToDisplay: ' + this.indicesToDisplay[0] + ' ' + this.indicesToDisplay[1]);
 877
 878     this.drawLeafsTwoPage();
 879     this.updateSearchHilites2UP();
 880     this.updateToolbarZoom(this.reduce);
 881
 882     this.prefetch();
 883 }
 884
 885 // prepareTwoPagePopUp()
 886 //
 887 // This function prepares the "View Page n" popup that shows while the mouse is
 888 // over the left/right "stack of sheets" edges.  It also binds the mouse
 889 // events for these divs.
 890 //______________________________________________________________________________
 891 GnuBook.prototype.prepareTwoPagePopUp = function() {
 892
 893     this.twoPagePopUp = document.createElement('div');
 894     $(this.twoPagePopUp).css({
 895         border: '1px solid black',
 896         padding: '2px 6px',
 897         position: 'absolute',
 898         fontFamily: 'sans-serif',
 899         fontSize: '14px',
 900         zIndex: '1000',
 901         backgroundColor: 'rgb(255, 255, 238)',
 902         opacity: 0.85
 903     }).appendTo('#GBcontainer');
 904     $(this.twoPagePopUp).hide();
 905
 906     $(this.leafEdgeL).add(this.leafEdgeR).bind('mouseenter', this, function(e) {
 907         $(e.data.twoPagePopUp).show();
 908     });
 909
 910     $(this.leafEdgeL).add(this.leafEdgeR).bind('mouseleave', this, function(e) {
 911         $(e.data.twoPagePopUp).hide();
 912     });
 913
 914     $(this.leafEdgeL).bind('click', this, function(e) {
 915         e.data.autoStop();
 916         var jumpIndex = e.data.jumpIndexForLeftEdgePageX(e.pageX);
 917         e.data.jumpToIndex(jumpIndex);
 918     });
 919
 920     $(this.leafEdgeR).bind('click', this, function(e) {
 921         e.data.autoStop();
 922         var jumpIndex = e.data.jumpIndexForRightEdgePageX(e.pageX);
 923         e.data.jumpToIndex(jumpIndex);
 924     });
 925
 926     $(this.leafEdgeR).bind('mousemove', this, function(e) {
 927
 928         var jumpIndex = e.data.jumpIndexForRightEdgePageX(e.pageX);
 929         $(e.data.twoPagePopUp).text('View ' + e.data.getPageName(jumpIndex));
 930
 931         // $$$ TODO: Make sure popup is positioned so that it is in view
 932         // (https://bugs.edge.launchpad.net/gnubook/+bug/327456)
 933         $(e.data.twoPagePopUp).css({
 934             left: e.pageX- $('#GBcontainer').offset().left + $('#GBcontainer').scrollLeft() + 20 + 'px',
 935             top: e.pageY - $('#GBcontainer').offset().top + $('#GBcontainer').scrollTop() + 'px'
 936         });
 937     });
 938
 939     $(this.leafEdgeL).bind('mousemove', this, function(e) {
 940
 941         var jumpIndex = e.data.jumpIndexForLeftEdgePageX(e.pageX);
 942         $(e.data.twoPagePopUp).text('View '+ e.data.getPageName(jumpIndex));
 943
 944         // $$$ TODO: Make sure popup is positioned so that it is in view
 945         //           (https://bugs.edge.launchpad.net/gnubook/+bug/327456)
 946         $(e.data.twoPagePopUp).css({
 947             left: e.pageX - $('#GBcontainer').offset().left + $('#GBcontainer').scrollLeft() - $(e.data.twoPagePopUp).width() - 25 + 'px',
 948             top: e.pageY-$('#GBcontainer').offset().top + $('#GBcontainer').scrollTop() + 'px'
 949         });
 950     });
 951 }
 952
 953 // calculateSpreadSize()
 954 //______________________________________________________________________________
 955 // Calculates 2-page spread dimensions based on this.twoPage.currentIndexL and
 956 // this.twoPage.currentIndexR
 957 // This function sets this.twoPage.height, twoPage.width, and twoPage.ratio
 958
 959 GnuBook.prototype.calculateSpreadSize = function() {
 960     console.log('calculateSpreadSize ' + this.twoPage.currentIndexL); // XXX
 961
 962     // $$$ TODO Calculate the spread size based on the reduction factor.  If we are using
 963     // fit mode we recalculate the reduction factor based on the current page sizes
 964     // and display size first.
 965
 966     var firstIndex  = this.twoPage.currentIndexL;
 967     var secondIndex = this.twoPage.currentIndexR;
 968     //console.log('first page is ' + firstIndex);
 969
 970     var spreadSize;
 971     if ( this.twoPage.autofit) {
 972         spreadSize = this.getIdealSpreadSize(firstIndex, secondIndex);
 973     } else {
 974         // set based on reduction factor
 975         spreadSize = this.getSpreadSizeFromReduce(firstIndex, secondIndex, this.reduce);
 976     }
 977
 978     this.twoPage.height = spreadSize.height;
 979     this.twoPage.width = spreadSize.width;
 980     this.twoPage.ratio = spreadSize.ratio;
 981     this.twoPage.edgeWidth = spreadSize.totalLeafEdgeWidth; // The combined width of both edges
 982
 983     this.twoPage.scaledWL = this.getPageWidth2UP(firstIndex);
 984     this.twoPage.scaledWR = this.getPageWidth2UP(secondIndex);
 985     this.twoPage.leafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
 986     this.twoPage.leafEdgeWidthR = this.twoPage.edgeWidth - this.twoPage.leafEdgeWidthL;
 987
 988     // The width of the book cover div.  The combined width of both pages, twice the width
 989     // of the book cover internal padding (2*10) and the page edges
 990     this.twoPage.bookCoverDivWidth = this.twoPage.scaledWL + this.twoPage.scaledWR + 2 * this.twoPage.coverInternalPadding + this.twoPage.edgeWidth;
 991
 992     // The height of the book cover div
 993     this.twoPage.bookCoverDivHeight = this.twoPage.height + 2 * this.twoPage.coverInternalPadding;
 994
 995     // Total height and width -- makes the spine middle centered
 996     var leftGutterOffset = this.gutterOffsetForIndex(firstIndex);
 997     var largestWidthFromCenter = Math.max( (this.twoPage.scaledWL + leftGutterOffset), (this.twoPage.scaledWR - leftGutterOffset));
 998     this.twoPage.totalWidth = 2 * (largestWidthFromCenter + this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding);
 999     this.twoPage.totalHeight = this.twoPage.height + 2 * (this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding);
1000
1001     // We want to minimize the unused space in two-up mode (maximize the amount of page
1002     // shown).  We give width to the leaf edges and these widths change (though the sum
1003     // of the two remains constant) as we flip through the book.  With the book
1004     // cover centered and fixed in the GBcontainer div the page images will meet
1005     // at the "gutter" which is generally offset from the center.
1006     this.twoPage.middle = this.twoPage.totalWidth >> 1;
1007     this.twoPage.gutter = this.twoPage.middle + this.gutterOffsetForIndex(firstIndex);
1008
1009     this.twoPage.bookCoverDivLeft = this.twoPage.middle - this.twoPage.scaledWL - this.twoPage.coverInternalPadding; // $$$ Account for border?
1010     this.twoPage.bookCoverDivTop = this.twoPage.coverExternalPadding; // $$$ Account for border?
1011
1012     this.twoPage.bookSpineDivHeight = this.twoPage.height + 2*this.twoPage.coverInternalPadding;
1013     this.twoPage.bookSpineDivLeft = this.twoPage.middle - (this.twoPage.bookSpineDivWidth >> 1);
1014     this.twoPage.bookSpineDivTop = this.twoPage.bookCoverDivTop;
1015
1016
1017     this.reduce = spreadSize.reduce; // $$$ really set this here?
1018 }
1019
1020 GnuBook.prototype.getIdealSpreadSize = function(firstIndex, secondIndex) {
1021     var ideal = {};
1022
1023     // We check which page is closest to a "normal" page and use that to set the height
1024     // for both pages.  This means that foldouts and other odd size pages will be displayed
1025     // smaller than the nominal zoom amount.
1026     var canon5Dratio = 1.5;
1027
1028     var first = {
1029         height: this.getPageHeight(firstIndex),
1030         width: this.getPageWidth(firstIndex)
1031     }
1032
1033     var second = {
1034         height: this.getPageHeight(secondIndex),
1035         width: this.getPageWidth(secondIndex)
1036     }
1037
1038     var firstIndexRatio  = first.height / first.width;
1039     var secondIndexRatio = second.height / second.width;
1040     //console.log('firstIndexRatio = ' + firstIndexRatio + ' secondIndexRatio = ' + secondIndexRatio);
1041
1042     if (Math.abs(firstIndexRatio - canon5Dratio) < Math.abs(secondIndexRatio - canon5Dratio)) {
1043         ideal.ratio = firstIndexRatio;
1044         //console.log('using firstIndexRatio ' + ratio);
1045     } else {
1046         ideal.ratio = secondIndexRatio;
1047         //console.log('using secondIndexRatio ' + ratio);
1048     }
1049
1050     var totalLeafEdgeWidth = parseInt(this.numLeafs * 0.1);
1051     var maxLeafEdgeWidth   = parseInt($('#GBcontainer').attr('clientWidth') * 0.1);
1052     ideal.totalLeafEdgeWidth     = Math.min(totalLeafEdgeWidth, maxLeafEdgeWidth);
1053
1054     ideal.width  = ($('#GBcontainer').attr('clientWidth') - 30 - ideal.totalLeafEdgeWidth)>>1;
1055     ideal.height = $('#GBcontainer').height() - 30;  // $$$ why - 30?  book edge width?
1056     //console.log('init idealWidth='+idealWidth+' idealHeight='+idealHeight + ' ratio='+ratio);
1057
1058     if (ideal.height/ideal.ratio <= ideal.width) {
1059         //use height
1060         ideal.width = parseInt(ideal.height/ideal.ratio);
1061     } else {
1062         //use width
1063         ideal.height = parseInt(ideal.width*ideal.ratio);
1064     }
1065
1066     // XXX check this logic with large spreads
1067     ideal.reduce = ((first.height + second.height) / 2) / ideal.height;
1068
1069     return ideal;
1070 }
1071
1072 GnuBook.prototype.getSpreadSizeFromReduce = function(firstIndex, secondIndex, reduce) {
1073     var spreadSize = {};
1074     // $$$ Scale this based on reduce?
1075     var totalLeafEdgeWidth = parseInt(this.numLeafs * 0.1);
1076     var maxLeafEdgeWidth   = parseInt($('#GBcontainer').attr('clientWidth') * 0.1);
1077     spreadSize.totalLeafEdgeWidth     = Math.min(totalLeafEdgeWidth, maxLeafEdgeWidth);
1078
1079     // $$$ this isn't quite right when the pages are different sizes
1080     var nativeWidth = this.getPageWidth(firstIndex) + this.getPageWidth(secondIndex);
1081     var nativeHeight = this.getPageHeight(firstIndex) + this.getPageHeight(secondIndex);
1082     spreadSize.height = parseInt( (nativeHeight / 2) / this.reduce );
1083     spreadSize.width = parseInt( (nativeWidth / 2) / this.reduce );
1084     spreadSize.reduce = reduce;
1085
1086     // XXX
1087     console.log('spread size: ' + firstIndex + ',' + secondIndex + ',' + reduce);
1088
1089     return spreadSize;
1090 }
1091
1092 // currentIndex()
1093 //______________________________________________________________________________
1094 // Returns the currently active index.
1095 GnuBook.prototype.currentIndex = function() {
1096     // $$$ we should be cleaner with our idea of which index is active in 1up/2up
1097     if (this.mode == this.constMode1up || this.mode == this.constMode2up) {
1098         return this.firstIndex;
1099     } else {
1100         throw 'currentIndex called for unimplemented mode ' + this.mode;
1101     }
1102 }
1103
1104 // right()
1105 //______________________________________________________________________________
1106 // Flip the right page over onto the left
1107 GnuBook.prototype.right = function() {
1108     if ('rl' != this.pageProgression) {
1109         // LTR
1110         gb.next();
1111     } else {
1112         // RTL
1113         gb.prev();
1114     }
1115 }
1116
1117 // rightmost()
1118 //______________________________________________________________________________
1119 // Flip to the rightmost page
1120 GnuBook.prototype.rightmost = function() {
1121     if ('rl' != this.pageProgression) {
1122         gb.last();
1123     } else {
1124         gb.first();
1125     }
1126 }
1127
1128 // left()
1129 //______________________________________________________________________________
1130 // Flip the left page over onto the right.
1131 GnuBook.prototype.left = function() {
1132     if ('rl' != this.pageProgression) {
1133         // LTR
1134         gb.prev();
1135     } else {
1136         // RTL
1137         gb.next();
1138     }
1139 }
1140
1141 // leftmost()
1142 //______________________________________________________________________________
1143 // Flip to the leftmost page
1144 GnuBook.prototype.leftmost = function() {
1145     if ('rl' != this.pageProgression) {
1146         gb.first();
1147     } else {
1148         gb.last();
1149     }
1150 }
1151
1152 // next()
1153 //______________________________________________________________________________
1154 GnuBook.prototype.next = function() {
1155     if (2 == this.mode) {
1156         this.autoStop();
1157         this.flipFwdToIndex(null);
1158     } else {
1159         if (this.firstIndex < this.lastDisplayableIndex()) {
1160             this.jumpToIndex(this.firstIndex+1);
1161         }
1162     }
1163 }
1164
1165 // prev()
1166 //______________________________________________________________________________
1167 GnuBook.prototype.prev = function() {
1168     if (2 == this.mode) {
1169         this.autoStop();
1170         this.flipBackToIndex(null);
1171     } else {
1172         if (this.firstIndex >= 1) {
1173             this.jumpToIndex(this.firstIndex-1);
1174         }
1175     }
1176 }
1177
1178 GnuBook.prototype.first = function() {
1179     if (2 == this.mode) {
1180         this.jumpToIndex(2);
1181     }
1182     else {
1183         this.jumpToIndex(0);
1184     }
1185 }
1186
1187 GnuBook.prototype.last = function() {
1188     if (2 == this.mode) {
1189         this.jumpToIndex(this.lastDisplayableIndex());
1190     }
1191     else {
1192         this.jumpToIndex(this.lastDisplayableIndex());
1193     }
1194 }
1195
1196 // flipBackToIndex()
1197 //______________________________________________________________________________
1198 // to flip back one spread, pass index=null
1199 GnuBook.prototype.flipBackToIndex = function(index) {
1200     if (1 == this.mode) return;
1201
1202     var leftIndex = this.twoPage.currentIndexL;
1203
1204     // $$$ Need to change this to be able to see first spread.
1205     //     See https://bugs.launchpad.net/gnubook/+bug/296788
1206     if (leftIndex <= 2) return;
1207     if (this.animating) return;
1208
1209     if (null != this.leafEdgeTmp) {
1210         alert('error: leafEdgeTmp should be null!');
1211         return;
1212     }
1213
1214     if (null == index) {
1215         index = leftIndex-2;
1216     }
1217     //if (index<0) return;
1218
1219     var previousIndices = this.getSpreadIndices(index);
1220
1221     if (previousIndices[0] < 0 || previousIndices[1] < 0) {
1222         return;
1223     }
1224
1225     //console.log("flipping back to " + previousIndices[0] + ',' + previousIndices[1]);
1226
1227     this.animating = true;
1228
1229     if ('rl' != this.pageProgression) {
1230         // Assume LTR and we are going backward
1231         this.prepareFlipLeftToRight(previousIndices[0], previousIndices[1]);
1232         this.flipLeftToRight(previousIndices[0], previousIndices[1]);
1233     } else {
1234         // RTL and going backward
1235         var gutter = this.prepareFlipRightToLeft(previousIndices[0], previousIndices[1]);
1236         this.flipRightToLeft(previousIndices[0], previousIndices[1], gutter);
1237     }
1238 }
1239
1240 // flipLeftToRight()
1241 //______________________________________________________________________________
1242 // Flips the page on the left towards the page on the right
1243 GnuBook.prototype.flipLeftToRight = function(newIndexL, newIndexR) {
1244
1245     var leftLeaf = this.twoPage.currentIndexL;
1246
1247     var oldLeafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
1248     var newLeafEdgeWidthL = this.leafEdgeWidth(newIndexL);
1249     var leafEdgeTmpW = oldLeafEdgeWidthL - newLeafEdgeWidthL;
1250
1251     var currWidthL   = this.getPageWidth2UP(leftLeaf);
1252     var newWidthL    = this.getPageWidth2UP(newIndexL);
1253     var newWidthR    = this.getPageWidth2UP(newIndexR);
1254
1255     var top  = this.twoPageTop();
1256     var gutter = this.twoPage.middle + this.gutterOffsetForIndex(newIndexL);
1257
1258     //console.log('leftEdgeTmpW ' + leafEdgeTmpW);
1259     //console.log('  gutter ' + gutter + ', scaledWL ' + scaledWL + ', newLeafEdgeWL ' + newLeafEdgeWidthL);
1260
1261     //animation strategy:
1262     // 0. remove search highlight, if any.
1263     // 1. create a new div, called leafEdgeTmp to represent the leaf edge between the leftmost edge
1264     //    of the left leaf and where the user clicked in the leaf edge.
1265     //    Note that if this function was triggered by left() and not a
1266     //    mouse click, the width of leafEdgeTmp is very small (zero px).
1267     // 2. animate both leafEdgeTmp to the gutter (without changing its width) and animate
1268     //    leftLeaf to width=0.
1269     // 3. When step 2 is finished, animate leafEdgeTmp to right-hand side of new right leaf
1270     //    (left=gutter+newWidthR) while also animating the new right leaf from width=0 to
1271     //    its new full width.
1272     // 4. After step 3 is finished, do the following:
1273     //      - remove leafEdgeTmp from the dom.
1274     //      - resize and move the right leaf edge (leafEdgeR) to left=gutter+newWidthR
1275     //          and width=twoPage.edgeWidth-newLeafEdgeWidthL.
1276     //      - resize and move the left leaf edge (leafEdgeL) to left=gutter-newWidthL-newLeafEdgeWidthL
1277     //          and width=newLeafEdgeWidthL.
1278     //      - resize the back cover (twoPage.coverDiv) to left=gutter-newWidthL-newLeafEdgeWidthL-10
1279     //          and width=newWidthL+newWidthR+twoPage.edgeWidth+20
1280     //      - move new left leaf (newIndexL) forward to zindex=2 so it can receive clicks.
1281     //      - remove old left and right leafs from the dom [pruneUnusedImgs()].
1282     //      - prefetch new adjacent leafs.
1283     //      - set up click handlers for both new left and right leafs.
1284     //      - redraw the search highlight.
1285     //      - update the pagenum box and the url.
1286
1287
1288     var leftEdgeTmpLeft = gutter - currWidthL - leafEdgeTmpW;
1289
1290     this.leafEdgeTmp = document.createElement('div');
1291     $(this.leafEdgeTmp).css({
1292         borderStyle: 'solid none solid solid',
1293         borderColor: 'rgb(51, 51, 34)',
1294         borderWidth: '1px 0px 1px 1px',
1295         background: 'transparent url(' + this.imagesBaseURL + 'left_edges.png) repeat scroll 0% 0%',
1296         width: leafEdgeTmpW + 'px',
1297         height: this.twoPage.height-1 + 'px',
1298         left: leftEdgeTmpLeft + 'px',
1299         top: top+'px',
1300         position: 'absolute',
1301         zIndex:1000
1302     }).appendTo('#GBtwopageview');
1303
1304     //$(this.leafEdgeL).css('width', newLeafEdgeWidthL+'px');
1305     $(this.leafEdgeL).css({
1306         width: newLeafEdgeWidthL+'px',
1307         left: gutter-currWidthL-newLeafEdgeWidthL+'px'
1308     });
1309
1310     // Left gets the offset of the current left leaf from the document
1311     var left = $(this.prefetchedImgs[leftLeaf]).offset().left;
1312     // $$$ This seems very similar to the gutter.  May be able to consolidate the logic.
1313     // XXX need to recalc
1314     var right = $('#GBtwopageview').attr('clientWidth')-left-$(this.prefetchedImgs[leftLeaf]).width()+$('#GBtwopageview').offset().left-2+'px';
1315     // We change the left leaf to right positioning
1316     // $$$ This causes animation glitches during resize.  See https://bugs.edge.launchpad.net/gnubook/+bug/328327
1317     $(this.prefetchedImgs[leftLeaf]).css({
1318         right: right,
1319         left: ''
1320     });
1321
1322      left = $(this.prefetchedImgs[leftLeaf]).offset().left - $('#book_div_1').offset().left;
1323
1324      right = left+$(this.prefetchedImgs[leftLeaf]).width()+'px';
1325
1326     $(this.leafEdgeTmp).animate({left: gutter}, this.flipSpeed, 'easeInSine');
1327     //$(this.prefetchedImgs[leftLeaf]).animate({width: '0px'}, 'slow', 'easeInSine');
1328
1329     var self = this;
1330
1331     this.removeSearchHilites();
1332
1333     //console.log('animating leafLeaf ' + leftLeaf + ' to 0px');
1334     $(this.prefetchedImgs[leftLeaf]).animate({width: '0px'}, self.flipSpeed, 'easeInSine', function() {
1335
1336         //console.log('     and now leafEdgeTmp to left: gutter+newWidthR ' + (gutter + newWidthR));
1337         $(self.leafEdgeTmp).animate({left: gutter+newWidthR+'px'}, self.flipSpeed, 'easeOutSine');
1338
1339         //console.log('  animating newIndexR ' + newIndexR + ' to ' + newWidthR + ' from ' + $(self.prefetchedImgs[newIndexR]).width());
1340         $(self.prefetchedImgs[newIndexR]).animate({width: newWidthR+'px'}, self.flipSpeed, 'easeOutSine', function() {
1341             $(self.prefetchedImgs[newIndexL]).css('zIndex', 2);
1342
1343             $(self.leafEdgeR).css({
1344                 // Moves the right leaf edge
1345                 width: self.twoPage.edgeWidth-newLeafEdgeWidthL+'px',
1346                 left:  gutter+newWidthR+'px'
1347             });
1348
1349             $(self.leafEdgeL).css({
1350                 // Moves and resizes the left leaf edge
1351                 width: newLeafEdgeWidthL+'px',
1352                 left:  gutter-newWidthL-newLeafEdgeWidthL+'px'
1353             });
1354
1355
1356             $(self.twoPage.coverDiv).css({
1357                 // Resizes the brown border div
1358                 width: newWidthL+newWidthR+self.twoPage.edgeWidth+20+'px',
1359                 left: gutter-newWidthL-newLeafEdgeWidthL-10+'px'
1360             });
1361
1362             $(self.leafEdgeTmp).remove();
1363             self.leafEdgeTmp = null;
1364
1365             self.twoPage.currentIndexL = newIndexL;
1366             self.twoPage.currentIndexR = newIndexR;
1367             self.firstIndex = self.twoPage.currentIndexL;
1368             self.displayedIndices = [newIndexL, newIndexR];
1369             self.setClickHandlers();
1370             self.pruneUnusedImgs();
1371             self.prefetch();
1372             self.animating = false;
1373
1374             self.updateSearchHilites2UP();
1375             self.updatePageNumBox2UP();
1376
1377             if (self.animationFinishedCallback) {
1378                 self.animationFinishedCallback();
1379                 self.animationFinishedCallback = null;
1380             }
1381         });
1382     });
1383
1384 }
1385
1386 // flipFwdToIndex()
1387 //______________________________________________________________________________
1388 // Whether we flip left or right is dependent on the page progression
1389 // to flip forward one spread, pass index=null
1390 GnuBook.prototype.flipFwdToIndex = function(index) {
1391
1392     if (this.animating) return;
1393
1394     if (null != this.leafEdgeTmp) {
1395         alert('error: leafEdgeTmp should be null!');
1396         return;
1397     }
1398
1399     if (null == index) {
1400         index = this.twoPage.currentIndexR+2; // $$$ assumes indices are continuous
1401     }
1402     if (index > this.lastDisplayableIndex()) return;
1403
1404     this.animating = true;
1405
1406     var nextIndices = this.getSpreadIndices(index);
1407
1408     //console.log('flipfwd to indices ' + nextIndices[0] + ',' + nextIndices[1]);
1409
1410     if ('rl' != this.pageProgression) {
1411         // We did not specify RTL
1412         var gutter = this.prepareFlipRightToLeft(nextIndices[0], nextIndices[1]);
1413         this.flipRightToLeft(nextIndices[0], nextIndices[1], gutter);
1414     } else {
1415         // RTL
1416         var gutter = this.prepareFlipLeftToRight(nextIndices[0], nextIndices[1]);
1417         this.flipLeftToRight(nextIndices[0], nextIndices[1]);
1418     }
1419 }
1420
1421 // flipRightToLeft(nextL, nextR, gutter)
1422 // $$$ better not to have to pass gutter in
1423 //______________________________________________________________________________
1424 // Flip from left to right and show the nextL and nextR indices on those sides
1425 GnuBook.prototype.flipRightToLeft = function(newIndexL, newIndexR) {
1426     var oldLeafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
1427     var oldLeafEdgeWidthR = this.twoPage.edgeWidth-oldLeafEdgeWidthL;
1428     var newLeafEdgeWidthL = this.leafEdgeWidth(newIndexL);
1429     var newLeafEdgeWidthR = this.twoPage.edgeWidth-newLeafEdgeWidthL;
1430
1431     var leafEdgeTmpW = oldLeafEdgeWidthR - newLeafEdgeWidthR;
1432
1433     var top = this.twoPageTop();
1434     var scaledW = this.getPageWidth2UP(this.twoPage.currentIndexR);
1435
1436     var middle = this.twoPage.middle;
1437     var gutter = middle + this.gutterOffsetForIndex(newIndexL);
1438
1439     this.leafEdgeTmp = document.createElement('div');
1440     $(this.leafEdgeTmp).css({
1441         borderStyle: 'solid none solid solid',
1442         borderColor: 'rgb(51, 51, 34)',
1443         borderWidth: '1px 0px 1px 1px',
1444         background: 'transparent url(' + this.imagesBaseURL + 'left_edges.png) repeat scroll 0% 0%',
1445         width: leafEdgeTmpW + 'px',
1446         height: this.twoPage.height-1 + 'px',
1447         left: gutter+scaledW+'px',
1448         top: top+'px',
1449         position: 'absolute',
1450         zIndex:1000
1451     }).appendTo('#GBtwopageview');
1452
1453     //var scaledWR = this.getPageWidth2UP(newIndexR); // $$$ should be current instead?
1454     //var scaledWL = this.getPageWidth2UP(newIndexL); // $$$ should be current instead?
1455
1456     var currWidthL = this.getPageWidth2UP(this.twoPage.currentIndexL);
1457     var currWidthR = this.getPageWidth2UP(this.twoPage.currentIndexR);
1458     var newWidthL = this.getPageWidth2UP(newIndexL);
1459     var newWidthR = this.getPageWidth2UP(newIndexR);
1460
1461     $(this.leafEdgeR).css({width: newLeafEdgeWidthR+'px', left: gutter+newWidthR+'px' });
1462
1463     var self = this; // closure-tastic!
1464
1465     var speed = this.flipSpeed;
1466
1467     this.removeSearchHilites();
1468
1469     $(this.leafEdgeTmp).animate({left: gutter}, speed, 'easeInSine');
1470     $(this.prefetchedImgs[this.twoPage.currentIndexR]).animate({width: '0px'}, speed, 'easeInSine', function() {
1471         $(self.leafEdgeTmp).animate({left: gutter-newWidthL-leafEdgeTmpW+'px'}, speed, 'easeOutSine');
1472         $(self.prefetchedImgs[newIndexL]).animate({width: newWidthL+'px'}, speed, 'easeOutSine', function() {
1473             $(self.prefetchedImgs[newIndexR]).css('zIndex', 2);
1474
1475             $(self.leafEdgeL).css({
1476                 width: newLeafEdgeWidthL+'px',
1477                 left: gutter-newWidthL-newLeafEdgeWidthL+'px'
1478             });
1479
1480             // Resizes the book cover
1481             $(self.twoPage.coverDiv).css({
1482                 width: self.twoPageCoverWidth(newWidthL+newWidthR)+'px',
1483                 left: self.coverExternalPadding+'px'
1484             });
1485
1486             $(self.leafEdgeTmp).remove();
1487             self.leafEdgeTmp = null;
1488
1489             self.twoPage.currentIndexL = newIndexL;
1490             self.twoPage.currentIndexR = newIndexR;
1491             self.firstIndex = self.twoPage.currentIndexL;
1492             self.displayedIndices = [newIndexL, newIndexR];
1493             self.setClickHandlers();
1494             self.pruneUnusedImgs();
1495             self.prefetch();
1496             self.animating = false;
1497
1498
1499             self.updateSearchHilites2UP();
1500             self.updatePageNumBox2UP();
1501
1502             if (self.animationFinishedCallback) {
1503                 self.animationFinishedCallback();
1504                 self.animationFinishedCallback = null;
1505             }
1506         });
1507     });
1508 }
1509
1510 // setClickHandlers
1511 //______________________________________________________________________________
1512 GnuBook.prototype.setClickHandlers = function() {
1513     var self = this;
1514     // $$$ TODO don't set again if already set
1515     $(this.prefetchedImgs[this.twoPage.currentIndexL]).click(function() {
1516         //self.prevPage();
1517         self.autoStop();
1518         self.left();
1519     });
1520     $(this.prefetchedImgs[this.twoPage.currentIndexR]).click(function() {
1521         //self.nextPage();'
1522         self.autoStop();
1523         self.right();
1524     });
1525 }
1526
1527 // prefetchImg()
1528 //______________________________________________________________________________
1529 GnuBook.prototype.prefetchImg = function(index) {
1530     if (undefined == this.prefetchedImgs[index]) {
1531         //console.log('prefetching ' + index);
1532         var img = document.createElement("img");
1533         img.src = this.getPageURI(index);
1534         this.prefetchedImgs[index] = img;
1535     }
1536 }
1537
1538
1539 // prepareFlipLeftToRight()
1540 //
1541 //______________________________________________________________________________
1542 //
1543 // Prepare to flip the left page towards the right.  This corresponds to moving
1544 // backward when the page progression is left to right.
1545 GnuBook.prototype.prepareFlipLeftToRight = function(prevL, prevR) {
1546
1547     //console.log('  preparing left->right for ' + prevL + ',' + prevR);
1548
1549     this.prefetchImg(prevL);
1550     this.prefetchImg(prevR);
1551
1552     var height  = this.getPageHeight(prevL);
1553     var width   = this.getPageWidth(prevL);
1554     var middle = this.twoPage.middle;
1555     var top  = this.twoPageTop();
1556     var scaledW = this.twoPage.height*width/height; // $$$ assumes height of page is dominant
1557
1558     // The gutter is the dividing line between the left and right pages.
1559     // It is offset from the middle to create the illusion of thickness to the pages
1560     var gutter = middle + this.gutterOffsetForIndex(prevL);
1561
1562     // XXX
1563     console.log('    gutter for ' + prevL + ' is ' + gutter);
1564     //console.log('    prevL.left: ' + (gutter - scaledW) + 'px');
1565     //console.log('    changing prevL ' + prevL + ' to left: ' + (gutter-scaledW) + ' width: ' + scaledW);
1566
1567     $(this.prefetchedImgs[prevL]).css({
1568         position: 'absolute',
1569         left: gutter-scaledW+'px',
1570         right: '', // clear right property
1571         top:    top+'px',
1572         backgroundColor: 'rgb(234, 226, 205)',
1573         height: this.twoPage.height,
1574         width:  scaledW+'px',
1575         borderRight: '1px solid black',
1576         zIndex: 1
1577     });
1578
1579     $('#GBtwopageview').append(this.prefetchedImgs[prevL]);
1580
1581     //console.log('    changing prevR ' + prevR + ' to left: ' + gutter + ' width: 0');
1582
1583     $(this.prefetchedImgs[prevR]).css({
1584         position: 'absolute',
1585         left:   gutter+'px',
1586         right: '',
1587         top:    top+'px',
1588         backgroundColor: 'rgb(234, 226, 205)',
1589         height: this.twoPage.height,
1590         width:  '0px',
1591         borderLeft: '1px solid black',
1592         zIndex: 2
1593     });
1594
1595     $('#GBtwopageview').append(this.prefetchedImgs[prevR]);
1596
1597 }
1598
1599 // XXXmang we're adding an extra pixel in the middle
1600 // prepareFlipRightToLeft()
1601 //______________________________________________________________________________
1602 GnuBook.prototype.prepareFlipRightToLeft = function(nextL, nextR) {
1603
1604     //console.log('  preparing left<-right for ' + nextL + ',' + nextR);
1605
1606     // Prefetch images
1607     this.prefetchImg(nextL);
1608     this.prefetchImg(nextR);
1609
1610     var height  = this.getPageHeight(nextR);
1611     var width   = this.getPageWidth(nextR);
1612     var middle = this.twoPage.middle;
1613     var top  = this.twoPageTop();
1614     var scaledW = this.twoPage.height*width/height;
1615
1616     var gutter = middle + this.gutterOffsetForIndex(nextL);
1617
1618     console.log('right to left to %d gutter is %d', nextL, gutter); // XXX
1619
1620     //console.log(' prepareRTL changing nextR ' + nextR + ' to left: ' + gutter);
1621     $(this.prefetchedImgs[nextR]).css({
1622         position: 'absolute',
1623         left:   gutter+'px',
1624         top:    top+'px',
1625         backgroundColor: 'rgb(234, 226, 205)',
1626         height: this.twoPage.height,
1627         width:  scaledW+'px',
1628         borderLeft: '1px solid black',
1629         zIndex: 1
1630     });
1631
1632     $('#GBtwopageview').append(this.prefetchedImgs[nextR]);
1633
1634     height  = this.getPageHeight(nextL);
1635     width   = this.getPageWidth(nextL);
1636     scaledW = this.twoPage.height*width/height;
1637
1638     //console.log(' prepareRTL changing nextL ' + nextL + ' to right: ' + $('#GBcontainer').width()-gutter);
1639     $(this.prefetchedImgs[nextL]).css({
1640         position: 'absolute',
1641         right:   $('#GBtwopageview').attr('clientWidth')-gutter+'px',
1642         top:    top+'px',
1643         backgroundColor: 'rgb(234, 226, 205)',
1644         height: this.twoPage.height,
1645         width:  0+'px', // Start at 0 width, then grow to the left
1646         borderRight: '1px solid black',
1647         zIndex: 2
1648     });
1649
1650     $('#GBtwopageview').append(this.prefetchedImgs[nextL]);
1651
1652 }
1653
1654 // getNextLeafs() -- NOT RTL AWARE
1655 //______________________________________________________________________________
1656 // GnuBook.prototype.getNextLeafs = function(o) {
1657 //     //TODO: we might have two left or two right leafs in a row (damaged book)
1658 //     //For now, assume that leafs are contiguous.
1659 //
1660 //     //return [this.twoPage.currentIndexL+2, this.twoPage.currentIndexL+3];
1661 //     o.L = this.twoPage.currentIndexL+2;
1662 //     o.R = this.twoPage.currentIndexL+3;
1663 // }
1664
1665 // getprevLeafs() -- NOT RTL AWARE
1666 //______________________________________________________________________________
1667 // GnuBook.prototype.getPrevLeafs = function(o) {
1668 //     //TODO: we might have two left or two right leafs in a row (damaged book)
1669 //     //For now, assume that leafs are contiguous.
1670 //
1671 //     //return [this.twoPage.currentIndexL-2, this.twoPage.currentIndexL-1];
1672 //     o.L = this.twoPage.currentIndexL-2;
1673 //     o.R = this.twoPage.currentIndexL-1;
1674 // }
1675
1676 // pruneUnusedImgs()
1677 //______________________________________________________________________________
1678 GnuBook.prototype.pruneUnusedImgs = function() {
1679     //console.log('current: ' + this.twoPage.currentIndexL + ' ' + this.twoPage.currentIndexR);
1680     for (var key in this.prefetchedImgs) {
1681         //console.log('key is ' + key);
1682         if ((key != this.twoPage.currentIndexL) && (key != this.twoPage.currentIndexR)) {
1683             //console.log('removing key '+ key);
1684             $(this.prefetchedImgs[key]).remove();
1685         }
1686         if ((key < this.twoPage.currentIndexL-4) || (key > this.twoPage.currentIndexR+4)) {
1687             //console.log('deleting key '+ key);
1688             delete this.prefetchedImgs[key];
1689         }
1690     }
1691 }
1692
1693 // prefetch()
1694 //______________________________________________________________________________
1695 GnuBook.prototype.prefetch = function() {
1696
1697     var lim = this.twoPage.currentIndexL-4;
1698     var i;
1699     lim = Math.max(lim, 0);
1700     for (i = lim; i < this.twoPage.currentIndexL; i++) {
1701         this.prefetchImg(i);
1702     }
1703
1704     if (this.numLeafs > (this.twoPage.currentIndexR+1)) {
1705         lim = Math.min(this.twoPage.currentIndexR+4, this.numLeafs-1);
1706         for (i=this.twoPage.currentIndexR+1; i<=lim; i++) {
1707             this.prefetchImg(i);
1708         }
1709     }
1710 }
1711
1712 // getPageWidth2UP()
1713 //______________________________________________________________________________
1714 GnuBook.prototype.getPageWidth2UP = function(index) {
1715     // We return the width based on the dominant height
1716     var height  = this.getPageHeight(index);
1717     var width   = this.getPageWidth(index);
1718     return Math.floor(this.twoPage.height*width/height); // $$$ we assume width is relative to current spread
1719 }
1720
1721 // search()
1722 //______________________________________________________________________________
1723 GnuBook.prototype.search = function(term) {
1724     $('#GnuBookSearchScript').remove();
1725         var script  = document.createElement("script");
1726         script.setAttribute('id', 'GnuBookSearchScript');
1727         script.setAttribute("type", "text/javascript");
1728         script.setAttribute("src", 'http://'+this.server+'/GnuBook/flipbook_search_gb.php?url='+escape(this.bookPath + '_djvu.xml')+'&term='+term+'&format=XML&callback=gb.GBSearchCallback');
1729         document.getElementsByTagName('head')[0].appendChild(script);
1730         $('#GnuBookSearchResults').html('Searching...');
1731 }
1732
1733 // GBSearchCallback()
1734 //______________________________________________________________________________
1735 GnuBook.prototype.GBSearchCallback = function(txt) {
1736     //alert(txt);
1737     if (jQuery.browser.msie) {
1738         var dom=new ActiveXObject("Microsoft.XMLDOM");
1739         dom.async="false";
1740         dom.loadXML(txt);
1741     } else {
1742         var parser = new DOMParser();
1743         var dom = parser.parseFromString(txt, "text/xml");
1744     }
1745
1746     $('#GnuBookSearchResults').empty();
1747     $('#GnuBookSearchResults').append('<ul>');
1748
1749     for (var key in this.searchResults) {
1750         if (null != this.searchResults[key].div) {
1751             $(this.searchResults[key].div).remove();
1752         }
1753         delete this.searchResults[key];
1754     }
1755
1756     var pages = dom.getElementsByTagName('PAGE');
1757
1758     if (0 == pages.length) {
1759         // $$$ it would be nice to echo the (sanitized) search result here
1760         $('#GnuBookSearchResults').append('<li>No search results found</li>');
1761     } else {
1762         for (var i = 0; i < pages.length; i++){
1763             //console.log(pages[i].getAttribute('file').substr(1) +'-'+ parseInt(pages[i].getAttribute('file').substr(1), 10));
1764
1765
1766             var re = new RegExp (/_(\d{4})/);
1767             var reMatch = re.exec(pages[i].getAttribute('file'));
1768             var index = parseInt(reMatch[1], 10);
1769             //var index = parseInt(pages[i].getAttribute('file').substr(1), 10);
1770
1771             var children = pages[i].childNodes;
1772             var context = '';
1773             for (var j=0; j<children.length; j++) {
1774                 //console.log(j + ' - ' + children[j].nodeName);
1775                 //console.log(children[j].firstChild.nodeValue);
1776                 if ('CONTEXT' == children[j].nodeName) {
1777                     context += children[j].firstChild.nodeValue;
1778                 } else if ('WORD' == children[j].nodeName) {
1779                     context += '<b>'+children[j].firstChild.nodeValue+'</b>';
1780
1781                     var index = this.leafNumToIndex(index);
1782                     if (null != index) {
1783                         //coordinates are [left, bottom, right, top, [baseline]]
1784                         //we'll skip baseline for now...
1785                         var coords = children[j].getAttribute('coords').split(',',4);
1786                         if (4 == coords.length) {
1787                             this.searchResults[index] = {'l':coords[0], 'b':coords[1], 'r':coords[2], 't':coords[3], 'div':null};
1788                         }
1789                     }
1790                 }
1791             }
1792             var pageName = this.getPageName(index);
1793             //TODO: remove hardcoded instance name
1794             $('#GnuBookSearchResults').append('<li><b><a href="javascript:gb.jumpToIndex('+index+');">' + pageName + '</a></b> - ' + context + '</li>');
1795         }
1796     }
1797     $('#GnuBookSearchResults').append('</ul>');
1798
1799     this.updateSearchHilites();
1800 }
1801
1802 // updateSearchHilites()
1803 //______________________________________________________________________________
1804 GnuBook.prototype.updateSearchHilites = function() {
1805     if (2 == this.mode) {
1806         this.updateSearchHilites2UP();
1807     } else {
1808         this.updateSearchHilites1UP();
1809     }
1810 }
1811
1812 // showSearchHilites1UP()
1813 //______________________________________________________________________________
1814 GnuBook.prototype.updateSearchHilites1UP = function() {
1815
1816     for (var key in this.searchResults) {
1817
1818         if (-1 != jQuery.inArray(parseInt(key), this.displayedIndices)) {
1819             var result = this.searchResults[key];
1820             if(null == result.div) {
1821                 result.div = document.createElement('div');
1822                 $(result.div).attr('className', 'GnuBookSearchHilite').appendTo('#pagediv'+key);
1823                 //console.log('appending ' + key);
1824             }
1825             $(result.div).css({
1826                 width:  (result.r-result.l)/this.reduce + 'px',
1827                 height: (result.b-result.t)/this.reduce + 'px',
1828                 left:   (result.l)/this.reduce + 'px',
1829                 top:    (result.t)/this.reduce +'px'
1830             });
1831
1832         } else {
1833             //console.log(key + ' not displayed');
1834             this.searchResults[key].div=null;
1835         }
1836     }
1837 }
1838
1839 // XXX move, clean up, use everywhere
1840 GnuBook.prototype.twoPageGutter = function() {
1841     return this.twoPage.middle + this.gutterOffsetForIndex(this.twoPage.currentIndexL);
1842 }
1843
1844 // XXX move, clean up, use everywhere
1845 GnuBook.prototype.twoPageTop = function() {
1846     return this.twoPage.coverExternalPadding + this.twoPage.coverInternalPadding; // $$$ + border?
1847 }
1848
1849 GnuBook.prototype.twoPageCoverWidth = function(totalPageWidth) {
1850     return totalPageWidth + this.twoPage.edgeWidth + 2*this.twoPage.coverInternalPadding;
1851 }
1852
1853 // showSearchHilites2UP()
1854 //______________________________________________________________________________
1855 GnuBook.prototype.updateSearchHilites2UP = function() {
1856
1857     for (var key in this.searchResults) {
1858         key = parseInt(key, 10);
1859         if (-1 != jQuery.inArray(key, this.displayedIndices)) {
1860             var result = this.searchResults[key];
1861             if(null == result.div) {
1862                 result.div = document.createElement('div');
1863                 $(result.div).attr('className', 'GnuBookSearchHilite').css('zIndex', 3).appendTo('#GBtwopageview');
1864                 //console.log('appending ' + key);
1865             }
1866
1867             // We calculate the reduction factor for the specific page because it can be different
1868             // for each page in the spread
1869             var height = this.getPageHeight(key);
1870             var width  = this.getPageWidth(key)
1871             var reduce = this.twoPage.height/height;
1872             var scaledW = parseInt(width*reduce);
1873
1874             var gutter = this.twoPageGutter();
1875             var pageL;
1876             if ('L' == this.getPageSide(key)) {
1877                 pageL = gutter-scaledW;
1878             } else {
1879                 pageL = gutter;
1880             }
1881             var pageT  = this.twoPageTop();
1882
1883             $(result.div).css({
1884                 width:  (result.r-result.l)*reduce + 'px',
1885                 height: (result.b-result.t)*reduce + 'px',
1886                 left:   pageL+(result.l)*reduce + 'px',
1887                 top:    pageT+(result.t)*reduce +'px'
1888             });
1889
1890         } else {
1891             //console.log(key + ' not displayed');
1892             if (null != this.searchResults[key].div) {
1893                 //console.log('removing ' + key);
1894                 $(this.searchResults[key].div).remove();
1895             }
1896             this.searchResults[key].div=null;
1897         }
1898     }
1899 }
1900
1901 // removeSearchHilites()
1902 //______________________________________________________________________________
1903 GnuBook.prototype.removeSearchHilites = function() {
1904     for (var key in this.searchResults) {
1905         if (null != this.searchResults[key].div) {
1906             $(this.searchResults[key].div).remove();
1907             this.searchResults[key].div=null;
1908         }
1909     }
1910 }
1911
1912 // showEmbedCode()
1913 //______________________________________________________________________________
1914 GnuBook.prototype.showEmbedCode = function() {
1915     if (null != this.embedPopup) { // check if already showing
1916         return;
1917     }
1918     this.autoStop();
1919     this.embedPopup = document.createElement("div");
1920     $(this.embedPopup).css({
1921         position: 'absolute',
1922         top:      '20px',
1923         left:     ($('#GBcontainer').attr('clientWidth')-400)/2 + 'px',
1924         width:    '400px',
1925         padding:  "20px",
1926         border:   "3px double #999999",
1927         zIndex:   3,
1928         backgroundColor: "#fff"
1929     }).appendTo('#GnuBook');
1930
1931     htmlStr =  '<p style="text-align:center;"><b>Embed Bookreader in your blog!</b></p>';
1932     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>';
1933     htmlStr += '<p>Embed Code: <input type="text" size="40" value="' + this.getEmbedCode() + '"></p>';
1934     htmlStr += '<p style="text-align:center;"><a href="" onclick="gb.embedPopup = null; $(this.parentNode.parentNode).remove(); return false">Close popup</a></p>';
1935
1936     this.embedPopup.innerHTML = htmlStr;
1937     $(this.embedPopup).find('input').bind('click', function() {
1938         this.select();
1939     })
1940 }
1941
1942 // autoToggle()
1943 //______________________________________________________________________________
1944 GnuBook.prototype.autoToggle = function() {
1945
1946     var bComingFrom1up = false;
1947     if (2 != this.mode) {
1948         bComingFrom1up = true;
1949         this.switchMode(2);
1950     }
1951
1952     var self = this;
1953     if (null == this.autoTimer) {
1954         this.flipSpeed = 2000;
1955
1956         // $$$ Draw events currently cause layout problems when they occur during animation.
1957         //     There is a specific problem when changing from 1-up immediately to autoplay in RTL so
1958         //     we workaround for now by not triggering immediate animation in that case.
1959         //     See https://bugs.launchpad.net/gnubook/+bug/328327
1960         if (('rl' == this.pageProgression) && bComingFrom1up) {
1961             // don't flip immediately -- wait until timer fires
1962         } else {
1963             // flip immediately
1964             this.flipFwdToIndex();
1965         }
1966
1967         $('#GBtoolbar .play').hide();
1968         $('#GBtoolbar .pause').show();
1969         this.autoTimer=setInterval(function(){
1970             if (self.animating) {return;}
1971
1972             if (Math.max(self.twoPage.currentIndexL, self.twoPage.currentIndexR) >= self.lastDisplayableIndex()) {
1973                 self.flipBackToIndex(1); // $$$ really what we want?
1974             } else {
1975                 self.flipFwdToIndex();
1976             }
1977         },5000);
1978     } else {
1979         this.autoStop();
1980     }
1981 }
1982
1983 // autoStop()
1984 //______________________________________________________________________________
1985 GnuBook.prototype.autoStop = function() {
1986     if (null != this.autoTimer) {
1987         clearInterval(this.autoTimer);
1988         this.flipSpeed = 'fast';
1989         $('#GBtoolbar .pause').hide();
1990         $('#GBtoolbar .play').show();
1991         this.autoTimer = null;
1992     }
1993 }
1994
1995 // keyboardNavigationIsDisabled(event)
1996 //   - returns true if keyboard navigation should be disabled for the event
1997 //______________________________________________________________________________
1998 GnuBook.prototype.keyboardNavigationIsDisabled = function(event) {
1999     if (event.target.tagName == "INPUT") {
2000         return true;
2001     }
2002     return false;
2003 }
2004
2005 // gutterOffsetForIndex
2006 //______________________________________________________________________________
2007 //
2008 // Returns the gutter offset for the spread containing the given index.
2009 // This function supports RTL
2010 GnuBook.prototype.gutterOffsetForIndex = function(pindex) {
2011
2012     // To find the offset of the gutter from the middle we calculate our percentage distance
2013     // through the book (0..1), remap to (-0.5..0.5) and multiply by the total page edge width
2014     var offset = parseInt(((pindex / this.numLeafs) - 0.5) * this.twoPage.edgeWidth);
2015
2016     // But then again for RTL it's the opposite
2017     if ('rl' == this.pageProgression) {
2018         offset = -offset;
2019     }
2020
2021     return offset;
2022 }
2023
2024 // leafEdgeWidth
2025 //______________________________________________________________________________
2026 // Returns the width of the leaf edge div for the page with index given
2027 GnuBook.prototype.leafEdgeWidth = function(pindex) {
2028     // $$$ could there be single pixel rounding errors for L vs R?
2029     if ((this.getPageSide(pindex) == 'L') && (this.pageProgression != 'rl')) {
2030         return parseInt( (pindex/this.numLeafs) * this.twoPage.edgeWidth + 0.5);
2031     } else {
2032         return parseInt( (1 - pindex/this.numLeafs) * this.twoPage.edgeWidth + 0.5);
2033     }
2034 }
2035
2036 // jumpIndexForLeftEdgePageX
2037 //______________________________________________________________________________
2038 // Returns the target jump leaf given a page coordinate (inside the left page edge div)
2039 GnuBook.prototype.jumpIndexForLeftEdgePageX = function(pageX) {
2040     if ('rl' != this.pageProgression) {
2041         // LTR - flipping backward
2042         var jumpIndex = this.twoPage.currentIndexL - ($(this.leafEdgeL).offset().left + $(this.leafEdgeL).width() - pageX) * 10;
2043
2044         // browser may have resized the div due to font size change -- see https://bugs.launchpad.net/gnubook/+bug/333570
2045         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.firstDisplayableIndex(), this.twoPage.currentIndexL - 2);
2046         return jumpIndex;
2047
2048     } else {
2049         var jumpIndex = this.twoPage.currentIndexL + ($(this.leafEdgeL).offset().left + $(this.leafEdgeL).width() - pageX) * 10;
2050         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.twoPage.currentIndexL + 2, this.lastDisplayableIndex());
2051         return jumpIndex;
2052     }
2053 }
2054
2055 // jumpIndexForRightEdgePageX
2056 //______________________________________________________________________________
2057 // Returns the target jump leaf given a page coordinate (inside the right page edge div)
2058 GnuBook.prototype.jumpIndexForRightEdgePageX = function(pageX) {
2059     if ('rl' != this.pageProgression) {
2060         // LTR
2061         var jumpIndex = this.twoPage.currentIndexR + (pageX - $(this.leafEdgeR).offset().left) * 10;
2062         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.twoPage.currentIndexR + 2, this.lastDisplayableIndex());
2063         return jumpIndex;
2064     } else {
2065         var jumpIndex = this.twoPage.currentIndexR - (pageX - $(this.leafEdgeR).offset().left) * 10;
2066         jumpIndex = GnuBook.util.clamp(Math.round(jumpIndex), this.firstDisplayableIndex(), this.twoPage.currentIndexR - 2);
2067         return jumpIndex;
2068     }
2069 }
2070
2071 GnuBook.prototype.initToolbar = function(mode, ui) {
2072
2073     $("#GnuBook").append("<div id='GBtoolbar'><span style='float:left;'>"
2074         + "<a class='GBicon logo rollover' href='" + this.logoURL + "'>&nbsp;</a>"
2075         + " <button class='GBicon rollover zoom_out' onclick='gb.zoom(-1); return false;'/>"
2076         + "<button class='GBicon rollover zoom_in' onclick='gb.zoom(1); return false;'/>"
2077         + " <span class='label'>Zoom: <span id='GBzoom'>"+parseInt(100/this.reduce)+"</span>%</span>"
2078         + " <button class='GBicon rollover one_page_mode' onclick='gb.switchMode(1); return false;'/>"
2079         + " <button class='GBicon rollover two_page_mode' onclick='gb.switchMode(2); return false;'/>"
2080         + "&nbsp;&nbsp;<a class='GBblack title' href='"+this.bookUrl+"' target='_blank'>"+this.shortTitle(50)+"</a>"
2081         + "</span></div>");
2082
2083     if (ui == "embed") {
2084         $("#GnuBook a.logo").attr("target","_blank");
2085     }
2086
2087     // $$$ turn this into a member variable
2088     var jToolbar = $('#GBtoolbar'); // j prefix indicates jQuery object
2089
2090     // We build in mode 2
2091     jToolbar.append("<span id='GBtoolbarbuttons' style='float: right'>"
2092         + "<button class='GBicon rollover embed' />"
2093         + "<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>"
2094         + "<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>"
2095         + "<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>"
2096         + "<button class='GBicon rollover play' /><button class='GBicon rollover pause' style='display: none' /></span>");
2097
2098     this.bindToolbarNavHandlers(jToolbar);
2099
2100     // Setup tooltips -- later we could load these from a file for i18n
2101     var titles = { '.logo': 'Go to Archive.org',
2102                    '.zoom_in': 'Zoom in',
2103                    '.zoom_out': 'Zoom out',
2104                    '.one_page_mode': 'One-page view',
2105                    '.two_page_mode': 'Two-page view',
2106                    '.embed': 'Embed bookreader',
2107                    '.book_left': 'Flip left',
2108                    '.book_right': 'Flip right',
2109                    '.book_up': 'Page up',
2110                    '.book_down': 'Page down',
2111                    '.play': 'Play',
2112                    '.pause': 'Pause',
2113                    '.book_top': 'First page',
2114                    '.book_bottom': 'Last page'
2115                   };
2116     if ('rl' == this.pageProgression) {
2117         titles['.book_leftmost'] = 'Last page';
2118         titles['.book_rightmost'] = 'First page';
2119     } else { // LTR
2120         titles['.book_leftmost'] = 'First page';
2121         titles['.book_rightmost'] = 'Last page';
2122     }
2123
2124     for (var icon in titles) {
2125         jToolbar.find(icon).attr('title', titles[icon]);
2126     }
2127
2128     // Hide mode buttons and autoplay if 2up is not available
2129     // $$$ if we end up with more than two modes we should show the applicable buttons
2130     if ( !this.canSwitchToMode(this.constMode2up) ) {
2131         jToolbar.find('.one_page_mode, .two_page_mode, .play, .pause').hide();
2132     }
2133
2134     // Switch to requested mode -- binds other click handlers
2135     this.switchToolbarMode(mode);
2136
2137 }
2138
2139
2140 // switchToolbarMode
2141 //______________________________________________________________________________
2142 // Update the toolbar for the given mode (changes navigation buttons)
2143 // $$$ we should soon split the toolbar out into its own module
2144 GnuBook.prototype.switchToolbarMode = function(mode) {
2145     if (1 == mode) {
2146         // 1-up
2147         $('#GBtoolbar .GBtoolbarmode2').hide();
2148         $('#GBtoolbar .GBtoolbarmode1').show().css('display', 'inline');
2149     } else {
2150         // 2-up
2151         $('#GBtoolbar .GBtoolbarmode1').hide();
2152         $('#GBtoolbar .GBtoolbarmode2').show().css('display', 'inline');
2153     }
2154 }
2155
2156 // bindToolbarNavHandlers
2157 //______________________________________________________________________________
2158 // Binds the toolbar handlers
2159 GnuBook.prototype.bindToolbarNavHandlers = function(jToolbar) {
2160
2161     jToolbar.find('.book_left').bind('click', function(e) {
2162         gb.left();
2163         return false;
2164     });
2165
2166     jToolbar.find('.book_right').bind('click', function(e) {
2167         gb.right();
2168         return false;
2169     });
2170
2171     jToolbar.find('.book_up').bind('click', function(e) {
2172         gb.prev();
2173         return false;
2174     });
2175
2176     jToolbar.find('.book_down').bind('click', function(e) {
2177         gb.next();
2178         return false;
2179     });
2180
2181     jToolbar.find('.embed').bind('click', function(e) {
2182         gb.showEmbedCode();
2183         return false;
2184     });
2185
2186     jToolbar.find('.play').bind('click', function(e) {
2187         gb.autoToggle();
2188         return false;
2189     });
2190
2191     jToolbar.find('.pause').bind('click', function(e) {
2192         gb.autoToggle();
2193         return false;
2194     });
2195
2196     jToolbar.find('.book_top').bind('click', function(e) {
2197         gb.first();
2198         return false;
2199     });
2200
2201     jToolbar.find('.book_bottom').bind('click', function(e) {
2202         gb.last();
2203         return false;
2204     });
2205
2206     jToolbar.find('.book_leftmost').bind('click', function(e) {
2207         gb.leftmost();
2208         return false;
2209     });
2210
2211     jToolbar.find('.book_rightmost').bind('click', function(e) {
2212         gb.rightmost();
2213         return false;
2214     });
2215 }
2216
2217 // updateToolbarZoom(reduce)
2218 //______________________________________________________________________________
2219 // Update the displayed zoom factor based on reduction factor
2220 GnuBook.prototype.updateToolbarZoom = function(reduce) {
2221     // $$$ TODO: Move toolbar to it's own object/plugin
2222     $('#GBzoom').text(parseInt(100/reduce));
2223 }
2224
2225 // firstDisplayableIndex
2226 //______________________________________________________________________________
2227 // Returns the index of the first visible page, dependent on the mode.
2228 // $$$ Currently we cannot display the front/back cover in 2-up and will need to update
2229 // this function when we can as part of https://bugs.launchpad.net/gnubook/+bug/296788
2230 GnuBook.prototype.firstDisplayableIndex = function() {
2231     if (this.mode == 0) {
2232         return 0;
2233     } else {
2234         return 1; // $$$ we assume there are enough pages... we need logic for very short books
2235     }
2236 }
2237
2238 // lastDisplayableIndex
2239 //______________________________________________________________________________
2240 // Returns the index of the last visible page, dependent on the mode.
2241 // $$$ Currently we cannot display the front/back cover in 2-up and will need to update
2242 // this function when we can as pa  rt of https://bugs.launchpad.net/gnubook/+bug/296788
2243 GnuBook.prototype.lastDisplayableIndex = function() {
2244     if (this.mode == 2) {
2245         if (this.lastDisplayableIndex2up === null) {
2246             // Calculate and cache
2247             var candidate = this.numLeafs - 1;
2248             for ( ; candidate >= 0; candidate--) {
2249                 var spreadIndices = this.getSpreadIndices(candidate);
2250                 if (Math.max(spreadIndices[0], spreadIndices[1]) < (this.numLeafs - 1)) {
2251                     break;
2252                 }
2253             }
2254             this.lastDisplayableIndex2up = candidate;
2255         }
2256         return this.lastDisplayableIndex2up;
2257     } else {
2258         return this.numLeafs - 1;
2259     }
2260 }
2261
2262 // shortTitle(maximumCharacters)
2263 //________
2264 // Returns a shortened version of the title with the maximum number of characters
2265 GnuBook.prototype.shortTitle = function(maximumCharacters) {
2266     if (this.bookTitle.length < maximumCharacters) {
2267         return this.bookTitle;
2268     }
2269
2270     var title = this.bookTitle.substr(0, maximumCharacters - 3);
2271     title += '...';
2272     return title;
2273 }
2274
2275
2276
2277 // Parameter related functions
2278
2279 // updateFromParams(params)
2280 //________
2281 // Update ourselves from the params object.
2282 //
2283 // e.g. this.updateFromParams(this.paramsFromFragment(window.location.hash))
2284 GnuBook.prototype.updateFromParams = function(params) {
2285     if ('undefined' != typeof(params.mode)) {
2286         this.switchMode(params.mode);
2287     }
2288
2289     // $$$ process /search
2290     // $$$ process /zoom
2291
2292     // We only respect page if index is not set
2293     if ('undefined' != typeof(params.index)) {
2294         if (params.index != this.currentIndex()) {
2295             this.jumpToIndex(params.index);
2296         }
2297     } else if ('undefined' != typeof(params.page)) {
2298         // $$$ this assumes page numbers are unique
2299         if (params.page != this.getPageNum(this.currentIndex())) {
2300             this.jumpToPage(params.page);
2301         }
2302     }
2303
2304     // $$$ process /region
2305     // $$$ process /highlight
2306 }
2307
2308 // paramsFromFragment(urlFragment)
2309 //________
2310 // Returns a object with configuration parametes from a URL fragment.
2311 //
2312 // E.g paramsFromFragment(window.location.hash)
2313 GnuBook.prototype.paramsFromFragment = function(urlFragment) {
2314     // URL fragment syntax specification: http://openlibrary.org/dev/docs/bookurls
2315
2316     var params = {};
2317
2318     // For convenience we allow an initial # character (as from window.location.hash)
2319     // but don't require it
2320     if (urlFragment.substr(0,1) == '#') {
2321         urlFragment = urlFragment.substr(1);
2322     }
2323
2324     // Simple #nn syntax
2325     var oldStyleLeafNum = parseInt( /^\d+$/.exec(urlFragment) );
2326     if ( !isNaN(oldStyleLeafNum) ) {
2327         params.index = oldStyleLeafNum;
2328
2329         // Done processing if using old-style syntax
2330         return params;
2331     }
2332
2333     // Split into key-value pairs
2334     var urlArray = urlFragment.split('/');
2335     var urlHash = {};
2336     for (var i = 0; i < urlArray.length; i += 2) {
2337         urlHash[urlArray[i]] = urlArray[i+1];
2338     }
2339
2340     // Mode
2341     if ('1up' == urlHash['mode']) {
2342         params.mode = this.constMode1up;
2343     } else if ('2up' == urlHash['mode']) {
2344         params.mode = this.constMode2up;
2345     }
2346
2347     // Index and page
2348     if ('undefined' != typeof(urlHash['page'])) {
2349         // page was set -- may not be int
2350         params.page = urlHash['page'];
2351     }
2352
2353     // $$$ process /region
2354     // $$$ process /search
2355     // $$$ process /highlight
2356
2357     return params;
2358 }
2359
2360 // paramsFromCurrent()
2361 //________
2362 // Create a params object from the current parameters.
2363 GnuBook.prototype.paramsFromCurrent = function() {
2364
2365     var params = {};
2366
2367     var pageNum = this.getPageNum(this.currentIndex());
2368     if ((pageNum === 0) || pageNum) {
2369         params.page = pageNum;
2370     }
2371
2372     params.index = this.currentIndex();
2373     params.mode = this.mode;
2374
2375     // $$$ highlight
2376     // $$$ region
2377     // $$$ search
2378
2379     return params;
2380 }
2381
2382 // fragmentFromParams(params)
2383 //________
2384 // Create a fragment string from the params object.
2385 // See http://openlibrary.org/dev/docs/bookurls for an explanation of the fragment syntax.
2386 GnuBook.prototype.fragmentFromParams = function(params) {
2387     var separator = '/';
2388
2389     var fragments = [];
2390
2391     if ('undefined' != typeof(params.page)) {
2392         fragments.push('page', params.page);
2393     } else {
2394         // Don't have page numbering -- use index instead
2395         fragments.push('page', 'n' + params.index);
2396     }
2397
2398     // $$$ highlight
2399     // $$$ region
2400     // $$$ search
2401
2402     // mode
2403     if ('undefined' != typeof(params.mode)) {
2404         if (params.mode == this.constMode1up) {
2405             fragments.push('mode', '1up');
2406         } else if (params.mode == this.constMode2up) {
2407             fragments.push('mode', '2up');
2408         } else {
2409             throw 'fragmentFromParams called with unknown mode ' + params.mode;
2410         }
2411     }
2412
2413     return fragments.join(separator);
2414 }
2415
2416 // getPageIndex(pageNum)
2417 //________
2418 // Returns the *highest* index the given page number, or undefined
2419 GnuBook.prototype.getPageIndex = function(pageNum) {
2420     var pageIndices = this.getPageIndices(pageNum);
2421
2422     if (pageIndices.length > 0) {
2423         return pageIndices[pageIndices.length - 1];
2424     }
2425
2426     return undefined;
2427 }
2428
2429 // getPageIndices(pageNum)
2430 //________
2431 // Returns an array (possibly empty) of the indices with the given page number
2432 GnuBook.prototype.getPageIndices = function(pageNum) {
2433     var indices = [];
2434
2435     // Check for special "nXX" page number
2436     if (pageNum.slice(0,1) == 'n') {
2437         try {
2438             var pageIntStr = pageNum.slice(1, pageNum.length);
2439             var pageIndex = parseInt(pageIntStr);
2440             indices.append(pageIndex);
2441             return indices;
2442         } catch(err) {
2443             // Do nothing... will run through page names and see if one matches
2444         }
2445     }
2446
2447     var i;
2448     for (i=0; i<this.numLeafs; i++) {
2449         if (this.getPageNum(i) == pageNum) {
2450             indices.push(i);
2451         }
2452     }
2453
2454     return indices;
2455 }
2456
2457 // getPageName(index)
2458 //________
2459 // Returns the name of the page as it should be displayed in the user interface
2460 GnuBook.prototype.getPageName = function(index) {
2461     return 'Page ' + this.getPageNum(index);
2462 }
2463
2464 // updateLocationHash
2465 //________
2466 // Update the location hash from the current parameters.  Call this instead of manually
2467 // using window.location.replace
2468 GnuBook.prototype.updateLocationHash = function() {
2469     var newHash = '#' + this.fragmentFromParams(this.paramsFromCurrent());
2470     window.location.replace(newHash);
2471
2472     // This is the variable checked in the timer.  Only user-generated changes
2473     // to the URL will trigger the event.
2474     this.oldLocationHash = newHash;
2475 }
2476
2477 // startLocationPolling
2478 //________
2479 // Starts polling of window.location to see hash fragment changes
2480 GnuBook.prototype.startLocationPolling = function() {
2481     var self = this; // remember who I am
2482     self.oldLocationHash = window.location.hash;
2483
2484     if (this.locationPollId) {
2485         clearInterval(this.locationPollID);
2486         this.locationPollId = null;
2487     }
2488
2489     this.locationPollId = setInterval(function() {
2490         var newHash = window.location.hash;
2491         if (newHash != self.oldLocationHash) {
2492             if (newHash != self.oldUserHash) { // Only process new user hash once
2493                 //console.log('url change detected ' + self.oldLocationHash + " -> " + newHash);
2494
2495                 // Queue change if animating
2496                 if (self.animating) {
2497                     self.autoStop();
2498                     self.animationFinishedCallback = function() {
2499                         self.updateFromParams(self.paramsFromFragment(newHash));
2500                     }
2501                 } else { // update immediately
2502                     self.updateFromParams(self.paramsFromFragment(newHash));
2503                 }
2504                 self.oldUserHash = newHash;
2505             }
2506         }
2507     }, 500);
2508 }
2509
2510 // getEmbedURL
2511 //________
2512 // Returns a URL for an embedded version of the current book
2513 GnuBook.prototype.getEmbedURL = function() {
2514     // We could generate a URL hash fragment here but for now we just leave at defaults
2515     return 'http://' + window.location.host + '/stream/'+this.bookId + '?ui=embed';
2516 }
2517
2518 // getEmbedCode
2519 //________
2520 // Returns the embed code HTML fragment suitable for copy and paste
2521 GnuBook.prototype.getEmbedCode = function() {
2522     return "<iframe src='" + this.getEmbedURL() + "' width='480px' height='430px'></iframe>";
2523 }
2524
2525 // canSwitchToMode
2526 //________
2527 // Returns true if we can switch to the requested mode
2528 GnuBook.prototype.canSwitchToMode = function(mode) {
2529     if (mode == this.constMode2up) {
2530         // check there are enough pages to display
2531         // $$$ this is a workaround for the mis-feature that we can't display
2532         //     short books in 2up mode
2533         if (this.numLeafs < 6) {
2534             return false;
2535         }
2536     }
2537
2538     return true;
2539 }
2540
2541 // Library functions
2542 GnuBook.util = {
2543     clamp: function(value, min, max) {
2544         return Math.min(Math.max(value, min), max);
2545     }
2546 }