sbAddonMetadata.js

Go to the documentation of this file.

const CONTRACTID = "@mozilla.org/rdf/datasource;1?name=addon-metadata";
const CLASSNAME = "Songbird Addon Metadata Datasource";
const CID = Components.ID("{a1edd551-0f29-4ce9-aebc-92fbee77f37e}");
const IID = Components.interfaces.nsIRDFDataSource;

const FILE_INSTALL_MANIFEST = "install.rdf";
const FILE_EXTENSIONS       = "extensions.rdf";
const FILE_ADDONMETADATA    = "addon-metadata.rdf";

const PREF_LASTMODIFIED = "songbird.addonmetadata.lastModifiedTime";

const KEY_PROFILEDIR                  = "ProfD";

const RDFURI_INSTALL_MANIFEST_ROOT    = "urn:mozilla:install-manifest";
const RDFURI_ADDON_ROOT               = "urn:songbird:addon:root"
const PREFIX_ADDON_URI                = "urn:songbird:addon:";
const PREFIX_NS_EM                    = "http://www.mozilla.org/2004/em-rdf#";
const PREFIX_NS_SONGBIRD              = "http://www.songbirdnest.com/2007/addon-metadata-rdf#";
const PREFIX_ITEM_URI                 = "urn:mozilla:item:";

function SONGBIRD_NS(property) {
  return PREFIX_NS_SONGBIRD + property;
}

function EM_NS(property) {
  return PREFIX_NS_EM + property;
}

function ADDON_NS(id) {
  return PREFIX_ADDON_URI + id;
}

function ITEM_NS(id) {
  return PREFIX_ITEM_URI + id;
}


function AddonMetadata() {
  //debug("\nAddonMetadata: constructed\n");
  
  this._RDF = Components.classes["@mozilla.org/rdf/rdf-service;1"]
                   .getService(Components.interfaces.nsIRDFService);

  try {

    // If possible, load the cached datasource from disk. 
    // Otherwise rebuild it by reading the metadata from all addons
    if (!this._loadDatasource() || this._isRebuildRequired()) {
      //debug("AddonMetadata: rebuilding addon metadata datasource\n");
      this._purgeDatasource();
      this._buildDatasource();
    }
    
  } catch (e) {
    dump("AddonMetadata: Constructor Error: " + e.toString());
  }
  
  var os  = Components.classes["@mozilla.org/observer-service;1"]
                      .getService(Components.interfaces.nsIObserverService);
  os.addObserver(this, "xpcom-shutdown", false);
};

AddonMetadata.prototype = {

  constructor: AddonMetadata,

  _RDF: null,
  _datasource: null,

  
  _isRebuildRequired: function _isRebuildRequired() {
    var emDataFile = this._getProfileFile(FILE_EXTENSIONS);
    
    if (!emDataFile.exists()) {      
      //debug("AddonMetadata._isRebuildRequired: " + FILE_EXTENSIONS + " not found\n");
      return true;
    }

    var newLastModified = emDataFile.lastModifiedTime.toString();

    // When was the last time we noticed that extensions.rdf had been modified
    var prefs = Components.classes["@mozilla.org/preferences-service;1"]
                          .getService(Components.interfaces.nsIPrefBranch);
    var lastModified = 0;
    try {  
      lastModified = prefs.getCharPref(PREF_LASTMODIFIED);
    } catch (e) {}    
    
    // If the extensions.rdf hasn't changed, then we don't need to rebuild
    //debug("AddonMetadata._isRebuildRequired: " + lastModified + " == " + newLastModified + "\n");
    if (lastModified == newLastModified) {
      return false;
    }
        
    // Store the new last modified time
    prefs.setCharPref(PREF_LASTMODIFIED, newLastModified);

    //debug("AddonMetadata._isRebuildRequired: true\n");

    // Extensions.rdf has changed, so we will need to rebuild the addons datasource.
    return true;
  },
  
  
  
  _loadDatasource: function _loadDatasource() {
    //debug("\nAddonMetadata: _loadDatasource \n");
    
    var file = this._getProfileFile(FILE_ADDONMETADATA);
    
    try { 
      this._datasource = this._getDatasource(file);
    } catch (e) {
      // Load did not go ok.  Will need to rebuild
      return false;
    }
    
    if (!file.exists()) {
      return false;
    }
    
    return true;
  },
  


  _purgeDatasource: function _purgeDatasource() {
    //debug("\nAddonMetadata: _purgeDatasource \n");
    
    var file = this._getProfileFile(FILE_ADDONMETADATA);
    
    // Make sure the RDF service isn't caching our ds
    this._RDF.UnregisterDataSource(this._datasource);
    
    // Kill the file
    try { 
      if (file.exists()) {
        file.remove(false);
      }
    } catch (e) {
      debug("\nAddonMetadata: _purgeDatasource: Could not remove " 
            + "addon-metadata.rdf. Bad things may happen.\n");
    }

    // Reload the datasource.  Since the file no longer exists
    // this will result in a new empty DS.
    this._loadDatasource();
  },
  
    
  

  _getProfileFile: function _getProfileFile(filename) {
    // get profile directory
    var file = Components.classes["@mozilla.org/file/directory_service;1"]
                         .getService(Components.interfaces.nsIProperties)
                         .get("ProfD", Components.interfaces.nsIFile);
    var localFile = file.QueryInterface(Components.interfaces.nsILocalFile);                         
    localFile.appendRelativePath(filename)
    return file;
  },


  
  _buildDatasource: function _buildDatasource() {
    //debug("\nAddonMetadata: _buildDatasource \n");

    // Make a container to list all installed extensions
    var itemRoot = this._RDF.GetResource(RDFURI_ADDON_ROOT);    
    var cu = Components.classes["@mozilla.org/rdf/container-utils;1"]
                       .getService(Components.interfaces.nsIRDFContainerUtils);
    var container = cu.MakeSeq(this._datasource, itemRoot);

    var extManager = Components.classes["@mozilla.org/extensions/manager;1"]
                           .getService(Components.interfaces.nsIExtensionManager);
   
    // Read the install.rdf for every addon
    var addons = extManager.getItemList(Components.interfaces.nsIUpdateItem.TYPE_ADDON, {});
    for (var i = 0; i < addons.length; i++)
    {
      var id = addons[i].id;
            
      // If the extension is disabled, do not include it in our datasource 
      if (this._isExtensionDisabled(id))  {
        //debug("\nAddonMetadata:  id {" + id +  "} is disabled.\n");
        continue;
      }
      
      //debug("\nAddonMetadata:  loading install.rdf for id {" + id +  "}\n");
      
      var location = extManager.getInstallLocation(id);
      var installManifestFile = location.getItemFile(id, FILE_INSTALL_MANIFEST);

      if (!installManifestFile.exists()) {
        this._reportErrors(["install.rdf for id " + id +  " was not found " + 
                  "at location " + installManifestFile.path]);
      }
      
      var manifestDS = this._getDatasource(installManifestFile);
      var itemNode = this._RDF.GetResource(ADDON_NS(id));
      // Copy the install.rdf metadata into the master datasource
      this._copyManifest(itemNode, manifestDS);
      
      // Add the new install.rdf root to the list of extensions
      container.AppendElement(itemNode);
    }

    // Save changes  
    this._datasource.QueryInterface(Components.interfaces.nsIRDFRemoteDataSource)
                    .Flush();
    //debug("\nAddonMetadata: _buildDatasource complete \n");
  },
  
  
  
  _isExtensionDisabled: function _isExtensionDisabled(id) {
    var item = this._RDF.GetResource(ITEM_NS(id));
    var extManager = Components.classes["@mozilla.org/extensions/manager;1"]
                        .getService(Components.interfaces.nsIExtensionManager);
    var userDisabled = this._RDF.GetResource(EM_NS("userDisabled"));
    if (extManager.datasource.hasArcOut(item, userDisabled)) {
      var target = extManager.datasource.GetTarget(item, userDisabled, true);
      if (target instanceof Components.interfaces.nsIRDFLiteral){
        target = target.QueryInterface(Components.interfaces.nsIRDFLiteral);
        return target.Value == "true";
      }
    }                      
    var appDisabled = this._RDF.GetResource(EM_NS("appDisabled"));
    if (extManager.datasource.hasArcOut(item, appDisabled)) {
      var target = extManager.datasource.GetTarget(item, appDisabled, true);
      if (target instanceof Components.interfaces.nsIRDFLiteral){
        target = target.QueryInterface(Components.interfaces.nsIRDFLiteral);
        return target.Value == "true";
      }
    }
    return false;
  },
 
  
  
  _copyManifest:  function _copyManifest(itemNode, manifestDS) {
  
    // Copy all resources from the manifest to the main DS
    var resources = manifestDS.GetAllResources();
    while (resources.hasMoreElements()) {
      var resource = resources.getNext().QueryInterface(Components.interfaces.nsIRDFResource);
      
      // Get all arcs out of the resource
      var arcs = manifestDS.ArcLabelsOut(resource);
      while (arcs.hasMoreElements()) {
        var arc = arcs.getNext().QueryInterface(Components.interfaces.nsIRDFResource);
              
        // For each arc, get all targets
        var targets = manifestDS.GetTargets(resource, arc, true);
        while (targets.hasMoreElements()) {
          var target = targets.getNext().QueryInterface(Components.interfaces.nsIRDFNode);
          
          // If this resource is the manifest root, replace it
          // with a resource representing the current addon
          newResource = resource;
          if (resource.Value == RDFURI_INSTALL_MANIFEST_ROOT) {
            newResource = itemNode;
          }
                    
          // Otherwise, assert into the main ds
          this._datasource.Assert(newResource, arc, target, true);
        }
      }                   
    }
  },

  



  _getDatasource: function _getDatasource(file) {
    var ioServ = Components.classes["@mozilla.org/network/io-service;1"]
                           .getService(Components.interfaces.nsIIOService);
    var fph = ioServ.getProtocolHandler("file")
                    .QueryInterface(Components.interfaces.nsIFileProtocolHandler);

    var fileURL = fph.getURLSpecFromFile(file);
    var ds = this._RDF.GetDataSourceBlocking(fileURL);

    return ds;
  },


  
  _deinit: function _deinit() {
    //debug("\nAddonMetadata: deinit\n");

    this._RDF = null;
    this._datasource = null;
  },
    
  

  // watch for XRE startup and shutdown messages 
  observe: function(subject, topic, data) {
    var os = Components.classes["@mozilla.org/observer-service;1"]
                       .getService(Components.interfaces.nsIObserverService);
    switch (topic) {
    case "xpcom-shutdown":
      os.removeObserver(this, "xpcom-shutdown");
      this._deinit();
      break;
    }
  },
  
  
  
  _reportErrors: function _reportErrors(errorList) {
    var consoleService = Components.classes["@mozilla.org/consoleservice;1"].
         getService(Components.interfaces.nsIConsoleService);
    for (var i = 0; i  < errorList.length; i++) {
      consoleService.logStringMessage("Addon Metadata Reader: " + errorList[i]);
      debug("AddonMetadataReader: " + errorList[i] + "\n");
    }
  },



  QueryInterface: function(iid) {
    if (!iid.equals(IID) &&
        !iid.equals(Components.interfaces.nsIObserver) && 
        !iid.equals(Components.interfaces.nsISupports))
      throw Components.results.NS_ERROR_NO_INTERFACE;
    
    // THIS IS SO WRONG! 
    // We can get away with it though since we really only want the datasource
    // and never the object that builds it.
    if (iid.equals(IID)) {
      return this._datasource;
    }
    
    return this;
  }
}; // AddonMetadata.prototype







var gModule = {
  registerSelf: function(componentManager, fileSpec, location, type) {
    componentManager = componentManager.QueryInterface(Components.interfaces.nsIComponentRegistrar);
    for (var key in this._objects) {
      var obj = this._objects[key];
      componentManager.registerFactoryLocation(obj.CID, obj.className, obj.contractID,
                                               fileSpec, location, type);
    }
  },

  getClassObject: function(componentManager, cid, iid) {
    if (!iid.equals(Components.interfaces.nsIFactory))
      throw Components.results.NS_ERROR_NOT_IMPLEMENTED;

    for (var key in this._objects) {
      if (cid.equals(this._objects[key].CID))
        return this._objects[key].factory;
    }
    
    throw Components.results.NS_ERROR_NO_INTERFACE;
  },

  _makeFactory: #1= function(ctor) {
    function ci(outer, iid) {
      if (outer != null)
        throw Components.results.NS_ERROR_NO_AGGREGATION;
      return (new ctor()).QueryInterface(iid);
    } 
    return { createInstance: ci };
  },
  
  _objects: {
    AddonMetadata:     {   CID        : CID,
                           contractID : CONTRACTID,
                           className  : CLASSNAME,
                           factory    : #1#(AddonMetadata)
                         },
  },

  canUnload: function(componentManager) { 
    return true; 
  }
}; // gModule

function NSGetModule(comMgr, fileSpec) {
  return gModule;
} // NSGetModule