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