зеркало из https://github.com/mozilla/gecko-dev.git
Bug 553169: Remove the old extension manager code
This commit is contained in:
Dave Townsend
Родитель
305a1a6dee
Коммит
a78f27ae24
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,758 +0,0 @@
|
||||||
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
||||||
/* ***** BEGIN LICENSE BLOCK *****
|
|
||||||
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
||||||
*
|
|
||||||
* The contents of this file are subject to the Mozilla Public License Version
|
|
||||||
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
||||||
* the License. You may obtain a copy of the License at
|
|
||||||
* http://www.mozilla.org/MPL/
|
|
||||||
*
|
|
||||||
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
||||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
||||||
* for the specific language governing rights and limitations under the
|
|
||||||
* License.
|
|
||||||
*
|
|
||||||
* The Original Code is the Extension Manager.
|
|
||||||
*
|
|
||||||
* The Initial Developer of the Original Code is Ben Goodger.
|
|
||||||
* Portions created by the Initial Developer are Copyright (C) 2004
|
|
||||||
* the Initial Developer. All Rights Reserved.
|
|
||||||
*
|
|
||||||
* Contributor(s):
|
|
||||||
* Ben Goodger <ben@mozilla.org> (Google Inc.)
|
|
||||||
* Robert Strong <robert.bugzilla@gmail.com>
|
|
||||||
* Alexander J. Vincent <ajvincent@gmail.com>
|
|
||||||
*
|
|
||||||
* Alternatively, the contents of this file may be used under the terms of
|
|
||||||
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
||||||
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
||||||
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
||||||
* of those above. If you wish to allow use of your version of this file only
|
|
||||||
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
||||||
* use your version of this file under the terms of the MPL, indicate your
|
|
||||||
* decision by deleting the provisions above and replace them with the notice
|
|
||||||
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
||||||
* the provisions above, a recipient may use your version of this file under
|
|
||||||
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
||||||
*
|
|
||||||
* ***** END LICENSE BLOCK ***** */
|
|
||||||
|
|
||||||
|
|
||||||
#include "nsISupports.idl"
|
|
||||||
|
|
||||||
interface nsIFile;
|
|
||||||
interface nsIRDFDataSource;
|
|
||||||
interface nsIUpdateItem;
|
|
||||||
interface nsIAddonInstallListener;
|
|
||||||
interface nsIAddonUpdateCheckListener;
|
|
||||||
interface nsISimpleEnumerator;
|
|
||||||
interface nsIDirectoryEnumerator;
|
|
||||||
interface nsIObserver;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Interface representing a location where extensions, themes etc are
|
|
||||||
* installed.
|
|
||||||
*/
|
|
||||||
[scriptable, uuid(32a74707-ec7c-af19-f4d8-d0cd8cb6a948)]
|
|
||||||
interface nsIInstallLocation : nsISupports
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* The string identifier of this Install Location
|
|
||||||
*/
|
|
||||||
readonly attribute AString name;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* An enumeration of nsIFiles for:
|
|
||||||
* - locations that contain items
|
|
||||||
* - potential dropped-in XPIs
|
|
||||||
* Note: This enumeration resolves Text Links to the directories they
|
|
||||||
* refer to.
|
|
||||||
*/
|
|
||||||
readonly attribute nsIDirectoryEnumerator itemLocations;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The file system location where items live. Items can be dropped in
|
|
||||||
* at this location. Can be null for Install Locations that don't have
|
|
||||||
* a file system presence.
|
|
||||||
* Note: This is a clone of the actual location which the caller can
|
|
||||||
* modify freely.
|
|
||||||
*/
|
|
||||||
readonly attribute nsIFile location;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Whether or not this Install Location is on an area of the file system
|
|
||||||
* that could be restricted on a restricted-access account, regardless
|
|
||||||
* of whether or not the location is restricted with the current user
|
|
||||||
* privileges.
|
|
||||||
*/
|
|
||||||
readonly attribute boolean restricted;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Whether or not the user can write to the Install Location with the
|
|
||||||
* current access privileges. This is different from restricted because
|
|
||||||
* it's not whether or not the location *might* be restricted, it's
|
|
||||||
* whether or not it actually *is* restricted right now.
|
|
||||||
*/
|
|
||||||
readonly attribute boolean canAccess;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constants representing priority of some default Install Locations.
|
|
||||||
* XXXben - priority ranking of user-level items vs. global-level items
|
|
||||||
* here is debatable. Should app-system-global trump
|
|
||||||
* xre-system-user?
|
|
||||||
* You should not use the exact values here, you should offset from
|
|
||||||
* these values each time you create a new Install Location. Offsetting
|
|
||||||
* can be brittle but you should know what Install Locations are being
|
|
||||||
* defined for your own application.
|
|
||||||
*/
|
|
||||||
const unsigned long PRIORITY_APP_PROFILE = 0;
|
|
||||||
const unsigned long PRIORITY_APP_SYSTEM_USER = 10;
|
|
||||||
const unsigned long PRIORITY_XRE_SYSTEM_USER = 100;
|
|
||||||
const unsigned long PRIORITY_APP_SYSTEM_GLOBAL = 1000;
|
|
||||||
const unsigned long PRIORITY_XRE_SYSTEM_GLOBAL = 10000;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The priority level of this Install Location in loading.
|
|
||||||
*/
|
|
||||||
readonly attribute long priority;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets the directory that contains an item.
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item.
|
|
||||||
* @returns The location of the item.
|
|
||||||
*/
|
|
||||||
nsIFile getItemLocation(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Retrieves the GUID for an item at the specified location.
|
|
||||||
* @param file
|
|
||||||
* The location where an item might live.
|
|
||||||
* @returns The ID for an item that might live at the location specified.
|
|
||||||
*
|
|
||||||
* N.B. This function makes no promises about whether or not this path is
|
|
||||||
* actually maintained by this Install Location.
|
|
||||||
*/
|
|
||||||
AString getIDForLocation(in nsIFile file);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets a nsIFile object for a file within an item's directory structure.
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item.
|
|
||||||
* @param path
|
|
||||||
* The path to the file beneath an Extension's directory
|
|
||||||
* @returns A file object at the requested location. The file does not
|
|
||||||
* necessarily have to exist.
|
|
||||||
*/
|
|
||||||
nsIFile getItemFile(in AString id, in AString path);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Determines whether or not an item's resources are managed by the Extension
|
|
||||||
* System or by some other user or process. For example, items linked to by
|
|
||||||
* text links are managed by the user, and items linked to from Registry
|
|
||||||
* Install Locations are usually managed by other applications or installers.
|
|
||||||
*
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item.
|
|
||||||
* @returns true if the item's resources are managed independently of the
|
|
||||||
* Extension System, false otherwise.
|
|
||||||
*/
|
|
||||||
boolean itemIsManagedIndependently(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Stages the specified file by copying it to some location from where it
|
|
||||||
* can be retrieved later to complete installation.
|
|
||||||
*
|
|
||||||
* @param file
|
|
||||||
* The file to stage
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item the file represents
|
|
||||||
* @returns The staged file
|
|
||||||
*/
|
|
||||||
nsIFile stageFile(in nsIFile file, in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the most recently staged package (e.g. the last XPI or JAR in a
|
|
||||||
* directory) for an item and removes items that do not qualify.
|
|
||||||
*
|
|
||||||
* @param id
|
|
||||||
* The ID of the staged package
|
|
||||||
* @returns an nsIFile if the package exists otherwise null.
|
|
||||||
*/
|
|
||||||
nsIFile getStageFile(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Removes a file from the stage. This cleans up the stage if there is nothing
|
|
||||||
* else left after the remove operation.
|
|
||||||
*
|
|
||||||
* @param file
|
|
||||||
* The file to remove.
|
|
||||||
*/
|
|
||||||
void removeFile(in nsIFile file);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Interface representing a system for the installation and management of
|
|
||||||
* Extensions, Themes etc.
|
|
||||||
*
|
|
||||||
* XXXben - Some of this stuff should go into a management-ey interface,
|
|
||||||
* some into an app-startup-ey interface.
|
|
||||||
*/
|
|
||||||
[scriptable, uuid(494e8302-8689-4a8a-a08d-0da17c649c7d)]
|
|
||||||
interface nsIExtensionManager : nsISupports
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Constants representing types of update checks.
|
|
||||||
*/
|
|
||||||
const unsigned long UPDATE_CHECK_NEWVERSION = 0;
|
|
||||||
const unsigned long UPDATE_CHECK_COMPATIBILITY = 1;
|
|
||||||
const unsigned long UPDATE_SYNC_COMPATIBILITY = 2;
|
|
||||||
const unsigned long UPDATE_NOTIFY_NEWVERSION = 3;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constants that callers can use to indicate the reason for an add-on update
|
|
||||||
* check. Internal code uses other constants in nsExtensionManager.js.in.
|
|
||||||
*
|
|
||||||
* The update check is being performed at the request of the user.
|
|
||||||
*/
|
|
||||||
const unsigned long UPDATE_WHEN_USER_REQUESTED = 1;
|
|
||||||
/**
|
|
||||||
* The update check is being performed after a new version of the application
|
|
||||||
* has been detected.
|
|
||||||
*/
|
|
||||||
const unsigned long UPDATE_WHEN_NEW_APP_DETECTED = 2;
|
|
||||||
/**
|
|
||||||
* The update check is being performed after a new version of the application
|
|
||||||
* has been installed.
|
|
||||||
*/
|
|
||||||
const unsigned long UPDATE_WHEN_NEW_APP_INSTALLED = 3;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Starts the Extension Manager, checking for item changes, additions and
|
|
||||||
* removals, and finishing pending operations.
|
|
||||||
* @returns true if the application has rewritten the extensions.ini file
|
|
||||||
* and needs to restart to register components/chrome etc,
|
|
||||||
* false otherwise
|
|
||||||
*/
|
|
||||||
boolean start();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Determines if there are incompatible items installed (and offers to
|
|
||||||
* upgrade them to newer versions if available, via a UI).
|
|
||||||
* @returns true if there were incompatible items that were disabled
|
|
||||||
* and the application needs to restart to re-register components,
|
|
||||||
* chrome etc, false otherwise.
|
|
||||||
*/
|
|
||||||
boolean checkForMismatches();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets the Install Location for an item
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item
|
|
||||||
* @returns The Install Location where the item is installed or null if the
|
|
||||||
* location cannot be obtained (e.g. an invalid id).
|
|
||||||
*/
|
|
||||||
nsIInstallLocation getInstallLocation(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* An enumeration of all registered Install Items
|
|
||||||
*/
|
|
||||||
readonly attribute nsISimpleEnumerator installLocations;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Installs an item from a XPI/JAR file into the location specified.
|
|
||||||
* @param xpiFile
|
|
||||||
* The source file to install from. This function stages a copy
|
|
||||||
* of this file for persistence across potential application
|
|
||||||
* restarts, you are responsible for removing the file you pass
|
|
||||||
* in.
|
|
||||||
* @param installLocationKey
|
|
||||||
* The name identifier of an Install Location to install into.
|
|
||||||
*/
|
|
||||||
void installItemFromFile(in nsIFile xpiFile, in AString installLocationKey);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Uninstalls an item
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item.
|
|
||||||
*/
|
|
||||||
void uninstallItem(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enables a disabled item
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item.
|
|
||||||
*/
|
|
||||||
void enableItem(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disables an enabled item
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item.
|
|
||||||
*/
|
|
||||||
void disableItem(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks for updates to a list of items.
|
|
||||||
* @param items
|
|
||||||
* An array of nsIUpdateItems to check for updates for.
|
|
||||||
* @param itemCount
|
|
||||||
* The length of |items|
|
|
||||||
* @param updateCheckType
|
|
||||||
* UPDATE_CHECK_NEWVERSION if this check should find the newest
|
|
||||||
* versions available and write the results to the extensions
|
|
||||||
* datasource.
|
|
||||||
* UPDATE_CHECK_COMPATIBILITY if this check should only find newer
|
|
||||||
* target application compatibility information for the currently
|
|
||||||
* installed version and write the results to the extensions
|
|
||||||
* datasource.
|
|
||||||
* UPDATE_SYNC_COMPATIBILITY if this check should only find target
|
|
||||||
* application compatibility information for the currently
|
|
||||||
* installed version and synchronize the values to the extensions
|
|
||||||
* datasource.
|
|
||||||
* UPDATE_NOTIFY_NEWVERSION if this check should find the newest
|
|
||||||
* versions available without updating the extensions datasource.
|
|
||||||
* @param listener
|
|
||||||
* An nsIAddonUpdateCheckListener object which will be notified
|
|
||||||
* during the update check process. If not null, the object's
|
|
||||||
* onUpdateStarted() and onUpdateEnded() methods will be called even
|
|
||||||
* if there are no items to update.
|
|
||||||
* @param updateType (optional)
|
|
||||||
* The type of the update check. Should be one of the UPDATE_WHEN
|
|
||||||
* values.
|
|
||||||
* @param appVersion (optional)
|
|
||||||
* The version of the application to check for compatible updates.
|
|
||||||
* This param is only honored when updateCheckType is equal to
|
|
||||||
* UPDATE_NOTIFY_NEWVERSION and it defaults to the current version of
|
|
||||||
* the application when it is not specified.
|
|
||||||
* @param platformVersion (optional)
|
|
||||||
* The version of the toolkit to check for compatible updates.
|
|
||||||
* This param is only honored when updateCheckType is equal to
|
|
||||||
* UPDATE_NOTIFY_NEWVERSION and it defaults to the current version of
|
|
||||||
* the toolkit when it is not specified.
|
|
||||||
*
|
|
||||||
* @throws NS_ERROR_ILLEGAL_VALUE if any item is invalid.
|
|
||||||
*/
|
|
||||||
void update([array, size_is(itemCount)] in nsIUpdateItem items,
|
|
||||||
in unsigned long itemCount,
|
|
||||||
in unsigned long updateCheckType,
|
|
||||||
in nsIAddonUpdateCheckListener listener,
|
|
||||||
[optional] in unsigned long updateType,
|
|
||||||
[optional] in AString appVersion,
|
|
||||||
[optional] in AString platformVersion);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets a nsIUpdateItem for the item with the specified id.
|
|
||||||
* @param id
|
|
||||||
* The GUID of the item to construct a nsIUpdateItem for.
|
|
||||||
* @returns The nsIUpdateItem representing the item or null if the item does
|
|
||||||
* not exist.
|
|
||||||
*/
|
|
||||||
nsIUpdateItem getItemForID(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Retrieves a list of visible nsIUpdateItems of items matching the
|
|
||||||
* specified type.
|
|
||||||
* @param type
|
|
||||||
* The type of item to return.
|
|
||||||
* @param countRef
|
|
||||||
* The XPCJS reference to the number of items returned.
|
|
||||||
* @returns An array of nsIUpdateItems matching the id/type filter.
|
|
||||||
*
|
|
||||||
* XXXben - it would be good if this function took an optional
|
|
||||||
* install location.
|
|
||||||
*/
|
|
||||||
void getItemList(in unsigned long type,
|
|
||||||
[optional] out unsigned long itemCount,
|
|
||||||
[retval, array, size_is(itemCount)] out nsIUpdateItem items);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Retrieves a list of nsIUpdateItems of items that are incompatible
|
|
||||||
* with the supplied parameters.
|
|
||||||
* @param appVersion
|
|
||||||
* The version of the application to check compatibility against
|
|
||||||
* @param platformVersion
|
|
||||||
* The version of the toolkit to check compatibility against
|
|
||||||
* @param type
|
|
||||||
* The type of item to return
|
|
||||||
* @param includeDisabled
|
|
||||||
* true if disabled items should be included in the result set,
|
|
||||||
* false otherwise
|
|
||||||
* @param countRef
|
|
||||||
* The XPCJS reference to the number of items returned.
|
|
||||||
* @returns An array of incompatible nsIUpdateItems.
|
|
||||||
*/
|
|
||||||
void getIncompatibleItemList(in AString appVersion,
|
|
||||||
in AString platformVersion,
|
|
||||||
in unsigned long type,
|
|
||||||
in boolean includeDisabled,
|
|
||||||
[optional] out unsigned long itemCount,
|
|
||||||
[retval, array, size_is(itemCount)] out nsIUpdateItem items);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The Extensions Datasource
|
|
||||||
* XXXben - the datasource should be registered with the RDF system, so it
|
|
||||||
* can be accessed via rdf:extensions, and not exposed through the API
|
|
||||||
* like this.
|
|
||||||
*/
|
|
||||||
readonly attribute nsIRDFDataSource datasource;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Adds active download entries to the UI
|
|
||||||
* @param items
|
|
||||||
* A list of nsIUpdateItems to entries to add
|
|
||||||
* @param itemCount
|
|
||||||
* The length of |items|
|
|
||||||
* @param manager
|
|
||||||
* null when called from chrome
|
|
||||||
* the XPInstallManager when not called from chrome (e.g. web page)
|
|
||||||
*
|
|
||||||
* @throws NS_ERROR_ILLEGAL_VALUE if any item is invalid, or if itemCount == 0.
|
|
||||||
*/
|
|
||||||
void addDownloads([array, size_is(itemCount)] in nsIUpdateItem items,
|
|
||||||
in unsigned long itemCount, in nsIObserver manager);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Removes an active download from the UI
|
|
||||||
* @param url
|
|
||||||
* The URL of the active download to remove
|
|
||||||
*/
|
|
||||||
void removeDownload(in AString url);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Adds an install listener so the front end can listen to download
|
|
||||||
* and install progress.
|
|
||||||
* @param listener
|
|
||||||
* The listener to add
|
|
||||||
* @returns the index of the added listen in the listener list.
|
|
||||||
*/
|
|
||||||
long addInstallListener(in nsIAddonInstallListener listener);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Removes an install progress listener.
|
|
||||||
* @param index
|
|
||||||
* The index of the listener to remove.
|
|
||||||
*/
|
|
||||||
void removeInstallListenerAt(in long index);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Cancels a pending install or upgrade of an item. If the item does
|
|
||||||
* not have a pending install or upgrade then this will do nothing.
|
|
||||||
* @param id
|
|
||||||
* The ID of the item.
|
|
||||||
*/
|
|
||||||
void cancelInstallItem(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Cancels a pending uninstall of an item
|
|
||||||
* @param id
|
|
||||||
* The ID of the item.
|
|
||||||
*/
|
|
||||||
void cancelUninstallItem(in AString id);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Retrieves a list of installed nsIUpdateItems of items that are dependent
|
|
||||||
* on another item.
|
|
||||||
* @param id
|
|
||||||
* The ID of the item that other items depend on.
|
|
||||||
* @param includeDisabled
|
|
||||||
* Whether to include disabled items in the set returned.
|
|
||||||
* @param countRef
|
|
||||||
* The XPCJS reference to the number of items returned.
|
|
||||||
* @returns An array of installed nsIUpdateItems that depend on the item
|
|
||||||
* specified by the id parameter.
|
|
||||||
*/
|
|
||||||
void getDependentItemListForID(in AString id,
|
|
||||||
in boolean includeDisabled,
|
|
||||||
[optional] out unsigned long itemCount,
|
|
||||||
[retval, array, size_is(itemCount)] out nsIUpdateItem items);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks for changes to the blocklist using the local blocklist file.
|
|
||||||
* This will immediately application disable items that have been hard blocked
|
|
||||||
* and application enable items that are no longer hard blocked. It will also
|
|
||||||
* return items that are either soft or hard blocked and aren't already
|
|
||||||
* disabled or disabled pending a restart.
|
|
||||||
*
|
|
||||||
* This is likely to change or go away in the future and should not be used
|
|
||||||
* by anyone outside of the blocklist service.
|
|
||||||
*
|
|
||||||
* @returns An array of nsIUpdateItems that are blocklisted or the user should
|
|
||||||
* be warned about but are currently enabled.
|
|
||||||
*/
|
|
||||||
void updateAndGetNewBlocklistedItems([optional] out unsigned long itemCount,
|
|
||||||
[retval, array, size_is(itemCount)] out nsIUpdateItem items);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* An item managed by the Extension System. Contains metadata that describes
|
|
||||||
* the item.
|
|
||||||
* XXXben work in progress, the name of this interface will change after the
|
|
||||||
* update system is complete, probably to nsIAddon
|
|
||||||
*/
|
|
||||||
[scriptable, uuid(f559f340-5160-420f-abc8-19b251708e7e)]
|
|
||||||
interface nsIUpdateItem : nsISupports
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* The GUID of the item.
|
|
||||||
*/
|
|
||||||
readonly attribute AString id;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The Version of the item, in FVF format.
|
|
||||||
*/
|
|
||||||
readonly attribute AString version;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The minimum version of the application that this item works with,
|
|
||||||
* in FVF format.
|
|
||||||
*/
|
|
||||||
readonly attribute AString minAppVersion;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The maximum version of the application that this item works with,
|
|
||||||
* in FVF format.
|
|
||||||
*/
|
|
||||||
readonly attribute AString maxAppVersion;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The name of the Install Location where this item is installed.
|
|
||||||
*/
|
|
||||||
readonly attribute AString installLocationKey;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The name of this item.
|
|
||||||
*/
|
|
||||||
readonly attribute AString name;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The URL of the XPI where this item can be downloaded.
|
|
||||||
*/
|
|
||||||
readonly attribute AString xpiURL;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The string Hash for the XPI file. Can be null and if supplied must be in
|
|
||||||
* the format of "type:hash" (see the types in nsICryptoHash and
|
|
||||||
* nsIXPInstallManager::initManagerWithHashes).
|
|
||||||
*/
|
|
||||||
readonly attribute AString xpiHash;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The URL of the icon that can be shown for this item.
|
|
||||||
*/
|
|
||||||
readonly attribute AString iconURL;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The URL of the update RDF file for this item.
|
|
||||||
*/
|
|
||||||
readonly attribute AString updateRDF;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The public key to verify updates for this item. This must be the public
|
|
||||||
* part of the key that was used to sign update manifests for this add-on.
|
|
||||||
*/
|
|
||||||
readonly attribute AString updateKey;
|
|
||||||
|
|
||||||
const unsigned long TYPE_APP = 0x01;
|
|
||||||
const unsigned long TYPE_EXTENSION = 0x02;
|
|
||||||
const unsigned long TYPE_THEME = 0x04;
|
|
||||||
const unsigned long TYPE_LOCALE = 0x08;
|
|
||||||
const unsigned long TYPE_MULTI_XPI = 0x20;
|
|
||||||
const unsigned long TYPE_ADDON = TYPE_EXTENSION + TYPE_THEME + TYPE_LOCALE;
|
|
||||||
const unsigned long TYPE_ANY = 0xff;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The type of this item.
|
|
||||||
*/
|
|
||||||
readonly attribute long type;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The target application ID used for checking compatibility for this item.
|
|
||||||
*
|
|
||||||
* @note Add-ons can specify a targetApplication id of toolkit@mozilla.org in
|
|
||||||
* their install manifest for compatibility with all apps using a
|
|
||||||
* specific release of the toolkit.
|
|
||||||
*/
|
|
||||||
readonly attribute AString targetAppID;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Initializes this Item object.
|
|
||||||
*/
|
|
||||||
void init(in AString id, in AString version,
|
|
||||||
in AString installLocationKey, in AString minAppVersion,
|
|
||||||
in AString maxAppVersion, in AString name,
|
|
||||||
in AString downloadURL, in AString xpiHash, in AString iconURL,
|
|
||||||
in AString updateURL, in AString updateKey, in long type,
|
|
||||||
in AString targetAppID);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a JS Object source representing an nsIUpdateItem.
|
|
||||||
*/
|
|
||||||
readonly attribute AString objectSource;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Interface for handling download and install progress notifications for
|
|
||||||
* add-ons.
|
|
||||||
*/
|
|
||||||
[scriptable, uuid(2333b04c-f371-4dea-a2f1-d8fdb0c82866)]
|
|
||||||
interface nsIAddonInstallListener : nsISupports
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Called when an add-on download starts. This will be called for every add-on
|
|
||||||
* downloaded including those started by an add-on update.
|
|
||||||
* @param addon
|
|
||||||
* The add-on that is being downloaded
|
|
||||||
*/
|
|
||||||
void onDownloadStarted(in nsIUpdateItem addon);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Progress occurred in the download operation. This will be called multiple
|
|
||||||
* times during the download of an add-on.
|
|
||||||
* @param addon
|
|
||||||
* The add-on that progress occurred for
|
|
||||||
* @param value
|
|
||||||
* The value of the current progress
|
|
||||||
* @param maxValue
|
|
||||||
* The maximum value |value| can reach
|
|
||||||
*/
|
|
||||||
void onDownloadProgress(in nsIUpdateItem addon, in unsigned long value,
|
|
||||||
in unsigned long maxValue);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called when an add-on download is complete. This will be called for every
|
|
||||||
* add-on downloaded.
|
|
||||||
* @param addon
|
|
||||||
* The add-on that finished downloading
|
|
||||||
*/
|
|
||||||
void onDownloadEnded(in nsIUpdateItem addon);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called when the extension manager starts to install an add-on either
|
|
||||||
* through a call to installItemFromFile or from a webpage triggered install.
|
|
||||||
* @param addon
|
|
||||||
* The add-on being installed
|
|
||||||
*/
|
|
||||||
void onInstallStarted(in nsIUpdateItem addon);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called when an add-on compatibility check starts. This will be called
|
|
||||||
* during an install if an add-on is incompatible according to its
|
|
||||||
* install.rdf.
|
|
||||||
* @param addon
|
|
||||||
* The add-on that the compatibility check will be for
|
|
||||||
*/
|
|
||||||
void onCompatibilityCheckStarted(in nsIUpdateItem addon);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called at the end of an add-on compatibility check. The status will be one
|
|
||||||
* of the results from nsIAddonUpdateCheckListener to indicate whether new
|
|
||||||
* information was found or not.
|
|
||||||
* @param addon
|
|
||||||
* The add-on that is having its compatibility checked
|
|
||||||
* @param status
|
|
||||||
* The status code from nsIAddonUpdateCheckListener for the update
|
|
||||||
* operation
|
|
||||||
*/
|
|
||||||
void onCompatibilityCheckEnded(in nsIUpdateItem addon, in long status);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called when an add-on install completes. The status will be 0 on success.
|
|
||||||
* any other value constitutes a failed install.
|
|
||||||
* @param addon
|
|
||||||
* The add-on that finished installing
|
|
||||||
* @param status
|
|
||||||
* The status of the installation from nsInstall.h
|
|
||||||
*/
|
|
||||||
void onInstallEnded(in nsIUpdateItem addon, in long status);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called when there are no more add-on downloads or installs in progress.
|
|
||||||
*/
|
|
||||||
void onInstallsCompleted();
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Interface for handling notifications during the addon update check process.
|
|
||||||
*/
|
|
||||||
[scriptable, uuid(c946119f-9e7c-41aa-a794-803148045350)]
|
|
||||||
interface nsIAddonUpdateCheckListener : nsISupports
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Addon update has begun
|
|
||||||
*/
|
|
||||||
void onUpdateStarted();
|
|
||||||
|
|
||||||
const unsigned long STATUS_NONE = 0;
|
|
||||||
const unsigned long STATUS_UPDATE = 1;
|
|
||||||
const unsigned long STATUS_VERSIONINFO = 2;
|
|
||||||
const unsigned long STATUS_DATA_FOUND =
|
|
||||||
STATUS_UPDATE + STATUS_VERSIONINFO;
|
|
||||||
const unsigned long STATUS_FAILURE = 4;
|
|
||||||
const unsigned long STATUS_NO_UPDATE = 8;
|
|
||||||
const unsigned long STATUS_DISABLED = 16;
|
|
||||||
const unsigned long STATUS_APP_MANAGED = 32;
|
|
||||||
const unsigned long STATUS_READ_ONLY = 64;
|
|
||||||
const unsigned long STATUS_PENDING_OP = 128;
|
|
||||||
const unsigned long STATUS_NOT_MANAGED = 256;
|
|
||||||
const unsigned long STATUS_DISALLOWED =
|
|
||||||
STATUS_DISABLED + STATUS_APP_MANAGED + STATUS_READ_ONLY +
|
|
||||||
STATUS_PENDING_OP + STATUS_NOT_MANAGED;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Addon update has ended
|
|
||||||
*/
|
|
||||||
void onUpdateEnded();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Update for an individual addon has begun
|
|
||||||
* @param addon
|
|
||||||
* A nsIUpdateItem object representing the addon being updated
|
|
||||||
*
|
|
||||||
* @throws NS_ERROR_ILLEGAL_VALUE if the addon is invalid.
|
|
||||||
*/
|
|
||||||
void onAddonUpdateStarted(in nsIUpdateItem addon);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Update for an individual addon has ended
|
|
||||||
* @param addon
|
|
||||||
* A nsIUpdateItem object representing the addon being updated
|
|
||||||
* @param status
|
|
||||||
* The success or failure code of the update operation
|
|
||||||
*
|
|
||||||
* @throws NS_ERROR_ILLEGAL_VALUE if the addon is invalid.
|
|
||||||
*/
|
|
||||||
void onAddonUpdateEnded(in nsIUpdateItem addon, in long status);
|
|
||||||
};
|
|
||||||
|
|
||||||
%{ C++
|
|
||||||
/**
|
|
||||||
* Install Location Key for Application-Global Items
|
|
||||||
*/
|
|
||||||
#define NS_INSTALL_LOCATION_APPGLOBAL NS_LITERAL_STRING("app-global")
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Install Location Key for Application-Profile Items
|
|
||||||
*/
|
|
||||||
#define NS_INSTALL_LOCATION_APPPROFILE NS_LITERAL_STRING("app-profile")
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The category that contains a list of contract-ids to Install Location
|
|
||||||
* services.
|
|
||||||
*/
|
|
||||||
#define CATEGORY_INSTALL_LOCATIONS "extension-install-locations"
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The observer topic to listen to for actions performed on installed
|
|
||||||
* items.
|
|
||||||
*/
|
|
||||||
#define EM_ACTION_REQUESTED_TOPIC "em-action-requested"
|
|
||||||
|
|
||||||
#define EM_ITEM_INSTALLED "item-installed"
|
|
||||||
#define EM_ITEM_UPGRADED "item-upgraded"
|
|
||||||
#define EM_ITEM_UNINSTALLED "item-uninstalled"
|
|
||||||
#define EM_ITEM_ENABLED "item-enabled"
|
|
||||||
#define EM_ITEM_DISABLED "item-disabled"
|
|
||||||
#define EM_ITEM_CANCEL "item-cancel-action"
|
|
||||||
|
|
||||||
%}
|
|
||||||
Загрузка…
Ссылка в новой задаче