/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ /** * This file contains an interface to the Permission Manager, * used to persistenly store permissions for different object types (cookies, * images etc) on a site-by-site basis. * * This service broadcasts the following notification when the permission list * is changed: * * topic : "perm-changed" (PERM_CHANGE_NOTIFICATION) * broadcast whenever the permission list changes in some way. there * are four possible data strings for this notification; one * notification will be broadcast for each change, and will involve * a single permission. * subject: an nsIPermission interface pointer representing the permission object * that changed. * data : "deleted" * a permission was deleted. the subject is the deleted permission. * "added" * a permission was added. the subject is the added permission. * "changed" * a permission was changed. the subject is the new permission. * "cleared" * the entire permission list was cleared. the subject is null. */ #include "nsISupports.idl" #include "nsISimpleEnumerator.idl" interface nsIURI; interface nsIObserver; interface nsIPrincipal; [scriptable, uuid(cc423aaf-f088-4ec2-86ef-7733225773f9)] interface nsIPermissionManager : nsISupports { /** * Predefined return values for the testPermission method and for * the permission param of the add method * NOTE: UNKNOWN_ACTION (0) is reserved to represent the * default permission when no entry is found for a host, and * should not be used by consumers to indicate otherwise. */ const PRUint32 UNKNOWN_ACTION = 0; const PRUint32 ALLOW_ACTION = 1; const PRUint32 DENY_ACTION = 2; /** * Predefined expiration types for permissions. Permissions can be permanent * (never expire), expire at the end of the session, or expire at a specified * time. */ const PRUint32 EXPIRE_NEVER = 0; const PRUint32 EXPIRE_SESSION = 1; const PRUint32 EXPIRE_TIME = 2; /** * Add permission information for a given URI and permission type. This * operation will cause the type string to be registered if it does not * currently exist. If a permission already exists for a given type, it * will be modified. * * @param uri the uri to add the permission for * @param type a case-sensitive ASCII string, identifying the consumer. * Consumers should choose this string to be unique, with * respect to other consumers. * @param permission an integer representing the desired action (e.g. allow * or deny). The interpretation of this number is up to the * consumer, and may represent different actions for different * types. Consumers may use one of the enumerated permission * actions defined above, for convenience. * NOTE: UNKNOWN_ACTION (0) is reserved to represent the * default permission when no entry is found for a host, and * should not be used by consumers to indicate otherwise. * @param expiretype a constant defining whether this permission should * never expire (EXPIRE_NEVER), expire at the end of the * session (EXPIRE_SESSION), or expire at a specified time * (EXPIRE_TIME). * @param expiretime an integer representation of when this permission * should be forgotten (milliseconds since Jan 1 1970 0:00:00). */ void add(in nsIURI uri, in string type, in PRUint32 permission, [optional] in PRUint32 expireType, [optional] in PRInt64 expireTime); /** * Add permission information for a given principal. * It is internally calling the other add() method using the nsIURI from the * principal. */ void addFromPrincipal(in nsIPrincipal principal, in string typed, in PRUint32 permission, [optional] in PRUint32 expireType, [optional] in PRInt64 expireTime); /** * Remove permission information for a given host string and permission type. * The host string represents the exact entry in the permission list (such as * obtained from the enumerator), not a URI which that permission might apply * to. * * @param host the host to remove the permission for * @param type a case-sensitive ASCII string, identifying the consumer. * The type must have been previously registered using the * add() method. */ void remove(in AUTF8String host, in string type); /** * Remove permission information for a given principal. * This is internally calling remove() with the host from the principal's URI. */ void removeFromPrincipal(in nsIPrincipal principal, in string type); /** * Clear permission information for all websites. */ void removeAll(); /** * Test whether a website has permission to perform the given action. * @param uri the uri to be tested * @param type a case-sensitive ASCII string, identifying the consumer * @param return see add(), param permission. returns UNKNOWN_ACTION when * there is no stored permission for this uri and / or type. */ PRUint32 testPermission(in nsIURI uri, in string type); /** * Test whether the principal has the permission to perform a given action. */ PRUint32 testPermissionFromPrincipal(in nsIPrincipal principal, in string type); /** * Test whether a website has permission to perform the given action. * This requires an exact hostname match, subdomains are not a match. * @param uri the uri to be tested * @param type a case-sensitive ASCII string, identifying the consumer * @param return see add(), param permission. returns UNKNOWN_ACTION when * there is no stored permission for this uri and / or type. */ PRUint32 testExactPermission(in nsIURI uri, in string type); /** * See testExactPermission() above. */ PRUint32 testExactPermissionFromPrincipal(in nsIPrincipal principal, in string type); /** * Allows enumeration of all stored permissions * @return an nsISimpleEnumerator interface that allows access to * nsIPermission objects */ readonly attribute nsISimpleEnumerator enumerator; }; %{ C++ #define NS_PERMISSIONMANAGER_CONTRACTID "@mozilla.org/permissionmanager;1" #define PERM_CHANGE_NOTIFICATION "perm-changed" %}