When zoomed in, scroll up/down such that a percentage of the current page is still...
[bookreader.git] / BookReader / BookReader.js
1 /*
2 Copyright(c)2008-2009 Internet Archive. Software license AGPL version 3.
3
4 This file is part of BookReader.
5
6     BookReader 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     BookReader 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 BookReader.  If not, see <http://www.gnu.org/licenses/>.
18     
19     The BookReader 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 // BookReader()
25 //______________________________________________________________________________
26 // After you instantiate this object, you must supply the following
27 // book-specific functions, before calling init().  Some of these functions
28 // can just be stubs for simple books.
29 //  - getPageWidth()
30 //  - getPageHeight()
31 //  - getPageURI()
32 //  - getPageSide()
33 //  - canRotatePage()
34 //  - getPageNum()
35 //  - getSpreadIndices()
36 // You must also add a numLeafs property before calling init().
37
38 function BookReader() {
39     this.reduce  = 4;
40     this.padding = 10;
41     this.mode    = 1; //1, 2, 3
42     this.ui = 'full'; // UI mode
43
44     // thumbnail mode
45     this.thumbWidth = 100; // will be overridden during prepareThumbnailView
46     this.thumbRowBuffer = 2; // number of rows to pre-cache out a view
47     this.thumbColumns = 6; // default
48     this.thumbMaxLoading = 4; // number of thumbnails to load at once
49     this.displayedRows=[];
50     
51     this.displayedIndices = [];
52     //this.indicesToDisplay = [];
53     this.imgs = {};
54     this.prefetchedImgs = {}; //an object with numeric keys cooresponding to page index
55     
56     this.timer     = null;
57     this.animating = false;
58     this.auto      = false;
59     this.autoTimer = null;
60     this.flipSpeed = 'fast';
61
62     this.twoPagePopUp = null;
63     this.leafEdgeTmp  = null;
64     this.embedPopup = null;
65     this.printPopup = null;
66     
67     this.searchTerm = '';
68     this.searchResults = {};
69     
70     this.firstIndex = null;
71     
72     this.lastDisplayableIndex2up = null;
73     
74     // We link to index.php to avoid redirect which breaks back button
75     this.logoURL = 'http://www.archive.org/index.php';
76     
77     // Base URL for images
78     this.imagesBaseURL = '/bookreader/images/';
79     
80     // Mode constants
81     this.constMode1up = 1;
82     this.constMode2up = 2;
83     this.constModeThumb = 3;
84     
85     // Zoom levels
86     // $$$ provide finer grained zooming
87     this.reductionFactors = [ {reduce: 0.5, autofit: null},
88                               {reduce: 1, autofit: null},
89                               {reduce: 2, autofit: null},
90                               {reduce: 4, autofit: null},
91                               {reduce: 8, autofit: null},
92                               {reduce: 16, autofit: null} ];
93
94     // Object to hold parameters related to 1up mode
95     this.onePage = {
96         autofit: 'height'                                     // valid values are height, width, none
97     },
98     
99     // Object to hold parameters related to 2up mode
100     this.twoPage = {
101         coverInternalPadding: 10, // Width of cover
102         coverExternalPadding: 10, // Padding outside of cover
103         bookSpineDivWidth: 30,    // Width of book spine  $$$ consider sizing based on book length
104         autofit: 'auto',
105     };
106     
107     // Background color for pages (e.g. when loading page image)
108     // $$$ TODO dynamically calculate based on page images
109     this.pageDefaultBackgroundColor = 'rgb(234, 226, 205)';
110     
111     return this;
112 };
113
114 // init()
115 //______________________________________________________________________________
116 BookReader.prototype.init = function() {
117
118     var startIndex = undefined;
119     this.pageScale = this.reduce; // preserve current reduce
120     
121     // Find start index and mode if set in location hash
122     var params = this.paramsFromFragment(window.location.hash);
123         
124     if ('undefined' != typeof(params.index)) {
125         startIndex = params.index;
126     } else if ('undefined' != typeof(params.page)) {
127         startIndex = this.getPageIndex(params.page);
128     }
129     
130     if ('undefined' == typeof(startIndex)) {
131         if ('undefined' != typeof(this.titleLeaf)) {
132             startIndex = this.leafNumToIndex(this.titleLeaf);
133         }
134     }
135     
136     if ('undefined' == typeof(startIndex)) {
137         startIndex = 0;
138     }
139     
140     if ('undefined' != typeof(params.mode)) {
141         this.mode = params.mode;
142     }
143     
144     // Set document title -- may have already been set in enclosing html for
145     // search engine visibility
146     document.title = this.shortTitle(50);
147     
148     // Sanitize parameters
149     if ( !this.canSwitchToMode( this.mode ) ) {
150         this.mode = this.constMode1up;
151     }
152     
153     $("#BookReader").empty();
154         
155     this.initToolbar(this.mode, this.ui); // Build inside of toolbar div
156     $("#BookReader").append("<div id='BRcontainer'></div>");
157     $("#BRcontainer").append("<div id='BRpageview'></div>");
158
159     $("#BRcontainer").bind('scroll', this, function(e) {
160         e.data.loadLeafs();
161     });
162         
163     this.setupKeyListeners();
164     this.startLocationPolling();
165
166     $(window).bind('resize', this, function(e) {
167         //console.log('resize!');
168         if (1 == e.data.mode) {
169             //console.log('centering 1page view');
170             if (e.data.autofit) {
171                 e.data.resizePageView();
172             }
173             e.data.centerPageView();
174             $('#BRpageview').empty()
175             e.data.displayedIndices = [];
176             e.data.updateSearchHilites(); //deletes hilights but does not call remove()            
177             e.data.loadLeafs();
178         } else if (3 == e.data.mode){
179             e.data.prepareThumbnailView();
180         } else {
181             //console.log('drawing 2 page view');
182             
183             // We only need to prepare again in autofit (size of spread changes)
184             if (e.data.twoPage.autofit) {
185                 e.data.prepareTwoPageView();
186             } else {
187                 // Re-center if the scrollbars have disappeared
188                 var center = e.data.twoPageGetViewCenter();
189                 var doRecenter = false;
190                 if (e.data.twoPage.totalWidth < $('#BRcontainer').attr('clientWidth')) {
191                     center.percentageX = 0.5;
192                     doRecenter = true;
193                 }
194                 if (e.data.twoPage.totalHeight < $('#BRcontainer').attr('clientHeight')) {
195                     center.percentageY = 0.5;
196                     doRecenter = true;
197                 }
198                 if (doRecenter) {
199                     e.data.twoPageCenterView(center.percentageX, center.percentageY);
200                 }
201             }
202         }
203     });
204     
205     $('.BRpagediv1up').bind('mousedown', this, function(e) {
206         // $$$ the purpose of this is to disable selection of the image (makes it turn blue)
207         //     but this also interferes with right-click.  See https://bugs.edge.launchpad.net/gnubook/+bug/362626
208         return false;
209     });
210
211     // $$$ refactor this so it's enough to set the first index and call preparePageView
212     //     (get rid of mode-specific logic at this point)
213     if (1 == this.mode) {
214         this.firstIndex = startIndex;
215         this.prepareOnePageView();
216         this.jumpToIndex(startIndex);
217     } else if (3 == this.mode) {
218         this.firstIndex = startIndex;
219         this.prepareThumbnailView();
220         this.jumpToIndex(startIndex);
221     } else {
222         //this.resizePageView();
223         
224         this.displayedIndices=[0];
225         this.firstIndex = startIndex;
226         this.displayedIndices = [this.firstIndex];
227         //console.log('titleLeaf: %d', this.titleLeaf);
228         //console.log('displayedIndices: %s', this.displayedIndices);
229         this.prepareTwoPageView();
230     }
231         
232     // Enact other parts of initial params
233     this.updateFromParams(params);
234 }
235
236 BookReader.prototype.setupKeyListeners = function() {
237     var self = this;
238     
239     var KEY_PGUP = 33;
240     var KEY_PGDOWN = 34;
241     var KEY_END = 35;
242     var KEY_HOME = 36;
243
244     var KEY_LEFT = 37;
245     var KEY_UP = 38;
246     var KEY_RIGHT = 39;
247     var KEY_DOWN = 40;
248
249     // We use document here instead of window to avoid a bug in jQuery on IE7
250     $(document).keydown(function(e) {
251     
252         // Keyboard navigation        
253         if (!self.keyboardNavigationIsDisabled(e)) {
254             switch(e.keyCode) {
255                 case KEY_PGUP:
256                 case KEY_UP:            
257                     // In 1up mode page scrolling is handled by browser
258                     if (2 == self.mode) {
259                         e.preventDefault();
260                         self.prev();
261                     }
262                     break;
263                 case KEY_DOWN:
264                 case KEY_PGDOWN:
265                     if (2 == self.mode) {
266                         e.preventDefault();
267                         self.next();
268                     }
269                     break;
270                 case KEY_END:
271                     e.preventDefault();
272                     self.last();
273                     break;
274                 case KEY_HOME:
275                     e.preventDefault();
276                     self.first();
277                     break;
278                 case KEY_LEFT:
279                     if (2 == self.mode) {
280                         e.preventDefault();
281                         self.left();
282                     }
283                     break;
284                 case KEY_RIGHT:
285                     if (2 == self.mode) {
286                         e.preventDefault();
287                         self.right();
288                     }
289                     break;
290             }
291         }
292     });
293 }
294
295 // drawLeafs()
296 //______________________________________________________________________________
297 BookReader.prototype.drawLeafs = function() {
298     if (1 == this.mode) {
299         this.drawLeafsOnePage();
300     } else if (3 == this.mode) {
301         this.drawLeafsThumbnail();
302     } else {
303         this.drawLeafsTwoPage();
304     }
305     
306 }
307
308 // bindGestures(jElement)
309 //______________________________________________________________________________
310 BookReader.prototype.bindGestures = function(jElement) {
311
312     jElement.unbind('gesturechange').bind('gesturechange', function(e) {
313         e.preventDefault();
314         if (e.originalEvent.scale > 1.5) {
315             br.zoom(1);
316         } else if (e.originalEvent.scale < 0.6) {
317             br.zoom(-1);
318         }
319     });
320         
321 }
322
323 BookReader.prototype.setClickHandler2UP = function( element, data, handler) {
324     //console.log('setting handler');
325     //console.log(element.tagName);
326     
327     $(element).unbind('tap').bind('tap', data, function(e) {
328         handler(e);
329     });
330 }
331
332 // drawLeafsOnePage()
333 //______________________________________________________________________________
334 BookReader.prototype.drawLeafsOnePage = function() {
335     //alert('drawing leafs!');
336     this.timer = null;
337
338
339     var scrollTop = $('#BRcontainer').attr('scrollTop');
340     var scrollBottom = scrollTop + $('#BRcontainer').height();
341     //console.log('top=' + scrollTop + ' bottom='+scrollBottom);
342     
343     var indicesToDisplay = [];
344     
345     var i;
346     var leafTop = 0;
347     var leafBottom = 0;
348     for (i=0; i<this.numLeafs; i++) {
349         var height  = parseInt(this._getPageHeight(i)/this.reduce); 
350     
351         leafBottom += height;
352         //console.log('leafTop = '+leafTop+ ' pageH = ' + this.pageH[i] + 'leafTop>=scrollTop=' + (leafTop>=scrollTop));
353         var topInView    = (leafTop >= scrollTop) && (leafTop <= scrollBottom);
354         var bottomInView = (leafBottom >= scrollTop) && (leafBottom <= scrollBottom);
355         var middleInView = (leafTop <=scrollTop) && (leafBottom>=scrollBottom);
356         if (topInView | bottomInView | middleInView) {
357             //console.log('displayed: ' + this.displayedIndices);
358             //console.log('to display: ' + i);
359             indicesToDisplay.push(i);
360         }
361         leafTop += height +10;      
362         leafBottom += 10;
363     }
364     
365     var firstIndexToDraw  = indicesToDisplay[0];
366     this.firstIndex      = firstIndexToDraw;
367     
368     // Update hash, but only if we're currently displaying a leaf
369     // Hack that fixes #365790
370     if (this.displayedIndices.length > 0) {
371         this.updateLocationHash();
372     }
373
374     if ((0 != firstIndexToDraw) && (1 < this.reduce)) {
375         firstIndexToDraw--;
376         indicesToDisplay.unshift(firstIndexToDraw);
377     }
378     
379     var lastIndexToDraw = indicesToDisplay[indicesToDisplay.length-1];
380     if ( ((this.numLeafs-1) != lastIndexToDraw) && (1 < this.reduce) ) {
381         indicesToDisplay.push(lastIndexToDraw+1);
382     }
383     
384     leafTop = 0;
385     var i;
386     for (i=0; i<firstIndexToDraw; i++) {
387         leafTop += parseInt(this._getPageHeight(i)/this.reduce) +10;
388     }
389
390     //var viewWidth = $('#BRpageview').width(); //includes scroll bar width
391     var viewWidth = $('#BRcontainer').attr('scrollWidth');
392
393
394     for (i=0; i<indicesToDisplay.length; i++) {
395         var index = indicesToDisplay[i];    
396         var height  = parseInt(this._getPageHeight(index)/this.reduce); 
397
398         if (BookReader.util.notInArray(indicesToDisplay[i], this.displayedIndices)) {            
399             var width   = parseInt(this._getPageWidth(index)/this.reduce); 
400             //console.log("displaying leaf " + indicesToDisplay[i] + ' leafTop=' +leafTop);
401             var div = document.createElement("div");
402             div.className = 'BRpagediv1up';
403             div.id = 'pagediv'+index;
404             div.style.position = "absolute";
405             $(div).css('top', leafTop + 'px');
406             var left = (viewWidth-width)>>1;
407             if (left<0) left = 0;
408             $(div).css('left', left+'px');
409             $(div).css('width', width+'px');
410             $(div).css('height', height+'px');
411             //$(div).text('loading...');
412             
413             $('#BRpageview').append(div);
414
415             var img = document.createElement("img");
416             img.src = this._getPageURI(index, this.reduce, 0);
417             $(img).css('width', width+'px');
418             $(img).css('height', height+'px');
419             $(div).append(img);
420
421         } else {
422             //console.log("not displaying " + indicesToDisplay[i] + ' score=' + jQuery.inArray(indicesToDisplay[i], this.displayedIndices));            
423         }
424
425         leafTop += height +10;
426
427     }
428     
429     for (i=0; i<this.displayedIndices.length; i++) {
430         if (BookReader.util.notInArray(this.displayedIndices[i], indicesToDisplay)) {
431             var index = this.displayedIndices[i];
432             //console.log('Removing leaf ' + index);
433             //console.log('id='+'#pagediv'+index+ ' top = ' +$('#pagediv'+index).css('top'));
434             $('#pagediv'+index).remove();
435         } else {
436             //console.log('NOT Removing leaf ' + this.displayedIndices[i]);
437         }
438     }
439     
440     this.displayedIndices = indicesToDisplay.slice();
441     this.updateSearchHilites();
442     
443     if (null != this.getPageNum(firstIndexToDraw))  {
444         $("#BRpagenum").val(this.getPageNum(this.currentIndex()));
445     } else {
446         $("#BRpagenum").val('');
447     }
448             
449     this.updateToolbarZoom(this.reduce);
450     
451 }
452
453 // drawLeafsThumbnail()
454 //______________________________________________________________________________
455 // If seekIndex is defined, the view will be drawn with that page visible (without any
456 // animated scrolling)
457 BookReader.prototype.drawLeafsThumbnail = function( seekIndex ) {
458     //alert('drawing leafs!');
459     this.timer = null;
460     
461     var viewWidth = $('#BRcontainer').attr('scrollWidth') - 20; // width minus buffer
462
463     //console.log('top=' + scrollTop + ' bottom='+scrollBottom);
464
465     var i;
466     var leafWidth;
467     var leafHeight;
468     var rightPos = 0;
469     var bottomPos = 0;
470     var maxRight = 0;
471     var currentRow = 0;
472     var leafIndex = 0;
473     var leafMap = [];
474     
475     var self = this;
476     
477     // Will be set to top of requested seek index, if set
478     var seekTop;
479
480     // Calculate the position of every thumbnail.  $$$ cache instead of calculating on every draw
481     for (i=0; i<this.numLeafs; i++) {
482         leafWidth = this.thumbWidth;
483         if (rightPos + (leafWidth + this.padding) > viewWidth){
484             currentRow++;
485             rightPos = 0;
486             leafIndex = 0;
487         }
488
489         if (leafMap[currentRow]===undefined) { leafMap[currentRow] = {}; }
490         if (leafMap[currentRow].leafs===undefined) {
491             leafMap[currentRow].leafs = [];
492             leafMap[currentRow].height = 0;
493             leafMap[currentRow].top = 0;
494         }
495         leafMap[currentRow].leafs[leafIndex] = {};
496         leafMap[currentRow].leafs[leafIndex].num = i;
497         leafMap[currentRow].leafs[leafIndex].left = rightPos;
498
499         leafHeight = parseInt((this.getPageHeight(leafMap[currentRow].leafs[leafIndex].num)*this.thumbWidth)/this.getPageWidth(leafMap[currentRow].leafs[leafIndex].num), 10);
500         if (leafHeight > leafMap[currentRow].height) {
501             leafMap[currentRow].height = leafHeight;
502         }
503         if (leafIndex===0) { bottomPos += this.padding + leafMap[currentRow].height; }
504         rightPos += leafWidth + this.padding;
505         if (rightPos > maxRight) { maxRight = rightPos; }
506         leafIndex++;
507         
508         if (i == seekIndex) {
509             seekTop = bottomPos - this.padding - leafMap[currentRow].height;
510         }
511     }
512
513     // reset the bottom position based on thumbnails
514     $('#BRpageview').height(bottomPos);
515
516     var pageViewBuffer = Math.floor(($('#BRcontainer').attr('scrollWidth') - maxRight) / 2) - 14;
517
518     // If seekTop is defined, seeking was requested and target found
519     if (typeof(seekTop) != 'undefined') {
520         $('#BRcontainer').scrollTop( seekTop );
521     }
522         
523     var scrollTop = $('#BRcontainer').attr('scrollTop');
524     var scrollBottom = scrollTop + $('#BRcontainer').height();
525
526     var leafTop = 0;
527     var leafBottom = 0;
528     var rowsToDisplay = [];
529
530     // Visible leafs with least/greatest index
531     var leastVisible = this.numLeafs - 1;
532     var mostVisible = 0;
533     
534     // Determine the thumbnails in view
535     for (i=0; i<leafMap.length; i++) {
536         leafBottom += this.padding + leafMap[i].height;
537         var topInView    = (leafTop >= scrollTop) && (leafTop <= scrollBottom);
538         var bottomInView = (leafBottom >= scrollTop) && (leafBottom <= scrollBottom);
539         var middleInView = (leafTop <=scrollTop) && (leafBottom>=scrollBottom);
540         if (topInView | bottomInView | middleInView) {
541             //console.log('row to display: ' + j);
542             rowsToDisplay.push(i);
543             if (leafMap[i].leafs[0].num < leastVisible) {
544                 leastVisible = leafMap[i].leafs[0].num;
545             }
546             if (leafMap[i].leafs[leafMap[i].leafs.length - 1].num > mostVisible) {
547                 mostVisible = leafMap[i].leafs[leafMap[i].leafs.length - 1].num;
548             }
549         }
550         if (leafTop > leafMap[i].top) { leafMap[i].top = leafTop; }
551         leafTop = leafBottom;
552     }
553
554     // create a buffer of preloaded rows before and after the visible rows
555     var firstRow = rowsToDisplay[0];
556     var lastRow = rowsToDisplay[rowsToDisplay.length-1];
557     for (i=1; i<this.thumbRowBuffer+1; i++) {
558         if (lastRow+i < leafMap.length) { rowsToDisplay.push(lastRow+i); }
559     }
560     for (i=1; i<this.thumbRowBuffer+1; i++) {
561         if (firstRow-i >= 0) { rowsToDisplay.push(firstRow-i); }
562     }
563
564     // Create the thumbnail divs and images (lazy loaded)
565     var j;
566     var row;
567     var left;
568     var index;
569     var div;
570     var link;
571     var img;
572     var page;
573     for (i=0; i<rowsToDisplay.length; i++) {
574         if (BookReader.util.notInArray(rowsToDisplay[i], this.displayedRows)) {    
575             row = rowsToDisplay[i];
576
577             for (j=0; j<leafMap[row].leafs.length; j++) {
578                 index = j;
579                 leaf = leafMap[row].leafs[j].num;
580
581                 leafWidth = this.thumbWidth;
582                 leafHeight = parseInt((this.getPageHeight(leaf)*this.thumbWidth)/this.getPageWidth(leaf), 10);
583                 leafTop = leafMap[row].top;
584                 left = leafMap[row].leafs[index].left + pageViewBuffer;
585                 if ('rl' == this.pageProgression){
586                     left = viewWidth - leafWidth - left;
587                 }
588
589                 div = document.createElement("div");
590                 div.id = 'pagediv'+leaf;
591                 div.style.position = "absolute";
592                 div.className = "BRpagedivthumb";
593
594                 left += this.padding;
595                 $(div).css('top', leafTop + 'px');
596                 $(div).css('left', left+'px');
597                 $(div).css('width', leafWidth+'px');
598                 $(div).css('height', leafHeight+'px');
599                 //$(div).text('loading...');
600
601                 // link to page in single page mode
602                 link = document.createElement("a");
603                 $(link).data('leaf', leaf);
604                 $(link).bind('tap', function(event) {
605                     self.firstIndex = $(this).data('leaf');
606                     self.switchMode(self.constMode1up);
607                     event.preventDefault();
608                 });
609                 
610                 // $$$ we don't actually go to this URL (click is handled in handler above)
611                 link.href = '#page/' + (this.getPageNum(leaf)) +'/mode/1up' ;
612                 $(div).append(link);
613                 
614                 $('#BRpageview').append(div);
615
616                 img = document.createElement("img");
617                 var thumbReduce = Math.floor(this.getPageWidth(leaf) / this.thumbWidth);
618                 
619                 $(img).attr('src', this.imagesBaseURL + 'transparent.png')
620                     .css({'width': leafWidth+'px', 'height': leafHeight+'px' })
621                     .addClass('BRlazyload')
622                     // Store the URL of the image that will replace this one
623                     .data('srcURL',  this._getPageURI(leaf, thumbReduce));
624                 $(link).append(img);
625                 //console.log('displaying thumbnail: ' + leaf);
626             }   
627         }
628     }
629     
630     // Remove thumbnails that are not to be displayed
631     var k;
632     for (i=0; i<this.displayedRows.length; i++) {
633         if (BookReader.util.notInArray(this.displayedRows[i], rowsToDisplay)) {
634             row = this.displayedRows[i];
635             
636             // $$$ Safari doesn't like the comprehension
637             //var rowLeafs =  [leaf.num for each (leaf in leafMap[row].leafs)];
638             //console.log('Removing row ' + row + ' ' + rowLeafs);
639             
640             for (k=0; k<leafMap[row].leafs.length; k++) {
641                 index = leafMap[row].leafs[k].num;
642                 //console.log('Removing leaf ' + index);
643                 $('#pagediv'+index).remove();
644             }
645         } else {
646             /*
647             var mRow = this.displayedRows[i];
648             var mLeafs = '[' +  [leaf.num for each (leaf in leafMap[mRow].leafs)] + ']';
649             console.log('NOT Removing row ' + mRow + ' ' + mLeafs);
650             */
651         }
652     }
653     
654     // Update which page is considered current to make sure a visible page is the current one
655     var currentIndex = this.currentIndex();
656     // console.log('current ' + currentIndex);
657     // console.log('least visible ' + leastVisible + ' most visible ' + mostVisible);
658     if (currentIndex < leastVisible) {
659         this.setCurrentIndex(leastVisible);
660     } else if (currentIndex > mostVisible) {
661         this.setCurrentIndex(mostVisible);
662     }
663
664     this.displayedRows = rowsToDisplay.slice();
665     
666     // Update hash, but only if we're currently displaying a leaf
667     // Hack that fixes #365790
668     if (this.displayedRows.length > 0) {
669         this.updateLocationHash();
670     }
671
672     // remove previous highlights
673     $('.BRpagedivthumb_highlight').removeClass('BRpagedivthumb_highlight');
674     
675     // highlight current page
676     $('#pagediv'+this.currentIndex()).addClass('BRpagedivthumb_highlight');
677     
678     this.lazyLoadThumbnails();
679
680     // Update page number box.  $$$ refactor to function
681     if (null !== this.getPageNum(this.currentIndex()))  {
682         $("#BRpagenum").val(this.getPageNum(this.currentIndex()));
683     } else {
684         $("#BRpagenum").val('');
685     }
686
687     this.updateToolbarZoom(this.reduce); 
688 }
689
690 BookReader.prototype.lazyLoadThumbnails = function() {
691
692     // console.log('lazy load');
693
694     // We check the complete property since load may not be fired if loading from the cache
695     $('.BRlazyloading').filter('[complete=true]').removeClass('BRlazyloading');
696
697     var loading = $('.BRlazyloading').length;
698     var toLoad = this.thumbMaxLoading - loading;
699
700     // console.log('  ' + loading + ' thumbnails loading');
701     // console.log('  this.thumbMaxLoading ' + this.thumbMaxLoading);
702     
703     var self = this;
704         
705     if (toLoad > 0) {
706         // $$$ TODO load those near top (but not beyond) page view first
707         $('#BRpageview img.BRlazyload').filter(':lt(' + toLoad + ')').each( function() {
708             self.lazyLoadImage(this);
709         });
710     }
711 }
712
713 BookReader.prototype.lazyLoadImage = function (dummyImage) {
714     //console.log(' lazy load started for ' + $(dummyImage).data('srcURL').match('([0-9]{4}).jp2')[1] );
715         
716     var img = new Image();
717     var self = this;
718     
719     $(img)
720         .addClass('BRlazyloading')
721         .one('load', function() {
722             //if (console) { console.log(' onload ' + $(this).attr('src').match('([0-9]{4}).jp2')[1]); };
723             
724             $(this).removeClass('BRlazyloading');
725             
726             // $$$ Calling lazyLoadThumbnails here was causing stack overflow on IE so
727             //     we call the function after a slight delay.  Also the img.complete property
728             //     is not yet set in IE8 inside this onload handler
729             setTimeout(function() { self.lazyLoadThumbnails(); }, 100);
730         })
731         .one('error', function() {
732             // Remove class so we no longer count as loading
733             $(this).removeClass('BRlazyloading');
734         })
735         .attr( { width: $(dummyImage).width(),
736                    height: $(dummyImage).height(),
737                    src: $(dummyImage).data('srcURL')
738         });
739                  
740     // replace with the new img
741     $(dummyImage).before(img).remove();
742     
743     img = null; // tidy up closure
744 }
745
746
747 // drawLeafsTwoPage()
748 //______________________________________________________________________________
749 BookReader.prototype.drawLeafsTwoPage = function() {
750     var scrollTop = $('#BRtwopageview').attr('scrollTop');
751     var scrollBottom = scrollTop + $('#BRtwopageview').height();
752     
753     // $$$ we should use calculated values in this.twoPage (recalc if necessary)
754     
755     var indexL = this.twoPage.currentIndexL;
756         
757     var heightL  = this._getPageHeight(indexL); 
758     var widthL   = this._getPageWidth(indexL);
759
760     var leafEdgeWidthL = this.leafEdgeWidth(indexL);
761     var leafEdgeWidthR = this.twoPage.edgeWidth - leafEdgeWidthL;
762     //var bookCoverDivWidth = this.twoPage.width*2 + 20 + this.twoPage.edgeWidth; // $$$ hardcoded cover width
763     var bookCoverDivWidth = this.twoPage.bookCoverDivWidth;
764     //console.log(leafEdgeWidthL);
765
766     var middle = this.twoPage.middle; // $$$ getter instead?
767     var top = this.twoPageTop();
768     var bookCoverDivLeft = this.twoPage.bookCoverDivLeft;
769
770     this.twoPage.scaledWL = this.getPageWidth2UP(indexL);
771     this.twoPage.gutter = this.twoPageGutter();
772     
773     this.prefetchImg(indexL);
774     $(this.prefetchedImgs[indexL]).css({
775         position: 'absolute',
776         left: this.twoPage.gutter-this.twoPage.scaledWL+'px',
777         right: '',
778         top:    top+'px',
779         backgroundColor: this.getPageBackgroundColor(indexL),
780         height: this.twoPage.height +'px', // $$$ height forced the same for both pages
781         width:  this.twoPage.scaledWL + 'px',
782         borderRight: '1px solid black',
783         zIndex: 2
784     }).appendTo('#BRtwopageview');
785     
786     var indexR = this.twoPage.currentIndexR;
787     var heightR  = this._getPageHeight(indexR); 
788     var widthR   = this._getPageWidth(indexR);
789
790     // $$$ should use getwidth2up?
791     //var scaledWR = this.twoPage.height*widthR/heightR;
792     this.twoPage.scaledWR = this.getPageWidth2UP(indexR);
793     this.prefetchImg(indexR);
794     $(this.prefetchedImgs[indexR]).css({
795         position: 'absolute',
796         left:   this.twoPage.gutter+'px',
797         right: '',
798         top:    top+'px',
799         backgroundColor: this.getPageBackgroundColor(indexR),
800         height: this.twoPage.height + 'px', // $$$ height forced the same for both pages
801         width:  this.twoPage.scaledWR + 'px',
802         borderLeft: '1px solid black',
803         zIndex: 2
804     }).appendTo('#BRtwopageview');
805         
806
807     this.displayedIndices = [this.twoPage.currentIndexL, this.twoPage.currentIndexR];
808     this.setMouseHandlers2UP();
809     this.twoPageSetCursor();
810
811     this.updatePageNumBox2UP();
812     this.updateToolbarZoom(this.reduce);
813     
814     // this.twoPagePlaceFlipAreas();  // No longer used
815
816 }
817
818 // updatePageNumBox2UP
819 //______________________________________________________________________________
820 BookReader.prototype.updatePageNumBox2UP = function() {
821     if (null != this.getPageNum(this.twoPage.currentIndexL))  {
822         $("#BRpagenum").val(this.getPageNum(this.currentIndex()));
823     } else {
824         $("#BRpagenum").val('');
825     }
826     this.updateLocationHash();
827 }
828
829 // loadLeafs()
830 //______________________________________________________________________________
831 BookReader.prototype.loadLeafs = function() {
832
833
834     var self = this;
835     if (null == this.timer) {
836         this.timer=setTimeout(function(){self.drawLeafs()},250);
837     } else {
838         clearTimeout(this.timer);
839         this.timer=setTimeout(function(){self.drawLeafs()},250);    
840     }
841 }
842
843 // zoom(direction)
844 //
845 // Pass 1 to zoom in, anything else to zoom out
846 //______________________________________________________________________________
847 BookReader.prototype.zoom = function(direction) {
848     switch (this.mode) {
849         case this.constMode1up:
850             if (direction == 1) {
851                 // XXX other cases
852                 return this.zoom1up('in');
853             } else {
854                 return this.zoom1up('out');
855             }
856             
857         case this.constMode2up:
858             if (direction == 1) {
859                 // XXX other cases
860                 return this.zoom2up('in');
861             } else { 
862                 return this.zoom2up('out');
863             }
864             
865         case this.constModeThumb:
866             // XXX update zoomThumb for named directions
867             return this.zoomThumb(direction);
868             
869     }
870 }
871
872 // zoom1up(dir)
873 //______________________________________________________________________________
874 BookReader.prototype.zoom1up = function(direction) {
875
876     if (2 == this.mode) {     //can only zoom in 1-page mode
877         this.switchMode(1);
878         return;
879     }
880     
881     var reduceFactor = this.nextReduce(this.reduce, direction, this.onePage.reductionFactors);
882     
883     if (this.reduce == reduceFactor.reduce) {
884         // Already at this level
885         return;
886     }
887     
888     this.reduce = reduceFactor.reduce; // $$$ incorporate into function
889     this.onePage.autofit = reduceFactor.autofit;
890         
891     this.pageScale = this.reduce; // preserve current reduce
892     this.resizePageView();
893
894     $('#BRpageview').empty()
895     this.displayedIndices = [];
896     this.loadLeafs();
897     
898     this.updateToolbarZoom(this.reduce);
899     
900     // Recalculate search hilites
901     this.removeSearchHilites(); 
902     this.updateSearchHilites();
903
904 }
905
906 // resizePageView()
907 //______________________________________________________________________________
908 BookReader.prototype.resizePageView = function() {
909
910     // $$$ This code assumes 1up mode
911     //     e.g. does not preserve position in thumbnail mode
912     //     See http://bugs.launchpad.net/bookreader/+bug/552972
913     
914     switch (this.mode) {
915         case this.constMode1up:
916         case this.constMode2up:
917             this.resizePageView1up();
918             break;
919         case this.constModeThumb:
920             this.prepareThumbnailView( this.currentIndex() );
921             break;
922         default:
923             alert('Resize not implemented for this mode');
924     }
925 }
926
927 BookReader.prototype.resizePageView1up = function() {
928     var i;
929     var viewHeight = 0;
930     //var viewWidth  = $('#BRcontainer').width(); //includes scrollBar
931     var viewWidth  = $('#BRcontainer').attr('clientWidth');   
932
933     var oldScrollTop  = $('#BRcontainer').attr('scrollTop');
934     var oldScrollLeft = $('#BRcontainer').attr('scrollLeft');
935     var oldPageViewHeight = $('#BRpageview').height();
936     var oldPageViewWidth = $('#BRpageview').width();
937     
938     var oldCenterY = this.centerY1up();
939     var oldCenterX = this.centerX1up();
940     
941     if (0 != oldPageViewHeight) {
942         var scrollRatio = oldCenterY / oldPageViewHeight;
943     } else {
944         var scrollRatio = 0;
945     }
946     
947     // Recalculate 1up reduction factors
948     this.onePageCalculateReductionFactors( $('#BRcontainer').attr('clientWidth'),
949                                            $('#BRcontainer').attr('clientHeight') );                                        
950     // Update current reduce (if in autofit)
951     if (this.onePage.autofit) {
952         var reductionFactor = this.nextReduce(this.reduce, this.onePage.autofit, this.onePage.reductionFactors);
953         this.reduce = reductionFactor.reduce;
954     }
955     
956     for (i=0; i<this.numLeafs; i++) {
957         viewHeight += parseInt(this._getPageHeight(i)/this.reduce) + this.padding; 
958         var width = parseInt(this._getPageWidth(i)/this.reduce);
959         if (width>viewWidth) viewWidth=width;
960     }
961     $('#BRpageview').height(viewHeight);
962     $('#BRpageview').width(viewWidth);
963
964     var newCenterY = scrollRatio*viewHeight;
965     var newTop = Math.max(0, Math.floor( newCenterY - $('#BRcontainer').height()/2 ));
966     $('#BRcontainer').attr('scrollTop', newTop);
967     
968     // We use clientWidth here to avoid miscalculating due to scroll bar
969     var newCenterX = oldCenterX * (viewWidth / oldPageViewWidth);
970     var newLeft = newCenterX - $('#BRcontainer').attr('clientWidth') / 2;
971     newLeft = Math.max(newLeft, 0);
972     $('#BRcontainer').attr('scrollLeft', newLeft);
973     //console.log('oldCenterX ' + oldCenterX + ' newCenterX ' + newCenterX + ' newLeft ' + newLeft);
974     
975     //this.centerPageView();
976     this.loadLeafs();
977         
978     this.removeSearchHilites();
979     this.updateSearchHilites();
980 }
981
982
983 // centerX1up()
984 //______________________________________________________________________________
985 // Returns the current offset of the viewport center in scaled document coordinates.
986 BookReader.prototype.centerX1up = function() {
987     var centerX;
988     if ($('#BRpageview').width() < $('#BRcontainer').attr('clientWidth')) { // fully shown
989         centerX = $('#BRpageview').width();
990     } else {
991         centerX = $('#BRcontainer').attr('scrollLeft') + $('#BRcontainer').attr('clientWidth') / 2;
992     }
993     centerX = Math.floor(centerX);
994     return centerX;
995 }
996
997 // centerY1up()
998 //______________________________________________________________________________
999 // Returns the current offset of the viewport center in scaled document coordinates.
1000 BookReader.prototype.centerY1up = function() {
1001     var centerY = $('#BRcontainer').attr('scrollTop') + $('#BRcontainer').height() / 2;
1002     return Math.floor(centerY);
1003 }
1004
1005 // centerPageView()
1006 //______________________________________________________________________________
1007 BookReader.prototype.centerPageView = function() {
1008
1009     var scrollWidth  = $('#BRcontainer').attr('scrollWidth');
1010     var clientWidth  =  $('#BRcontainer').attr('clientWidth');
1011     //console.log('sW='+scrollWidth+' cW='+clientWidth);
1012     if (scrollWidth > clientWidth) {
1013         $('#BRcontainer').attr('scrollLeft', (scrollWidth-clientWidth)/2);
1014     }
1015
1016 }
1017
1018 // zoom2up(direction)
1019 //______________________________________________________________________________
1020 BookReader.prototype.zoom2up = function(direction) {
1021
1022     // Hard stop autoplay
1023     this.stopFlipAnimations();
1024     
1025     // Recalculate autofit factors
1026     this.twoPageCalculateReductionFactors();
1027     
1028     // Get new zoom state
1029     var reductionFactor = this.nextReduce(this.reduce, direction, this.twoPage.reductionFactors);
1030     if ((this.reduce == reductionFactor.reduce) && (this.twoPage.autofit == reductionFactor.autofit)) {
1031         // Same zoom
1032         return;
1033     }
1034     this.twoPage.autofit = reductionFactor.autofit;
1035     this.reduce = reductionFactor.reduce;
1036     this.pageScale = this.reduce; // preserve current reduce
1037
1038     // Preserve view center position
1039     var oldCenter = this.twoPageGetViewCenter();
1040     
1041     // If zooming in, reload imgs.  DOM elements will be removed by prepareTwoPageView
1042     // $$$ An improvement would be to use the low res image until the larger one is loaded.
1043     if (1 == direction) {
1044         for (var img in this.prefetchedImgs) {
1045             delete this.prefetchedImgs[img];
1046         }
1047     }
1048     
1049     // Prepare view with new center to minimize visual glitches
1050     this.prepareTwoPageView(oldCenter.percentageX, oldCenter.percentageY);
1051 }
1052
1053 BookReader.prototype.zoomThumb = function(direction) {
1054     var oldColumns = this.thumbColumns;
1055     switch (direction) {
1056         case -1:
1057             this.thumbColumns += 1;
1058             break;
1059         case 1:
1060             this.thumbColumns -= 1;
1061             break;
1062     }
1063     
1064     // clamp
1065     if (this.thumbColumns < 2) {
1066         this.thumbColumns = 2;
1067     } else if (this.thumbColumns > 8) {
1068         this.thumbColumns = 8;
1069     }
1070     
1071     if (this.thumbColumns != oldColumns) {
1072         this.prepareThumbnailView();
1073     }
1074 }
1075
1076 // Returns the width per thumbnail to display the requested number of columns
1077 // Note: #BRpageview must already exist since its width is used to calculate the
1078 //       thumbnail width
1079 BookReader.prototype.getThumbnailWidth = function(thumbnailColumns) {
1080     var padding = (thumbnailColumns + 1) * this.padding;
1081     var width = ($('#BRpageview').width() - padding) / (thumbnailColumns + 0.5); // extra 0.5 is for some space at sides
1082     return parseInt(width);
1083 }
1084
1085 // quantizeReduce(reduce)
1086 //______________________________________________________________________________
1087 // Quantizes the given reduction factor to closest power of two from set from 12.5% to 200%
1088 BookReader.prototype.quantizeReduce = function(reduce, reductionFactors) {
1089     var quantized = reductionFactors[0].reduce;
1090     var distance = Math.abs(reduce - quantized);
1091     for (var i = 1; i < reductionFactors.length; i++) {
1092         newDistance = Math.abs(reduce - reductionFactors[i].reduce);
1093         if (newDistance < distance) {
1094             distance = newDistance;
1095             quantized = reductionFactors[i].reduce;
1096         }
1097     }
1098     
1099     return quantized;
1100 }
1101
1102 // reductionFactors should be array of sorted reduction factors
1103 // e.g. [ {reduce: 0.25, autofit: null}, {reduce: 0.3, autofit: 'width'}, {reduce: 1, autofit: null} ]
1104 BookReader.prototype.nextReduce = function( currentReduce, direction, reductionFactors ) {
1105
1106     // XXX add 'closest', to replace quantize function
1107     
1108     if (direction == 'in') {
1109         var newReduceIndex = 0;
1110     
1111         for (var i = 1; i < reductionFactors.length; i++) {
1112             if (reductionFactors[i].reduce < currentReduce) {
1113                 newReduceIndex = i;
1114             }
1115         }
1116         return reductionFactors[newReduceIndex];
1117         
1118     } else if (direction == 'out') { // zoom out
1119         var lastIndex = reductionFactors.length - 1;
1120         var newReduceIndex = lastIndex;
1121         
1122         for (var i = lastIndex; i >= 0; i--) {
1123             if (reductionFactors[i].reduce > currentReduce) {
1124                 newReduceIndex = i;
1125             }
1126         }
1127         return reductionFactors[newReduceIndex];
1128     }
1129     
1130     // Asked for specific autofit mode
1131     for (var i = 0; i < reductionFactors.length; i++) {
1132         if (reductionFactors[i].autofit == direction) {
1133             return reductionFactors[i];
1134         }
1135     }
1136     
1137     alert('Could not find reduction factor for direction ' + direction);
1138     return reductionFactors[0];
1139
1140 }
1141
1142 BookReader.prototype._reduceSort = function(a, b) {
1143     return a.reduce - b.reduce;
1144 }
1145
1146 // jumpToPage()
1147 //______________________________________________________________________________
1148 // Attempts to jump to page.  Returns true if page could be found, false otherwise.
1149 BookReader.prototype.jumpToPage = function(pageNum) {
1150
1151     var pageIndex = this.getPageIndex(pageNum);
1152
1153     if ('undefined' != typeof(pageIndex)) {
1154         var leafTop = 0;
1155         var h;
1156         this.jumpToIndex(pageIndex);
1157         $('#BRcontainer').attr('scrollTop', leafTop);
1158         return true;
1159     }
1160     
1161     // Page not found
1162     return false;
1163 }
1164
1165 // jumpToIndex()
1166 //______________________________________________________________________________
1167 BookReader.prototype.jumpToIndex = function(index, pageX, pageY) {
1168
1169     if (this.constMode2up == this.mode) {
1170         this.autoStop();
1171         
1172         // By checking against min/max we do nothing if requested index
1173         // is current
1174         if (index < Math.min(this.twoPage.currentIndexL, this.twoPage.currentIndexR)) {
1175             this.flipBackToIndex(index);
1176         } else if (index > Math.max(this.twoPage.currentIndexL, this.twoPage.currentIndexR)) {
1177             this.flipFwdToIndex(index);
1178         }
1179
1180     } else if (this.constModeThumb == this.mode) {
1181         var viewWidth = $('#BRcontainer').attr('scrollWidth') - 20; // width minus buffer
1182         var i;
1183         var leafWidth = 0;
1184         var leafHeight = 0;
1185         var rightPos = 0;
1186         var bottomPos = 0;
1187         var rowHeight = 0;
1188         var leafTop = 0;
1189         var leafIndex = 0;
1190
1191         for (i=0; i<(index+1); i++) {
1192             leafWidth = this.thumbWidth;
1193             if (rightPos + (leafWidth + this.padding) > viewWidth){
1194                 rightPos = 0;
1195                 rowHeight = 0;
1196                 leafIndex = 0;
1197             }
1198
1199             leafHeight = parseInt((this.getPageHeight(leafIndex)*this.thumbWidth)/this.getPageWidth(leafIndex), 10);
1200             if (leafHeight > rowHeight) { rowHeight = leafHeight; }
1201             if (leafIndex==0) { leafTop = bottomPos; }
1202             if (leafIndex==0) { bottomPos += this.padding + rowHeight; }
1203             rightPos += leafWidth + this.padding;
1204             leafIndex++;
1205         }
1206         this.firstIndex=index;
1207         if ($('#BRcontainer').attr('scrollTop') == leafTop) {
1208             this.loadLeafs();
1209         } else {
1210             $('#BRcontainer').animate({scrollTop: leafTop },'fast');
1211         }
1212     } else {
1213         // 1up
1214         var i;
1215         var leafTop = 0;
1216         var leafLeft = 0;
1217         var h;
1218         for (i=0; i<index; i++) {
1219             h = parseInt(this._getPageHeight(i)/this.reduce); 
1220             leafTop += h + this.padding;
1221         }
1222
1223         if (pageY) {
1224             //console.log('pageY ' + pageY);
1225             var offset = parseInt( (pageY) / this.reduce);
1226             offset -= $('#BRcontainer').attr('clientHeight') >> 1;
1227             //console.log( 'jumping to ' + leafTop + ' ' + offset);
1228             leafTop += offset;
1229         } else {
1230             // Show page just a little below the top
1231             leafTop -= this.padding / 2;
1232         }
1233
1234         if (pageX) {
1235             var offset = parseInt( (pageX) / this.reduce);
1236             offset -= $('#BRcontainer').attr('clientWidth') >> 1;
1237             leafLeft += offset;
1238         }
1239
1240         //$('#BRcontainer').attr('scrollTop', leafTop);
1241         $('#BRcontainer').animate({scrollTop: leafTop, scrollLeft: leafLeft },'fast');
1242     }
1243 }
1244
1245
1246 // switchMode()
1247 //______________________________________________________________________________
1248 BookReader.prototype.switchMode = function(mode) {
1249
1250     //console.log('  asked to switch to mode ' + mode + ' from ' + this.mode);
1251     
1252     if (mode == this.mode) {
1253         return;
1254     }
1255     
1256     if (!this.canSwitchToMode(mode)) {
1257         return;
1258     }
1259
1260     this.autoStop();
1261     this.removeSearchHilites();
1262
1263     this.mode = mode;
1264     this.switchToolbarMode(mode);
1265
1266     // reinstate scale if moving from thumbnail view
1267     if (this.pageScale != this.reduce) {
1268         this.reduce = this.pageScale;
1269     }
1270     
1271     // $$$ TODO preserve center of view when switching between mode
1272     //     See https://bugs.edge.launchpad.net/gnubook/+bug/416682
1273
1274     // XXX maybe better to preserve zoom in each mode
1275     if (1 == mode) {
1276         this.onePageCalculateReductionFactors( $('#BRcontainer').attr('clientWidth'), $('#BRcontainer').attr('clientHeight'));
1277         this.reduce = this.quantizeReduce(this.reduce, this.onePage.reductionFactors);
1278         this.prepareOnePageView();
1279     } else if (3 == mode) {
1280         this.reduce = this.quantizeReduce(this.reduce, this.reductionFactors);
1281         this.prepareThumbnailView();
1282     } else {
1283         // $$$ why don't we save autofit?
1284         this.twoPage.autofit = null; // Take zoom level from other mode
1285         this.twoPageCalculateReductionFactors();
1286         this.reduce = this.quantizeReduce(this.reduce, this.twoPage.reductionFactors);
1287         this.prepareTwoPageView();
1288         this.twoPageCenterView(0.5, 0.5); // $$$ TODO preserve center
1289     }
1290
1291 }
1292
1293 //prepareOnePageView()
1294 //______________________________________________________________________________
1295 BookReader.prototype.prepareOnePageView = function() {
1296
1297     // var startLeaf = this.displayedIndices[0];
1298     var startLeaf = this.currentIndex();
1299         
1300     $('#BRcontainer').empty();
1301     $('#BRcontainer').css({
1302         overflowY: 'scroll',
1303         overflowX: 'auto'
1304     });
1305         
1306     $("#BRcontainer").append("<div id='BRpageview'></div>");
1307
1308     // Attaches to first child - child must be present
1309     $('#BRcontainer').dragscrollable();
1310     this.bindGestures($('#BRcontainer'));
1311
1312     // $$$ keep select enabled for now since disabling it breaks keyboard
1313     //     nav in FF 3.6 (https://bugs.edge.launchpad.net/bookreader/+bug/544666)
1314     // BookReader.util.disableSelect($('#BRpageview'));
1315     
1316     this.resizePageView();    
1317     
1318     this.jumpToIndex(startLeaf);
1319     this.displayedIndices = [];
1320     
1321     this.drawLeafsOnePage();
1322 }
1323
1324 //prepareThumbnailView()
1325 //______________________________________________________________________________
1326 BookReader.prototype.prepareThumbnailView = function() {
1327     
1328     $('#BRcontainer').empty();
1329     $('#BRcontainer').css({
1330         overflowY: 'scroll',
1331         overflowX: 'auto'
1332     });
1333         
1334     $("#BRcontainer").append("<div id='BRpageview'></div>");
1335     
1336     $('#BRcontainer').dragscrollable();
1337     this.bindGestures($('#BRcontainer'));
1338
1339     // $$$ keep select enabled for now since disabling it breaks keyboard
1340     //     nav in FF 3.6 (https://bugs.edge.launchpad.net/bookreader/+bug/544666)
1341     // BookReader.util.disableSelect($('#BRpageview'));
1342     
1343     this.thumbWidth = this.getThumbnailWidth(this.thumbColumns);
1344     this.reduce = this.getPageWidth(0)/this.thumbWidth;
1345
1346     this.displayedRows = [];
1347
1348     // Draw leafs with current index directly in view (no animating to the index)
1349     this.drawLeafsThumbnail( this.currentIndex() );
1350     
1351 }
1352
1353 // prepareTwoPageView()
1354 //______________________________________________________________________________
1355 // Some decisions about two page view:
1356 //
1357 // Both pages will be displayed at the same height, even if they were different physical/scanned
1358 // sizes.  This simplifies the animation (from a design as well as technical standpoint).  We
1359 // examine the page aspect ratios (in calculateSpreadSize) and use the page with the most "normal"
1360 // aspect ratio to determine the height.
1361 //
1362 // The two page view div is resized to keep the middle of the book in the middle of the div
1363 // even as the page sizes change.  To e.g. keep the middle of the book in the middle of the BRcontent
1364 // div requires adjusting the offset of BRtwpageview and/or scrolling in BRcontent.
1365 BookReader.prototype.prepareTwoPageView = function(centerPercentageX, centerPercentageY) {
1366     $('#BRcontainer').empty();
1367     $('#BRcontainer').css('overflow', 'auto');
1368         
1369     // We want to display two facing pages.  We may be missing
1370     // one side of the spread because it is the first/last leaf,
1371     // foldouts, missing pages, etc
1372
1373     //var targetLeaf = this.displayedIndices[0];
1374     var targetLeaf = this.firstIndex;
1375
1376     if (targetLeaf < this.firstDisplayableIndex()) {
1377         targetLeaf = this.firstDisplayableIndex();
1378     }
1379     
1380     if (targetLeaf > this.lastDisplayableIndex()) {
1381         targetLeaf = this.lastDisplayableIndex();
1382     }
1383     
1384     //this.twoPage.currentIndexL = null;
1385     //this.twoPage.currentIndexR = null;
1386     //this.pruneUnusedImgs();
1387     
1388     var currentSpreadIndices = this.getSpreadIndices(targetLeaf);
1389     this.twoPage.currentIndexL = currentSpreadIndices[0];
1390     this.twoPage.currentIndexR = currentSpreadIndices[1];
1391     this.firstIndex = this.twoPage.currentIndexL;
1392     
1393     this.calculateSpreadSize(); //sets twoPage.width, twoPage.height and others
1394
1395     this.pruneUnusedImgs();
1396     this.prefetch(); // Preload images or reload if scaling has changed
1397
1398     //console.dir(this.twoPage);
1399     
1400     // Add the two page view
1401     // $$$ Can we get everything set up and then append?
1402     $('#BRcontainer').append('<div id="BRtwopageview"></div>');
1403     
1404     // Attaches to first child, so must come after we add the page view
1405     $('#BRcontainer').dragscrollable();
1406     this.bindGestures($('#BRcontainer'));
1407
1408     // $$$ calculate first then set
1409     $('#BRtwopageview').css( {
1410         height: this.twoPage.totalHeight + 'px',
1411         width: this.twoPage.totalWidth + 'px',
1412         position: 'absolute'
1413         });
1414         
1415     // If there will not be scrollbars (e.g. when zooming out) we center the book
1416     // since otherwise the book will be stuck off-center
1417     if (this.twoPage.totalWidth < $('#BRcontainer').attr('clientWidth')) {
1418         centerPercentageX = 0.5;
1419     }
1420     if (this.twoPage.totalHeight < $('#BRcontainer').attr('clientHeight')) {
1421         centerPercentageY = 0.5;
1422     }
1423         
1424     this.twoPageCenterView(centerPercentageX, centerPercentageY);
1425     
1426     this.twoPage.coverDiv = document.createElement('div');
1427     $(this.twoPage.coverDiv).attr('id', 'BRbookcover').css({
1428         width:  this.twoPage.bookCoverDivWidth + 'px',
1429         height: this.twoPage.bookCoverDivHeight+'px',
1430         visibility: 'visible',
1431         position: 'absolute',
1432         left: this.twoPage.bookCoverDivLeft + 'px',
1433         top: this.twoPage.bookCoverDivTop+'px',
1434     }).appendTo('#BRtwopageview');
1435     
1436     this.leafEdgeR = document.createElement('div');
1437     this.leafEdgeR.className = 'BRleafEdgeR';
1438     $(this.leafEdgeR).css({
1439         width: this.twoPage.leafEdgeWidthR + 'px',
1440         height: this.twoPage.height-1 + 'px',
1441         left: this.twoPage.gutter+this.twoPage.scaledWR+'px',
1442         top: this.twoPage.bookCoverDivTop+this.twoPage.coverInternalPadding+'px',
1443     }).appendTo('#BRtwopageview');
1444     
1445     this.leafEdgeL = document.createElement('div');
1446     this.leafEdgeL.className = 'BRleafEdgeL';
1447     $(this.leafEdgeL).css({
1448         width: this.twoPage.leafEdgeWidthL + 'px',
1449         height: this.twoPage.height-1 + 'px',
1450         left: this.twoPage.bookCoverDivLeft+this.twoPage.coverInternalPadding+'px',
1451         top: this.twoPage.bookCoverDivTop+this.twoPage.coverInternalPadding+'px',    
1452     }).appendTo('#BRtwopageview');
1453
1454     div = document.createElement('div');
1455     $(div).attr('id', 'BRbookspine').css({
1456         width:           this.twoPage.bookSpineDivWidth+'px',
1457         height:          this.twoPage.bookSpineDivHeight+'px',
1458         left:            this.twoPage.bookSpineDivLeft+'px',
1459         top:             this.twoPage.bookSpineDivTop+'px'
1460     }).appendTo('#BRtwopageview');
1461     
1462     var self = this; // for closure
1463     
1464     /* Flip areas no longer used
1465     this.twoPage.leftFlipArea = document.createElement('div');
1466     this.twoPage.leftFlipArea.className = 'BRfliparea';
1467     $(this.twoPage.leftFlipArea).attr('id', 'BRleftflip').css({
1468         border: '0',
1469         width:  this.twoPageFlipAreaWidth() + 'px',
1470         height: this.twoPageFlipAreaHeight() + 'px',
1471         position: 'absolute',
1472         left:   this.twoPageLeftFlipAreaLeft() + 'px',
1473         top:    this.twoPageFlipAreaTop() + 'px',
1474         cursor: 'w-resize',
1475         zIndex: 100
1476     }).bind('click', function(e) {
1477         self.left();
1478     }).bind('mousedown', function(e) {
1479         e.preventDefault();
1480     }).appendTo('#BRtwopageview');
1481     
1482     this.twoPage.rightFlipArea = document.createElement('div');
1483     this.twoPage.rightFlipArea.className = 'BRfliparea';
1484     $(this.twoPage.rightFlipArea).attr('id', 'BRrightflip').css({
1485         border: '0',
1486         width:  this.twoPageFlipAreaWidth() + 'px',
1487         height: this.twoPageFlipAreaHeight() + 'px',
1488         position: 'absolute',
1489         left:   this.twoPageRightFlipAreaLeft() + 'px',
1490         top:    this.twoPageFlipAreaTop() + 'px',
1491         cursor: 'e-resize',
1492         zIndex: 100
1493     }).bind('click', function(e) {
1494         self.right();
1495     }).bind('mousedown', function(e) {
1496         e.preventDefault();
1497     }).appendTo('#BRtwopageview');
1498     */
1499     
1500     this.prepareTwoPagePopUp();
1501     
1502     this.displayedIndices = [];
1503     
1504     //this.indicesToDisplay=[firstLeaf, firstLeaf+1];
1505     //console.log('indicesToDisplay: ' + this.indicesToDisplay[0] + ' ' + this.indicesToDisplay[1]);
1506     
1507     this.drawLeafsTwoPage();
1508     this.updateToolbarZoom(this.reduce);
1509     
1510     this.prefetch();
1511
1512     this.removeSearchHilites();
1513     this.updateSearchHilites();
1514
1515 }
1516
1517 // prepareTwoPagePopUp()
1518 //
1519 // This function prepares the "View Page n" popup that shows while the mouse is
1520 // over the left/right "stack of sheets" edges.  It also binds the mouse
1521 // events for these divs.
1522 //______________________________________________________________________________
1523 BookReader.prototype.prepareTwoPagePopUp = function() {
1524
1525     this.twoPagePopUp = document.createElement('div');
1526     this.twoPagePopUp.className = 'BRtwoPagePopUp';
1527     $(this.twoPagePopUp).css({
1528         zIndex: '1000',
1529     }).appendTo('#BRcontainer');
1530     $(this.twoPagePopUp).hide();
1531     
1532     $(this.leafEdgeL).add(this.leafEdgeR).bind('mouseenter', this, function(e) {
1533         $(e.data.twoPagePopUp).show();
1534     });
1535
1536     $(this.leafEdgeL).add(this.leafEdgeR).bind('mouseleave', this, function(e) {
1537         $(e.data.twoPagePopUp).hide();
1538     });
1539
1540     $(this.leafEdgeL).bind('click', this, function(e) { 
1541         e.data.autoStop();
1542         var jumpIndex = e.data.jumpIndexForLeftEdgePageX(e.pageX);
1543         e.data.jumpToIndex(jumpIndex);
1544     });
1545
1546     $(this.leafEdgeR).bind('click', this, function(e) { 
1547         e.data.autoStop();
1548         var jumpIndex = e.data.jumpIndexForRightEdgePageX(e.pageX);
1549         e.data.jumpToIndex(jumpIndex);    
1550     });
1551
1552     $(this.leafEdgeR).bind('mousemove', this, function(e) {
1553
1554         var jumpIndex = e.data.jumpIndexForRightEdgePageX(e.pageX);
1555         $(e.data.twoPagePopUp).text('View ' + e.data.getPageName(jumpIndex));
1556         
1557         // $$$ TODO: Make sure popup is positioned so that it is in view
1558         // (https://bugs.edge.launchpad.net/gnubook/+bug/327456)        
1559         $(e.data.twoPagePopUp).css({
1560             left: e.pageX- $('#BRcontainer').offset().left + $('#BRcontainer').scrollLeft() + 20 + 'px',
1561             top: e.pageY - $('#BRcontainer').offset().top + $('#BRcontainer').scrollTop() + 'px'
1562         });
1563     });
1564
1565     $(this.leafEdgeL).bind('mousemove', this, function(e) {
1566     
1567         var jumpIndex = e.data.jumpIndexForLeftEdgePageX(e.pageX);
1568         $(e.data.twoPagePopUp).text('View '+ e.data.getPageName(jumpIndex));
1569
1570         // $$$ TODO: Make sure popup is positioned so that it is in view
1571         //           (https://bugs.edge.launchpad.net/gnubook/+bug/327456)        
1572         $(e.data.twoPagePopUp).css({
1573             left: e.pageX - $('#BRcontainer').offset().left + $('#BRcontainer').scrollLeft() - $(e.data.twoPagePopUp).width() - 25 + 'px',
1574             top: e.pageY-$('#BRcontainer').offset().top + $('#BRcontainer').scrollTop() + 'px'
1575         });
1576     });
1577 }
1578
1579 // calculateSpreadSize()
1580 //______________________________________________________________________________
1581 // Calculates 2-page spread dimensions based on this.twoPage.currentIndexL and
1582 // this.twoPage.currentIndexR
1583 // This function sets this.twoPage.height, twoPage.width
1584
1585 BookReader.prototype.calculateSpreadSize = function() {
1586
1587     var firstIndex  = this.twoPage.currentIndexL;
1588     var secondIndex = this.twoPage.currentIndexR;
1589     //console.log('first page is ' + firstIndex);
1590
1591     // Calculate page sizes and total leaf width
1592     var spreadSize;
1593     if ( this.twoPage.autofit) {    
1594         spreadSize = this.getIdealSpreadSize(firstIndex, secondIndex);
1595     } else {
1596         // set based on reduction factor
1597         spreadSize = this.getSpreadSizeFromReduce(firstIndex, secondIndex, this.reduce);
1598     }
1599     
1600     // Both pages together
1601     this.twoPage.height = spreadSize.height;
1602     this.twoPage.width = spreadSize.width;
1603     
1604     // Individual pages
1605     this.twoPage.scaledWL = this.getPageWidth2UP(firstIndex);
1606     this.twoPage.scaledWR = this.getPageWidth2UP(secondIndex);
1607     
1608     // Leaf edges
1609     this.twoPage.edgeWidth = spreadSize.totalLeafEdgeWidth; // The combined width of both edges
1610     this.twoPage.leafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
1611     this.twoPage.leafEdgeWidthR = this.twoPage.edgeWidth - this.twoPage.leafEdgeWidthL;
1612     
1613     
1614     // Book cover
1615     // The width of the book cover div.  The combined width of both pages, twice the width
1616     // of the book cover internal padding (2*10) and the page edges
1617     this.twoPage.bookCoverDivWidth = this.twoPage.scaledWL + this.twoPage.scaledWR + 2 * this.twoPage.coverInternalPadding + this.twoPage.edgeWidth;
1618     // The height of the book cover div
1619     this.twoPage.bookCoverDivHeight = this.twoPage.height + 2 * this.twoPage.coverInternalPadding;
1620     
1621     
1622     // We calculate the total width and height for the div so that we can make the book
1623     // spine centered
1624     var leftGutterOffset = this.gutterOffsetForIndex(firstIndex);
1625     var leftWidthFromCenter = this.twoPage.scaledWL - leftGutterOffset + this.twoPage.leafEdgeWidthL;
1626     var rightWidthFromCenter = this.twoPage.scaledWR + leftGutterOffset + this.twoPage.leafEdgeWidthR;
1627     var largestWidthFromCenter = Math.max( leftWidthFromCenter, rightWidthFromCenter );
1628     this.twoPage.totalWidth = 2 * (largestWidthFromCenter + this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding);
1629     this.twoPage.totalHeight = this.twoPage.height + 2 * (this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding);
1630         
1631     // We want to minimize the unused space in two-up mode (maximize the amount of page
1632     // shown).  We give width to the leaf edges and these widths change (though the sum
1633     // of the two remains constant) as we flip through the book.  With the book
1634     // cover centered and fixed in the BRcontainer div the page images will meet
1635     // at the "gutter" which is generally offset from the center.
1636     this.twoPage.middle = this.twoPage.totalWidth >> 1;
1637     this.twoPage.gutter = this.twoPage.middle + this.gutterOffsetForIndex(firstIndex);
1638     
1639     // The left edge of the book cover moves depending on the width of the pages
1640     // $$$ change to getter
1641     this.twoPage.bookCoverDivLeft = this.twoPage.gutter - this.twoPage.scaledWL - this.twoPage.leafEdgeWidthL - this.twoPage.coverInternalPadding;
1642     // The top edge of the book cover stays a fixed distance from the top
1643     this.twoPage.bookCoverDivTop = this.twoPage.coverExternalPadding;
1644
1645     // Book spine
1646     this.twoPage.bookSpineDivHeight = this.twoPage.height + 2*this.twoPage.coverInternalPadding;
1647     this.twoPage.bookSpineDivLeft = this.twoPage.middle - (this.twoPage.bookSpineDivWidth >> 1);
1648     this.twoPage.bookSpineDivTop = this.twoPage.bookCoverDivTop;
1649
1650
1651     this.reduce = spreadSize.reduce; // $$$ really set this here?
1652 }
1653
1654 BookReader.prototype.getIdealSpreadSize = function(firstIndex, secondIndex) {
1655     var ideal = {};
1656
1657     // We check which page is closest to a "normal" page and use that to set the height
1658     // for both pages.  This means that foldouts and other odd size pages will be displayed
1659     // smaller than the nominal zoom amount.
1660     var canon5Dratio = 1.5;
1661     
1662     var first = {
1663         height: this._getPageHeight(firstIndex),
1664         width: this._getPageWidth(firstIndex)
1665     }
1666     
1667     var second = {
1668         height: this._getPageHeight(secondIndex),
1669         width: this._getPageWidth(secondIndex)
1670     }
1671     
1672     var firstIndexRatio  = first.height / first.width;
1673     var secondIndexRatio = second.height / second.width;
1674     //console.log('firstIndexRatio = ' + firstIndexRatio + ' secondIndexRatio = ' + secondIndexRatio);
1675
1676     var ratio;
1677     if (Math.abs(firstIndexRatio - canon5Dratio) < Math.abs(secondIndexRatio - canon5Dratio)) {
1678         ratio = firstIndexRatio;
1679         //console.log('using firstIndexRatio ' + ratio);
1680     } else {
1681         ratio = secondIndexRatio;
1682         //console.log('using secondIndexRatio ' + ratio);
1683     }
1684
1685     var totalLeafEdgeWidth = parseInt(this.numLeafs * 0.1);
1686     var maxLeafEdgeWidth   = parseInt($('#BRcontainer').attr('clientWidth') * 0.1);
1687     ideal.totalLeafEdgeWidth     = Math.min(totalLeafEdgeWidth, maxLeafEdgeWidth);
1688     
1689     var widthOutsidePages = 2 * (this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding) + ideal.totalLeafEdgeWidth;
1690     var heightOutsidePages = 2* (this.twoPage.coverInternalPadding + this.twoPage.coverExternalPadding);
1691     
1692     ideal.width = ($('#BRcontainer').width() - widthOutsidePages) >> 1;
1693     ideal.width -= 10; // $$$ fudge factor
1694     ideal.height = $('#BRcontainer').height() - heightOutsidePages;
1695     ideal.height -= 20; // fudge factor
1696     //console.log('init idealWidth='+ideal.width+' idealHeight='+ideal.height + ' ratio='+ratio);
1697
1698     if (ideal.height/ratio <= ideal.width) {
1699         //use height
1700         ideal.width = parseInt(ideal.height/ratio);
1701     } else {
1702         //use width
1703         ideal.height = parseInt(ideal.width*ratio);
1704     }
1705     
1706     // $$$ check this logic with large spreads
1707     ideal.reduce = ((first.height + second.height) / 2) / ideal.height;
1708     
1709     return ideal;
1710 }
1711
1712 // getSpreadSizeFromReduce()
1713 //______________________________________________________________________________
1714 // Returns the spread size calculated from the reduction factor for the given pages
1715 BookReader.prototype.getSpreadSizeFromReduce = function(firstIndex, secondIndex, reduce) {
1716     var spreadSize = {};
1717     // $$$ Scale this based on reduce?
1718     var totalLeafEdgeWidth = parseInt(this.numLeafs * 0.1);
1719     var maxLeafEdgeWidth   = parseInt($('#BRcontainer').attr('clientWidth') * 0.1); // $$$ Assumes leaf edge width constant at all zoom levels
1720     spreadSize.totalLeafEdgeWidth     = Math.min(totalLeafEdgeWidth, maxLeafEdgeWidth);
1721
1722     // $$$ Possibly incorrect -- we should make height "dominant"
1723     var nativeWidth = this._getPageWidth(firstIndex) + this._getPageWidth(secondIndex);
1724     var nativeHeight = this._getPageHeight(firstIndex) + this._getPageHeight(secondIndex);
1725     spreadSize.height = parseInt( (nativeHeight / 2) / this.reduce );
1726     spreadSize.width = parseInt( (nativeWidth / 2) / this.reduce );
1727     spreadSize.reduce = reduce;
1728     
1729     return spreadSize;
1730 }
1731
1732 // twoPageGetAutofitReduce()
1733 //______________________________________________________________________________
1734 // Returns the current ideal reduction factor
1735 BookReader.prototype.twoPageGetAutofitReduce = function() {
1736     var spreadSize = this.getIdealSpreadSize(this.twoPage.currentIndexL, this.twoPage.currentIndexR);
1737     return spreadSize.reduce;
1738 }
1739
1740 BookReader.prototype.onePageGetAutofitWidth = function() {
1741     var widthPadding = 20;
1742     return (this.getMedianPageSize().width + 0.0) / ($('#BRcontainer').attr('clientWidth') - widthPadding * 2);
1743 }
1744
1745 BookReader.prototype.onePageGetAutofitHeight = function() {
1746     return (this.getMedianPageSize().height + 0.0) / ($('#BRcontainer').attr('clientHeight') - this.padding * 2); // make sure a little of adjacent pages show
1747 }
1748
1749 BookReader.prototype.getMedianPageSize = function() {
1750     if (this._medianPageSize) {
1751         return this._medianPageSize;
1752     }
1753     
1754     // A little expensive but we just do it once
1755     var widths = [];
1756     var heights = [];
1757     for (var i = 0; i < this.numLeafs; i++) {
1758         widths.push(this.getPageWidth(i));
1759         heights.push(this.getPageHeight(i));
1760     }
1761     
1762     widths.sort();
1763     heights.sort();
1764     
1765     this._medianPageSize = { width: widths[parseInt(widths.length / 2)], height: heights[parseInt(heights.length / 2)] };
1766     return this._medianPageSize; 
1767 }
1768
1769 // Update the reduction factors for 1up mode given the available width and height.  Recalculates
1770 // the autofit reduction factors.
1771 BookReader.prototype.onePageCalculateReductionFactors = function( width, height ) {
1772     this.onePage.reductionFactors = this.reductionFactors.concat(
1773         [ 
1774             { reduce: this.onePageGetAutofitWidth(), autofit: 'width' },
1775             { reduce: this.onePageGetAutofitHeight(), autofit: 'height'}
1776         ]);
1777     this.onePage.reductionFactors.sort(this._reduceSort);
1778 }
1779
1780 BookReader.prototype.twoPageCalculateReductionFactors = function() {    
1781     this.twoPage.reductionFactors = this.reductionFactors.concat(
1782         [
1783             { reduce: this.getIdealSpreadSize( this.twoPage.currentIndexL, this.twoPage.currentIndexR ).reduce,
1784               autofit: 'auto' }
1785         ]);
1786     this.twoPage.reductionFactors.sort(this._reduceSort);
1787 }
1788
1789 // twoPageSetCursor()
1790 //______________________________________________________________________________
1791 // Set the cursor for two page view
1792 BookReader.prototype.twoPageSetCursor = function() {
1793     // console.log('setting cursor');
1794     if ( ($('#BRtwopageview').width() > $('#BRcontainer').attr('clientWidth')) ||
1795          ($('#BRtwopageview').height() > $('#BRcontainer').attr('clientHeight')) ) {
1796         $(this.prefetchedImgs[this.twoPage.currentIndexL]).css('cursor','move');
1797         $(this.prefetchedImgs[this.twoPage.currentIndexR]).css('cursor','move');
1798     } else {
1799         $(this.prefetchedImgs[this.twoPage.currentIndexL]).css('cursor','');
1800         $(this.prefetchedImgs[this.twoPage.currentIndexR]).css('cursor','');
1801     }
1802 }
1803
1804 // currentIndex()
1805 //______________________________________________________________________________
1806 // Returns the currently active index.
1807 BookReader.prototype.currentIndex = function() {
1808     // $$$ we should be cleaner with our idea of which index is active in 1up/2up
1809     if (this.mode == this.constMode1up || this.mode == this.constModeThumb) {
1810         return this.firstIndex; // $$$ TODO page in center of view would be better
1811     } else if (this.mode == this.constMode2up) {
1812         // Only allow indices that are actually present in book
1813         return BookReader.util.clamp(this.firstIndex, 0, this.numLeafs - 1);    
1814     } else {
1815         throw 'currentIndex called for unimplemented mode ' + this.mode;
1816     }
1817 }
1818
1819 // setCurrentIndex(index)
1820 //______________________________________________________________________________
1821 // Sets the idea of current index without triggering other actions such as animation.
1822 // Compare to jumpToIndex which animates to that index
1823 BookReader.prototype.setCurrentIndex = function(index) {
1824     this.firstIndex = index;
1825 }
1826
1827
1828 // right()
1829 //______________________________________________________________________________
1830 // Flip the right page over onto the left
1831 BookReader.prototype.right = function() {
1832     if ('rl' != this.pageProgression) {
1833         // LTR
1834         this.next();
1835     } else {
1836         // RTL
1837         this.prev();
1838     }
1839 }
1840
1841 // rightmost()
1842 //______________________________________________________________________________
1843 // Flip to the rightmost page
1844 BookReader.prototype.rightmost = function() {
1845     if ('rl' != this.pageProgression) {
1846         this.last();
1847     } else {
1848         this.first();
1849     }
1850 }
1851
1852 // left()
1853 //______________________________________________________________________________
1854 // Flip the left page over onto the right.
1855 BookReader.prototype.left = function() {
1856     if ('rl' != this.pageProgression) {
1857         // LTR
1858         this.prev();
1859     } else {
1860         // RTL
1861         this.next();
1862     }
1863 }
1864
1865 // leftmost()
1866 //______________________________________________________________________________
1867 // Flip to the leftmost page
1868 BookReader.prototype.leftmost = function() {
1869     if ('rl' != this.pageProgression) {
1870         this.first();
1871     } else {
1872         this.last();
1873     }
1874 }
1875
1876 // next()
1877 //______________________________________________________________________________
1878 BookReader.prototype.next = function() {
1879     if (2 == this.mode) {
1880         this.autoStop();
1881         this.flipFwdToIndex(null);
1882     } else {
1883         if (this.firstIndex < this.lastDisplayableIndex()) {
1884             this.jumpToIndex(this.firstIndex+1);
1885         }
1886     }
1887 }
1888
1889 // prev()
1890 //______________________________________________________________________________
1891 BookReader.prototype.prev = function() {
1892     if (2 == this.mode) {
1893         this.autoStop();
1894         this.flipBackToIndex(null);
1895     } else {
1896         if (this.firstIndex >= 1) {
1897             this.jumpToIndex(this.firstIndex-1);
1898         }    
1899     }
1900 }
1901
1902 BookReader.prototype.first = function() {
1903     this.jumpToIndex(this.firstDisplayableIndex());
1904 }
1905
1906 BookReader.prototype.last = function() {
1907     this.jumpToIndex(this.lastDisplayableIndex());
1908 }
1909
1910 // scrollDown()
1911 //______________________________________________________________________________
1912 // Scrolls down one screen view
1913 BookReader.prototype.scrollDown = function() {
1914     if ($.inArray(this.mode, [this.constMode1up, this.constModeThumb]) >= 0) {
1915         if ( this.mode == this.constMode1up && (this.reduce >= this.onePageGetAutofitHeight()) ) {
1916             // Whole pages are visible, scroll whole page only
1917             return this.next();
1918         }
1919     
1920         $('#BRcontainer').animate(
1921             { scrollTop: '+=' + this._scrollAmount() + 'px'},
1922             400, 'easeInOutExpo'
1923         );
1924         return true;
1925     } else {
1926         return false;
1927     }
1928 }
1929
1930 // scrollUp()
1931 //______________________________________________________________________________
1932 // Scrolls up one screen view
1933 BookReader.prototype.scrollUp = function() {
1934     if ($.inArray(this.mode, [this.constMode1up, this.constModeThumb]) >= 0) {
1935         if ( this.mode == this.constMode1up && (this.reduce >= this.onePageGetAutofitHeight()) ) {
1936             // Whole pages are visible, scroll whole page only
1937             return this.prev();
1938         }
1939
1940         $('#BRcontainer').animate(
1941             { scrollTop: '-=' + this._scrollAmount() + 'px'},
1942             400, 'easeInOutExpo'
1943         );
1944         return true;
1945     } else {
1946         return false;
1947     }
1948 }
1949
1950 // _scrollAmount()
1951 //______________________________________________________________________________
1952 // The amount to scroll vertically in integer pixels
1953 BookReader.prototype._scrollAmount = function() {
1954     if (this.constMode1up == this.mode) {
1955         // Overlap by % of page size
1956         return parseInt($('#BRcontainer').attr('clientHeight') - this.getPageHeight(this.currentIndex()) / this.reduce * 0.03);
1957     }
1958     
1959     return parseInt(0.9 * $('#BRcontainer').attr('clientHeight'));
1960 }
1961
1962
1963 // flipBackToIndex()
1964 //______________________________________________________________________________
1965 // to flip back one spread, pass index=null
1966 BookReader.prototype.flipBackToIndex = function(index) {
1967     
1968     if (1 == this.mode) return;
1969
1970     var leftIndex = this.twoPage.currentIndexL;
1971     
1972     if (this.animating) return;
1973
1974     if (null != this.leafEdgeTmp) {
1975         alert('error: leafEdgeTmp should be null!');
1976         return;
1977     }
1978     
1979     if (null == index) {
1980         index = leftIndex-2;
1981     }
1982     //if (index<0) return;
1983     
1984     var previousIndices = this.getSpreadIndices(index);
1985     
1986     if (previousIndices[0] < this.firstDisplayableIndex() || previousIndices[1] < this.firstDisplayableIndex()) {
1987         return;
1988     }
1989     
1990     this.animating = true;
1991     
1992     if ('rl' != this.pageProgression) {
1993         // Assume LTR and we are going backward    
1994         this.prepareFlipLeftToRight(previousIndices[0], previousIndices[1]);        
1995         this.flipLeftToRight(previousIndices[0], previousIndices[1]);
1996     } else {
1997         // RTL and going backward
1998         var gutter = this.prepareFlipRightToLeft(previousIndices[0], previousIndices[1]);
1999         this.flipRightToLeft(previousIndices[0], previousIndices[1], gutter);
2000     }
2001 }
2002
2003 // flipLeftToRight()
2004 //______________________________________________________________________________
2005 // Flips the page on the left towards the page on the right
2006 BookReader.prototype.flipLeftToRight = function(newIndexL, newIndexR) {
2007
2008     var leftLeaf = this.twoPage.currentIndexL;
2009     
2010     var oldLeafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
2011     var newLeafEdgeWidthL = this.leafEdgeWidth(newIndexL);    
2012     var leafEdgeTmpW = oldLeafEdgeWidthL - newLeafEdgeWidthL;
2013     
2014     var currWidthL   = this.getPageWidth2UP(leftLeaf);
2015     var newWidthL    = this.getPageWidth2UP(newIndexL);
2016     var newWidthR    = this.getPageWidth2UP(newIndexR);
2017
2018     var top  = this.twoPageTop();
2019     var gutter = this.twoPage.middle + this.gutterOffsetForIndex(newIndexL);
2020     
2021     //console.log('leftEdgeTmpW ' + leafEdgeTmpW);
2022     //console.log('  gutter ' + gutter + ', scaledWL ' + scaledWL + ', newLeafEdgeWL ' + newLeafEdgeWidthL);
2023     
2024     //animation strategy:
2025     // 0. remove search highlight, if any.
2026     // 1. create a new div, called leafEdgeTmp to represent the leaf edge between the leftmost edge 
2027     //    of the left leaf and where the user clicked in the leaf edge.
2028     //    Note that if this function was triggered by left() and not a
2029     //    mouse click, the width of leafEdgeTmp is very small (zero px).
2030     // 2. animate both leafEdgeTmp to the gutter (without changing its width) and animate
2031     //    leftLeaf to width=0.
2032     // 3. When step 2 is finished, animate leafEdgeTmp to right-hand side of new right leaf
2033     //    (left=gutter+newWidthR) while also animating the new right leaf from width=0 to
2034     //    its new full width.
2035     // 4. After step 3 is finished, do the following:
2036     //      - remove leafEdgeTmp from the dom.
2037     //      - resize and move the right leaf edge (leafEdgeR) to left=gutter+newWidthR
2038     //          and width=twoPage.edgeWidth-newLeafEdgeWidthL.
2039     //      - resize and move the left leaf edge (leafEdgeL) to left=gutter-newWidthL-newLeafEdgeWidthL
2040     //          and width=newLeafEdgeWidthL.
2041     //      - resize the back cover (twoPage.coverDiv) to left=gutter-newWidthL-newLeafEdgeWidthL-10
2042     //          and width=newWidthL+newWidthR+twoPage.edgeWidth+20
2043     //      - move new left leaf (newIndexL) forward to zindex=2 so it can receive clicks.
2044     //      - remove old left and right leafs from the dom [pruneUnusedImgs()].
2045     //      - prefetch new adjacent leafs.
2046     //      - set up click handlers for both new left and right leafs.
2047     //      - redraw the search highlight.
2048     //      - update the pagenum box and the url.
2049     
2050     
2051     var leftEdgeTmpLeft = gutter - currWidthL - leafEdgeTmpW;
2052
2053     this.leafEdgeTmp = document.createElement('div');
2054     this.leafEdgeTmp.className = 'BRleafEdgeTmp';
2055     $(this.leafEdgeTmp).css({
2056         width: leafEdgeTmpW + 'px',
2057         height: this.twoPage.height-1 + 'px',
2058         left: leftEdgeTmpLeft + 'px',
2059         top: top+'px',
2060         zIndex:1000
2061     }).appendTo('#BRtwopageview');
2062     
2063     //$(this.leafEdgeL).css('width', newLeafEdgeWidthL+'px');
2064     $(this.leafEdgeL).css({
2065         width: newLeafEdgeWidthL+'px', 
2066         left: gutter-currWidthL-newLeafEdgeWidthL+'px'
2067     });   
2068
2069     // Left gets the offset of the current left leaf from the document
2070     var left = $(this.prefetchedImgs[leftLeaf]).offset().left;
2071     // $$$ This seems very similar to the gutter.  May be able to consolidate the logic.
2072     var right = $('#BRtwopageview').attr('clientWidth')-left-$(this.prefetchedImgs[leftLeaf]).width()+$('#BRtwopageview').offset().left-2+'px';
2073     
2074     // We change the left leaf to right positioning
2075     // $$$ This causes animation glitches during resize.  See https://bugs.edge.launchpad.net/gnubook/+bug/328327
2076     $(this.prefetchedImgs[leftLeaf]).css({
2077         right: right,
2078         left: ''
2079     });
2080
2081     $(this.leafEdgeTmp).animate({left: gutter}, this.flipSpeed, 'easeInSine');    
2082     //$(this.prefetchedImgs[leftLeaf]).animate({width: '0px'}, 'slow', 'easeInSine');
2083     
2084     var self = this;
2085
2086     this.removeSearchHilites();
2087
2088     //console.log('animating leafLeaf ' + leftLeaf + ' to 0px');
2089     $(this.prefetchedImgs[leftLeaf]).animate({width: '0px'}, self.flipSpeed, 'easeInSine', function() {
2090     
2091         //console.log('     and now leafEdgeTmp to left: gutter+newWidthR ' + (gutter + newWidthR));
2092         $(self.leafEdgeTmp).animate({left: gutter+newWidthR+'px'}, self.flipSpeed, 'easeOutSine');
2093
2094         //console.log('  animating newIndexR ' + newIndexR + ' to ' + newWidthR + ' from ' + $(self.prefetchedImgs[newIndexR]).width());
2095         $(self.prefetchedImgs[newIndexR]).animate({width: newWidthR+'px'}, self.flipSpeed, 'easeOutSine', function() {
2096             $(self.prefetchedImgs[newIndexL]).css('zIndex', 2);
2097             
2098             $(self.leafEdgeR).css({
2099                 // Moves the right leaf edge
2100                 width: self.twoPage.edgeWidth-newLeafEdgeWidthL+'px',
2101                 left:  gutter+newWidthR+'px'
2102             });
2103
2104             $(self.leafEdgeL).css({
2105                 // Moves and resizes the left leaf edge
2106                 width: newLeafEdgeWidthL+'px',
2107                 left:  gutter-newWidthL-newLeafEdgeWidthL+'px'
2108             });
2109
2110             // Resizes the brown border div
2111             $(self.twoPage.coverDiv).css({
2112                 width: self.twoPageCoverWidth(newWidthL+newWidthR)+'px',
2113                 left: gutter-newWidthL-newLeafEdgeWidthL-self.twoPage.coverInternalPadding+'px'
2114             });
2115             
2116             $(self.leafEdgeTmp).remove();
2117             self.leafEdgeTmp = null;
2118
2119             // $$$ TODO refactor with opposite direction flip
2120             
2121             self.twoPage.currentIndexL = newIndexL;
2122             self.twoPage.currentIndexR = newIndexR;
2123             self.twoPage.scaledWL = newWidthL;
2124             self.twoPage.scaledWR = newWidthR;
2125             self.twoPage.gutter = gutter;
2126             
2127             self.firstIndex = self.twoPage.currentIndexL;
2128             self.displayedIndices = [newIndexL, newIndexR];
2129             self.pruneUnusedImgs();
2130             self.prefetch();            
2131             self.animating = false;
2132             
2133             self.updateSearchHilites2UP();
2134             self.updatePageNumBox2UP();
2135             
2136             // self.twoPagePlaceFlipAreas(); // No longer used
2137             self.setMouseHandlers2UP();
2138             self.twoPageSetCursor();
2139             
2140             if (self.animationFinishedCallback) {
2141                 self.animationFinishedCallback();
2142                 self.animationFinishedCallback = null;
2143             }
2144         });
2145     });        
2146     
2147 }
2148
2149 // flipFwdToIndex()
2150 //______________________________________________________________________________
2151 // Whether we flip left or right is dependent on the page progression
2152 // to flip forward one spread, pass index=null
2153 BookReader.prototype.flipFwdToIndex = function(index) {
2154
2155     if (this.animating) return;
2156
2157     if (null != this.leafEdgeTmp) {
2158         alert('error: leafEdgeTmp should be null!');
2159         return;
2160     }
2161
2162     if (null == index) {
2163         index = this.twoPage.currentIndexR+2; // $$$ assumes indices are continuous
2164     }
2165     if (index > this.lastDisplayableIndex()) return;
2166
2167     this.animating = true;
2168     
2169     var nextIndices = this.getSpreadIndices(index);
2170     
2171     //console.log('flipfwd to indices ' + nextIndices[0] + ',' + nextIndices[1]);
2172
2173     if ('rl' != this.pageProgression) {
2174         // We did not specify RTL
2175         var gutter = this.prepareFlipRightToLeft(nextIndices[0], nextIndices[1]);
2176         this.flipRightToLeft(nextIndices[0], nextIndices[1], gutter);
2177     } else {
2178         // RTL
2179         var gutter = this.prepareFlipLeftToRight(nextIndices[0], nextIndices[1]);
2180         this.flipLeftToRight(nextIndices[0], nextIndices[1]);
2181     }
2182 }
2183
2184 // flipRightToLeft(nextL, nextR, gutter)
2185 // $$$ better not to have to pass gutter in
2186 //______________________________________________________________________________
2187 // Flip from left to right and show the nextL and nextR indices on those sides
2188 BookReader.prototype.flipRightToLeft = function(newIndexL, newIndexR) {
2189     var oldLeafEdgeWidthL = this.leafEdgeWidth(this.twoPage.currentIndexL);
2190     var oldLeafEdgeWidthR = this.twoPage.edgeWidth-oldLeafEdgeWidthL;
2191     var newLeafEdgeWidthL = this.leafEdgeWidth(newIndexL);  
2192     var newLeafEdgeWidthR = this.twoPage.edgeWidth-newLeafEdgeWidthL;
2193
2194     var leafEdgeTmpW = oldLeafEdgeWidthR - newLeafEdgeWidthR;
2195
2196     var top = this.twoPageTop();
2197     var scaledW = this.getPageWidth2UP(this.twoPage.currentIndexR);
2198
2199     var middle = this.twoPage.middle;
2200     var gutter = middle + this.gutterOffsetForIndex(newIndexL);
2201     
2202     this.leafEdgeTmp = document.createElement('div');
2203     this.leafEdgeTmp.className = 'BRleafEdgeTmp';
2204     $(this.leafEdgeTmp).css({
2205         width: leafEdgeTmpW + 'px',
2206         height: this.twoPage.height-1 + 'px',
2207         left: gutter+scaledW+'px',
2208         top: top+'px',    
2209         zIndex:1000
2210     }).appendTo('#BRtwopageview');
2211
2212     //var scaledWR = this.getPageWidth2UP(newIndexR); // $$$ should be current instead?
2213     //var scaledWL = this.getPageWidth2UP(newIndexL); // $$$ should be current instead?
2214     
2215     var currWidthL = this.getPageWidth2UP(this.twoPage.currentIndexL);
2216     var currWidthR = this.getPageWidth2UP(this.twoPage.currentIndexR);
2217     var newWidthL = this.getPageWidth2UP(newIndexL);
2218     var newWidthR = this.getPageWidth2UP(newIndexR);
2219     
2220     $(this.leafEdgeR).css({width: newLeafEdgeWidthR+'px', left: gutter+newWidthR+'px' });
2221
2222     var self = this; // closure-tastic!
2223
2224     var speed = this.flipSpeed;
2225
2226     this.removeSearchHilites();
2227     
2228     $(this.leafEdgeTmp).animate({left: gutter}, speed, 'easeInSine');    
2229     $(this.prefetchedImgs[this.twoPage.currentIndexR]).animate({width: '0px'}, speed, 'easeInSine', function() {
2230         $(self.leafEdgeTmp).animate({left: gutter-newWidthL-leafEdgeTmpW+'px'}, speed, 'easeOutSine');    
2231         $(self.prefetchedImgs[newIndexL]).animate({width: newWidthL+'px'}, speed, 'easeOutSine', function() {
2232             $(self.prefetchedImgs[newIndexR]).css('zIndex', 2);
2233             
2234             $(self.leafEdgeL).css({
2235                 width: newLeafEdgeWidthL+'px', 
2236                 left: gutter-newWidthL-newLeafEdgeWidthL+'px'
2237             });
2238             
2239             // Resizes the book cover
2240             $(self.twoPage.coverDiv).css({
2241                 width: self.twoPageCoverWidth(newWidthL+newWidthR)+'px',
2242                 left: gutter - newWidthL - newLeafEdgeWidthL - self.twoPage.coverInternalPadding + 'px'
2243             });
2244             
2245             $(self.leafEdgeTmp).remove();
2246             self.leafEdgeTmp = null;
2247             
2248             self.twoPage.currentIndexL = newIndexL;
2249             self.twoPage.currentIndexR = newIndexR;
2250             self.twoPage.scaledWL = newWidthL;
2251             self.twoPage.scaledWR = newWidthR;
2252             self.twoPage.gutter = gutter;
2253
2254             self.firstIndex = self.twoPage.currentIndexL;
2255             self.displayedIndices = [newIndexL, newIndexR];
2256             self.pruneUnusedImgs();
2257             self.prefetch();
2258             self.animating = false;
2259
2260
2261             self.updateSearchHilites2UP();
2262             self.updatePageNumBox2UP();
2263             
2264             // self.twoPagePlaceFlipAreas(); // No longer used
2265             self.setMouseHandlers2UP();     
2266             self.twoPageSetCursor();
2267             
2268             if (self.animationFinishedCallback) {
2269                 self.animationFinishedCallback();
2270                 self.animationFinishedCallback = null;
2271             }
2272         });
2273     });    
2274 }
2275
2276 // setMouseHandlers2UP
2277 //______________________________________________________________________________
2278 BookReader.prototype.setMouseHandlers2UP = function() {
2279     this.setClickHandler2UP( this.prefetchedImgs[this.twoPage.currentIndexL],
2280         { self: this },
2281         function(e) {
2282             e.data.self.left();
2283             e.preventDefault();
2284         }
2285     );
2286         
2287     this.setClickHandler2UP( this.prefetchedImgs[this.twoPage.currentIndexR],
2288         { self: this },
2289         function(e) {
2290             e.data.self.right();
2291             e.preventDefault();
2292         }
2293     );
2294 }
2295
2296 // prefetchImg()
2297 //______________________________________________________________________________
2298 BookReader.prototype.prefetchImg = function(index) {
2299     var pageURI = this._getPageURI(index);
2300
2301     // Load image if not loaded or URI has changed (e.g. due to scaling)
2302     var loadImage = false;
2303     if (undefined == this.prefetchedImgs[index]) {
2304         //console.log('no image for ' + index);
2305         loadImage = true;
2306     } else if (pageURI != this.prefetchedImgs[index].uri) {
2307         //console.log('uri changed for ' + index);
2308         loadImage = true;
2309     }
2310     
2311     if (loadImage) {
2312         //console.log('prefetching ' + index);
2313         var img = document.createElement("img");
2314         img.src = pageURI;
2315         img.uri = pageURI; // browser may rewrite src so we stash raw URI here
2316         this.prefetchedImgs[index] = img;
2317     }
2318 }
2319
2320
2321 // prepareFlipLeftToRight()
2322 //
2323 //______________________________________________________________________________
2324 //
2325 // Prepare to flip the left page towards the right.  This corresponds to moving
2326 // backward when the page progression is left to right.
2327 BookReader.prototype.prepareFlipLeftToRight = function(prevL, prevR) {
2328
2329     //console.log('  preparing left->right for ' + prevL + ',' + prevR);
2330
2331     this.prefetchImg(prevL);
2332     this.prefetchImg(prevR);
2333     
2334     var height  = this._getPageHeight(prevL); 
2335     var width   = this._getPageWidth(prevL);    
2336     var middle = this.twoPage.middle;
2337     var top  = this.twoPageTop();                
2338     var scaledW = this.twoPage.height*width/height; // $$$ assumes height of page is dominant
2339
2340     // The gutter is the dividing line between the left and right pages.
2341     // It is offset from the middle to create the illusion of thickness to the pages
2342     var gutter = middle + this.gutterOffsetForIndex(prevL);
2343     
2344     //console.log('    gutter for ' + prevL + ' is ' + gutter);
2345     //console.log('    prevL.left: ' + (gutter - scaledW) + 'px');
2346     //console.log('    changing prevL ' + prevL + ' to left: ' + (gutter-scaledW) + ' width: ' + scaledW);
2347     
2348     leftCSS = {
2349         position: 'absolute',
2350         left: gutter-scaledW+'px',
2351         right: '', // clear right property
2352         top:    top+'px',
2353         height: this.twoPage.height,
2354         width:  scaledW+'px',
2355         backgroundColor: this.getPageBackgroundColor(prevL),
2356         borderRight: '1px solid black',
2357         zIndex: 1
2358     }
2359     
2360     $(this.prefetchedImgs[prevL]).css(leftCSS);
2361
2362     $('#BRtwopageview').append(this.prefetchedImgs[prevL]);
2363
2364     //console.log('    changing prevR ' + prevR + ' to left: ' + gutter + ' width: 0');
2365
2366     rightCSS = {
2367         position: 'absolute',
2368         left:   gutter+'px',
2369         right: '',
2370         top:    top+'px',
2371         height: this.twoPage.height,
2372         width:  '0px',
2373         backgroundColor: this.getPageBackgroundColor(prevR),
2374         borderLeft: '1px solid black',
2375         zIndex: 2
2376     }
2377     
2378     $(this.prefetchedImgs[prevR]).css(rightCSS);
2379
2380     $('#BRtwopageview').append(this.prefetchedImgs[prevR]);
2381             
2382 }
2383
2384 // $$$ mang we're adding an extra pixel in the middle.  See https://bugs.edge.launchpad.net/gnubook/+bug/411667
2385 // prepareFlipRightToLeft()
2386 //______________________________________________________________________________
2387 BookReader.prototype.prepareFlipRightToLeft = function(nextL, nextR) {
2388
2389     //console.log('  preparing left<-right for ' + nextL + ',' + nextR);
2390
2391     // Prefetch images
2392     this.prefetchImg(nextL);
2393     this.prefetchImg(nextR);
2394
2395     var height  = this._getPageHeight(nextR); 
2396     var width   = this._getPageWidth(nextR);    
2397     var middle = this.twoPage.middle;
2398     var top  = this.twoPageTop();               
2399     var scaledW = this.twoPage.height*width/height;
2400
2401     var gutter = middle + this.gutterOffsetForIndex(nextL);
2402         
2403     //console.log(' prepareRTL changing nextR ' + nextR + ' to left: ' + gutter);
2404     $(this.prefetchedImgs[nextR]).css({
2405         position: 'absolute',
2406         left:   gutter+'px',
2407         top:    top+'px',
2408         backgroundColor: this.getPageBackgroundColor(nextR),
2409         height: this.twoPage.height,
2410         width:  scaledW+'px',
2411         borderLeft: '1px solid black',
2412         zIndex: 1
2413     });
2414
2415     $('#BRtwopageview').append(this.prefetchedImgs[nextR]);
2416
2417     height  = this._getPageHeight(nextL); 
2418     width   = this._getPageWidth(nextL);      
2419     scaledW = this.twoPage.height*width/height;
2420
2421     //console.log(' prepareRTL changing nextL ' + nextL + ' to right: ' + $('#BRcontainer').width()-gutter);
2422     $(this.prefetchedImgs[nextL]).css({
2423         position: 'absolute',
2424         right:   $('#BRtwopageview').attr('clientWidth')-gutter+'px',
2425         top:    top+'px',
2426         backgroundColor: this.getPageBackgroundColor(nextL),
2427         height: this.twoPage.height,
2428         width:  0+'px', // Start at 0 width, then grow to the left
2429         borderRight: '1px solid black',
2430         zIndex: 2
2431     });
2432
2433     $('#BRtwopageview').append(this.prefetchedImgs[nextL]);    
2434             
2435 }
2436
2437 // getNextLeafs() -- NOT RTL AWARE
2438 //______________________________________________________________________________
2439 // BookReader.prototype.getNextLeafs = function(o) {
2440 //     //TODO: we might have two left or two right leafs in a row (damaged book)
2441 //     //For now, assume that leafs are contiguous.
2442 //     
2443 //     //return [this.twoPage.currentIndexL+2, this.twoPage.currentIndexL+3];
2444 //     o.L = this.twoPage.currentIndexL+2;
2445 //     o.R = this.twoPage.currentIndexL+3;
2446 // }
2447
2448 // getprevLeafs() -- NOT RTL AWARE
2449 //______________________________________________________________________________
2450 // BookReader.prototype.getPrevLeafs = function(o) {
2451 //     //TODO: we might have two left or two right leafs in a row (damaged book)
2452 //     //For now, assume that leafs are contiguous.
2453 //     
2454 //     //return [this.twoPage.currentIndexL-2, this.twoPage.currentIndexL-1];
2455 //     o.L = this.twoPage.currentIndexL-2;
2456 //     o.R = this.twoPage.currentIndexL-1;
2457 // }
2458
2459 // pruneUnusedImgs()
2460 //______________________________________________________________________________
2461 BookReader.prototype.pruneUnusedImgs = function() {
2462     //console.log('current: ' + this.twoPage.currentIndexL + ' ' + this.twoPage.currentIndexR);
2463     for (var key in this.prefetchedImgs) {
2464         //console.log('key is ' + key);
2465         if ((key != this.twoPage.currentIndexL) && (key != this.twoPage.currentIndexR)) {
2466             //console.log('removing key '+ key);
2467             $(this.prefetchedImgs[key]).remove();
2468         }
2469         if ((key < this.twoPage.currentIndexL-4) || (key > this.twoPage.currentIndexR+4)) {
2470             //console.log('deleting key '+ key);
2471             delete this.prefetchedImgs[key];
2472         }
2473     }
2474 }
2475
2476 // prefetch()
2477 //______________________________________________________________________________
2478 BookReader.prototype.prefetch = function() {
2479
2480     // $$$ We should check here if the current indices have finished
2481     //     loading (with some timeout) before loading more page images
2482     //     See https://bugs.edge.launchpad.net/bookreader/+bug/511391
2483
2484     // prefetch visible pages first
2485     this.prefetchImg(this.twoPage.currentIndexL);
2486     this.prefetchImg(this.twoPage.currentIndexR);
2487         
2488     var adjacentPagesToLoad = 3;
2489     
2490     var lowCurrent = Math.min(this.twoPage.currentIndexL, this.twoPage.currentIndexR);
2491     var highCurrent = Math.max(this.twoPage.currentIndexL, this.twoPage.currentIndexR);
2492         
2493     var start = Math.max(lowCurrent - adjacentPagesToLoad, 0);
2494     var end = Math.min(highCurrent + adjacentPagesToLoad, this.numLeafs - 1);
2495     
2496     // Load images spreading out from current
2497     for (var i = 1; i <= adjacentPagesToLoad; i++) {
2498         var goingDown = lowCurrent - i;
2499         if (goingDown >= start) {
2500             this.prefetchImg(goingDown);
2501         }
2502         var goingUp = highCurrent + i;
2503         if (goingUp <= end) {
2504             this.prefetchImg(goingUp);
2505         }
2506     }
2507
2508     /*
2509     var lim = this.twoPage.currentIndexL-4;
2510     var i;
2511     lim = Math.max(lim, 0);
2512     for (i = lim; i < this.twoPage.currentIndexL; i++) {
2513         this.prefetchImg(i);
2514     }
2515     
2516     if (this.numLeafs > (this.twoPage.currentIndexR+1)) {
2517         lim = Math.min(this.twoPage.currentIndexR+4, this.numLeafs-1);
2518         for (i=this.twoPage.currentIndexR+1; i<=lim; i++) {
2519             this.prefetchImg(i);
2520         }
2521     }
2522     */
2523 }
2524
2525 // getPageWidth2UP()
2526 //______________________________________________________________________________
2527 BookReader.prototype.getPageWidth2UP = function(index) {
2528     // We return the width based on the dominant height
2529     var height  = this._getPageHeight(index); 
2530     var width   = this._getPageWidth(index);    
2531     return Math.floor(this.twoPage.height*width/height); // $$$ we assume width is relative to current spread
2532 }    
2533
2534 // search()
2535 //______________________________________________________________________________
2536 BookReader.prototype.search = function(term) {
2537     term = term.replace(/\//g, ' '); // strip slashes
2538     this.searchTerm = term;
2539     $('#BookReaderSearchScript').remove();
2540     var script  = document.createElement("script");
2541     script.setAttribute('id', 'BookReaderSearchScript');
2542     script.setAttribute("type", "text/javascript");
2543     script.setAttribute("src", 'http://'+this.server+'/BookReader/flipbook_search_br.php?url='+escape(this.bookPath + '_djvu.xml')+'&term='+term+'&format=XML&callback=br.BRSearchCallback');
2544     document.getElementsByTagName('head')[0].appendChild(script);
2545     $('#BookReaderSearchBox').val(term);
2546     $('#BookReaderSearchResults').html('Searching...');
2547 }
2548
2549 // BRSearchCallback()
2550 //______________________________________________________________________________
2551 BookReader.prototype.BRSearchCallback = function(txt) {
2552     //alert(txt);
2553     if (jQuery.browser.msie) {
2554         var dom=new ActiveXObject("Microsoft.XMLDOM");
2555         dom.async="false";
2556         dom.loadXML(txt);    
2557     } else {
2558         var parser = new DOMParser();
2559         var dom = parser.parseFromString(txt, "text/xml");    
2560     }
2561     
2562     $('#BookReaderSearchResults').empty();    
2563     $('#BookReaderSearchResults').append('<ul>');
2564     
2565     for (var key in this.searchResults) {
2566         if (null != this.searchResults[key].div) {
2567             $(this.searchResults[key].div).remove();
2568         }
2569         delete this.searchResults[key];
2570     }
2571     
2572     var pages = dom.getElementsByTagName('PAGE');
2573     
2574     if (0 == pages.length) {
2575         // $$$ it would be nice to echo the (sanitized) search result here
2576         $('#BookReaderSearchResults').append('<li>No search results found</li>');
2577     } else {    
2578         for (var i = 0; i < pages.length; i++){
2579             //console.log(pages[i].getAttribute('file').substr(1) +'-'+ parseInt(pages[i].getAttribute('file').substr(1), 10));
2580     
2581             
2582             var re = new RegExp (/_(\d{4})\.djvu/);
2583             var reMatch = re.exec(pages[i].getAttribute('file'));
2584             var index = parseInt(reMatch[1], 10);
2585             //var index = parseInt(pages[i].getAttribute('file').substr(1), 10);
2586             
2587             var children = pages[i].childNodes;
2588             var context = '';
2589             for (var j=0; j<children.length; j++) {
2590                 //console.log(j + ' - ' + children[j].nodeName);
2591                 //console.log(children[j].firstChild.nodeValue);
2592                 if ('CONTEXT' == children[j].nodeName) {
2593                     context += children[j].firstChild.nodeValue;
2594                 } else if ('WORD' == children[j].nodeName) {
2595                     context += '<b>'+children[j].firstChild.nodeValue+'</b>';
2596                     
2597                     var index = this.leafNumToIndex(index);
2598                     if (null != index) {
2599                         //coordinates are [left, bottom, right, top, [baseline]]
2600                         //we'll skip baseline for now...
2601                         var coords = children[j].getAttribute('coords').split(',',4);
2602                         if (4 == coords.length) {
2603                             this.searchResults[index] = {'l':parseInt(coords[0]), 'b':parseInt(coords[1]), 'r':parseInt(coords[2]), 't':parseInt(coords[3]), 'div':null};
2604                         }
2605                     }
2606                 }
2607             }
2608             var pageName = this.getPageName(index);
2609             var middleX = (this.searchResults[index].l + this.searchResults[index].r) >> 1;
2610             var middleY = (this.searchResults[index].t + this.searchResults[index].b) >> 1;
2611             //TODO: remove hardcoded instance name
2612             $('#BookReaderSearchResults').append('<li><b><a href="javascript:br.jumpToIndex('+index+','+middleX+','+middleY+');">' + pageName + '</a></b> - ' + context + '</li>');
2613         }
2614     }
2615     $('#BookReaderSearchResults').append('</ul>');
2616
2617     // $$$ update again for case of loading search URL in new browser window (search box may not have been ready yet)
2618     $('#BookReaderSearchBox').val(this.searchTerm);
2619
2620     this.updateSearchHilites();
2621 }
2622
2623 // updateSearchHilites()
2624 //______________________________________________________________________________
2625 BookReader.prototype.updateSearchHilites = function() {
2626     if (2 == this.mode) {
2627         this.updateSearchHilites2UP();
2628     } else {
2629         this.updateSearchHilites1UP();
2630     }
2631 }
2632
2633 // showSearchHilites1UP()
2634 //______________________________________________________________________________
2635 BookReader.prototype.updateSearchHilites1UP = function() {
2636
2637     for (var key in this.searchResults) {
2638         
2639         if (jQuery.inArray(parseInt(key), this.displayedIndices) >= 0) {
2640             var result = this.searchResults[key];
2641             if (null == result.div) {
2642                 result.div = document.createElement('div');
2643                 $(result.div).attr('className', 'BookReaderSearchHilite').appendTo('#pagediv'+key);
2644                 //console.log('appending ' + key);
2645             }    
2646             $(result.div).css({
2647                 width:  (result.r-result.l)/this.reduce + 'px',
2648                 height: (result.b-result.t)/this.reduce + 'px',
2649                 left:   (result.l)/this.reduce + 'px',
2650                 top:    (result.t)/this.reduce +'px'
2651             });
2652
2653         } else {
2654             //console.log(key + ' not displayed');
2655             this.searchResults[key].div=null;
2656         }
2657     }
2658 }
2659
2660 // twoPageGutter()
2661 //______________________________________________________________________________
2662 // Returns the position of the gutter (line between the page images)
2663 BookReader.prototype.twoPageGutter = function() {
2664     return this.twoPage.middle + this.gutterOffsetForIndex(this.twoPage.currentIndexL);
2665 }
2666
2667 // twoPageTop()
2668 //______________________________________________________________________________
2669 // Returns the offset for the top of the page images
2670 BookReader.prototype.twoPageTop = function() {
2671     return this.twoPage.coverExternalPadding + this.twoPage.coverInternalPadding; // $$$ + border?
2672 }
2673
2674 // twoPageCoverWidth()
2675 //______________________________________________________________________________
2676 // Returns the width of the cover div given the total page width
2677 BookReader.prototype.twoPageCoverWidth = function(totalPageWidth) {
2678     return totalPageWidth + this.twoPage.edgeWidth + 2*this.twoPage.coverInternalPadding;
2679 }
2680
2681 // twoPageGetViewCenter()
2682 //______________________________________________________________________________
2683 // Returns the percentage offset into twopageview div at the center of container div
2684 // { percentageX: float, percentageY: float }
2685 BookReader.prototype.twoPageGetViewCenter = function() {
2686     var center = {};
2687
2688     var containerOffset = $('#BRcontainer').offset();
2689     var viewOffset = $('#BRtwopageview').offset();
2690     center.percentageX = (containerOffset.left - viewOffset.left + ($('#BRcontainer').attr('clientWidth') >> 1)) / this.twoPage.totalWidth;
2691     center.percentageY = (containerOffset.top - viewOffset.top + ($('#BRcontainer').attr('clientHeight') >> 1)) / this.twoPage.totalHeight;
2692     
2693     return center;
2694 }
2695
2696 // twoPageCenterView(percentageX, percentageY)
2697 //______________________________________________________________________________
2698 // Centers the point given by percentage from left,top of twopageview
2699 BookReader.prototype.twoPageCenterView = function(percentageX, percentageY) {
2700     if ('undefined' == typeof(percentageX)) {
2701         percentageX = 0.5;
2702     }
2703     if ('undefined' == typeof(percentageY)) {
2704         percentageY = 0.5;
2705     }
2706
2707     var viewWidth = $('#BRtwopageview').width();
2708     var containerClientWidth = $('#BRcontainer').attr('clientWidth');
2709     var intoViewX = percentageX * viewWidth;
2710     
2711     var viewHeight = $('#BRtwopageview').height();
2712     var containerClientHeight = $('#BRcontainer').attr('clientHeight');
2713     var intoViewY = percentageY * viewHeight;
2714     
2715     if (viewWidth < containerClientWidth) {
2716         // Can fit width without scrollbars - center by adjusting offset
2717         $('#BRtwopageview').css('left', (containerClientWidth >> 1) - intoViewX + 'px');    
2718     } else {
2719         // Need to scroll to center
2720         $('#BRtwopageview').css('left', 0);
2721         $('#BRcontainer').scrollLeft(intoViewX - (containerClientWidth >> 1));
2722     }
2723     
2724     if (viewHeight < containerClientHeight) {
2725         // Fits with scrollbars - add offset
2726         $('#BRtwopageview').css('top', (containerClientHeight >> 1) - intoViewY + 'px');
2727     } else {
2728         $('#BRtwopageview').css('top', 0);
2729         $('#BRcontainer').scrollTop(intoViewY - (containerClientHeight >> 1));
2730     }
2731 }
2732
2733 // twoPageFlipAreaHeight
2734 //______________________________________________________________________________
2735 // Returns the integer height of the click-to-flip areas at the edges of the book
2736 BookReader.prototype.twoPageFlipAreaHeight = function() {
2737     return parseInt(this.twoPage.height);
2738 }
2739
2740 // twoPageFlipAreaWidth
2741 //______________________________________________________________________________
2742 // Returns the integer width of the flip areas 
2743 BookReader.prototype.twoPageFlipAreaWidth = function() {
2744     var max = 100; // $$$ TODO base on view width?
2745     var min = 10;
2746     
2747     var width = this.twoPage.width * 0.15;
2748     return parseInt(BookReader.util.clamp(width, min, max));
2749 }
2750
2751 // twoPageFlipAreaTop
2752 //______________________________________________________________________________
2753 // Returns integer top offset for flip areas
2754 BookReader.prototype.twoPageFlipAreaTop = function() {
2755     return parseInt(this.twoPage.bookCoverDivTop + this.twoPage.coverInternalPadding);
2756 }
2757
2758 // twoPageLeftFlipAreaLeft
2759 //______________________________________________________________________________
2760 // Left offset for left flip area
2761 BookReader.prototype.twoPageLeftFlipAreaLeft = function() {
2762     return parseInt(this.twoPage.gutter - this.twoPage.scaledWL);
2763 }
2764
2765 // twoPageRightFlipAreaLeft
2766 //______________________________________________________________________________
2767 // Left offset for right flip area
2768 BookReader.prototype.twoPageRightFlipAreaLeft = function() {
2769     return parseInt(this.twoPage.gutter + this.twoPage.scaledWR - this.twoPageFlipAreaWidth());
2770 }
2771
2772 // twoPagePlaceFlipAreas
2773 //______________________________________________________________________________
2774 // Readjusts position of flip areas based on current layout
2775 BookReader.prototype.twoPagePlaceFlipAreas = function() {
2776     // We don't set top since it shouldn't change relative to view
2777     $(this.twoPage.leftFlipArea).css({
2778         left: this.twoPageLeftFlipAreaLeft() + 'px',
2779         width: this.twoPageFlipAreaWidth() + 'px'
2780     });
2781     $(this.twoPage.rightFlipArea).css({
2782         left: this.twoPageRightFlipAreaLeft() + 'px',
2783         width: this.twoPageFlipAreaWidth() + 'px'
2784     });
2785 }
2786     
2787 // showSearchHilites2UP()
2788 //______________________________________________________________________________
2789 BookReader.prototype.updateSearchHilites2UP = function() {
2790
2791     for (var key in this.searchResults) {
2792         key = parseInt(key, 10);
2793         if (jQuery.inArray(key, this.displayedIndices) >= 0) {
2794             var result = this.searchResults[key];
2795             if (null == result.div) {
2796                 result.div = document.createElement('div');
2797                 $(result.div).attr('className', 'BookReaderSearchHilite').css('zIndex', 3).appendTo('#BRtwopageview');
2798                 //console.log('appending ' + key);
2799             }
2800
2801             // We calculate the reduction factor for the specific page because it can be different
2802             // for each page in the spread
2803             var height = this._getPageHeight(key);
2804             var width  = this._getPageWidth(key)
2805             var reduce = this.twoPage.height/height;
2806             var scaledW = parseInt(width*reduce);
2807             
2808             var gutter = this.twoPageGutter();
2809             var pageL;
2810             if ('L' == this.getPageSide(key)) {
2811                 pageL = gutter-scaledW;
2812             } else {
2813                 pageL = gutter;
2814             }
2815             var pageT  = this.twoPageTop();
2816             
2817             $(result.div).css({
2818                 width:  (result.r-result.l)*reduce + 'px',
2819                 height: (result.b-result.t)*reduce + 'px',
2820                 left:   pageL+(result.l)*reduce + 'px',
2821                 top:    pageT+(result.t)*reduce +'px'
2822             });
2823
2824         } else {
2825             //console.log(key + ' not displayed');
2826             if (null != this.searchResults[key].div) {
2827                 //console.log('removing ' + key);
2828                 $(this.searchResults[key].div).remove();
2829             }
2830             this.searchResults[key].div=null;
2831         }
2832     }
2833 }
2834
2835 // removeSearchHilites()
2836 //______________________________________________________________________________
2837 BookReader.prototype.removeSearchHilites = function() {
2838     for (var key in this.searchResults) {
2839         if (null != this.searchResults[key].div) {
2840             $(this.searchResults[key].div).remove();
2841             this.searchResults[key].div=null;
2842         }        
2843     }
2844 }
2845
2846 // printPage
2847 //______________________________________________________________________________
2848 BookReader.prototype.printPage = function() {
2849     window.open(this.getPrintURI(), 'printpage', 'width=400, height=500, resizable=yes, scrollbars=no, toolbar=no, location=no');
2850
2851     /* iframe implementation
2852
2853     if (null != this.printPopup) { // check if already showing
2854         return;
2855     }
2856     this.printPopup = document.createElement("div");
2857     $(this.printPopup).css({
2858         position: 'absolute',
2859         top:      '20px',
2860         left:     ($('#BRcontainer').width()-400)/2 + 'px',
2861         width:    '400px',
2862         padding:  "20px",
2863         border:   "3px double #999999",
2864         zIndex:   3,
2865         backgroundColor: "#fff"
2866     }).appendTo('#BookReader');
2867
2868     var indexToPrint;
2869     if (this.constMode1up == this.mode) {
2870         indexToPrint = this.firstIndex;
2871     } else {
2872         indexToPrint = this.twoPage.currentIndexL;
2873     }
2874     
2875     this.indexToPrint = indexToPrint;
2876     
2877     var htmlStr = '<div style="text-align: center;">';
2878     htmlStr =  '<p style="text-align:center;"><b><a href="javascript:void(0);" onclick="window.frames[0].focus(); window.frames[0].print(); return false;">Click here to print this page</a></b></p>';
2879     htmlStr += '<div id="printDiv" name="printDiv" style="text-align: center; width: 233px; margin: auto">'
2880     htmlStr +=   '<p style="text-align:right; margin: 0; font-size: 0.85em">';
2881     //htmlStr +=     '<button class="BRicon rollover book_up" onclick="br.updatePrintFrame(-1); return false;"></button> ';
2882     //htmlStr +=     '<button class="BRicon rollover book_down" onclick="br.updatePrintFrame(1); return false;"></button>';
2883     htmlStr += '<a href="#" onclick="br.updatePrintFrame(-1); return false;">Prev</a> <a href="#" onclick="br.updatePrintFrame(1); return false;">Next</a>';
2884     htmlStr +=   '</p>';
2885     htmlStr += '</div>';
2886     htmlStr += '<p style="text-align:center;"><a href="" onclick="br.printPopup = null; $(this.parentNode.parentNode).remove(); return false">Close popup</a></p>';
2887     htmlStr += '</div>';
2888     
2889     this.printPopup.innerHTML = htmlStr;
2890     
2891     var iframe = document.createElement('iframe');
2892     iframe.id = 'printFrame';
2893     iframe.name = 'printFrame';
2894     iframe.width = '233px'; // 8.5 x 11 aspect
2895     iframe.height = '300px';
2896     
2897     var self = this; // closure
2898         
2899     $(iframe).load(function() {
2900         var doc = BookReader.util.getIFrameDocument(this);
2901         $('body', doc).html(self.getPrintFrameContent(self.indexToPrint));
2902     });
2903     
2904     $('#printDiv').prepend(iframe);
2905     */
2906 }
2907
2908 // Get print URI from current indices and mode
2909 BookReader.prototype.getPrintURI = function() {
2910     var indexToPrint;
2911     if (this.constMode2up == this.mode) {
2912         indexToPrint = this.twoPage.currentIndexL;        
2913     } else {
2914         indexToPrint = this.firstIndex; // $$$ the index in the middle of the viewport would make more sense
2915     }
2916     
2917     var options = 'id=' + this.bookId + '&server=' + this.server + '&zip=' + this.zip
2918         + '&format=' + this.imageFormat + '&file=' + this._getPageFile(indexToPrint)
2919         + '&width=' + this._getPageWidth(indexToPrint) + '&height=' + this._getPageHeight(indexToPrint);
2920    
2921     if (this.constMode2up == this.mode) {
2922         options += '&file2=' + this._getPageFile(this.twoPage.currentIndexR) + '&width2=' + this._getPageWidth(this.twoPage.currentIndexR);
2923         options += '&height2=' + this._getPageHeight(this.twoPage.currentIndexR);
2924         options += '&title=' + encodeURIComponent(this.shortTitle(50) + ' - Pages ' + this.getPageNum(this.twoPage.currentIndexL) + ', ' + this.getPageNum(this.twoPage.currentIndexR));
2925     } else {
2926         options += '&title=' + encodeURIComponent(this.shortTitle(50) + ' - Page ' + this.getPageNum(indexToPrint));
2927     }
2928
2929     return '/bookreader/print.php?' + options;
2930 }
2931
2932 /* iframe implementation
2933 BookReader.prototype.getPrintFrameContent = function(index) {    
2934     // We fit the image based on an assumed A4 aspect ratio.  A4 is a bit taller aspect than
2935     // 8.5x11 so we should end up not overflowing on either paper size.
2936     var paperAspect = 8.5 / 11;
2937     var imageAspect = this._getPageWidth(index) / this._getPageHeight(index);
2938     
2939     var rotate = 0;
2940     
2941     // Rotate if possible and appropriate, to get larger image size on printed page
2942     if (this.canRotatePage(index)) {
2943         if (imageAspect > 1 && imageAspect > paperAspect) {
2944             // more wide than square, and more wide than paper
2945             rotate = 90;
2946             imageAspect = 1/imageAspect;
2947         }
2948     }
2949     
2950     var fitAttrs;
2951     if (imageAspect > paperAspect) {
2952         // wider than paper, fit width
2953         fitAttrs = 'width="95%"';
2954     } else {
2955         // taller than paper, fit height
2956         fitAttrs = 'height="95%"';
2957     }
2958
2959     var imageURL = this._getPageURI(index, 1, rotate);
2960     var iframeStr = '<html style="padding: 0; border: 0; margin: 0"><head><title>' + this.bookTitle + '</title></head><body style="padding: 0; border:0; margin: 0">';
2961     iframeStr += '<div style="text-align: center; width: 99%; height: 99%; overflow: hidden;">';
2962     iframeStr +=   '<img src="' + imageURL + '" ' + fitAttrs + ' />';
2963     iframeStr += '</div>';
2964     iframeStr += '</body></html>';
2965     
2966     return iframeStr;
2967 }
2968
2969 BookReader.prototype.updatePrintFrame = function(delta) {
2970     var newIndex = this.indexToPrint + delta;
2971     newIndex = BookReader.util.clamp(newIndex, 0, this.numLeafs - 1);
2972     if (newIndex == this.indexToPrint) {
2973         return;
2974     }
2975     this.indexToPrint = newIndex;
2976     var doc = BookReader.util.getIFrameDocument($('#printFrame')[0]);
2977     $('body', doc).html(this.getPrintFrameContent(this.indexToPrint));
2978 }
2979 */
2980
2981 // showEmbedCode()
2982 //______________________________________________________________________________
2983 BookReader.prototype.showEmbedCode = function() {
2984     if (null != this.embedPopup) { // check if already showing
2985         return;
2986     }
2987     this.autoStop();
2988     this.embedPopup = document.createElement("div");
2989     $(this.embedPopup).css({
2990         position: 'absolute',
2991         top:      '20px',
2992         left:     ($('#BRcontainer').attr('clientWidth')-400)/2 + 'px',
2993         width:    '400px',
2994         padding:  "20px",
2995         border:   "3px double #999999",
2996         zIndex:   3,
2997         backgroundColor: "#fff"
2998     }).appendTo('#BookReader');
2999
3000     htmlStr =  '<p style="text-align:center;"><b>Embed Bookreader in your blog!</b></p>';
3001     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>';
3002     htmlStr += '<p>Embed Code: <input type="text" size="40" value="' + this.getEmbedCode() + '"></p>';
3003     htmlStr += '<p style="text-align:center;"><a href="" onclick="br.embedPopup = null; $(this.parentNode.parentNode).remove(); return false">Close popup</a></p>';    
3004
3005     this.embedPopup.innerHTML = htmlStr;
3006     $(this.embedPopup).find('input').bind('click', function() {
3007         this.select();
3008     })
3009 }
3010
3011 // autoToggle()
3012 //______________________________________________________________________________
3013 BookReader.prototype.autoToggle = function() {
3014
3015     var bComingFrom1up = false;
3016     if (2 != this.mode) {
3017         bComingFrom1up = true;
3018         this.switchMode(2);
3019     }
3020     
3021     // Change to autofit if book is too large
3022     if (this.reduce < this.twoPageGetAutofitReduce()) {
3023         this.zoom2up('auto');
3024     }
3025
3026     var self = this;
3027     if (null == this.autoTimer) {
3028         this.flipSpeed = 2000;
3029         
3030         // $$$ Draw events currently cause layout problems when they occur during animation.
3031         //     There is a specific problem when changing from 1-up immediately to autoplay in RTL so
3032         //     we workaround for now by not triggering immediate animation in that case.
3033         //     See https://bugs.launchpad.net/gnubook/+bug/328327
3034         if (('rl' == this.pageProgression) && bComingFrom1up) {
3035             // don't flip immediately -- wait until timer fires
3036         } else {
3037             // flip immediately
3038             this.flipFwdToIndex();        
3039         }
3040
3041         $('#BRtoolbar .play').hide();
3042         $('#BRtoolbar .pause').show();
3043         this.autoTimer=setInterval(function(){
3044             if (self.animating) {return;}
3045             
3046             if (Math.max(self.twoPage.currentIndexL, self.twoPage.currentIndexR) >= self.lastDisplayableIndex()) {
3047                 self.flipBackToIndex(1); // $$$ really what we want?
3048             } else {            
3049                 self.flipFwdToIndex();
3050             }
3051         },5000);
3052     } else {
3053         this.autoStop();
3054     }
3055 }
3056
3057 // autoStop()
3058 //______________________________________________________________________________
3059 // Stop autoplay mode, allowing animations to finish
3060 BookReader.prototype.autoStop = function() {
3061     if (null != this.autoTimer) {
3062         clearInterval(this.autoTimer);
3063         this.flipSpeed = 'fast';
3064         $('#BRtoolbar .pause').hide();
3065         $('#BRtoolbar .play').show();
3066         this.autoTimer = null;
3067     }
3068 }
3069
3070 // stopFlipAnimations
3071 //______________________________________________________________________________
3072 // Immediately stop flip animations.  Callbacks are triggered.
3073 BookReader.prototype.stopFlipAnimations = function() {
3074
3075     this.autoStop(); // Clear timers
3076
3077     // Stop animation, clear queue, trigger callbacks
3078     if (this.leafEdgeTmp) {
3079         $(this.leafEdgeTmp).stop(false, true);
3080     }
3081     jQuery.each(this.prefetchedImgs, function() {
3082         $(this).stop(false, true);
3083         });
3084
3085     // And again since animations also queued in callbacks
3086     if (this.leafEdgeTmp) {
3087         $(this.leafEdgeTmp).stop(false, true);
3088     }
3089     jQuery.each(this.prefetchedImgs, function() {
3090         $(this).stop(false, true);
3091         });
3092    
3093 }
3094
3095 // keyboardNavigationIsDisabled(event)
3096 //   - returns true if keyboard navigation should be disabled for the event
3097 //______________________________________________________________________________
3098 BookReader.prototype.keyboardNavigationIsDisabled = function(event) {
3099     if (event.target.tagName == "INPUT") {
3100         return true;
3101     }   
3102     return false;
3103 }
3104
3105 // gutterOffsetForIndex
3106 //______________________________________________________________________________
3107 //
3108 // Returns the gutter offset for the spread containing the given index.
3109 // This function supports RTL
3110 BookReader.prototype.gutterOffsetForIndex = function(pindex) {
3111
3112     // To find the offset of the gutter from the middle we calculate our percentage distance
3113     // through the book (0..1), remap to (-0.5..0.5) and multiply by the total page edge width
3114     var offset = parseInt(((pindex / this.numLeafs) - 0.5) * this.twoPage.edgeWidth);
3115     
3116     // But then again for RTL it's the opposite
3117     if ('rl' == this.pageProgression) {
3118         offset = -offset;
3119     }
3120     
3121     return offset;
3122 }
3123
3124 // leafEdgeWidth
3125 //______________________________________________________________________________
3126 // Returns the width of the leaf edge div for the page with index given
3127 BookReader.prototype.leafEdgeWidth = function(pindex) {
3128     // $$$ could there be single pixel rounding errors for L vs R?
3129     if ((this.getPageSide(pindex) == 'L') && (this.pageProgression != 'rl')) {
3130         return parseInt( (pindex/this.numLeafs) * this.twoPage.edgeWidth + 0.5);
3131     } else {
3132         return parseInt( (1 - pindex/this.numLeafs) * this.twoPage.edgeWidth + 0.5);
3133     }
3134 }
3135
3136 // jumpIndexForLeftEdgePageX
3137 //______________________________________________________________________________
3138 // Returns the target jump leaf given a page coordinate (inside the left page edge div)
3139 BookReader.prototype.jumpIndexForLeftEdgePageX = function(pageX) {
3140     if ('rl' != this.pageProgression) {
3141         // LTR - flipping backward
3142         var jumpIndex = this.twoPage.currentIndexL - ($(this.leafEdgeL).offset().left + $(this.leafEdgeL).width() - pageX) * 10;
3143
3144         // browser may have resized the div due to font size change -- see https://bugs.launchpad.net/gnubook/+bug/333570        
3145         jumpIndex = BookReader.util.clamp(Math.round(jumpIndex), this.firstDisplayableIndex(), this.twoPage.currentIndexL - 2);
3146         return jumpIndex;
3147
3148     } else {
3149         var jumpIndex = this.twoPage.currentIndexL + ($(this.leafEdgeL).offset().left + $(this.leafEdgeL).width() - pageX) * 10;
3150         jumpIndex = BookReader.util.clamp(Math.round(jumpIndex), this.twoPage.currentIndexL + 2, this.lastDisplayableIndex());
3151         return jumpIndex;
3152     }
3153 }
3154
3155 // jumpIndexForRightEdgePageX
3156 //______________________________________________________________________________
3157 // Returns the target jump leaf given a page coordinate (inside the right page edge div)
3158 BookReader.prototype.jumpIndexForRightEdgePageX = function(pageX) {
3159     if ('rl' != this.pageProgression) {
3160         // LTR
3161         var jumpIndex = this.twoPage.currentIndexR + (pageX - $(this.leafEdgeR).offset().left) * 10;
3162         jumpIndex = BookReader.util.clamp(Math.round(jumpIndex), this.twoPage.currentIndexR + 2, this.lastDisplayableIndex());
3163         return jumpIndex;
3164     } else {
3165         var jumpIndex = this.twoPage.currentIndexR - (pageX - $(this.leafEdgeR).offset().left) * 10;
3166         jumpIndex = BookReader.util.clamp(Math.round(jumpIndex), this.firstDisplayableIndex(), this.twoPage.currentIndexR - 2);
3167         return jumpIndex;
3168     }
3169 }
3170
3171 BookReader.prototype.initToolbar = function(mode, ui) {
3172
3173     $("#BookReader").append("<div id='BRtoolbar'>"
3174         + "<span id='BRtoolbarbuttons' style='float: right'>"
3175         +   "<button class='BRicon print rollover' /> <button class='BRicon rollover embed' />"
3176         +   "<form class='BRpageform' action='javascript:' onsubmit='br.jumpToPage(this.elements[0].value)'> <span class='label'>Page:<input id='BRpagenum' type='text' size='3' onfocus='br.autoStop();'></input></span></form>"
3177         +   "<div class='BRtoolbarmode2' style='display: none'><button class='BRicon rollover book_leftmost' /><button class='BRicon rollover book_left' /><button class='BRicon rollover book_right' /><button class='BRicon rollover book_rightmost' /></div>"
3178         +   "<div class='BRtoolbarmode1' style='display: none'><button class='BRicon rollover book_top' /><button class='BRicon rollover book_up' /> <button class='BRicon rollover book_down' /><button class='BRicon rollover book_bottom' /></div>"
3179         +   "<div class='BRtoolbarmode3' style='display: none'><button class='BRicon rollover book_top' /><button class='BRicon rollover book_up' /> <button class='BRicon rollover book_down' /><button class='BRicon rollover book_bottom' /></div>"
3180         +   "<button class='BRicon rollover play' /><button class='BRicon rollover pause' style='display: none' />"
3181         + "</span>"
3182         
3183         + "<span>"
3184         +   "<a class='BRicon logo rollover' href='" + this.logoURL + "'>&nbsp;</a>"
3185         +   " <button class='BRicon rollover zoom_out' onclick='br.zoom(-1); return false;'/>" 
3186         +   "<button class='BRicon rollover zoom_in' onclick='br.zoom(1); return false;'/>"
3187         +   " <span class='label'>Zoom: <span id='BRzoom'>"+parseInt(100/this.reduce)+"</span></span>"
3188         +   " <button class='BRicon rollover one_page_mode' onclick='br.switchMode(1); return false;'/>"
3189         +   " <button class='BRicon rollover two_page_mode' onclick='br.switchMode(2); return false;'/>"
3190         +   " <button class='BRicon rollover thumbnail_mode' onclick='br.switchMode(3); return false;'/>"
3191         + "</span>"
3192         
3193         + "<span id='#BRbooktitle'>"
3194         +   "&nbsp;&nbsp;<a class='BRblack title' href='"+this.bookUrl+"' target='_blank'>"+this.bookTitle+"</a>"
3195         + "</span>"
3196         + "</div>");
3197     
3198     this.updateToolbarZoom(this.reduce); // Pretty format
3199         
3200     if (ui == "embed" || ui == "touch") {
3201         $("#BookReader a.logo").attr("target","_blank");
3202     }
3203
3204     // $$$ turn this into a member variable
3205     var jToolbar = $('#BRtoolbar'); // j prefix indicates jQuery object
3206     
3207     // We build in mode 2
3208     jToolbar.append();
3209
3210     this.bindToolbarNavHandlers(jToolbar);
3211     
3212     // Setup tooltips -- later we could load these from a file for i18n
3213     var titles = { '.logo': 'Go to Archive.org',
3214                    '.zoom_in': 'Zoom in',
3215                    '.zoom_out': 'Zoom out',
3216                    '.one_page_mode': 'One-page view',
3217                    '.two_page_mode': 'Two-page view',
3218                    '.thumbnail_mode': 'Thumbnail view',
3219                    '.print': 'Print this page',
3220                    '.embed': 'Embed bookreader',
3221                    '.book_left': 'Flip left',
3222                    '.book_right': 'Flip right',
3223                    '.book_up': 'Page up',
3224                    '.book_down': 'Page down',
3225                    '.play': 'Play',
3226                    '.pause': 'Pause',
3227                    '.book_top': 'First page',
3228                    '.book_bottom': 'Last page'
3229                   };
3230     if ('rl' == this.pageProgression) {
3231         titles['.book_leftmost'] = 'Last page';
3232         titles['.book_rightmost'] = 'First page';
3233     } else { // LTR
3234         titles['.book_leftmost'] = 'First page';
3235         titles['.book_rightmost'] = 'Last page';
3236     }
3237                   
3238     for (var icon in titles) {
3239         jToolbar.find(icon).attr('title', titles[icon]);
3240     }
3241     
3242     // Hide mode buttons and autoplay if 2up is not available
3243     // $$$ if we end up with more than two modes we should show the applicable buttons
3244     if ( !this.canSwitchToMode(this.constMode2up) ) {
3245         jToolbar.find('.one_page_mode, .two_page_mode, .play, .pause').hide();
3246     }
3247
3248     // Switch to requested mode -- binds other click handlers
3249     this.switchToolbarMode(mode);
3250     
3251 }
3252
3253
3254 // switchToolbarMode
3255 //______________________________________________________________________________
3256 // Update the toolbar for the given mode (changes navigation buttons)
3257 // $$$ we should soon split the toolbar out into its own module
3258 BookReader.prototype.switchToolbarMode = function(mode) { 
3259     if (1 == mode) {
3260         // 1-up
3261         $('#BRtoolbar .BRtoolbarzoom').show().css('display', 'inline');
3262         $('#BRtoolbar .BRtoolbarmode2').hide();
3263         $('#BRtoolbar .BRtoolbarmode3').hide();
3264         $('#BRtoolbar .BRtoolbarmode1').show().css('display', 'inline');
3265     } else if (2 == mode) {
3266         // 2-up
3267         $('#BRtoolbar .BRtoolbarzoom').show().css('display', 'inline');
3268         $('#BRtoolbar .BRtoolbarmode1').hide();
3269         $('#BRtoolbar .BRtoolbarmode3').hide();
3270         $('#BRtoolbar .BRtoolbarmode2').show().css('display', 'inline');
3271     } else {
3272         // 3-up    
3273         $('#BRtoolbar .BRtoolbarzoom').hide();
3274         $('#BRtoolbar .BRtoolbarmode2').hide();
3275         $('#BRtoolbar .BRtoolbarmode1').hide();
3276         $('#BRtoolbar .BRtoolbarmode3').show().css('display', 'inline');
3277     }
3278 }
3279
3280 // bindToolbarNavHandlers
3281 //______________________________________________________________________________
3282 // Binds the toolbar handlers
3283 BookReader.prototype.bindToolbarNavHandlers = function(jToolbar) {
3284
3285     var self = this; // closure
3286
3287     jToolbar.find('.book_left').bind('click', function(e) {
3288         self.left();
3289         return false;
3290     });
3291          
3292     jToolbar.find('.book_right').bind('click', function(e) {
3293         self.right();
3294         return false;
3295     });
3296         
3297     jToolbar.find('.book_up').bind('click', function(e) {
3298         if ($.inArray(self.mode, [self.constMode1up, self.constModeThumb]) >= 0) {
3299             self.scrollUp();
3300         } else {
3301             self.prev();
3302         }
3303         return false;
3304     });        
3305         
3306     jToolbar.find('.book_down').bind('click', function(e) {
3307         if ($.inArray(self.mode, [self.constMode1up, self.constModeThumb]) >= 0) {
3308             self.scrollDown();
3309         } else {
3310             self.next();
3311         }
3312         return false;
3313     });
3314
3315     jToolbar.find('.print').bind('click', function(e) {
3316         self.printPage();
3317         return false;
3318     });
3319         
3320     jToolbar.find('.embed').bind('click', function(e) {
3321         self.showEmbedCode();
3322         return false;
3323     });
3324
3325     jToolbar.find('.play').bind('click', function(e) {
3326         self.autoToggle();
3327         return false;
3328     });
3329
3330     jToolbar.find('.pause').bind('click', function(e) {
3331         self.autoToggle();
3332         return false;
3333     });
3334     
3335     jToolbar.find('.book_top').bind('click', function(e) {
3336         self.first();
3337         return false;
3338     });
3339
3340     jToolbar.find('.book_bottom').bind('click', function(e) {
3341         self.last();
3342         return false;
3343     });
3344     
3345     jToolbar.find('.book_leftmost').bind('click', function(e) {
3346         self.leftmost();
3347         return false;
3348     });
3349   
3350     jToolbar.find('.book_rightmost').bind('click', function(e) {
3351         self.rightmost();
3352         return false;
3353     });
3354 }
3355
3356 // updateToolbarZoom(reduce)
3357 //______________________________________________________________________________
3358 // Update the displayed zoom factor based on reduction factor
3359 BookReader.prototype.updateToolbarZoom = function(reduce) {
3360     var value;
3361     var autofit = null;
3362
3363     // $$$ TODO preserve zoom/fit for each mode
3364     if (this.mode == this.constMode2up) {
3365         autofit = this.twoPage.autofit;
3366     } else {
3367         autofit = this.onePage.autofit;
3368     }
3369     
3370     if (autofit) {
3371         value = autofit[0].toUpperCase() + autofit.slice(1);
3372     } else {
3373         value = (100 / reduce).toFixed(2);
3374         // Strip trailing zeroes and decimal if all zeroes
3375         value = value.replace(/0+$/,'');
3376         value = value.replace(/\.$/,'');
3377         value += '%';
3378     }
3379     $('#BRzoom').text(value);
3380 }
3381
3382 // firstDisplayableIndex
3383 //______________________________________________________________________________
3384 // Returns the index of the first visible page, dependent on the mode.
3385 // $$$ Currently we cannot display the front/back cover in 2-up and will need to update
3386 // this function when we can as part of https://bugs.launchpad.net/gnubook/+bug/296788
3387 BookReader.prototype.firstDisplayableIndex = function() {
3388     if (this.mode != this.constMode2up) {
3389         return 0;
3390     }
3391     
3392     if ('rl' != this.pageProgression) {
3393         // LTR
3394         if (this.getPageSide(0) == 'L') {
3395             return 0;
3396         } else {
3397             return -1;
3398         }
3399     } else {
3400         // RTL
3401         if (this.getPageSide(0) == 'R') {
3402             return 0;
3403         } else {
3404             return -1;
3405         }
3406     }
3407 }
3408
3409 // lastDisplayableIndex
3410 //______________________________________________________________________________
3411 // Returns the index of the last visible page, dependent on the mode.
3412 // $$$ Currently we cannot display the front/back cover in 2-up and will need to update
3413 // this function when we can as pa  rt of https://bugs.launchpad.net/gnubook/+bug/296788
3414 BookReader.prototype.lastDisplayableIndex = function() {
3415
3416     var lastIndex = this.numLeafs - 1;
3417     
3418     if (this.mode != this.constMode2up) {
3419         return lastIndex;
3420     }
3421
3422     if ('rl' != this.pageProgression) {
3423         // LTR
3424         if (this.getPageSide(lastIndex) == 'R') {
3425             return lastIndex;
3426         } else {
3427             return lastIndex + 1;
3428         }
3429     } else {
3430         // RTL
3431         if (this.getPageSide(lastIndex) == 'L') {
3432             return lastIndex;
3433         } else {
3434             return lastIndex + 1;
3435         }
3436     }
3437 }
3438
3439 // shortTitle(maximumCharacters)
3440 //________
3441 // Returns a shortened version of the title with the maximum number of characters
3442 BookReader.prototype.shortTitle = function(maximumCharacters) {
3443     if (this.bookTitle.length < maximumCharacters) {
3444         return this.bookTitle;
3445     }
3446     
3447     var title = this.bookTitle.substr(0, maximumCharacters - 3);
3448     title += '...';
3449     return title;
3450 }
3451
3452 // Parameter related functions
3453
3454 // updateFromParams(params)
3455 //________
3456 // Update ourselves from the params object.
3457 //
3458 // e.g. this.updateFromParams(this.paramsFromFragment(window.location.hash))
3459 BookReader.prototype.updateFromParams = function(params) {
3460     if ('undefined' != typeof(params.mode)) {
3461         this.switchMode(params.mode);
3462     }
3463
3464     // process /search
3465     if ('undefined' != typeof(params.searchTerm)) {
3466         if (this.searchTerm != params.searchTerm) {
3467             this.search(params.searchTerm);
3468         }
3469     }
3470     
3471     // $$$ process /zoom
3472     
3473     // We only respect page if index is not set
3474     if ('undefined' != typeof(params.index)) {
3475         if (params.index != this.currentIndex()) {
3476             this.jumpToIndex(params.index);
3477         }
3478     } else if ('undefined' != typeof(params.page)) {
3479         // $$$ this assumes page numbers are unique
3480         if (params.page != this.getPageNum(this.currentIndex())) {
3481             this.jumpToPage(params.page);
3482         }
3483     }
3484     
3485     // $$$ process /region
3486     // $$$ process /highlight
3487 }
3488
3489 // paramsFromFragment(urlFragment)
3490 //________
3491 // Returns a object with configuration parametes from a URL fragment.
3492 //
3493 // E.g paramsFromFragment(window.location.hash)
3494 BookReader.prototype.paramsFromFragment = function(urlFragment) {
3495     // URL fragment syntax specification: http://openlibrary.org/dev/docs/bookurls
3496
3497     var params = {};
3498     
3499     // For convenience we allow an initial # character (as from window.location.hash)
3500     // but don't require it
3501     if (urlFragment.substr(0,1) == '#') {
3502         urlFragment = urlFragment.substr(1);
3503     }
3504     
3505     // Simple #nn syntax
3506     var oldStyleLeafNum = parseInt( /^\d+$/.exec(urlFragment) );
3507     if ( !isNaN(oldStyleLeafNum) ) {
3508         params.index = oldStyleLeafNum;
3509         
3510         // Done processing if using old-style syntax
3511         return params;
3512     }
3513     
3514     // Split into key-value pairs
3515     var urlArray = urlFragment.split('/');
3516     var urlHash = {};
3517     for (var i = 0; i < urlArray.length; i += 2) {
3518         urlHash[urlArray[i]] = urlArray[i+1];
3519     }
3520     
3521     // Mode
3522     if ('1up' == urlHash['mode']) {
3523         params.mode = this.constMode1up;
3524     } else if ('2up' == urlHash['mode']) {
3525         params.mode = this.constMode2up;
3526     } else if ('thumb' == urlHash['mode']) {
3527         params.mode = this.constModeThumb;
3528     }
3529     
3530     // Index and page
3531     if ('undefined' != typeof(urlHash['page'])) {
3532         // page was set -- may not be int
3533         params.page = urlHash['page'];
3534     }
3535     
3536     // $$$ process /region
3537     // $$$ process /search
3538     
3539     if (urlHash['search'] != undefined) {
3540         params.searchTerm = BookReader.util.decodeURIComponentPlus(urlHash['search']);
3541     }
3542     
3543     // $$$ process /highlight
3544         
3545     return params;
3546 }
3547
3548 // paramsFromCurrent()
3549 //________
3550 // Create a params object from the current parameters.
3551 BookReader.prototype.paramsFromCurrent = function() {
3552
3553     var params = {};
3554     
3555     var index = this.currentIndex();
3556     var pageNum = this.getPageNum(index);
3557     if ((pageNum === 0) || pageNum) {
3558         params.page = pageNum;
3559     }
3560     
3561     params.index = index;
3562     params.mode = this.mode;
3563     
3564     // $$$ highlight
3565     // $$$ region
3566
3567     // search    
3568     if (this.searchHighlightVisible()) {
3569         params.searchTerm = this.searchTerm;
3570     }
3571     
3572     return params;
3573 }
3574
3575 // fragmentFromParams(params)
3576 //________
3577 // Create a fragment string from the params object.
3578 // See http://openlibrary.org/dev/docs/bookurls for an explanation of the fragment syntax.
3579 BookReader.prototype.fragmentFromParams = function(params) {
3580     var separator = '/';
3581
3582     var fragments = [];
3583     
3584     if ('undefined' != typeof(params.page)) {
3585         fragments.push('page', params.page);
3586     } else {
3587         // Don't have page numbering -- use index instead
3588         fragments.push('page', 'n' + params.index);
3589     }
3590     
3591     // $$$ highlight
3592     // $$$ region
3593     
3594     // mode
3595     if ('undefined' != typeof(params.mode)) {    
3596         if (params.mode == this.constMode1up) {
3597             fragments.push('mode', '1up');
3598         } else if (params.mode == this.constMode2up) {
3599             fragments.push('mode', '2up');
3600         } else if (params.mode == this.constModeThumb) {
3601             fragments.push('mode', 'thumb');
3602         } else {
3603             throw 'fragmentFromParams called with unknown mode ' + params.mode;
3604         }
3605     }
3606     
3607     // search
3608     if (params.searchTerm) {
3609         fragments.push('search', params.searchTerm);
3610     }
3611     
3612     return BookReader.util.encodeURIComponentPlus(fragments.join(separator)).replace(/%2F/g, '/');
3613 }
3614
3615 // getPageIndex(pageNum)
3616 //________
3617 // Returns the *highest* index the given page number, or undefined
3618 BookReader.prototype.getPageIndex = function(pageNum) {
3619     var pageIndices = this.getPageIndices(pageNum);
3620     
3621     if (pageIndices.length > 0) {
3622         return pageIndices[pageIndices.length - 1];
3623     }
3624
3625     return undefined;
3626 }
3627
3628 // getPageIndices(pageNum)
3629 //________
3630 // Returns an array (possibly empty) of the indices with the given page number
3631 BookReader.prototype.getPageIndices = function(pageNum) {
3632     var indices = [];
3633
3634     // Check for special "nXX" page number
3635     if (pageNum.slice(0,1) == 'n') {
3636         try {
3637             var pageIntStr = pageNum.slice(1, pageNum.length);
3638             var pageIndex = parseInt(pageIntStr);
3639             indices.push(pageIndex);
3640             return indices;
3641         } catch(err) {
3642             // Do nothing... will run through page names and see if one matches
3643         }
3644     }
3645
3646     var i;
3647     for (i=0; i<this.numLeafs; i++) {
3648         if (this.getPageNum(i) == pageNum) {
3649             indices.push(i);
3650         }
3651     }
3652     
3653     return indices;
3654 }
3655
3656 // getPageName(index)
3657 //________
3658 // Returns the name of the page as it should be displayed in the user interface
3659 BookReader.prototype.getPageName = function(index) {
3660     return 'Page ' + this.getPageNum(index);
3661 }
3662
3663 // updateLocationHash
3664 //________
3665 // Update the location hash from the current parameters.  Call this instead of manually
3666 // using window.location.replace
3667 BookReader.prototype.updateLocationHash = function() {
3668     var newHash = '#' + this.fragmentFromParams(this.paramsFromCurrent());
3669     window.location.replace(newHash);
3670     
3671     // This is the variable checked in the timer.  Only user-generated changes
3672     // to the URL will trigger the event.
3673     this.oldLocationHash = newHash;
3674 }
3675
3676 // startLocationPolling
3677 //________
3678 // Starts polling of window.location to see hash fragment changes
3679 BookReader.prototype.startLocationPolling = function() {
3680     var self = this; // remember who I am
3681     self.oldLocationHash = window.location.hash;
3682     
3683     if (this.locationPollId) {
3684         clearInterval(this.locationPollID);
3685         this.locationPollId = null;
3686     }
3687     
3688     this.locationPollId = setInterval(function() {
3689         var newHash = window.location.hash;
3690         if (newHash != self.oldLocationHash) {
3691             if (newHash != self.oldUserHash) { // Only process new user hash once
3692                 //console.log('url change detected ' + self.oldLocationHash + " -> " + newHash);
3693                 
3694                 // Queue change if animating
3695                 if (self.animating) {
3696                     self.autoStop();
3697                     self.animationFinishedCallback = function() {
3698                         self.updateFromParams(self.paramsFromFragment(newHash));
3699                     }                        
3700                 } else { // update immediately
3701                     self.updateFromParams(self.paramsFromFragment(newHash));
3702                 }
3703                 self.oldUserHash = newHash;
3704             }
3705         }
3706     }, 500);
3707 }
3708
3709 // canSwitchToMode
3710 //________
3711 // Returns true if we can switch to the requested mode
3712 BookReader.prototype.canSwitchToMode = function(mode) {
3713     if (mode == this.constMode2up) {
3714         // check there are enough pages to display
3715         // $$$ this is a workaround for the mis-feature that we can't display
3716         //     short books in 2up mode
3717         if (this.numLeafs < 6) {
3718             return false;
3719         }
3720     }
3721     
3722     return true;
3723 }
3724
3725 // searchHighlightVisible
3726 //________
3727 // Returns true if a search highlight is currently being displayed
3728 BookReader.prototype.searchHighlightVisible = function() {
3729     if (this.constMode2up == this.mode) {
3730         if (this.searchResults[this.twoPage.currentIndexL]
3731                 || this.searchResults[this.twoPage.currentIndexR]) {
3732             return true;
3733         }
3734     } else { // 1up
3735         if (this.searchResults[this.currentIndex()]) {
3736             return true;
3737         }
3738     }
3739     return false;
3740 }
3741
3742 // getPageBackgroundColor
3743 //--------
3744 // Returns a CSS property string for the background color for the given page
3745 // $$$ turn into regular CSS?
3746 BookReader.prototype.getPageBackgroundColor = function(index) {
3747     if (index >= 0 && index < this.numLeafs) {
3748         // normal page
3749         return this.pageDefaultBackgroundColor;
3750     }
3751     
3752     return '';
3753 }
3754
3755 // _getPageWidth
3756 //--------
3757 // Returns the page width for the given index, or first or last page if out of range
3758 BookReader.prototype._getPageWidth = function(index) {
3759     // Synthesize a page width for pages not actually present in book.
3760     // May or may not be the best approach.
3761     // If index is out of range we return the width of first or last page
3762     index = BookReader.util.clamp(index, 0, this.numLeafs - 1);
3763     return this.getPageWidth(index);
3764 }
3765
3766 // _getPageHeight
3767 //--------
3768 // Returns the page height for the given index, or first or last page if out of range
3769 BookReader.prototype._getPageHeight= function(index) {
3770     index = BookReader.util.clamp(index, 0, this.numLeafs - 1);
3771     return this.getPageHeight(index);
3772 }
3773
3774 // _getPageURI
3775 //--------
3776 // Returns the page URI or transparent image if out of range
3777 BookReader.prototype._getPageURI = function(index, reduce, rotate) {
3778     if (index < 0 || index >= this.numLeafs) { // Synthesize page
3779         return this.imagesBaseURL + "/transparent.png";
3780     }
3781     
3782     if ('undefined' == typeof(reduce)) {
3783         // reduce not passed in
3784         // $$$ this probably won't work for thumbnail mode
3785         var ratio = this.getPageHeight(index) / this.twoPage.height;
3786         var scale;
3787         // $$$ we make an assumption here that the scales are available pow2 (like kakadu)
3788         if (ratio < 2) {
3789             scale = 1;
3790         } else if (ratio < 4) {
3791             scale = 2;
3792         } else if (ratio < 8) {
3793             scale = 4;
3794         } else if (ratio < 16) {
3795             scale = 8;
3796         } else  if (ratio < 32) {
3797             scale = 16;
3798         } else {
3799             scale = 32;
3800         }
3801         reduce = scale;
3802     }
3803     
3804     return this.getPageURI(index, reduce, rotate);
3805 }
3806
3807 // Library functions
3808 BookReader.util = {
3809     disableSelect: function(jObject) {        
3810         // Bind mouse handlers
3811         // Disable mouse click to avoid selected/highlighted page images - bug 354239
3812         jObject.bind('mousedown', function(e) {
3813             // $$$ check here for right-click and don't disable.  Also use jQuery style
3814             //     for stopping propagation. See https://bugs.edge.launchpad.net/gnubook/+bug/362626
3815             return false;
3816         });
3817         // Special hack for IE7
3818         jObject[0].onselectstart = function(e) { return false; };
3819     },
3820     
3821     clamp: function(value, min, max) {
3822         return Math.min(Math.max(value, min), max);
3823     },
3824     
3825     notInArray: function(value, array) {
3826         // inArray returns -1 or undefined if value not in array
3827         return ! (jQuery.inArray(value, array) >= 0);
3828     },
3829
3830     getIFrameDocument: function(iframe) {
3831         // Adapted from http://xkr.us/articles/dom/iframe-document/
3832         var outer = (iframe.contentWindow || iframe.contentDocument);
3833         return (outer.document || outer);
3834     },
3835     
3836     decodeURIComponentPlus: function(value) {
3837         // Decodes a URI component and converts '+' to ' '
3838         return decodeURIComponent(value).replace(/\+/g, ' ');
3839     },
3840     
3841     encodeURIComponentPlus: function(value) {
3842         // Encodes a URI component and converts ' ' to '+'
3843         return encodeURIComponent(value).replace(/%20/g, '+');
3844     }
3845     // The final property here must NOT have a comma after it - IE7
3846 }