mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
Bug 1192921: Refactor add-on manager startup loop to better support validating install locations after scanning. r=rhelmer
The add-ons manager recognises the notion of "install locations". Each location can contain add-ons that are installed in the application. There are two main types, directory locations which exist as a directory somewhere in the filesystem and registry locations which exist in the Windows registry. The profile location is the one where add-ons installed through the UI exist, the other locations are for add-ons that are bundled with the application, installed by the OS or by third-party applications. Install locations have priorities. The profile location has the highest priority then the others gradually lower priorities. When an add-on exists in more than one install location the version in the highest priority location is the one that is visible and can be active in the application. We still retain details about the other versions in the database. On every startup the add-ons manager scans over these install locations to see if the set of installed add-ons has changed at all. A very quick check is done to see if the more thorough check in processFileChanges (which synchronously loads the add-ons database and install manifests for the add-ons) is needed. The job of processFileChanges is to load information about all the add-ons and update the add-ons database to match. It has to decide which add-ons to make visible, track what changes were made to the visible set of add-ons and call restartless add-ons install and uninstall scripts. The original version of processFileChanges attempted to optimise this by doing all of the work in a single loop over the add-ons in the locations. This mostly worked but made certain situations difficult to handle (see bug 607818 f.e.). There isn't much need for this level of optimisation. We're already in a slow pass and once all the data is loaded off the disk looping over it is fast. This changeset moves processFileChanges into the XPIProviderUtils file which is lazy loaded when necessary. While most of the code is the same it instead does one loop to update the database and gather information, then a second loop to update add-on visibility, record changes and call bootstrap scripts.
This commit is contained in:
Dave Townsend
parent
4c860c336a
commit
2369f350d7
@ -1646,6 +1646,7 @@ var AddonManagerInternal = {
|
||||
|
||||
if (gStartupComplete)
|
||||
return;
|
||||
logger.debug("Registering startup change '" + aType + "' for " + aID);
|
||||
|
||||
// Ensure that an ID is only listed in one type of change
|
||||
for (let type in this.startupChanges)
|
||||
|
||||
@ -82,7 +82,6 @@ const PREF_EM_UPDATE_BACKGROUND_URL = "extensions.update.background.url";
|
||||
const PREF_EM_ENABLED_ADDONS = "extensions.enabledAddons";
|
||||
const PREF_EM_EXTENSION_FORMAT = "extensions.";
|
||||
const PREF_EM_ENABLED_SCOPES = "extensions.enabledScopes";
|
||||
const PREF_EM_AUTO_DISABLED_SCOPES = "extensions.autoDisableScopes";
|
||||
const PREF_EM_SHOW_MISMATCH_UI = "extensions.showMismatchUI";
|
||||
const PREF_XPI_ENABLED = "xpinstall.enabled";
|
||||
const PREF_XPI_WHITELIST_REQUIRED = "xpinstall.whitelist.required";
|
||||
@ -158,12 +157,6 @@ const PROP_LOCALE_SINGLE = ["name", "description", "creator", "homepageURL"];
|
||||
const PROP_LOCALE_MULTI = ["developers", "translators", "contributors"];
|
||||
const PROP_TARGETAPP = ["id", "minVersion", "maxVersion"];
|
||||
|
||||
// Properties that should be migrated where possible from an old database. These
|
||||
// shouldn't include properties that can be read directly from install.rdf files
|
||||
// or calculated
|
||||
const DB_MIGRATE_METADATA= ["installDate", "userDisabled", "softDisabled",
|
||||
"sourceURI", "applyBackgroundUpdates",
|
||||
"releaseNotesURI", "foreignInstall", "syncGUID"];
|
||||
// Properties to cache and reload when an addon installation is pending
|
||||
const PENDING_INSTALL_METADATA =
|
||||
["syncGUID", "targetApplications", "userDisabled", "softDisabled",
|
||||
@ -264,7 +257,7 @@ const LOGGER_ID = "addons.xpi";
|
||||
// (Requires AddonManager.jsm)
|
||||
let logger = Log.repository.getLogger(LOGGER_ID);
|
||||
|
||||
const LAZY_OBJECTS = ["XPIDatabase"];
|
||||
const LAZY_OBJECTS = ["XPIDatabase", "XPIDatabaseReconcile"];
|
||||
|
||||
var gLazyObjectsLoaded = false;
|
||||
|
||||
@ -276,9 +269,17 @@ function loadLazyObjects() {
|
||||
});
|
||||
|
||||
let shared = {
|
||||
ADDON_SIGNING,
|
||||
SIGNED_TYPES,
|
||||
BOOTSTRAP_REASONS,
|
||||
AddonInternal,
|
||||
XPIProvider,
|
||||
XPIStates,
|
||||
syncLoadManifestFromFile,
|
||||
isUsableAddon,
|
||||
recordAddonTelemetry,
|
||||
applyBlocklistChanges,
|
||||
flushStartupCache,
|
||||
}
|
||||
|
||||
for (let key of Object.keys(shared))
|
||||
@ -294,7 +295,7 @@ function loadLazyObjects() {
|
||||
return scope;
|
||||
}
|
||||
|
||||
for (let name of LAZY_OBJECTS) {
|
||||
LAZY_OBJECTS.forEach(name => {
|
||||
Object.defineProperty(gGlobalScope, name, {
|
||||
get: function lazyObjectGetter() {
|
||||
let objs = loadLazyObjects();
|
||||
@ -302,7 +303,7 @@ for (let name of LAZY_OBJECTS) {
|
||||
},
|
||||
configurable: true
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
function findMatchingStaticBlocklistItem(aAddon) {
|
||||
@ -2001,6 +2002,9 @@ this.XPIStates = {
|
||||
if (changed) {
|
||||
logger.debug("Changed add-on ${id} in ${location}", {id: id, location: location.name});
|
||||
}
|
||||
else {
|
||||
logger.debug("Existing add-on ${id} in ${location}", {id: id, location: location.name});
|
||||
}
|
||||
foundAddons.set(id, xpiState);
|
||||
}
|
||||
XPIProvider.setTelemetry(id, "location", location.name);
|
||||
@ -3122,681 +3126,6 @@ this.XPIProvider = {
|
||||
return changed;
|
||||
},
|
||||
|
||||
/**
|
||||
* Compares the add-ons that are currently installed to those that were
|
||||
* known to be installed when the application last ran and applies any
|
||||
* changes found to the database. Also sends "startupcache-invalidate" signal to
|
||||
* observerservice if it detects that data may have changed.
|
||||
* Always called after XPIProviderUtils.js and extensions.json have been loaded.
|
||||
*
|
||||
* @param aManifests
|
||||
* A dictionary of cached AddonInstalls for add-ons that have been
|
||||
* installed
|
||||
* @param aUpdateCompatibility
|
||||
* true to update add-ons appDisabled property when the application
|
||||
* version has changed
|
||||
* @param aOldAppVersion
|
||||
* The version of the application last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @param aOldPlatformVersion
|
||||
* The version of the platform last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @return a boolean indicating if a change requiring flushing the caches was
|
||||
* detected
|
||||
*/
|
||||
processFileChanges: function XPI_processFileChanges(aManifests,
|
||||
aUpdateCompatibility,
|
||||
aOldAppVersion,
|
||||
aOldPlatformVersion) {
|
||||
let visibleAddons = {};
|
||||
let oldBootstrappedAddons = this.bootstrappedAddons;
|
||||
this.bootstrappedAddons = {};
|
||||
|
||||
/**
|
||||
* Updates an add-on's metadata and determines if a restart of the
|
||||
* application is necessary. This is called when either the add-on's
|
||||
* install directory path or last modified time has changed.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @param aAddonState
|
||||
* The new state of the add-on
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
function updateMetadata(aInstallLocation, aOldAddon, aAddonState) {
|
||||
logger.debug("Add-on " + aOldAddon.id + " modified in " + aInstallLocation.name);
|
||||
|
||||
// Check if there is an updated install manifest for this add-on
|
||||
let newAddon = aManifests[aInstallLocation.name][aOldAddon.id];
|
||||
|
||||
try {
|
||||
// If not load it
|
||||
if (!newAddon) {
|
||||
let file = aInstallLocation.getLocationForID(aOldAddon.id);
|
||||
newAddon = syncLoadManifestFromFile(file);
|
||||
applyBlocklistChanges(aOldAddon, newAddon);
|
||||
|
||||
// Carry over any pendingUninstall state to add-ons modified directly
|
||||
// in the profile. This is important when the attempt to remove the
|
||||
// add-on in processPendingFileChanges failed and caused an mtime
|
||||
// change to the add-ons files.
|
||||
newAddon.pendingUninstall = aOldAddon.pendingUninstall;
|
||||
}
|
||||
|
||||
// The ID in the manifest that was loaded must match the ID of the old
|
||||
// add-on.
|
||||
if (newAddon.id != aOldAddon.id)
|
||||
throw new Error("Incorrect id in install manifest for existing add-on " + aOldAddon.id);
|
||||
}
|
||||
catch (e) {
|
||||
logger.warn("updateMetadata: Add-on " + aOldAddon.id + " is invalid", e);
|
||||
XPIDatabase.removeAddonMetadata(aOldAddon);
|
||||
XPIStates.removeAddon(aOldAddon.location, aOldAddon.id);
|
||||
if (!aInstallLocation.locked)
|
||||
aInstallLocation.uninstallAddon(aOldAddon.id);
|
||||
else
|
||||
logger.warn("Could not uninstall invalid item from locked install location");
|
||||
// If this was an active add-on then we must force a restart
|
||||
if (aOldAddon.active)
|
||||
return true;
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
// Set the additional properties on the new AddonInternal
|
||||
newAddon._installLocation = aInstallLocation;
|
||||
newAddon.updateDate = aAddonState.mtime;
|
||||
newAddon.visible = !(newAddon.id in visibleAddons);
|
||||
|
||||
// Update the database
|
||||
let newDBAddon = XPIDatabase.updateAddonMetadata(aOldAddon, newAddon,
|
||||
aAddonState.descriptor);
|
||||
if (newDBAddon.visible) {
|
||||
visibleAddons[newDBAddon.id] = newDBAddon;
|
||||
// Remember add-ons that were changed during startup
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_CHANGED,
|
||||
newDBAddon.id);
|
||||
if (aOldAddon.active == newDBAddon.disabled) {
|
||||
let change = aOldAddon.active ? AddonManager.STARTUP_CHANGE_DISABLED
|
||||
: AddonManager.STARTUP_CHANGE_ENABLED;
|
||||
AddonManagerPrivate.addStartupChange(change, newDBAddon.id);
|
||||
}
|
||||
|
||||
// If this was the active theme and it is now disabled then enable the
|
||||
// default theme
|
||||
if (aOldAddon.active && newDBAddon.disabled)
|
||||
XPIProvider.enableDefaultTheme();
|
||||
|
||||
// If the new add-on is bootstrapped and active then call its install method
|
||||
if (newDBAddon.active && newDBAddon.bootstrap) {
|
||||
// Startup cache must be flushed before calling the bootstrap script
|
||||
flushStartupCache();
|
||||
|
||||
let installReason = Services.vc.compare(aOldAddon.version, newDBAddon.version) < 0 ?
|
||||
BOOTSTRAP_REASONS.ADDON_UPGRADE :
|
||||
BOOTSTRAP_REASONS.ADDON_DOWNGRADE;
|
||||
|
||||
let file = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
|
||||
file.persistentDescriptor = aAddonState.descriptor;
|
||||
XPIProvider.callBootstrapMethod(newDBAddon, file, "install",
|
||||
installReason, { oldVersion: aOldAddon.version });
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates an add-on's descriptor for when the add-on has moved in the
|
||||
* filesystem but hasn't changed in any other way.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @param aAddonState
|
||||
* The new state of the add-on
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
function updateDescriptor(aInstallLocation, aOldAddon, aAddonState) {
|
||||
logger.debug("Add-on " + aOldAddon.id + " moved to " + aAddonState.descriptor);
|
||||
|
||||
aOldAddon.descriptor = aAddonState.descriptor;
|
||||
aOldAddon.visible = !(aOldAddon.id in visibleAddons);
|
||||
XPIDatabase.saveChanges();
|
||||
|
||||
if (aOldAddon.visible) {
|
||||
visibleAddons[aOldAddon.id] = aOldAddon;
|
||||
|
||||
if (aOldAddon.bootstrap && aOldAddon.active) {
|
||||
let bootstrap = oldBootstrappedAddons[aOldAddon.id];
|
||||
bootstrap.descriptor = aAddonState.descriptor;
|
||||
XPIProvider.bootstrappedAddons[aOldAddon.id] = bootstrap;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called when no change has been detected for an add-on's metadata. The
|
||||
* add-on may have become visible due to other add-ons being removed or
|
||||
* the add-on may need to be updated when the application version has
|
||||
* changed.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @param aAddonState
|
||||
* The new state of the add-on
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
function updateVisibilityAndCompatibility(aInstallLocation, aOldAddon,
|
||||
aAddonState) {
|
||||
let changed = false;
|
||||
|
||||
// This add-ons metadata has not changed but it may have become visible
|
||||
if (!(aOldAddon.id in visibleAddons)) {
|
||||
visibleAddons[aOldAddon.id] = aOldAddon;
|
||||
|
||||
if (!aOldAddon.visible) {
|
||||
// Remember add-ons that were changed during startup.
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_CHANGED,
|
||||
aOldAddon.id);
|
||||
XPIDatabase.makeAddonVisible(aOldAddon);
|
||||
|
||||
if (aOldAddon.bootstrap) {
|
||||
// The add-on is bootstrappable so call its install script
|
||||
let file = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
|
||||
file.persistentDescriptor = aAddonState.descriptor;
|
||||
XPIProvider.callBootstrapMethod(aOldAddon, file,
|
||||
"install",
|
||||
BOOTSTRAP_REASONS.ADDON_INSTALL);
|
||||
|
||||
// If it should be active then mark it as active otherwise unload
|
||||
// its scope
|
||||
if (!aOldAddon.disabled) {
|
||||
XPIDatabase.updateAddonActive(aOldAddon, true);
|
||||
}
|
||||
else {
|
||||
XPIProvider.unloadBootstrapScope(newAddon.id);
|
||||
}
|
||||
}
|
||||
else {
|
||||
// Otherwise a restart is necessary
|
||||
changed = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// App version changed, we may need to update the appDisabled property.
|
||||
if (aUpdateCompatibility) {
|
||||
let wasDisabled = aOldAddon.disabled;
|
||||
let wasAppDisabled = aOldAddon.appDisabled;
|
||||
let wasUserDisabled = aOldAddon.userDisabled;
|
||||
let wasSoftDisabled = aOldAddon.softDisabled;
|
||||
let updateDB = false;
|
||||
|
||||
// If updating from a version of the app that didn't support signedState
|
||||
// then fetch that property now
|
||||
if (aOldAddon.signedState === undefined && ADDON_SIGNING &&
|
||||
SIGNED_TYPES.has(aOldAddon.type)) {
|
||||
let file = aInstallLocation.getLocationForID(aOldAddon.id);
|
||||
let manifest = syncLoadManifestFromFile(file);
|
||||
aOldAddon.signedState = manifest.signedState;
|
||||
updateDB = true;
|
||||
}
|
||||
// This updates the addon's JSON cached data in place
|
||||
applyBlocklistChanges(aOldAddon, aOldAddon, aOldAppVersion,
|
||||
aOldPlatformVersion);
|
||||
aOldAddon.appDisabled = !isUsableAddon(aOldAddon);
|
||||
|
||||
let isDisabled = aOldAddon.disabled;
|
||||
|
||||
// If either property has changed update the database.
|
||||
if (updateDB || wasAppDisabled != aOldAddon.appDisabled ||
|
||||
wasUserDisabled != aOldAddon.userDisabled ||
|
||||
wasSoftDisabled != aOldAddon.softDisabled) {
|
||||
logger.debug("Add-on " + aOldAddon.id + " changed appDisabled state to " +
|
||||
aOldAddon.appDisabled + ", userDisabled state to " +
|
||||
aOldAddon.userDisabled + " and softDisabled state to " +
|
||||
aOldAddon.softDisabled);
|
||||
XPIDatabase.saveChanges();
|
||||
}
|
||||
|
||||
// If this is a visible add-on and it has changed disabled state then we
|
||||
// may need a restart or to update the bootstrap list.
|
||||
if (aOldAddon.visible && wasDisabled != isDisabled) {
|
||||
// Remember add-ons that became disabled or enabled by the application
|
||||
// change
|
||||
let change = isDisabled ? AddonManager.STARTUP_CHANGE_DISABLED
|
||||
: AddonManager.STARTUP_CHANGE_ENABLED;
|
||||
AddonManagerPrivate.addStartupChange(change, aOldAddon.id);
|
||||
if (aOldAddon.bootstrap) {
|
||||
// Update the add-ons active state
|
||||
XPIDatabase.updateAddonActive(aOldAddon, !isDisabled);
|
||||
}
|
||||
else {
|
||||
changed = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (aOldAddon.visible && aOldAddon.active && aOldAddon.bootstrap) {
|
||||
XPIProvider.bootstrappedAddons[aOldAddon.id] = {
|
||||
version: aOldAddon.version,
|
||||
type: aOldAddon.type,
|
||||
descriptor: aAddonState.descriptor,
|
||||
multiprocessCompatible: aOldAddon.multiprocessCompatible
|
||||
};
|
||||
}
|
||||
|
||||
return changed;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called when an add-on has been removed.
|
||||
*
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
function removeMetadata(aOldAddon) {
|
||||
// This add-on has disappeared
|
||||
logger.debug("Add-on " + aOldAddon.id + " removed from " + aOldAddon.location);
|
||||
XPIDatabase.removeAddonMetadata(aOldAddon);
|
||||
|
||||
// Remember add-ons that were uninstalled during startup
|
||||
if (aOldAddon.visible) {
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_UNINSTALLED,
|
||||
aOldAddon.id);
|
||||
}
|
||||
else if (AddonManager.getStartupChanges(AddonManager.STARTUP_CHANGE_INSTALLED)
|
||||
.indexOf(aOldAddon.id) != -1) {
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_CHANGED,
|
||||
aOldAddon.id);
|
||||
}
|
||||
|
||||
if (aOldAddon.active) {
|
||||
// Enable the default theme if the previously active theme has been
|
||||
// removed
|
||||
if (aOldAddon.type == "theme")
|
||||
XPIProvider.enableDefaultTheme();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to add the metadata for an add-on in one of the install locations
|
||||
* to the database. This can be called in three different cases. Either an
|
||||
* add-on has been dropped into the location from outside of Firefox, or
|
||||
* an add-on has been installed through the application, or the database
|
||||
* has been upgraded or become corrupt and add-on data has to be reloaded
|
||||
* into it.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aId
|
||||
* The ID of the add-on
|
||||
* @param aAddonState
|
||||
* The new state of the add-on
|
||||
* @param aMigrateData
|
||||
* If during startup the database had to be upgraded this will
|
||||
* contain data that used to be held about this add-on
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
function addMetadata(aInstallLocation, aId, aAddonState, aMigrateData) {
|
||||
logger.debug("New add-on " + aId + " installed in " + aInstallLocation.name);
|
||||
|
||||
let newAddon = null;
|
||||
let sameVersion = false;
|
||||
// Check the updated manifests lists for the install location, If there
|
||||
// is no manifest for the add-on ID then newAddon will be undefined
|
||||
if (aInstallLocation.name in aManifests)
|
||||
newAddon = aManifests[aInstallLocation.name][aId];
|
||||
|
||||
// If we had staged data for this add-on or we aren't recovering from a
|
||||
// corrupt database and we don't have migration data for this add-on then
|
||||
// this must be a new install.
|
||||
let isNewInstall = (!!newAddon) || (!XPIDatabase.activeBundles && !aMigrateData);
|
||||
|
||||
// If it's a new install and we haven't yet loaded the manifest then it
|
||||
// must be something dropped directly into the install location
|
||||
let isDetectedInstall = isNewInstall && !newAddon;
|
||||
|
||||
// Load the manifest if necessary and sanity check the add-on ID
|
||||
try {
|
||||
if (!newAddon) {
|
||||
// Load the manifest from the add-on.
|
||||
let file = aInstallLocation.getLocationForID(aId);
|
||||
newAddon = syncLoadManifestFromFile(file);
|
||||
}
|
||||
// The add-on in the manifest should match the add-on ID.
|
||||
if (newAddon.id != aId) {
|
||||
throw new Error("Invalid addon ID: expected addon ID " + aId +
|
||||
", found " + newAddon.id + " in manifest");
|
||||
}
|
||||
}
|
||||
catch (e) {
|
||||
logger.warn("addMetadata: Add-on " + aId + " is invalid", e);
|
||||
|
||||
// Remove the invalid add-on from the install location if the install
|
||||
// location isn't locked, no restart will be necessary
|
||||
if (!aInstallLocation.locked)
|
||||
aInstallLocation.uninstallAddon(aId);
|
||||
else
|
||||
logger.warn("Could not uninstall invalid item from locked install location");
|
||||
return false;
|
||||
}
|
||||
|
||||
// Update the AddonInternal properties.
|
||||
newAddon._installLocation = aInstallLocation;
|
||||
newAddon.visible = !(newAddon.id in visibleAddons);
|
||||
newAddon.installDate = aAddonState.mtime;
|
||||
newAddon.updateDate = aAddonState.mtime;
|
||||
newAddon.foreignInstall = isDetectedInstall;
|
||||
|
||||
// appDisabled depends on whether the add-on is a foreignInstall so update
|
||||
newAddon.appDisabled = !isUsableAddon(newAddon);
|
||||
|
||||
if (aMigrateData) {
|
||||
// If there is migration data then apply it.
|
||||
logger.debug("Migrating data from old database");
|
||||
|
||||
DB_MIGRATE_METADATA.forEach(function(aProp) {
|
||||
// A theme's disabled state is determined by the selected theme
|
||||
// preference which is read in loadManifestFromRDF
|
||||
if (aProp == "userDisabled" && newAddon.type == "theme")
|
||||
return;
|
||||
|
||||
if (aProp in aMigrateData)
|
||||
newAddon[aProp] = aMigrateData[aProp];
|
||||
});
|
||||
|
||||
// Force all non-profile add-ons to be foreignInstalls since they can't
|
||||
// have been installed through the API
|
||||
newAddon.foreignInstall |= aInstallLocation.name != KEY_APP_PROFILE;
|
||||
|
||||
// Some properties should only be migrated if the add-on hasn't changed.
|
||||
// The version property isn't a perfect check for this but covers the
|
||||
// vast majority of cases.
|
||||
if (aMigrateData.version == newAddon.version) {
|
||||
logger.debug("Migrating compatibility info");
|
||||
sameVersion = true;
|
||||
if ("targetApplications" in aMigrateData)
|
||||
newAddon.applyCompatibilityUpdate(aMigrateData, true);
|
||||
}
|
||||
|
||||
// Since the DB schema has changed make sure softDisabled is correct
|
||||
applyBlocklistChanges(newAddon, newAddon, aOldAppVersion,
|
||||
aOldPlatformVersion);
|
||||
}
|
||||
|
||||
// The default theme is never a foreign install
|
||||
if (newAddon.type == "theme" && newAddon.internalName == XPIProvider.defaultSkin)
|
||||
newAddon.foreignInstall = false;
|
||||
|
||||
if (isDetectedInstall && newAddon.foreignInstall) {
|
||||
// If the add-on is a foreign install and is in a scope where add-ons
|
||||
// that were dropped in should default to disabled then disable it
|
||||
let disablingScopes = Preferences.get(PREF_EM_AUTO_DISABLED_SCOPES, 0);
|
||||
if (aInstallLocation.scope & disablingScopes) {
|
||||
logger.warn("Disabling foreign installed add-on " + newAddon.id + " in "
|
||||
+ aInstallLocation.name);
|
||||
newAddon.userDisabled = true;
|
||||
}
|
||||
}
|
||||
|
||||
// If we have a list of what add-ons should be marked as active then use
|
||||
// it to guess at migration data.
|
||||
if (!isNewInstall && XPIDatabase.activeBundles) {
|
||||
// For themes we know which is active by the current skin setting
|
||||
if (newAddon.type == "theme")
|
||||
newAddon.active = newAddon.internalName == XPIProvider.currentSkin;
|
||||
else
|
||||
newAddon.active = XPIDatabase.activeBundles.indexOf(aAddonState.descriptor) != -1;
|
||||
|
||||
// If the add-on wasn't active and it isn't already disabled in some way
|
||||
// then it was probably either softDisabled or userDisabled
|
||||
if (!newAddon.active && newAddon.visible && !newAddon.disabled) {
|
||||
// If the add-on is softblocked then assume it is softDisabled
|
||||
if (newAddon.blocklistState == Blocklist.STATE_SOFTBLOCKED)
|
||||
newAddon.softDisabled = true;
|
||||
else
|
||||
newAddon.userDisabled = true;
|
||||
}
|
||||
}
|
||||
else {
|
||||
newAddon.active = (newAddon.visible && !newAddon.disabled);
|
||||
}
|
||||
|
||||
let newDBAddon = XPIDatabase.addAddonMetadata(newAddon, aAddonState.descriptor);
|
||||
|
||||
if (newDBAddon.visible) {
|
||||
// Remember add-ons that were first detected during startup.
|
||||
if (isDetectedInstall) {
|
||||
// If a copy from a higher priority location was removed then this
|
||||
// add-on has changed
|
||||
if (AddonManager.getStartupChanges(AddonManager.STARTUP_CHANGE_UNINSTALLED)
|
||||
.indexOf(newDBAddon.id) != -1) {
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_CHANGED,
|
||||
newDBAddon.id);
|
||||
}
|
||||
else {
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_INSTALLED,
|
||||
newDBAddon.id);
|
||||
}
|
||||
}
|
||||
|
||||
// Note if any visible add-on is not in the application install location
|
||||
if (newDBAddon._installLocation.name != KEY_APP_GLOBAL)
|
||||
XPIProvider.allAppGlobal = false;
|
||||
|
||||
visibleAddons[newDBAddon.id] = newDBAddon;
|
||||
|
||||
let installReason = BOOTSTRAP_REASONS.ADDON_INSTALL;
|
||||
let extraParams = {};
|
||||
|
||||
// Copy add-on details (enabled, bootstrap, version, etc) to XPIState.
|
||||
aAddonState.syncWithDB(newDBAddon);
|
||||
|
||||
// If we're hiding a bootstrapped add-on then call its uninstall method
|
||||
if (newDBAddon.id in oldBootstrappedAddons) {
|
||||
let oldBootstrap = oldBootstrappedAddons[newDBAddon.id];
|
||||
extraParams.oldVersion = oldBootstrap.version;
|
||||
XPIProvider.bootstrappedAddons[newDBAddon.id] = oldBootstrap;
|
||||
|
||||
// If the old version is the same as the new version, or we're
|
||||
// recovering from a corrupt DB, don't call uninstall and install
|
||||
// methods.
|
||||
if (sameVersion || !isNewInstall) {
|
||||
logger.debug("addMetadata: early return, sameVersion " + sameVersion
|
||||
+ ", isNewInstall " + isNewInstall);
|
||||
return false;
|
||||
}
|
||||
|
||||
installReason = Services.vc.compare(oldBootstrap.version, newDBAddon.version) < 0 ?
|
||||
BOOTSTRAP_REASONS.ADDON_UPGRADE :
|
||||
BOOTSTRAP_REASONS.ADDON_DOWNGRADE;
|
||||
|
||||
let oldAddonFile = Cc["@mozilla.org/file/local;1"].
|
||||
createInstance(Ci.nsIFile);
|
||||
oldAddonFile.persistentDescriptor = oldBootstrap.descriptor;
|
||||
|
||||
XPIProvider.callBootstrapMethod(createAddonDetails(newDBAddon.id, oldBootstrap),
|
||||
oldAddonFile, "uninstall", installReason,
|
||||
{ newVersion: newDBAddon.version });
|
||||
|
||||
XPIProvider.unloadBootstrapScope(newDBAddon.id);
|
||||
|
||||
// If the new add-on is bootstrapped then we must flush the caches
|
||||
// before calling the new bootstrap script
|
||||
if (newDBAddon.bootstrap)
|
||||
flushStartupCache();
|
||||
}
|
||||
|
||||
if (!newDBAddon.bootstrap)
|
||||
return true;
|
||||
|
||||
// Visible bootstrapped add-ons need to have their install method called
|
||||
let file = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
|
||||
file.persistentDescriptor = aAddonState.descriptor;
|
||||
XPIProvider.callBootstrapMethod(newDBAddon, file,
|
||||
"install", installReason, extraParams);
|
||||
if (!newDBAddon.active)
|
||||
XPIProvider.unloadBootstrapScope(newDBAddon.id);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
let changed = false;
|
||||
|
||||
// Get all the add-ons in the existing DB and Map them into Sets by install location
|
||||
let allDBAddons = new Map();
|
||||
for (let a of XPIDatabase.getAddons()) {
|
||||
let locationSet = allDBAddons.get(a.location);
|
||||
if (!locationSet) {
|
||||
locationSet = new Set();
|
||||
allDBAddons.set(a.location, locationSet);
|
||||
}
|
||||
locationSet.add(a);
|
||||
}
|
||||
|
||||
for (let installLocation of this.installLocations) {
|
||||
// Get all the on-disk XPI states for this location, and keep track of which
|
||||
// ones we see in the database.
|
||||
let states = XPIStates.getLocation(installLocation.name);
|
||||
let seen = new Set();
|
||||
// Iterate through the add-ons installed the last time the application
|
||||
// ran
|
||||
let dbAddons = allDBAddons.get(installLocation.name);
|
||||
if (dbAddons) {
|
||||
// we've processed this location
|
||||
allDBAddons.delete(installLocation.name);
|
||||
|
||||
logger.debug("processFileChanges reconciling DB for location ${l} state ${s} db ${d}",
|
||||
{l: installLocation.name, s: states, d: [for (a of dbAddons) a.id]});
|
||||
for (let aOldAddon of dbAddons) {
|
||||
// If a version of this add-on has been installed in an higher
|
||||
// priority install location then count it as changed
|
||||
if (AddonManager.getStartupChanges(AddonManager.STARTUP_CHANGE_INSTALLED)
|
||||
.indexOf(aOldAddon.id) != -1) {
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_CHANGED,
|
||||
aOldAddon.id);
|
||||
}
|
||||
|
||||
// Check if the add-on is still installed
|
||||
let xpiState = states && states.get(aOldAddon.id);
|
||||
if (xpiState) {
|
||||
// in this block, the add-on is in both XPIStates and the DB
|
||||
seen.add(xpiState);
|
||||
|
||||
recordAddonTelemetry(aOldAddon);
|
||||
|
||||
// Check if the add-on has been changed outside the XPI provider
|
||||
if (aOldAddon.updateDate != xpiState.mtime) {
|
||||
// Did time change in the wrong direction?
|
||||
if (xpiState.mtime < aOldAddon.updateDate) {
|
||||
this.setTelemetry(aOldAddon.id, "olderFile", {
|
||||
name: this._mostRecentlyModifiedFile[aOldAddon.id],
|
||||
mtime: xpiState.mtime,
|
||||
oldtime: aOldAddon.updateDate
|
||||
});
|
||||
} else {
|
||||
this.setTelemetry(aOldAddon.id, "modifiedFile",
|
||||
this._mostRecentlyModifiedFile[aOldAddon.id]);
|
||||
}
|
||||
}
|
||||
|
||||
// The add-on has changed if the modification time has changed, or
|
||||
// we have an updated manifest for it. Also reload the metadata for
|
||||
// add-ons in the application directory when the application version
|
||||
// has changed
|
||||
if (aOldAddon.id in aManifests[installLocation.name] ||
|
||||
aOldAddon.updateDate != xpiState.mtime ||
|
||||
(aUpdateCompatibility && installLocation.name == KEY_APP_GLOBAL)) {
|
||||
changed = updateMetadata(installLocation, aOldAddon, xpiState) ||
|
||||
changed;
|
||||
}
|
||||
else if (aOldAddon.descriptor != xpiState.descriptor) {
|
||||
changed = updateDescriptor(installLocation, aOldAddon, xpiState) ||
|
||||
changed;
|
||||
}
|
||||
else {
|
||||
changed = updateVisibilityAndCompatibility(installLocation,
|
||||
aOldAddon, xpiState) ||
|
||||
changed;
|
||||
}
|
||||
if (aOldAddon.visible && aOldAddon._installLocation.name != KEY_APP_GLOBAL)
|
||||
XPIProvider.allAppGlobal = false;
|
||||
// Copy add-on details (enabled, bootstrap, version, etc) to XPIState.
|
||||
xpiState.syncWithDB(aOldAddon);
|
||||
}
|
||||
else {
|
||||
// The add-on is in the DB, but not in xpiState (and thus not on disk).
|
||||
changed = removeMetadata(aOldAddon) || changed;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Any add-on in our current location that we haven't seen needs to
|
||||
// be added to the database.
|
||||
// Get the migration data for this install location so we can include that as
|
||||
// we add, in case this is a database upgrade or rebuild.
|
||||
let locMigrateData = {};
|
||||
if (XPIDatabase.migrateData && installLocation.name in XPIDatabase.migrateData)
|
||||
locMigrateData = XPIDatabase.migrateData[installLocation.name];
|
||||
if (states) {
|
||||
for (let [id, xpiState] of states) {
|
||||
if (!seen.has(xpiState)) {
|
||||
changed = addMetadata(installLocation, id, xpiState,
|
||||
(locMigrateData[id] || null)) || changed;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Anything left in allDBAddons is a location where the database contains add-ons,
|
||||
// but the browser is no longer configured to use that location. The metadata for those
|
||||
// add-ons must be removed from the database.
|
||||
for (let [locationName, addons] of allDBAddons) {
|
||||
logger.debug("Removing orphaned DB add-on entries from " + locationName);
|
||||
for (let a of addons) {
|
||||
logger.debug("Remove ${location}:${id}", a);
|
||||
changed = removeMetadata(a) || changed;
|
||||
}
|
||||
}
|
||||
|
||||
XPIStates.save();
|
||||
this.persistBootstrappedAddons();
|
||||
|
||||
// Clear out any cached migration data.
|
||||
XPIDatabase.migrateData = null;
|
||||
|
||||
return changed;
|
||||
},
|
||||
|
||||
/**
|
||||
* Imports the xpinstall permissions from preferences into the permissions
|
||||
* manager for the user to change later.
|
||||
@ -3931,10 +3260,10 @@ this.XPIProvider = {
|
||||
AddonManagerPrivate.recordSimpleMeasure("XPIDB_startup_load_reasons", updateReasons);
|
||||
XPIDatabase.syncLoadDB(false);
|
||||
try {
|
||||
extensionListChanged = this.processFileChanges(manifests,
|
||||
aAppChanged,
|
||||
aOldAppVersion,
|
||||
aOldPlatformVersion);
|
||||
extensionListChanged = XPIDatabaseReconcile.processFileChanges(manifests,
|
||||
aAppChanged,
|
||||
aOldAppVersion,
|
||||
aOldPlatformVersion);
|
||||
}
|
||||
catch (e) {
|
||||
logger.error("Failed to process extension changes at startup", e);
|
||||
|
||||
@ -12,6 +12,7 @@ const Cu = Components.utils;
|
||||
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
||||
Cu.import("resource://gre/modules/Services.jsm");
|
||||
Cu.import("resource://gre/modules/AddonManager.jsm");
|
||||
Cu.import("resource://gre/modules/Preferences.jsm");
|
||||
|
||||
XPCOMUtils.defineLazyModuleGetter(this, "AddonRepository",
|
||||
"resource://gre/modules/addons/AddonRepository.jsm");
|
||||
@ -23,6 +24,9 @@ XPCOMUtils.defineLazyModuleGetter(this, "Promise",
|
||||
"resource://gre/modules/Promise.jsm");
|
||||
XPCOMUtils.defineLazyModuleGetter(this, "OS",
|
||||
"resource://gre/modules/osfile.jsm");
|
||||
XPCOMUtils.defineLazyServiceGetter(this, "Blocklist",
|
||||
"@mozilla.org/extensions/blocklist;1",
|
||||
Ci.nsIBlocklistService);
|
||||
|
||||
Cu.import("resource://gre/modules/Log.jsm");
|
||||
const LOGGER_ID = "addons.xpi-utils";
|
||||
@ -46,6 +50,10 @@ const PREF_DB_SCHEMA = "extensions.databaseSchema";
|
||||
const PREF_PENDING_OPERATIONS = "extensions.pendingOperations";
|
||||
const PREF_EM_ENABLED_ADDONS = "extensions.enabledAddons";
|
||||
const PREF_EM_DSS_ENABLED = "extensions.dss.enabled";
|
||||
const PREF_EM_AUTO_DISABLED_SCOPES = "extensions.autoDisableScopes";
|
||||
|
||||
const KEY_APP_PROFILE = "app-profile";
|
||||
const KEY_APP_GLOBAL = "app-global";
|
||||
|
||||
// Properties that only exist in the database
|
||||
const DB_METADATA = ["syncGUID",
|
||||
@ -72,6 +80,13 @@ const PROP_JSON_FIELDS = ["id", "syncGUID", "location", "version", "type",
|
||||
"strictCompatibility", "locales", "targetApplications",
|
||||
"targetPlatforms", "multiprocessCompatible", "signedState"];
|
||||
|
||||
// Properties that should be migrated where possible from an old database. These
|
||||
// shouldn't include properties that can be read directly from install.rdf files
|
||||
// or calculated
|
||||
const DB_MIGRATE_METADATA= ["installDate", "userDisabled", "softDisabled",
|
||||
"sourceURI", "applyBackgroundUpdates",
|
||||
"releaseNotesURI", "foreignInstall", "syncGUID"];
|
||||
|
||||
// Time to wait before async save of XPI JSON database, in milliseconds
|
||||
const ASYNC_SAVE_DELAY_MS = 20;
|
||||
|
||||
@ -785,7 +800,7 @@ this.XPIDatabase = {
|
||||
if (aRebuildOnError) {
|
||||
logger.warn("Rebuilding add-ons database from installed extensions.");
|
||||
try {
|
||||
XPIProvider.processFileChanges({}, false);
|
||||
XPIDatabaseReconcile.processFileChanges({}, false);
|
||||
}
|
||||
catch (e) {
|
||||
logger.error("Failed to rebuild XPI database from installed extensions", e);
|
||||
@ -1084,7 +1099,7 @@ this.XPIDatabase = {
|
||||
})
|
||||
.then(null,
|
||||
error => {
|
||||
logger.error("getAddon failed", e);
|
||||
logger.error("getAddon failed", error);
|
||||
makeSafe(aCallback)(null);
|
||||
});
|
||||
},
|
||||
@ -1301,6 +1316,7 @@ this.XPIDatabase = {
|
||||
if ((otherAddon.id == aAddon.id) && (otherAddon._key != aAddon._key)) {
|
||||
logger.debug("Hide addon " + otherAddon._key);
|
||||
otherAddon.visible = false;
|
||||
otherAddon.active = false;
|
||||
}
|
||||
}
|
||||
aAddon.visible = true;
|
||||
@ -1488,3 +1504,599 @@ this.XPIDatabase = {
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
this.XPIDatabaseReconcile = {
|
||||
/**
|
||||
* Returns a map of ID -> add-on. When the same add-on ID exists in multiple
|
||||
* install locations the highest priority location is chosen.
|
||||
*/
|
||||
flattenByID(addonMap) {
|
||||
let map = new Map();
|
||||
|
||||
for (let installLocation of XPIProvider.installLocations) {
|
||||
let locationMap = addonMap.get(installLocation.name);
|
||||
if (!locationMap)
|
||||
continue;
|
||||
|
||||
for (let [id, addon] of locationMap) {
|
||||
if (!map.has(id))
|
||||
map.set(id, addon);
|
||||
}
|
||||
}
|
||||
|
||||
return map;
|
||||
},
|
||||
|
||||
/**
|
||||
* Finds the visible add-ons from the map.
|
||||
*/
|
||||
getVisibleAddons(addonMap) {
|
||||
let map = new Map();
|
||||
|
||||
for (let [location, addons] of addonMap) {
|
||||
for (let [id, addon] of addons) {
|
||||
if (!addon.visible)
|
||||
continue;
|
||||
|
||||
if (map.has(id)) {
|
||||
logger.warn("Previous database listed more than one visible add-on with id " + id);
|
||||
continue;
|
||||
}
|
||||
|
||||
map.set(id, addon);
|
||||
}
|
||||
}
|
||||
|
||||
return map;
|
||||
},
|
||||
|
||||
/**
|
||||
* Called to add the metadata for an add-on in one of the install locations
|
||||
* to the database. This can be called in three different cases. Either an
|
||||
* add-on has been dropped into the location from outside of Firefox, or
|
||||
* an add-on has been installed through the application, or the database
|
||||
* has been upgraded or become corrupt and add-on data has to be reloaded
|
||||
* into it.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aId
|
||||
* The ID of the add-on
|
||||
* @param aAddonState
|
||||
* The new state of the add-on
|
||||
* @param aNewAddon
|
||||
* The manifest for the new add-on if it has already been loaded
|
||||
* @param aOldAppVersion
|
||||
* The version of the application last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @param aOldPlatformVersion
|
||||
* The version of the platform last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @param aMigrateData
|
||||
* If during startup the database had to be upgraded this will
|
||||
* contain data that used to be held about this add-on
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
addMetadata(aInstallLocation, aId, aAddonState, aNewAddon, aOldAppVersion,
|
||||
aOldPlatformVersion, aMigrateData) {
|
||||
logger.debug("New add-on " + aId + " installed in " + aInstallLocation.name);
|
||||
|
||||
// If we had staged data for this add-on or we aren't recovering from a
|
||||
// corrupt database and we don't have migration data for this add-on then
|
||||
// this must be a new install.
|
||||
let isNewInstall = (!!aNewAddon) || (!XPIDatabase.activeBundles && !aMigrateData);
|
||||
|
||||
// If it's a new install and we haven't yet loaded the manifest then it
|
||||
// must be something dropped directly into the install location
|
||||
let isDetectedInstall = isNewInstall && !aNewAddon;
|
||||
|
||||
// Load the manifest if necessary and sanity check the add-on ID
|
||||
try {
|
||||
if (!aNewAddon) {
|
||||
// Load the manifest from the add-on.
|
||||
let file = aInstallLocation.getLocationForID(aId);
|
||||
aNewAddon = syncLoadManifestFromFile(file);
|
||||
}
|
||||
// The add-on in the manifest should match the add-on ID.
|
||||
if (aNewAddon.id != aId) {
|
||||
throw new Error("Invalid addon ID: expected addon ID " + aId +
|
||||
", found " + aNewAddon.id + " in manifest");
|
||||
}
|
||||
}
|
||||
catch (e) {
|
||||
logger.warn("addMetadata: Add-on " + aId + " is invalid", e);
|
||||
|
||||
// Remove the invalid add-on from the install location if the install
|
||||
// location isn't locked, no restart will be necessary
|
||||
if (!aInstallLocation.locked)
|
||||
aInstallLocation.uninstallAddon(aId);
|
||||
else
|
||||
logger.warn("Could not uninstall invalid item from locked install location");
|
||||
return null;
|
||||
}
|
||||
|
||||
// Update the AddonInternal properties.
|
||||
aNewAddon._installLocation = aInstallLocation;
|
||||
aNewAddon.installDate = aAddonState.mtime;
|
||||
aNewAddon.updateDate = aAddonState.mtime;
|
||||
aNewAddon.foreignInstall = isDetectedInstall;
|
||||
|
||||
// appDisabled depends on whether the add-on is a foreignInstall so update
|
||||
aNewAddon.appDisabled = !isUsableAddon(aNewAddon);
|
||||
|
||||
if (aMigrateData) {
|
||||
// If there is migration data then apply it.
|
||||
logger.debug("Migrating data from old database");
|
||||
|
||||
DB_MIGRATE_METADATA.forEach(function(aProp) {
|
||||
// A theme's disabled state is determined by the selected theme
|
||||
// preference which is read in loadManifestFromRDF
|
||||
if (aProp == "userDisabled" && aNewAddon.type == "theme")
|
||||
return;
|
||||
|
||||
if (aProp in aMigrateData)
|
||||
aNewAddon[aProp] = aMigrateData[aProp];
|
||||
});
|
||||
|
||||
// Force all non-profile add-ons to be foreignInstalls since they can't
|
||||
// have been installed through the API
|
||||
aNewAddon.foreignInstall |= aInstallLocation.name != KEY_APP_PROFILE;
|
||||
|
||||
// Some properties should only be migrated if the add-on hasn't changed.
|
||||
// The version property isn't a perfect check for this but covers the
|
||||
// vast majority of cases.
|
||||
if (aMigrateData.version == aNewAddon.version) {
|
||||
logger.debug("Migrating compatibility info");
|
||||
if ("targetApplications" in aMigrateData)
|
||||
aNewAddon.applyCompatibilityUpdate(aMigrateData, true);
|
||||
}
|
||||
|
||||
// Since the DB schema has changed make sure softDisabled is correct
|
||||
applyBlocklistChanges(aNewAddon, aNewAddon, aOldAppVersion,
|
||||
aOldPlatformVersion);
|
||||
}
|
||||
|
||||
// The default theme is never a foreign install
|
||||
if (aNewAddon.type == "theme" && aNewAddon.internalName == XPIProvider.defaultSkin)
|
||||
aNewAddon.foreignInstall = false;
|
||||
|
||||
if (isDetectedInstall && aNewAddon.foreignInstall) {
|
||||
// If the add-on is a foreign install and is in a scope where add-ons
|
||||
// that were dropped in should default to disabled then disable it
|
||||
let disablingScopes = Preferences.get(PREF_EM_AUTO_DISABLED_SCOPES, 0);
|
||||
if (aInstallLocation.scope & disablingScopes) {
|
||||
logger.warn("Disabling foreign installed add-on " + aNewAddon.id + " in "
|
||||
+ aInstallLocation.name);
|
||||
aNewAddon.userDisabled = true;
|
||||
}
|
||||
}
|
||||
|
||||
return XPIDatabase.addAddonMetadata(aNewAddon, aAddonState.descriptor);
|
||||
},
|
||||
|
||||
/**
|
||||
* Called when an add-on has been removed.
|
||||
*
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
removeMetadata(aOldAddon) {
|
||||
// This add-on has disappeared
|
||||
logger.debug("Add-on " + aOldAddon.id + " removed from " + aOldAddon.location);
|
||||
XPIDatabase.removeAddonMetadata(aOldAddon);
|
||||
},
|
||||
|
||||
/**
|
||||
* Updates an add-on's metadata and determines if a restart of the
|
||||
* application is necessary. This is called when either the add-on's
|
||||
* install directory path or last modified time has changed.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @param aAddonState
|
||||
* The new state of the add-on
|
||||
* @param aNewAddon
|
||||
* The manifest for the new add-on if it has already been loaded
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
updateMetadata(aInstallLocation, aOldAddon, aAddonState, aNewAddon) {
|
||||
logger.debug("Add-on " + aOldAddon.id + " modified in " + aInstallLocation.name);
|
||||
|
||||
try {
|
||||
// If there isn't an updated install manifest for this add-on then load it.
|
||||
if (!aNewAddon) {
|
||||
let file = aInstallLocation.getLocationForID(aOldAddon.id);
|
||||
aNewAddon = syncLoadManifestFromFile(file);
|
||||
applyBlocklistChanges(aOldAddon, aNewAddon);
|
||||
|
||||
// Carry over any pendingUninstall state to add-ons modified directly
|
||||
// in the profile. This is important when the attempt to remove the
|
||||
// add-on in processPendingFileChanges failed and caused an mtime
|
||||
// change to the add-ons files.
|
||||
aNewAddon.pendingUninstall = aOldAddon.pendingUninstall;
|
||||
}
|
||||
|
||||
// The ID in the manifest that was loaded must match the ID of the old
|
||||
// add-on.
|
||||
if (aNewAddon.id != aOldAddon.id)
|
||||
throw new Error("Incorrect id in install manifest for existing add-on " + aOldAddon.id);
|
||||
}
|
||||
catch (e) {
|
||||
logger.warn("updateMetadata: Add-on " + aOldAddon.id + " is invalid", e);
|
||||
XPIDatabase.removeAddonMetadata(aOldAddon);
|
||||
XPIStates.removeAddon(aOldAddon.location, aOldAddon.id);
|
||||
if (!aInstallLocation.locked)
|
||||
aInstallLocation.uninstallAddon(aOldAddon.id);
|
||||
else
|
||||
logger.warn("Could not uninstall invalid item from locked install location");
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
// Set the additional properties on the new AddonInternal
|
||||
aNewAddon._installLocation = aInstallLocation;
|
||||
aNewAddon.updateDate = aAddonState.mtime;
|
||||
|
||||
// Update the database
|
||||
return XPIDatabase.updateAddonMetadata(aOldAddon, aNewAddon, aAddonState.descriptor);
|
||||
},
|
||||
|
||||
/**
|
||||
* Updates an add-on's descriptor for when the add-on has moved in the
|
||||
* filesystem but hasn't changed in any other way.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @param aAddonState
|
||||
* The new state of the add-on
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
updateDescriptor(aInstallLocation, aOldAddon, aAddonState) {
|
||||
logger.debug("Add-on " + aOldAddon.id + " moved to " + aAddonState.descriptor);
|
||||
aOldAddon.descriptor = aAddonState.descriptor;
|
||||
|
||||
return aOldAddon;
|
||||
},
|
||||
|
||||
/**
|
||||
* Called when no change has been detected for an add-on's metadata but the
|
||||
* application has changed so compatibility may have changed.
|
||||
*
|
||||
* @param aInstallLocation
|
||||
* The install location containing the add-on
|
||||
* @param aOldAddon
|
||||
* The AddonInternal as it appeared the last time the application
|
||||
* ran
|
||||
* @param aOldAppVersion
|
||||
* The version of the application last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @param aOldPlatformVersion
|
||||
* The version of the platform last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @return a boolean indicating if flushing caches is required to complete
|
||||
* changing this add-on
|
||||
*/
|
||||
updateCompatibility(aInstallLocation, aOldAddon, aOldAppVersion, aOldPlatformVersion) {
|
||||
logger.debug("Updating compatibility for add-on " + aOldAddon.id + " in " + aInstallLocation.name);
|
||||
|
||||
// If updating from a version of the app that didn't support signedState
|
||||
// then fetch that property now
|
||||
if (aOldAddon.signedState === undefined && ADDON_SIGNING &&
|
||||
SIGNED_TYPES.has(aOldAddon.type)) {
|
||||
let file = aInstallLocation.getLocationForID(aOldAddon.id);
|
||||
let manifest = syncLoadManifestFromFile(file);
|
||||
aOldAddon.signedState = manifest.signedState;
|
||||
}
|
||||
// This updates the addon's JSON cached data in place
|
||||
applyBlocklistChanges(aOldAddon, aOldAddon, aOldAppVersion,
|
||||
aOldPlatformVersion);
|
||||
aOldAddon.appDisabled = !isUsableAddon(aOldAddon);
|
||||
|
||||
return aOldAddon;
|
||||
},
|
||||
|
||||
/**
|
||||
* Compares the add-ons that are currently installed to those that were
|
||||
* known to be installed when the application last ran and applies any
|
||||
* changes found to the database. Also sends "startupcache-invalidate" signal to
|
||||
* observerservice if it detects that data may have changed.
|
||||
* Always called after XPIProviderUtils.js and extensions.json have been loaded.
|
||||
*
|
||||
* @param aManifests
|
||||
* A dictionary of cached AddonInstalls for add-ons that have been
|
||||
* installed
|
||||
* @param aUpdateCompatibility
|
||||
* true to update add-ons appDisabled property when the application
|
||||
* version has changed
|
||||
* @param aOldAppVersion
|
||||
* The version of the application last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @param aOldPlatformVersion
|
||||
* The version of the platform last run with this profile or null
|
||||
* if it is a new profile or the version is unknown
|
||||
* @return a boolean indicating if a change requiring flushing the caches was
|
||||
* detected
|
||||
*/
|
||||
processFileChanges(aManifests, aUpdateCompatibility, aOldAppVersion, aOldPlatformVersion) {
|
||||
let loadedManifest = (aInstallLocation, aId) => {
|
||||
if (!(aInstallLocation.name in aManifests))
|
||||
return null;
|
||||
if (!(aId in aManifests[aInstallLocation.name]))
|
||||
return null;
|
||||
return aManifests[aInstallLocation.name][aId];
|
||||
};
|
||||
|
||||
// Get the previous add-ons from the database and put them into maps by location
|
||||
let previousAddons = new Map();
|
||||
for (let a of XPIDatabase.getAddons()) {
|
||||
let locationAddonMap = previousAddons.get(a.location);
|
||||
if (!locationAddonMap) {
|
||||
locationAddonMap = new Map();
|
||||
previousAddons.set(a.location, locationAddonMap);
|
||||
}
|
||||
locationAddonMap.set(a.id, a);
|
||||
}
|
||||
|
||||
// Build the list of current add-ons into similar maps. When add-ons are still
|
||||
// present we re-use the add-on objects from the database and update their
|
||||
// details directly
|
||||
let currentAddons = new Map();
|
||||
for (let installLocation of XPIProvider.installLocations) {
|
||||
let locationAddonMap = new Map();
|
||||
currentAddons.set(installLocation.name, locationAddonMap);
|
||||
|
||||
// Get all the on-disk XPI states for this location, and keep track of which
|
||||
// ones we see in the database.
|
||||
let states = XPIStates.getLocation(installLocation.name);
|
||||
|
||||
// Iterate through the add-ons installed the last time the application
|
||||
// ran
|
||||
let dbAddons = previousAddons.get(installLocation.name);
|
||||
if (dbAddons) {
|
||||
for (let [id, oldAddon] of dbAddons) {
|
||||
// Check if the add-on is still installed
|
||||
let xpiState = states && states.get(id);
|
||||
if (xpiState) {
|
||||
// Here the add-on was present in the database and on disk
|
||||
recordAddonTelemetry(oldAddon);
|
||||
|
||||
// Check if the add-on has been changed outside the XPI provider
|
||||
if (oldAddon.updateDate != xpiState.mtime) {
|
||||
// Did time change in the wrong direction?
|
||||
if (xpiState.mtime < oldAddon.updateDate) {
|
||||
XPIProvider.setTelemetry(oldAddon.id, "olderFile", {
|
||||
name: XPIProvider._mostRecentlyModifiedFile[id],
|
||||
mtime: xpiState.mtime,
|
||||
oldtime: oldAddon.updateDate
|
||||
});
|
||||
} else {
|
||||
XPIProvider.setTelemetry(oldAddon.id, "modifiedFile",
|
||||
XPIProvider._mostRecentlyModifiedFile[id]);
|
||||
}
|
||||
}
|
||||
|
||||
// The add-on has changed if the modification time has changed, or
|
||||
// we have an updated manifest for it. Also reload the metadata for
|
||||
// add-ons in the application directory when the application version
|
||||
// has changed
|
||||
let newAddon = loadedManifest(installLocation, id);
|
||||
if (newAddon || oldAddon.updateDate != xpiState.mtime ||
|
||||
(aUpdateCompatibility && installLocation.name == KEY_APP_GLOBAL)) {
|
||||
newAddon = this.updateMetadata(installLocation, oldAddon, xpiState, newAddon);
|
||||
}
|
||||
else if (oldAddon.descriptor != xpiState.descriptor) {
|
||||
newAddon = this.updateDescriptor(installLocation, oldAddon, xpiState);
|
||||
}
|
||||
else if (aUpdateCompatibility) {
|
||||
newAddon = this.updateCompatibility(installLocation, oldAddon, aOldAppVersion, aOldPlatformVersion);
|
||||
}
|
||||
else {
|
||||
// No change
|
||||
newAddon = oldAddon;
|
||||
}
|
||||
|
||||
if (newAddon)
|
||||
locationAddonMap.set(newAddon.id, newAddon);
|
||||
}
|
||||
else {
|
||||
// The add-on is in the DB, but not in xpiState (and thus not on disk).
|
||||
this.removeMetadata(oldAddon);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Any add-on in our current location that we haven't seen needs to
|
||||
// be added to the database.
|
||||
// Get the migration data for this install location so we can include that as
|
||||
// we add, in case this is a database upgrade or rebuild.
|
||||
let locMigrateData = {};
|
||||
if (XPIDatabase.migrateData && installLocation.name in XPIDatabase.migrateData)
|
||||
locMigrateData = XPIDatabase.migrateData[installLocation.name];
|
||||
|
||||
if (states) {
|
||||
for (let [id, xpiState] of states) {
|
||||
if (locationAddonMap.has(id))
|
||||
continue;
|
||||
let migrateData = id in locMigrateData ? locMigrateData[id] : null;
|
||||
let newAddon = loadedManifest(installLocation, id);
|
||||
let addon = this.addMetadata(installLocation, id, xpiState, newAddon,
|
||||
aOldAppVersion, aOldPlatformVersion, migrateData);
|
||||
if (addon)
|
||||
locationAddonMap.set(addon.id, addon);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// previousAddons may contain locations where the database contains add-ons
|
||||
// but the browser is no longer configured to use that location. The metadata
|
||||
// for those add-ons must be removed from the database.
|
||||
for (let [locationName, addons] of previousAddons) {
|
||||
if (!currentAddons.has(locationName)) {
|
||||
for (let [id, oldAddon] of addons)
|
||||
this.removeMetadata(oldAddon);
|
||||
}
|
||||
}
|
||||
|
||||
let previousVisible = this.getVisibleAddons(previousAddons);
|
||||
let currentVisible = this.flattenByID(currentAddons);
|
||||
let sawActiveTheme = false;
|
||||
XPIProvider.bootstrappedAddons = {};
|
||||
|
||||
// Pass over the new set of visible add-ons, record any changes that occured
|
||||
// during startup and call bootstrap install/uninstall scripts as necessary
|
||||
for (let [id, currentAddon] of currentVisible) {
|
||||
let previousAddon = previousVisible.get(id);
|
||||
|
||||
// Note if any visible add-on is not in the application install location
|
||||
if (currentAddon._installLocation.name != KEY_APP_GLOBAL)
|
||||
XPIProvider.allAppGlobal = false;
|
||||
|
||||
let isActive = !currentAddon.disabled;
|
||||
let wasActive = previousAddon ? previousAddon.active : currentAddon.active
|
||||
|
||||
if (!previousAddon) {
|
||||
// If we had a manifest for this add-on it was a staged install and
|
||||
// so wasn't something recovered from a corrupt database
|
||||
let wasStaged = !!loadedManifest(currentAddon._installLocation, id);
|
||||
|
||||
// We might be recovering from a corrupt database, if so use the
|
||||
// list of known active add-ons to update the new add-on
|
||||
if (!wasStaged && XPIDatabase.activeBundles) {
|
||||
// For themes we know which is active by the current skin setting
|
||||
if (currentAddon.type == "theme")
|
||||
isActive = currentAddon.internalName == XPIProvider.currentSkin;
|
||||
else
|
||||
isActive = XPIDatabase.activeBundles.indexOf(currentAddon.descriptor) != -1;
|
||||
|
||||
// If the add-on wasn't active and it isn't already disabled in some way
|
||||
// then it was probably either softDisabled or userDisabled
|
||||
if (!isActive && !currentAddon.disabled) {
|
||||
// If the add-on is softblocked then assume it is softDisabled
|
||||
if (currentAddon.blocklistState == Blocklist.STATE_SOFTBLOCKED)
|
||||
currentAddon.softDisabled = true;
|
||||
else
|
||||
currentAddon.userDisabled = true;
|
||||
}
|
||||
}
|
||||
else {
|
||||
// This is a new install
|
||||
if (currentAddon.foreignInstall)
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_INSTALLED, id);
|
||||
|
||||
if (currentAddon.bootstrap) {
|
||||
// Visible bootstrapped add-ons need to have their install method called
|
||||
XPIProvider.callBootstrapMethod(currentAddon, currentAddon._sourceBundle,
|
||||
"install", BOOTSTRAP_REASONS.ADDON_INSTALL);
|
||||
if (!isActive)
|
||||
XPIProvider.unloadBootstrapScope(currentAddon.id);
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (previousAddon !== currentAddon) {
|
||||
// This is an add-on that has changed, either the metadata was reloaded
|
||||
// or the version in a different location has become visible
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_CHANGED, id);
|
||||
|
||||
let installReason = Services.vc.compare(previousAddon.version, currentAddon.version) < 0 ?
|
||||
BOOTSTRAP_REASONS.ADDON_UPGRADE :
|
||||
BOOTSTRAP_REASONS.ADDON_DOWNGRADE;
|
||||
|
||||
// If the previous add-on was in a different location, bootstrapped
|
||||
// and still exists then call its uninstall method.
|
||||
if (previousAddon.bootstrap && previousAddon._installLocation &&
|
||||
currentAddon._installLocation != previousAddon._installLocation &&
|
||||
currentAddons.get(previousAddon._installLocation.name).has(id)) {
|
||||
|
||||
let file = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
|
||||
file.persistentDescriptor = previousAddon._sourceBundle.persistentDescriptor;
|
||||
XPIProvider.callBootstrapMethod(previousAddon, file,
|
||||
"uninstall", installReason,
|
||||
{ newVersion: currentAddon.version });
|
||||
XPIProvider.unloadBootstrapScope(previousAddon.id);
|
||||
}
|
||||
|
||||
// Make sure to flush the cache when an old add-on has gone away
|
||||
flushStartupCache();
|
||||
|
||||
if (currentAddon.bootstrap) {
|
||||
// Visible bootstrapped add-ons need to have their install method called
|
||||
let file = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
|
||||
file.persistentDescriptor = currentAddon._sourceBundle.persistentDescriptor;
|
||||
XPIProvider.callBootstrapMethod(currentAddon, file,
|
||||
"install", installReason,
|
||||
{ oldVersion: previousAddon.version });
|
||||
if (currentAddon.disabled)
|
||||
XPIProvider.unloadBootstrapScope(currentAddon.id);
|
||||
}
|
||||
}
|
||||
|
||||
if (isActive != wasActive) {
|
||||
let change = isActive ? AddonManager.STARTUP_CHANGE_ENABLED
|
||||
: AddonManager.STARTUP_CHANGE_DISABLED;
|
||||
AddonManagerPrivate.addStartupChange(change, id);
|
||||
}
|
||||
}
|
||||
|
||||
XPIDatabase.makeAddonVisible(currentAddon);
|
||||
currentAddon.active = isActive;
|
||||
|
||||
// Make sure the bootstrap information is up to date for this ID
|
||||
if (currentAddon.bootstrap && currentAddon.active) {
|
||||
XPIProvider.bootstrappedAddons[id] = {
|
||||
version: currentAddon.version,
|
||||
type: currentAddon.type,
|
||||
descriptor: currentAddon._sourceBundle.persistentDescriptor,
|
||||
multiprocessCompatible: currentAddon.multiprocessCompatible
|
||||
};
|
||||
}
|
||||
|
||||
if (currentAddon.active && currentAddon.internalName == XPIProvider.selectedSkin)
|
||||
sawActiveTheme = true;
|
||||
}
|
||||
|
||||
// Pass over the set of previously visible add-ons that have now gone away
|
||||
// and record the change.
|
||||
for (let [id, previousAddon] of previousVisible) {
|
||||
if (currentVisible.has(id))
|
||||
continue;
|
||||
|
||||
// This add-on vanished
|
||||
AddonManagerPrivate.addStartupChange(AddonManager.STARTUP_CHANGE_UNINSTALLED, id);
|
||||
}
|
||||
|
||||
// None of the active add-ons match the selected theme, enable the default.
|
||||
if (!sawActiveTheme) {
|
||||
XPIProvider.enableDefaultTheme();
|
||||
}
|
||||
|
||||
// Finally update XPIStates to match everything
|
||||
for (let [locationName, locationAddonMap] of currentAddons) {
|
||||
for (let [id, addon] of locationAddonMap) {
|
||||
let xpiState = XPIStates.getAddon(locationName, id);
|
||||
xpiState.syncWithDB(addon);
|
||||
}
|
||||
}
|
||||
XPIStates.save();
|
||||
|
||||
XPIProvider.persistBootstrappedAddons();
|
||||
|
||||
// Clear out any cached migration data.
|
||||
XPIDatabase.migrateData = null;
|
||||
XPIDatabase.saveChanges();
|
||||
|
||||
return true;
|
||||
},
|
||||
}
|
||||
|
||||
@ -1067,9 +1067,8 @@ function run_test_21() {
|
||||
do_check_eq(getUninstallReason(), -1);
|
||||
do_check_eq(getUninstallNewVersion(), -1);
|
||||
|
||||
// TODO this reason should probably be ADDON_DOWNGRADE (bug 607818)
|
||||
do_check_eq(getInstallReason(), ADDON_INSTALL);
|
||||
do_check_eq(getInstallOldVersion(), 0);
|
||||
do_check_eq(getInstallReason(), ADDON_DOWNGRADE);
|
||||
do_check_eq(getInstallOldVersion(), 2);
|
||||
|
||||
do_check_eq(getStartupReason(), APP_STARTUP);
|
||||
do_check_eq(getStartupOldVersion(), 0);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user