miniPlayer.js

Go to the documentation of this file.

/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2009 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

if (typeof(Ci) == "undefined")
  var Ci = Components.interfaces;
if (typeof(Cc) == "undefined")
  var Cc = Components.classes;
if (typeof(Cr) == "undefined")
  var Cr = Components.results;
if (typeof(Cu) == "undefined")
  var Cu = Components.utils;
  
Cu.import("resource://app/jsmodules/sbLibraryUtils.jsm");
Cu.import("resource://app/jsmodules/ArrayConverter.jsm");

var gMiniplayer = {


  // Window Event Handling //

  onLoad: function onLoad()
  {
    dump("\nMiniplayer." + arguments.callee.name + "\n");

    window.focus();

    // Note, most listeners are hardcoded in miniplayer.xul

    // Prevent window from being resized inappropriately
    this._setMinMaxCallback();

    // Set tooltip for feather switch button
    var nextLayout = this._getNextLayout();
    var button = document.getElementById("miniplayer_feathers_button");
    var switchToString =
      SBFormattedString("feathers.switchto", [nextLayout.name],
                        SBString("feathers.switchfeathers", "Switch Feathers"));
    button.setAttribute("tooltiptext", switchToString);

    // Set attributes on the Window element so we can use them in CSS.
    var windowElement = document.getElementsByTagName("window")[0];
    windowElement.setAttribute("hasTitlebar",this._hasTitlebar());

    initializeDocumentPlatformAttribute();

    // Add resizer listeners
    this._miniPlayerMinWidth = parseInt(getComputedStyle(
                                        document.documentElement, "").minWidth);
    this._miniPlayerMinHeight = parseInt(getComputedStyle(
                                         document.documentElement, "").minHeight);

    // Set to initialized to properly resize on load.
    this._initialized = false;
    var resizer = document.getElementById("miniplayer_resizer_right");
    resizer.addEventListener("mousemove", gMiniplayer.resizeHandler, false);

  },

  resizeHandler: function miniPlayer_resizeHandler(e) {
    var windowElement = document.getElementsByTagName("window")[0],
        width = windowElement.boxObject.width;

    // Opening a window with hidechrome=true does not initially size the window
    // properly. The result is residual whitespace in place of chrome, titlebar.
    // For reference, see https://bugzilla.mozilla.org/show_bug.cgi?id=392509.
    // In order to circumvent the issue, when opened, the window resize handler
    // will be triggered, sizing the window to its respective width and minimum
    // height.
    if (!this._initialized) {
      this._initialized = true;
      window.resizeTo(width,
                      gMiniplayer._miniPlayerMinHeight);
    }

    if (e.type == "mousemove") {
      if (!gMiniplayer._mouseDown || (gMiniplayer._mouseDown == false) ||
          e.clientX < gMiniplayer._miniPlayerMinWidth)
      {
        if (e.clientX < gMiniplayer._miniPlayerMinWidth)
          window.resizeTo(gMiniplayer._miniPlayerMinWidth,
                          gMiniplayer._miniPlayerMinHeight);
        e.preventDefault();
        e.stopPropagation();
        return;
      }
    } else if (gMiniplayer._cancelResize && gMiniplayer._cancelResize == true) {
      gMiniplayer._cancelResize = false;
      e.preventDefault();
      e.stopPropagation();
      return;
    }
    if (width < gMiniplayer._miniPlayerMinWidth) {
      setTimeout(function() {
        window.resizeTo(gMiniplayer._miniPlayerMinWidth,
                        gMiniplayer._miniPlayerMinHeight);
      }, 0);
    }

    var ratings = document.getElementById("faceplate-tool");
    var faceplate = document.getElementById("faceplate");
    var autoscroll = document.getElementById("sb-faceplate-autoscroll-box");
    
    // At <500px we drop the ratings
    if (width < 500 && ratings.style.visibility != "collapse") {
      ratings.style.visibility = "collapse";
    } else if (width >= 500 && ratings.style.visibility != "visible") {
      ratings.style.visibility = "visible";
    }
    
    // <315px we drop the autoscroll
    if (width < 315 && autoscroll.style.visibility != "collapse") {
      autoscroll.style.visibility = "collapse";
    } else if (width >= 315 && autoscroll.style.visibility != "visible") {
      autoscroll.style.visibility = "visible";
    }

    // <308px we drop the faceplate in its entirety
    if (width < 308 && faceplate.style.visibility != "collapse") {
      faceplate.style.visibility = "collapse";
    } else if (width >= 308 && faceplate.style.visibility != "visible") {
      faceplate.style.visibility = "visible";
    }

    var resizerBoundaryPassed = (e.type == "mousemove" && e.clientX > 308);
    if (width < 308 && !resizerBoundaryPassed) {
      setTimeout(function() {
        window.resizeTo(gMiniplayer._miniPlayerMinWidth,
                        gMiniplayer._miniPlayerMinHeight);
      }, 0);
    } else {
      gMiniplayer._cancelResize = true;
      if (width < gMiniplayer._miniPlayerMinWidth && resizerBoundaryPassed) {
        setTimeout(function() {
          window.resizeTo(gMiniplayer._miniPlayerMinWidth,
                          gMiniplayer._miniPlayerMinHeight);
        }, 0);
      }
    }

  },

  onUnload: function onUnload()
  {
    var resizer = document.getElementById("miniplayer_resizer_right");
    resizer.removeEventListener("mousemove", gMiniplayer.resizeHandler, false);

    dump("\nMiniplayer." + arguments.callee.name + "\n");
        
    this._resetMinMaxCallback();

  },

  onKeypress: function onKeypress( evt )
  {
    dump("\nMiniplayer." + arguments.callee.name + "\n");

    dump("\nChecking for quit key\n");
    // Check if the user wishes to quit.
    checkQuitKey(evt);

    // TODO Does this not interfere with global hotkeys?
    // Should this be a consistent thing that anyone can use?
    var sbIMediacoreStatus = Components.interfaces.sbIMediacoreStatus;
    switch ( evt.keyCode )
    {
      case 37: // Arrow Left
        gMM.sequencer.previous();
        break;
      case 39: // Arrow Right
        gMM.sequencer.next();
        break;
      case 40: // Arrow Down
      case 13: // Return
        if ( gMM.status.state == sbIMediacoreStatus.STATUS_PLAYING ||
             gMM.status.state == sbIMediacoreStatus.STATUS_BUFFERING )
          gMM.playbackControl.pause();
        else if(gMM.primaryCore)
          gMM.playbackControl.play();
        else
          // If we have no context, initiate playback
          // via the root application controller
          var app = Components.classes["@songbirdnest.com/Songbird/ApplicationController;1"]
                              .getService(Components.interfaces.sbIApplicationController);
          app.playDefault();
        break;
    }
    switch ( evt.charCode )
    {
      case 32: // Space
          if ( gMM.status.state == sbIMediacoreStatus.STATUS_PLAYING ||
              gMM.status.state == sbIMediacoreStatus.STATUS_BUFFERING )
          gMM.playbackControl.pause();
        else
          gMM.playbackControl.play();
        break;
    }
  },


  onDblClick: function onDblClick( evt )
  {
    dump("\nMiniplayer." + arguments.callee.name + "\n");
    if (evt.target.localName == 'sb-draggable') {
      this.revertFeathers();
    }
  },


  revertFeathers: function revertFeathers()
  {
    // Attempt to switch to the next layout available for the current skin
    try {
      var feathersMgr = Cc['@songbirdnest.com/songbird/feathersmanager;1']
                           .getService(Ci.sbIFeathersManager);
      var skinName = feathersMgr.currentSkinName;
      var layoutURL = feathersMgr.currentLayoutURL;
      var nextLayout = this._getNextLayout();
      
      // If it is actually going to do anything, switch to the
      // next layout
      if (nextLayout.url != layoutURL) {
        feathersMgr.switchFeathers(nextLayout.url, skinName);
      }
    } catch (e) {
      dump("revertFeathers(): Unable to switch to the " +
           "next layout for the current skin.\n\n" +
           " Error: " + e.toString() + "\n");  
    }
  },

  _getNextLayout: function getNextLayout()
  {
    var feathersMgr = Cc['@songbirdnest.com/songbird/feathersmanager;1']
                         .getService(Ci.sbIFeathersManager);
    var skinName = feathersMgr.currentSkinName;
    var layoutURL = feathersMgr.currentLayoutURL;
      
    // Find the layout that comes after the current layout, if one doesn't
    // exist, then we'll just fallback to the default layout for this skin
    var enum = feathersMgr.getLayoutsForSkin(skinName);
    var switchLayout;
    while (enum.hasMoreElements()) {
      var nextLayout = enum.getNext();
      if (!switchLayout)
        switchLayout = nextLayout;
      if (nextLayout.QueryInterface(Ci.sbILayoutDescription).url == layoutURL
          && enum.hasMoreElements())
      {
        switchlayout = enum.getNext().QueryInterface(Ci.sbILayoutDescription);
      }
    }
    return switchLayout;
  },


  // Window Min/Max Support //



  _minMaxHandler: {

    GetMinWidth: function()
    {
      var minWidth = getComputedStyle(document.documentElement, "").minWidth;
      return (minWidth == "none") ? -1 : parseInt(minWidth);
    },

    GetMinHeight: function()
    {
      var minHeight = getComputedStyle(document.documentElement, "").minHeight;
      return (minHeight == "none") ? -1 : parseInt(minHeight);
    },

    GetMaxWidth: function()
    {
      var maxWidth = getComputedStyle(document.documentElement, "").maxWidth;
      return (maxWidth == "none") ? -1 : parseInt(maxWidth);
    },

    GetMaxHeight: function()
    {
      var maxHeight = getComputedStyle(document.documentElement, "").maxHeight;
      return (maxHeight == "none") ? -1 : parseInt(maxHeight);
    },

    OnWindowClose: function()
    {
      setTimeout(quitApp, 0);
    },

    QueryInterface : function(aIID)
    {
      if (!aIID.equals(Components.interfaces.sbIWindowMinMaxCallback) &&
          !aIID.equals(Components.interfaces.nsISupportsWeakReference) &&
          !aIID.equals(Components.interfaces.nsISupports))
      {
        throw Components.results.NS_ERROR_NO_INTERFACE;
      }

      return this;
    }
  },



  // Helper Functions //


  _setMinMaxCallback: function _setMinMaxCallback()
  {
    var platform = getPlatformString();

    try {

      if (platform == "Windows_NT") {
        var windowMinMax = Components.classes["@songbirdnest.com/Songbird/WindowMinMax;1"];
        var service = windowMinMax.getService(Components.interfaces.sbIWindowMinMax);

        service.setCallback(document, this._minMaxHandler);
        return;
      } else if (platform == "Darwin") {
        var nativeWinMgr = 
                Cc["@songbirdnest.com/integration/native-window-manager;1"]
                  .getService(Ci.sbINativeWindowManager);
        if (nativeWinMgr.supportsMinimumWindowSize) {
          var minWidth = this._minMaxHandler.GetMinWidth();
          var minHeight = this._minMaxHandler.GetMinHeight();
          dump("min: " + minWidth + " x " + minHeight + "\n");
          var cstyle = window.getComputedStyle(document.documentElement, '');
          dump ("document min: " + cstyle.minWidth + "\n");
          nativeWinMgr.setMinimumWindowSize(window, minWidth, minHeight);
        }
      }
    }
    catch (err) {
      // No component
      dump("Error. songbird_hack.js:setMinMaxCallback() \n " + err + "\n");
    }
    return;
  },

  _resetMinMaxCallback: function _resetMinMaxCallback()
  {
    var platform = getPlatformString();

    try
    {
      if (platform == "Windows_NT") {
        var windowMinMax = Components.classes["@songbirdnest.com/Songbird/WindowMinMax;1"];
        var service = windowMinMax.getService(Components.interfaces.sbIWindowMinMax);
        service.resetCallback(document);

        return;
      }

    }
    catch(err) {
      dump("Error. songbird_hack.js: SBUnitialize() \n" + err + "\n");
    }

    return;
  },

  // XXXpvh: can this be removed and replaced with the GetPlatformString used everywhere else?
  _getPlatform: function _getPlatform() {
    var platform;
    try {
      var sysInfo =
        Components.classes["@mozilla.org/system-info;1"]
                  .getService(Components.interfaces.nsIPropertyBag2);
      platform = sysInfo.getProperty("name");
    }
    catch (e) {
      dump("System-info not available, trying the user agent string.\n");
      var user_agent = navigator.userAgent;
      if (user_agent.indexOf("Mac OS X") != -1)
        platform = "Darwin";
    }
    return platform;
  },


  _hasTitlebar: function _hasTitlebar() {

    // Jump through some hoops to get at nsIWebBrowserChrome.chromeFlags
    window.QueryInterface(Components.interfaces.nsIInterfaceRequestor);
    var webnav = window.getInterface(Components.interfaces.nsIWebNavigation);
    var treeItem = webnav.QueryInterface(Components.interfaces.nsIDocShellTreeItem);
    var treeOwner = treeItem.treeOwner;
    var requestor = treeOwner.QueryInterface(Components.interfaces.nsIInterfaceRequestor);
    var windowChrome = requestor.getInterface(Components.interfaces.nsIWebBrowserChrome);

    // Phew... now, do we have a titlebar?
    return windowChrome.chromeFlags & windowChrome.CHROME_TITLEBAR;
  }
}  // End of gMiniplayer