sbDeviceServicePaneService.js

Go to the documentation of this file.

/* vim: set ts=2 sw=2 expandtab : */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 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
 */

const Cc = Components.classes;
const Ci = Components.interfaces;
const Cr = Components.results;
const Cu = Components.utils;

const CONTRACTID = "@songbirdnest.com/servicepane/device;1";

const SP = "http://songbirdnest.com/rdf/servicepane#";
const LSP = 'http://songbirdnest.com/rdf/library-servicepane#';
const DEVICESP_NS = "http://songbirdnest.com/rdf/device-servicepane#";

const URN_PREFIX_DEVICE = "urn:device:";
const DEVICE_NODE_WEIGHT = -2;

Cu.import("resource://gre/modules/XPCOMUtils.jsm");
Cu.import("resource://app/jsmodules/ArrayConverter.jsm");
Cu.import("resource://app/jsmodules/DOMUtils.jsm");
Cu.import("resource://app/jsmodules/sbProperties.jsm");
Cu.import("resource://app/jsmodules/sbLibraryUtils.jsm");
Cu.import("resource://app/jsmodules/DebugUtils.jsm");

function logcall(parentArgs) {
  dump("\n");
  dump(parentArgs.callee.name + "(");
  for (var i = 0; i < parentArgs.length; i++) {
    dump(parentArgs[i]);
    if (i < parentArgs.length - 1) {
      dump(', ');
    }
  }
  dump(")\n");
}



function sbDeviceServicePane() {
  this._servicePane = null;
  this._libraryServicePane = null;

  // use the default stringbundle to translate tree nodes
  this.stringbundle = null;

  this.log = DebugUtils.generateLogFunction("DeviceServicePaneService");
}

// XPCOM Support        //
sbDeviceServicePane.prototype.QueryInterface =
  XPCOMUtils.generateQI([Ci.sbIServicePaneModule,
                         Ci.sbIServicePaneMutationListener,
                         Ci.sbIDeviceServicePaneService]);
sbDeviceServicePane.prototype.classDescription =
  "Songbird Device Service Pane Service";
sbDeviceServicePane.prototype.classID =
  Components.ID("{845c31ee-c30e-4fb6-9667-0b10e58c7069}");
sbDeviceServicePane.prototype.contractID =
  CONTRACTID;
sbDeviceServicePane.prototype._xpcom_categories = [
  {
    category: 'service-pane',
    entry: 'device', // we want this to load first
    value: CONTRACTID
  }];

// sbIServicePaneModule //

sbDeviceServicePane.prototype.servicePaneInit =
function sbDeviceServicePane_servicePaneInit(sps) {
  //logcall(arguments);

  // keep track of the service pane services
  this._servicePane = sps;
  this._libraryServicePane = Cc["@songbirdnest.com/servicepane/library;1"]
                               .getService(Ci.sbILibraryServicePaneService);

  // load the device context menu document
  this._deviceContextMenuDoc =
        DOMUtils.loadDocument
          ("chrome://songbird/content/xul/device/deviceContextMenu.xul");

  // cache the device manager
  this._deviceMgr = Cc["@songbirdnest.com/Songbird/DeviceManager;2"]
                      .getService(Ci.sbIDeviceManager2);

  this._mainLibraryListeners = [];
  this._deviceLibraryAndListenerObjs = [];
}

sbDeviceServicePane.prototype.shutdown =
function sbDeviceServicePane_shutdown() {
  // release object references
  for (var i = 0; i < this._deviceLibraryAndListenerObjs.length; i++) {
    var currObj = this._deviceLibraryAndListenerObjs[i];
    currObj["library"].removeListener(currObj["listener"]);
  }

  for (var i = 0; i < this._mainLibraryListeners.length; i++) {
    LibraryUtils.mainLibrary.removeListener(this._mainLibraryListeners[i]);
  }

  this._servicePane.root.removeMutationListener(this);
  this._servicePane = null;
  if (this._deviceGroupNode)
    this._deviceGroupNode.removeMutationListener(this);
  this._deviceGroupNode = null;
  this._libraryServicePane = null;
  this._deviceContextMenuDoc = null;
  this._deviceMgr = null;
}

sbDeviceServicePane.prototype.fillContextMenu =
function sbDeviceServicePane_fillContextMenu(aNode, aContextMenu, aParentWindow) {
  // Get the node device ID.  Do nothing if not a device node.
  var deviceID = aNode.getAttributeNS(DEVICESP_NS, "device-id");
  if (!deviceID)
    return;

  // Do nothing if not set to fill with the default device context menu items.
  var fillDefaultContextMenu = aNode.getAttributeNS(DEVICESP_NS,
                                                    "fillDefaultContextMenu");
  if (fillDefaultContextMenu != "true")
    return;

  // Get the device node type.
  var deviceNodeType = aNode.getAttributeNS(DEVICESP_NS, "deviceNodeType");

  // Import device context menu items into the context menu.
  if (deviceNodeType == "device") {
    DOMUtils.importChildElements(aContextMenu,
                                 this._deviceContextMenuDoc,
                                 "device_context_menu_items",
                                 { "device-id": deviceID,
                                   "service_pane_node_id": aNode.id });
  } else if (deviceNodeType == "library") {
    DOMUtils.importChildElements(aContextMenu,
                                 this._deviceContextMenuDoc,
                                 "device_library_context_menu_items",
                                 { "device-id": deviceID,
                                   "service_pane_node_id": aNode.id });
  }
}

sbDeviceServicePane.prototype.fillNewItemMenu =
function sbDeviceServicePane_fillNewItemMenu(aNode, aContextMenu, aParentWindow) {
}

sbDeviceServicePane.prototype.onSelectionChanged =
function sbDeviceServicePane_onSelectionChanged(aNode, aContainer, aParentWindow) {
}

sbDeviceServicePane.prototype.canDrop =
function sbDeviceServicePane_canDrop(aNode, aDragSession, aOrientation, aWindow) {
  return false;
}

sbDeviceServicePane.prototype.onDrop =
function sbDeviceServicePane_onDrop(aNode, aDragSession, aOrientation, aWindow) {
}

sbDeviceServicePane.prototype.onDragGesture =
function sbDeviceServicePane_onDragGesture(aNode, aDataTransfer) {
  return false;
}


sbDeviceServicePane.prototype.onBeforeRename =
function sbDeviceServicePane_onBeforeRename(aNode) {
}

sbDeviceServicePane.prototype.onRename =
function sbDeviceServicePane_onRename(aNode, aNewName) {
}


// sbIDeviceServicePaneService //

sbDeviceServicePane.prototype.createNodeForDevice =
function sbDeviceServicePane_createNodeForDevice(aDevice, aDeviceIdentifier) {
  //logcall(arguments);
  this.log("createNodeForDevice");

  // Make sure the devices group exists first
  let devicesNode = this._ensureDevicesGroupExists();

  // Get the Node.
  var id = this._deviceURN(aDevice, aDeviceIdentifier);
  var node = this._servicePane.getNode(id);
  if (!node) {
    // Create the node
    node = this._servicePane.createNode();
    node.id = id;
  }

  // Refresh the information just in case it is supposed to change
  node.contractid = CONTRACTID;
  node.setAttributeNS(SP, "Weight", DEVICE_NODE_WEIGHT);
  node.editable = false;

  // Add the node
  if (!node.parentNode) {
    this.log("\tNo parentNode, appending to devices group node");
    devicesNode.appendChild(node);
  }

  return node;
}

sbDeviceServicePane.prototype.createNodeForDevice2 =
function sbDeviceServicePane_createNodeForDevice2(aDevice, aEjectable) {
  this.log("createNodeForDevice2");

  // Make sure the devices group exists first
  let devicesNode = this._ensureDevicesGroupExists();

  // Get the Node.
  var id = this._deviceURN2(aDevice);

  var node = this._servicePane.getNode(id);
  if (!node) {
    // Create the node
    node = this._servicePane.createNode();
    node.id = id;
  }

  // Refresh the information just in case it is supposed to change
  node.contractid = CONTRACTID;
  node.setAttributeNS(DEVICESP_NS, "device-id", aDevice.id);
  node.setAttributeNS(DEVICESP_NS, "deviceNodeType", "device");
  node.setAttributeNS(SP, "Weight", DEVICE_NODE_WEIGHT);
  if (aEjectable) {
    node.setAttribute("ejectable", "true");
    let listener = new _deviceNodeEventListener(aDevice);
    node.addEventListener(listener);
  }
  node.editable = false;
  node.className = "device";

  try {
    var iconUri = aDevice.properties.iconUri;
    if (iconUri) {
      var spec = iconUri.spec;
      if (iconUri.schemeIs("file") && /\.ico$/i(spec)) {
        // for *.ico, try to get the small icon
        spec = "moz-icon://" + spec + "?size=16";
      }
      node.image = spec;
    }
  } catch(ex) {
    /* we do not care if setting the icon fails */
  }

  // Add the node
  if (!node.parentNode) {
    this.log("\tNo parentNode, appending to devices group node");
    devicesNode.appendChild(node);
  }

  this._device = aDevice;
  return node;
}

sbDeviceServicePane.prototype.createLibraryNodeForDevice =
function sbDeviceServicePane_createLibraryNodeForDevice(aDevice, aLibrary) {
  this.log("Creating library nodes for device " + aDevice.id);
  var deviceNode = this.getNodeForDevice(aDevice);

  // Create the library nodes and move them underneath the device node
  this._libraryServicePane.createNodeForLibrary(aLibrary);
  this._moveLibraryNodes(aLibrary);

  /* Add a listener to detect when a device library item's originItemGuid
   * property is updated.
   * We use this listener to detect when a medialist has its originItemGuid
   * changed which will occur when the medialist is imporpied into the main
   * library and will likely mean we should remove its 'deviceonly' icon */
  var deviceUpdateListener = new DeviceLibraryItemUpdateListener();
  var listenToPropsArray =
    Cc["@songbirdnest.com/Songbird/Properties/MutablePropertyArray;1"]
      .createInstance(Ci.sbIMutablePropertyArray);
  listenToPropsArray.appendProperty(SBProperties.originItemGuid, "");
  aLibrary.addListener(deviceUpdateListener,
                       false,
                       Ci.sbIMediaList.LISTENER_FLAGS_ITEMUPDATED,
                       listenToPropsArray);
  var deviceLibListenerObj = {
    library: aLibrary,
    listener: deviceUpdateListener
  };

  this._deviceLibraryAndListenerObjs.push(deviceLibListenerObj);

  /* Add a listener to the main library to detect when a medialist is removed.
   * This listener, when a medialist is removed, checks if there is an item
   * on the device whose originItemGuid pointed to the removed medialist and, if
   * so, labels the device medialist with the 'deviceonly' icon. */
  var mainLibraryRemovedListener = new MainLibraryItemRemovedListener(aLibrary);
  LibraryUtils.mainLibrary.addListener
                          (mainLibraryRemovedListener,
                           false,
                           Ci.sbIMediaList.LISTENER_FLAGS_AFTERITEMREMOVED,
                           null);
  this._mainLibraryListeners.push(mainLibraryRemovedListener);

  return this._libraryServicePane.getNodeForLibraryResource(aLibrary);
}

sbDeviceServicePane.prototype.getNodeForDevice =
function sbDeviceServicePane_getNodeForDevice(aDevice) {
  // Get the Node.
  var id = this._deviceURN2(aDevice);
  return this._servicePane.getNode(id);
}

sbDeviceServicePane.prototype.setFillDefaultContextMenu =
function sbDeviceServicePane_setFillDefaultContxtMenu(aNode,
                                                      aEnabled) {
  if (aEnabled) {
    aNode.setAttributeNS(DEVICESP_NS, "fillDefaultContextMenu", "true");
  } else {
    aNode.setAttributeNS(DEVICESP_NS, "fillDefaultContextMenu", "false");
  }
}

sbDeviceServicePane.prototype.insertChildByName =
function sbDeviceServicePane_insertChildByName(aDevice, aChild) {
  var lastNode = null;
  var deviceNode = this.getNodeForDevice(aDevice);
  for (let node = deviceNode.firstChild; node; node = node.nextSibling) {
    var listType = node.getAttributeNS(LSP, "ListType");
    // Ignore library node.
    if (listType == "library") {
      continue;
    }

    // Find the node to insert before. Ignore case.
    var childname = aChild.name ? aChild.name.toLowerCase() : aChild.name;
    var nodename = node.name ? node.name.toLowerCase() : node.name;
    if (childname < nodename) {
      lastNode = node;
      break;
    }
  }

  // Insert before the node found, or insert at the end if lastNode is null.
  deviceNode.insertBefore(aChild, lastNode);

  // If we are inserting a medialist node, check if it is deviceonly
  if (aChild.className.match(/medialist/) != null) {

    /* The node looks like a medialist.  We'll get its resource, check that
     * it's a medialist, and look for an item in the mainLibrary that has a
     * guid matching its originGUID.  If we can't find one, we'll label the
     * node as representing a deviceonly medialist */
    var resource = this._libraryServicePane.getLibraryResourceForNode(aChild);
    if (resource instanceof Ci.sbIMediaList &&
        !LibraryUtils.getMainLibraryOriginItem(resource)) {
      var classes = aChild.className.split(/\s/);
      classes.push("medialisttype-deviceonly");
      aChild.className = classes.join(' ');
    }
  }
}

// sbIServicePaneMutationListener //
function _deviceNodeEventListener(aDevice) {
  this._device = aDevice;
}
_deviceNodeEventListener.prototype = {
  handleEvent: function sbDeviceServicePane_handleEvent(aEventName) {
    switch (aEventName) {
      case "eject":
        try {
          this._device.eject();
        } catch (e) {
          dump("Exception in sbDeviceServicePane event listener: " + e + "\n");
        }
        break;
    }
  }
}

// sbIServicePaneMutationListener //
sbDeviceServicePane.prototype.attrModified =
function sbDeviceServicePane_attrModified(aNode, aAttrName, aNamespace,
                                          aOldVal, aNewVal) {
  // Ensure that the parent device's node reflects any changes.
  this._updateParentDeviceNode();
};

sbDeviceServicePane.prototype.nodeInserted =
function sbDeviceServicePane_nodeInserted(aNode, aParent, aInsertBefore) {
  // Ensure that the parent device's node reflects any changes.
  this._updateParentDeviceNode();
};

sbDeviceServicePane.prototype.nodeRemoved =
function sbDeviceServicePane_nodeRemoved(aNode, aParent) {
  // Ensure that the parent device's node reflects any changes.
  this._updateParentDeviceNode();
};

// DeviceLibraryItemUpdateListener //
/* This listener detects when the originItemGuid of an item in the mainlibrary
 * is updated.  If the item is a medialist, we check if there is an item in the
 * main library with a guid matching that originItemGuid.  If there is not, we
 * label the medialist with a 'deviceonly' icon in the servicepane.
 * We are unconcerned with mediaitems as they are labeled 'deviceonly'
 * separately */
function DeviceLibraryItemUpdateListener() {
}

DeviceLibraryItemUpdateListener.prototype = {
  onItemUpdated: function DeviceLibraryItemUpdateListener_onItemUpdated
                 (aMediaList, aMediaItem, aProperties) {

    // only deal with medialists
    if (!(aMediaItem instanceof Ci.sbIMediaList)) {
      return true;
    }
    var libSPS = Cc["@songbirdnest.com/servicepane/library;1"]
                   .getService(Ci.sbILibraryServicePaneService);
    var node = libSPS.getNodeForLibraryResource(aMediaItem);
    var classes = node.className.split(/\s/);

    /* Check if there is an item in the main library with a guid corresponding
     * to this medialist's originItemGuid. */
    if (!LibraryUtils.getMainLibraryOriginItem(aMediaItem)) {
      // no corresponding item in the main library, label as deviceonly
      classes.push("medialisttype-deviceonly");
    }
    else {
      /* Corresponding item in the main library, this is not deviceonly
       * so remove the 'medialisttype-deviceonly' class if it exists */
      classes = classes.filter(function(aClass) {
        return aClass != "medialisttype-deviceonly";
      });
    }
    node.className = classes.join(' ');
  }
}

// MainLibraryItemRemovedListener  //
/* This listener detects when a medialist is removed from the mainlibrary and
 * checks if there is a medialist on this device whose originItemGuid pointed to
 * the removed item's guid.  If there was, that device medialist should now be
 * marked as deviceonly. */
function MainLibraryItemRemovedListener(devLibrary) {
  this.deviceLibrary = devLibrary;
}

MainLibraryItemRemovedListener.prototype = {
  onAfterItemRemoved: function MainLibraryItemRemovedListener_onAfterItemRemoved
                 (aMediaList, aMediaItem, aIndex) {

    // only concerned with medialists that are removed
    if (!(aMediaItem instanceof Ci.sbIMediaList)) {
      return true;
    }

    /* Check for items on the device whose originItemGuid pointed to the removed
     * medialist's guid */
    var foundLists = this.deviceLibrary.getItemsByProperty
                                       (SBProperties.originItemGuid,
                                        aMediaItem.guid);
    var libSPS = Cc["@songbirdnest.com/servicepane/library;1"]
                   .getService(Ci.sbILibraryServicePaneService);

    for (let i = 0; i < foundLists.length; i++) {

      // We found an item of interest, check if its node was already 'deviceonly'
      var foundList = foundLists.queryElementAt(i, Ci.sbIMediaItem);

      var node = libSPS.getNodeForLibraryResource(foundList);

      if (node && node.className.match(/medialisttype-deviceonly/) == null) {

        /* The device medialist whose originItemGuid corresponded to the removed
         * medialist's guid was not labeled 'deviceonly' and should be. */
        var classes = node.className.split(/\s/);
        classes.push("medialisttype-deviceonly");
        node.className = classes.join(" ");
        return true;
      }
    }
  }
}

// Private Methods //

sbDeviceServicePane.prototype._updateParentDeviceNode =
function sbDeviceServicePane__updateParentDeviceNode() {
  try {
    // Check to see if the devices group should be hidden or not
    let hidden = true;
    let devicesNode = this._servicePane.getNode("SB:Devices");
    if (!devicesNode) {
      // there's no devices to look at, we don't care
      return;
    }
    for (let node = devicesNode.firstChild; node; node = node.nextSibling) {
      if (node && !node.hidden) {
        hidden = false;
        break;
      }
    }

    if (devicesNode.hidden != hidden) {
      this.log("Hiding devices node since all children are gone or hidden");
      devicesNode.hidden = hidden;
    }
  }
  catch (e) {
    this.log("Execption updating device node: " + e);
  }
};

sbDeviceServicePane.prototype._deviceURN =
function sbDeviceServicePane__deviceURN(aDevice, aDeviceIdentifier) {
  return URN_PREFIX_DEVICE + aDevice.deviceCategory + ":" + aDeviceIdentifier;
}

sbDeviceServicePane.prototype._ensureDevicesGroupExists =
function sbDeviceServicePane__ensureDevicesGroupExists() {
  this.log("ensureDevicesGroupExists");
  let fnode = this._servicePane.getNode("SB:Devices");
  if (!fnode) {
    // make sure it exists
    fnode = this._servicePane.createNode();
    fnode.id = "SB:Devices";
    fnode.name = "&servicesource.devices";
    this._addClassNames(fnode, ["folder", this._makeCSSProperty(fnode.name)]);
    fnode.contractid = CONTRACTID;
    // XXXstevel need to set fnode.dndAcceptIn?
    fnode.editable = false;
    fnode.setAttributeNS(SP, 'Weight', -2);
    this._servicePane.root.appendChild(fnode);
    fnode.addMutationListener(this);
    this._deviceGroupNode = fnode;
    this.log("\tDevices group created");
  }

  return fnode;
}

sbDeviceServicePane.prototype._addClassNames =
function sbDeviceServicePane__addClassNames(aNode, aList) {
  let className = aNode.className || "";
  let existing = {};
  for each (let name in className.split(" "))
    existing[name] = true;

  for each (let name in aList)
    if (!existing.hasOwnProperty(name))
      className += (className ? " " : "") + name;

  aNode.className = className;
}


sbDeviceServicePane.prototype._makeCSSProperty =
function sbDeviceServicePane__makeCSSProperty(aString) {
  if ( aString[0] == "&" ) {
    aString = aString.substr(1, aString.length);
    aString = aString.replace(/\./g, "-");
  }
  return aString;
}


sbDeviceServicePane.prototype._deviceURN2 =
function sbDeviceServicePane__deviceURN2(aDevice) {
  var id = "" + aDevice.id;

  if(id.charAt(0) == "{" &&
     id.charAt(-1) == "}") {
    id = id.substring(1, -1);
  }


  return URN_PREFIX_DEVICE + id;
}


sbDeviceServicePane.prototype._moveLibraryNodes =
function sbDeviceServicePane__moveLibraryNodes(aLibrary) {
  var nodeList = this._libraryServicePane.getNodesForLibraryResource(aLibrary);
  nodeList = ArrayConverter.JSArray(nodeList);
  for each (var node in nodeList) {
    node.QueryInterface(Ci.sbIServicePaneNode);
    this._moveLibraryResourceNode(node);
  }
}


sbDeviceServicePane.prototype._getNodeIndexFromClassName =
function sbDeviceServicePane__getNodeIndexFromClassName(aNode) {
  const K_TYPES = ["audio", "video", "podcast"];
  var types = aNode.className.split(/\s/);
  var index = -1;
  for (let i = 0; i < types.length; ++i) {
    if ((index = K_TYPES.indexOf(types[i])) > -1)
      break;
  }

  return index;
}


sbDeviceServicePane.prototype._moveLibraryResourceNode =
function sbDeviceServicePane__moveLibraryResourceNode(aNode) {
  var resource = this._libraryServicePane.getLibraryResourceForNode(aNode);
  if (!resource) {
    return;
  }
  if (!(resource instanceof Ci.sbIMediaList)) {
    // not a media list, we don't care
    return;
  }
  var device = this._deviceMgr.getDeviceForItem(resource);
  if (!device) {
    // not a device playlist
    return;
  }

  // Only move nodes that the device supports
  var functions = device.capabilities.getSupportedFunctionTypes({});
  const CAPS_MAP = {
    "audio": Ci.sbIDeviceCapabilities.FUNCTION_AUDIO_PLAYBACK,
    "video": Ci.sbIDeviceCapabilities.FUNCTION_VIDEO_PLAYBACK
  };

  var props = aNode.className.split(/\s/);
  props = props.filter(function(val) val in CAPS_MAP);
  // there should only be one anyway...
  // assert(props.length < 2);
  if (functions.indexOf(CAPS_MAP[props[0]]) < 0) {
    this.log("Not moving library node " + aNode.id +
             " to device node, capability not supported");
    return;
  }

  // Set up the device library node info.
  aNode.setAttributeNS(DEVICESP_NS, "device-id", device.id);
  aNode.setAttributeNS(DEVICESP_NS, "deviceNodeType", "library");

  var deviceNode = this.getNodeForDevice(device);
  if (deviceNode && aNode.parentNode != deviceNode) {
    var index1 = this._getNodeIndexFromClassName(aNode);
    if (index1 == -1) {
      dump("_moveLibraryResourceNode: Not in the node array??!!\n");
      deviceNode.appendChild(aNode);
      return;
    }

    var child = deviceNode.firstChild;
    while (child) {
      var index2 = this._getNodeIndexFromClassName(child);
      if (index2 == -1 || index1 < index2)
        break;

      child = child.nextSibling;
    }
    deviceNode.insertBefore(aNode, child);
  }
}

// XPCOM //

var NSGetModule = XPCOMUtils.generateNSGetModule([sbDeviceServicePane]);