pageflow 0.8.2 → 0.9.0

data/app/assets/javascripts/pageflow/audio/player_pool.js

@@ -0,0 +1,15 @@
+pageflow.Audio.PlayerPool = function(audio, options) {
+  this.players = {};
+
+  this.get = function(audioFileId) {
+    this.players[audioFileId] =
+      this.players[audioFileId] ||
+      audio.createPlayer(audioFileId, options);
+
+    return this.players[audioFileId];
+  };
+
+  this.dispose = function() {
+    this.players = {};
+  };
+};

data/app/assets/javascripts/pageflow/audio_player.js

@@ -1,5 +1,12 @@
+//= require ./media_player
+
 //= require_self
+
 //= require ./audio_player/media_events
+//= require ./audio_player/null
+//= require ./audio_player/seek_with_invalid_state_handling
+//= require ./audio_player/rewind_method
+//= require ./audio_player/pause_in_background
 
 pageflow.AudioPlayer = function(sources, options) {
   options = options || {};
@@ -32,6 +39,17 @@ pageflow.AudioPlayer = function(sources, options) {
     pageflow.AudioPlayer.mediaEvents(audio, options.context);
   }
 
+  if (options.pauseInBackground && pageflow.browser.has('mobile platform')) {
+    pageflow.AudioPlayer.pauseInBackground(audio);
+  }
+
+  pageflow.mediaPlayer.enhance(audio, _.extend({
+    loadWaiting: true
+  }, options || {}));
+
+  pageflow.AudioPlayer.seekWithInvalidStateHandling(audio);
+  pageflow.AudioPlayer.rewindMethod(audio);
+
   audio.src = function(sources) {
     ready.then(function() {
       var source = _.detect(sources || [], function(source) {
@@ -60,7 +78,7 @@ pageflow.AudioPlayer = function(sources, options) {
   var originalSeek = audio.seek;
   audio.seek = function() {
     if (this.currentSrc) {
-      originalSeek.apply(this, arguments);
+      return originalSeek.apply(this, arguments);
     }
   };
 
@@ -71,6 +89,10 @@ pageflow.AudioPlayer = function(sources, options) {
     }
   };
 
+  audio.paused = function() {
+    return !audio.playing;
+  };
+
   audio.src(sources);
   return audio;
 };

data/app/assets/javascripts/pageflow/audio_player/null.js

@@ -0,0 +1,37 @@
+pageflow.AudioPlayer.Null = function() {
+  this.playAndFadeIn = function() {
+    return new $.Deferred().resolve().promise();
+  };
+
+  this.fadeOutAndPause = function() {
+    return new $.Deferred().resolve().promise();
+  };
+
+  this.changeVolumeFactor = function() {
+    return new $.Deferred().resolve().promise();
+  };
+
+  this.play = function() {};
+
+  this.pause = function() {};
+
+  this.paused = function() {
+    return true;
+  };
+
+  this.seek = function() {
+    return new $.Deferred().resolve().promise();
+  };
+
+  this.rewind = function() {
+    return new $.Deferred().resolve().promise();
+  };
+
+  this.formatTime = function() {};
+
+  this.one = function(event, handler) {
+    handler();
+  };
+};
+
+_.extend(pageflow.AudioPlayer.Null.prototype, Backbone.Events);

data/app/assets/javascripts/pageflow/audio_player/pause_in_background.js

@@ -0,0 +1,34 @@
+// Prevent audio play back when browser enters background on mobile
+// device. Use the face that timeupdate events continue to fire while
+// intervals no longer executed when the browser is in the background.
+pageflow.AudioPlayer.pauseInBackground = function(player) {
+  var interval;
+  var lastInterval;
+  var resolution = 100;
+
+  function startProbeInterval() {
+    interval = setInterval(function() {
+      lastInterval = new Date().getTime();
+    }, resolution);
+  }
+
+  function stopProbeInterval() {
+    clearInterval(interval);
+    interval = null;
+  }
+
+  function pauseIfProbeIntervalHalted() {
+    if (intervalHalted()) {
+      player.pause();
+    }
+  }
+
+  function intervalHalted() {
+    return interval && lastInterval < new Date().getTime() - resolution * 5;
+  }
+
+  player.on('play', startProbeInterval);
+  player.on('pause', stopProbeInterval);
+  player.on('ended', stopProbeInterval);
+  player.on('timeupdate', pauseIfProbeIntervalHalted);
+};

data/app/assets/javascripts/pageflow/audio_player/rewind_method.js

@@ -0,0 +1,17 @@
+pageflow.AudioPlayer.rewindMethod = function(player) {
+  /**
+   * Seek to beginning of file. If already at the beginning do
+   * nothing.
+   */
+  player.rewind = function() {
+    if (player.position > 0) {
+      var result = player.seek(0);
+
+      player.trigger('timeupdate', player.position, player.duration);
+      return result;
+    }
+    else {
+      return new $.Deferred().resolve().promise();
+    }
+  };
+};

data/app/assets/javascripts/pageflow/audio_player/seek_with_invalid_state_handling.js

@@ -0,0 +1,41 @@
+/**
+ * Calling seek before the media tag is ready causes InvalidState
+ * exeption. If this happens, we wait for the next progress event and
+ * retry. We resolve a promise once seeking succeeded.
+ *
+ * @api private
+ */
+pageflow.AudioPlayer.seekWithInvalidStateHandling = function(player) {
+  var originalSeek = player.seek;
+
+  player.seek = function(time) {
+    return retryOnProgress(function() {
+      originalSeek.call(player, time);
+    });
+  };
+
+  function retryOnProgress(fn) {
+    var tries = 0;
+
+    return new $.Deferred(function(deferred) {
+      function tryOrWaitForProgress() {
+        tries += 1;
+
+        if (tries >= 50) {
+          deferred.reject();
+          return;
+        }
+
+        try {
+          fn();
+          deferred.resolve();
+        }
+        catch(e) {
+          player.one('progress', tryOrWaitForProgress);
+        }
+      }
+
+      tryOrWaitForProgress();
+    }).promise();
+  }
+};

data/app/assets/javascripts/pageflow/base.js

@@ -26,13 +26,19 @@
 //= require backbone-rails
 //= require_self
 
+//= require ./object
+//= require ./entry_data
+//= require ./seed_entry_data
 //= require ./cookies
 //= require ./events
 //= require ./page_type
+//= require ./page_transitions
 //= require ./asset_urls
 //= require ./preload
 //= require ./bandwidth
+//= require ./browser
 //= require ./features
+//= require ./audio
 //= require ./audio_player
 //= require ./video_player
 //= require ./visited
@@ -42,6 +48,10 @@
 //= require ./widget_types
 //= require ./built_in_widget_types
 //= require ./links
+//= require ./highlighted_page
+//= require ./chapter_filter
+//= require ./fullscreen
+//= require ./multimedia_alert
 
 //= require ./settings
 

data/app/assets/javascripts/pageflow/browser.js

@@ -0,0 +1,123 @@
+//= require_self
+//= require_tree ./browser
+
+/**
+ * Browser feature detection.
+ *
+ * @since 0.9
+ */
+pageflow.browser = (function(){
+  var tests = {},
+      results = {},
+      ready = new $.Deferred();
+
+  return {
+    off: {},
+    on: {},
+    unset: {},
+
+    /**
+     * Add a feature test.
+     *
+     * @param name [String] Name of the feature. Can contain whitespace.
+     * @param test [Function] A function that either returns `true` or
+     *   `false` or a promise that resolves to `true` or `false`.
+     */
+    feature: function(name, test) {
+      var s = name.replace(/ /g, '_');
+
+      this.off[s] = function() {
+        window.localStorage['override ' + name] = 'off';
+        pageflow.log('Feature off: ' + name, {force: true});
+      };
+
+      this.on[s] = function() {
+        window.localStorage['override ' + name] = 'on';
+        pageflow.log('Feature on: ' + name, {force: true});
+      };
+
+      this.unset[s] = function() {
+        window.localStorage.removeItem('override ' + name);
+        pageflow.log('Feature unset: ' + name, {force: true});
+      };
+
+      tests[name] = test;
+    },
+
+    /**
+     * Check whether the browser has a specific feature. This method
+     * may only be called after the `#ready` promise is resolved.
+     *
+     * @param name [String] Name of the feature.
+     * @return [Boolean]
+     */
+    has: function(name) {
+      if (this.ready().state() != 'resolved') {
+        throw 'Feature detection has not finished yet.';
+      }
+
+      if (!results.hasOwnProperty(name)) {
+        throw 'Unknown feature "' + name +'".';
+      }
+
+      return results[name];
+    },
+
+    /**
+     * A promise that is resolved once feature detection has finished.
+     *
+     * @return [Promise]
+     */
+    ready: function() {
+      return ready.promise();
+    },
+
+    /** @api private */
+    detectFeatures: function() {
+      var promises = {};
+
+      var asyncHas = function(name) {
+        var runTest = function() {
+          if ((pageflow.debugMode() || pageflow.ALLOW_FEATURE_OVERRIDES) &&
+              window.localStorage &&
+              typeof window.localStorage['override ' + name] !== 'undefined') {
+            var value = (window.localStorage['override ' + name] === 'on');
+            pageflow.log('FEATURE OVERRIDDEN ' + name + ': ' + value, {force: true});
+            return value;
+          }
+          else {
+            return tests[name](asyncHas);
+          }
+        };
+
+        promises[name] = promises[name] || $.when(runTest(name));
+        return promises[name];
+      };
+
+      asyncHas.not = function(name) {
+        return asyncHas(name).pipe(function(result) {
+          return !result;
+        });
+      };
+
+      asyncHas.all = function(/* arguments */) {
+        return $.when.apply(null, arguments).pipe(function(/* arguments */) {
+          return _.all(arguments);
+        });
+      };
+
+      $.when.apply(null, _.map(_.keys(tests), function(name) {
+        return asyncHas(name).then(function(result) {
+          var cssClassName = name.replace(/ /g, '_');
+
+          $('body').toggleClass('has_' + cssClassName, !!result);
+          $('body').toggleClass('has_no_' + cssClassName, !result);
+
+          results[name] = !!result;
+        });
+      })).then(ready.resolve);
+
+      return this.ready();
+    }
+  };
+}());

data/app/assets/javascripts/pageflow/{features → browser}/hashchange_support.js

@@ -1,4 +1,4 @@
-pageflow.features.add('hashchange support', function() {
+pageflow.browser.feature('hashchange support', function() {
   var iOS = parseFloat(
   ('' + (/CPU.*OS ([0-9_]{1,5})|(CPU like).*AppleWebKit.*Mobile/i.exec(navigator.userAgent) || [0,''])[1])
   .replace('undefined', '3_2').replace('_', '.').replace('_', '')

data/app/assets/javascripts/pageflow/{features → browser}/high_bandwidth.js

@@ -1,4 +1,4 @@
-pageflow.features.add('high bandwidth', function() {
+pageflow.browser.feature('high bandwidth', function() {
   return pageflow.bandwidth().pipe(function(result) {
     var isHigh = result.speedInBps > 8000 * 1024;
 

data/app/assets/javascripts/pageflow/{features → browser}/ie_platform.js

@@ -1,4 +1,4 @@
-pageflow.features.add('ie', function() {
+pageflow.browser.feature('ie', function() {
   if (navigator.appName == 'Microsoft Internet Explorer')
   {
     return true;

data/app/assets/javascripts/pageflow/browser/ios_platform.js

@@ -0,0 +1,6 @@
+pageflow.browser.feature('ios platform', function() {
+  var matchers = [/iPod/i, /iPad/i, /iPhone/i];
+  return _.any(matchers, function(matcher) {
+    return navigator.userAgent.match(matcher);
+  });
+});

data/app/assets/javascripts/pageflow/{features → browser}/mobile_platform.js

@@ -1,4 +1,4 @@
-pageflow.features.add('mobile platform', function() {
+pageflow.browser.feature('mobile platform', function() {
   var matchers = [/iPod/i, /iPad/i, /iPhone/i, /Android/i, /Silk/i, /IEMobile/i];
   return _.any(matchers, function(matcher) {
     return navigator.userAgent.match(matcher);

data/app/assets/javascripts/pageflow/{features → browser}/phone_platform.js

@@ -1,4 +1,4 @@
-pageflow.features.add('phone platform', function() {
+pageflow.browser.feature('phone platform', function() {
   var matchers = [/iPod/i, /iPad/i, /iPhone/i, /Android/i, /IEMobile/i];
 
   return _.any(matchers, function(matcher) {

data/app/assets/javascripts/pageflow/browser/pushstate_support.js

@@ -0,0 +1,3 @@
+pageflow.browser.feature('pushstate support', function() {
+  return (window.history && 'pushState' in window.history);
+});

data/app/assets/javascripts/pageflow/{features → browser}/touch_support.js

@@ -1,4 +1,4 @@
-pageflow.features.add('touch support', function() {
+pageflow.browser.feature('touch support', function() {
   return ('ontouchstart' in window) ||
     /* Firefox on android */
     window.DocumentTouch && document instanceof window.DocumentTouch ||

data/app/assets/javascripts/pageflow/browser/video.js

@@ -0,0 +1,16 @@
+pageflow.browser.feature('rewrite video sources support', function() {
+  // set from conditionally included script file
+  return !pageflow.ie9;
+});
+
+pageflow.browser.feature('stop buffering support', function(has) {
+  return has.not('mobile platform');
+});
+
+pageflow.browser.feature('buffer underrun waiting support', function(has) {
+  return has.not('mobile platform');
+});
+
+pageflow.browser.feature('prebuffering support', function(has) {
+  return has.not('mobile platform');
+});

data/app/assets/javascripts/pageflow/browser/volume_control_support.js

@@ -0,0 +1,3 @@
+pageflow.browser.feature('volume control support', function(has) {
+  return has.not('ios platform');
+});

data/app/assets/javascripts/pageflow/chapter_filter.js

@@ -0,0 +1,56 @@
+pageflow.ChapterFilter = pageflow.Object.extend({
+  initialize: function(entryData) {
+    this.entry = entryData;
+  },
+
+  strategies: {
+    all: function() {
+      return true;
+    },
+
+    non: function() {
+      return false;
+    },
+
+    current_chapter: function(currentChapterId, otherChapterId) {
+      return otherChapterId === currentChapterId;
+    },
+
+    inherit_from_parent: function(currentChapterId, otherChapterId) {
+      return this.chapterVisibleFromChapter(this.entry.getParentChapterId(currentChapterId), otherChapterId);
+    },
+
+    same_parent_page: function(currentChapterId, otherChapterId) {
+      return this.entry.getParentPagePermaId(currentChapterId) === this.entry.getParentPagePermaId(otherChapterId);
+    },
+
+    same_parent_chapter: function(currentChapterId, otherChapterId) {
+      return this.entry.getParentChapterId(currentChapterId) === this.entry.getParentChapterId(otherChapterId);
+    }
+  },
+
+  chapterVisibleFromPage: function(currentPagePermaId, chapterId) {
+    var currentChapterId = this.entry.getChapterIdByPagePermaId(currentPagePermaId);
+    return this.chapterVisibleFromChapter(currentChapterId, chapterId);
+  },
+
+  chapterVisibleFromChapter: function(currentChapterId, otherChapterId) {
+    return this.getStrategy(currentChapterId)
+      .call(this, currentChapterId, otherChapterId);
+  },
+
+  getStrategy: function(chapterId) {
+    return this.strategies[this.getNavigationBarMode(chapterId)] ||
+      this.strategies.all;
+  },
+
+  getNavigationBarMode: function(chapterId) {
+    return this.entry.getChapterConfiguration(chapterId).navigation_bar_mode;
+  }
+});
+
+pageflow.ChapterFilter.strategies = _(pageflow.ChapterFilter.prototype.strategies).keys();
+
+pageflow.ChapterFilter.create = function() {
+  return new pageflow.ChapterFilter(pageflow.entryData);
+};