mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-25 11:15:34 +00:00
2a55d065b7
This change renames OriginAttributes.mInBrowser to mInIsolatedMozBrowser and nsIPrincipal::GetIsInBrowserElement to GetIsInIsolatedMozBrowserElement. Other methods that pass these values around also have name changes. Tokens such as "inBrowser" have previously been serialized into cache keys, used as DB column names, stored in app registries, etc. No changes are made to any serialization formats. Only runtime method and variable names are updated. No behavior changes are made in this patch, so some renamed methods may have nonsensical implementations. These are corrected in subsequent patches focused on behavior. MozReview-Commit-ID: 66HfMlsXFLs
101 lines
3.8 KiB
Plaintext
101 lines
3.8 KiB
Plaintext
/* -*- Mode: IDL; 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/.
|
|
*/
|
|
|
|
/**
|
|
* A collection of static utility methods that are only exposed to Chrome. This
|
|
* interface is not exposed in workers, while ThreadSafeChromeUtils is.
|
|
*/
|
|
[ChromeOnly, Exposed=(Window,System)]
|
|
interface ChromeUtils : ThreadSafeChromeUtils {
|
|
/**
|
|
* A helper that converts OriginAttributesDictionary to a opaque suffix string.
|
|
*
|
|
* @param originAttrs The originAttributes from the caller.
|
|
*/
|
|
static ByteString
|
|
originAttributesToSuffix(optional OriginAttributesDictionary originAttrs);
|
|
|
|
/**
|
|
* Returns true if the members of |originAttrs| match the provided members
|
|
* of |pattern|.
|
|
*
|
|
* @param originAttrs The originAttributes under consideration.
|
|
* @param pattern The pattern to use for matching.
|
|
*/
|
|
static boolean
|
|
originAttributesMatchPattern(optional OriginAttributesDictionary originAttrs,
|
|
optional OriginAttributesPatternDictionary pattern);
|
|
|
|
/**
|
|
* Returns an OriginAttributesDictionary with all default attributes added
|
|
* and assigned default values.
|
|
*
|
|
* @returns An OriginAttributesDictionary populated with the
|
|
* default attributes added and assigned default values.
|
|
*/
|
|
static OriginAttributesDictionary
|
|
createDefaultOriginAttributes();
|
|
|
|
/**
|
|
* Returns an OriginAttributesDictionary with values from the |origin| suffix
|
|
* and unspecified attributes added and assigned default values.
|
|
*
|
|
* @param origin The origin URI to create from.
|
|
* @returns An OriginAttributesDictionary with values from
|
|
* the origin suffix and unspecified attributes
|
|
* added and assigned default values.
|
|
*/
|
|
[Throws]
|
|
static OriginAttributesDictionary
|
|
createOriginAttributesFromOrigin(DOMString origin);
|
|
|
|
/**
|
|
* Returns an OriginAttributesDictionary that is a copy of |originAttrs| with
|
|
* unspecified attributes added and assigned default values.
|
|
*
|
|
* @param originAttrs The origin attributes to copy.
|
|
* @returns An OriginAttributesDictionary copy of |originAttrs|
|
|
* with unspecified attributes added and assigned
|
|
* default values.
|
|
*/
|
|
static OriginAttributesDictionary
|
|
createOriginAttributesFromDict(optional OriginAttributesDictionary originAttrs);
|
|
|
|
/**
|
|
* Returns true if the 2 OriginAttributes are equal.
|
|
*/
|
|
static boolean
|
|
isOriginAttributesEqual(optional OriginAttributesDictionary aA,
|
|
optional OriginAttributesDictionary aB);
|
|
};
|
|
|
|
/**
|
|
* Used by principals and the script security manager to represent origin
|
|
* attributes. The first dictionary is designed to contain the full set of
|
|
* OriginAttributes, the second is used for pattern-matching (i.e. does this
|
|
* OriginAttributesDictionary match the non-empty attributes in this pattern).
|
|
*
|
|
* IMPORTANT: If you add any members here, you need to do the following:
|
|
* (1) Add them to both dictionaries.
|
|
* (2) Update the methods on mozilla::OriginAttributes, including equality,
|
|
* serialization, deserialization, and inheritance.
|
|
* (3) Update the methods on mozilla::OriginAttributesPattern, including matching.
|
|
*/
|
|
dictionary OriginAttributesDictionary {
|
|
unsigned long appId = 0;
|
|
unsigned long userContextId = 0;
|
|
boolean inIsolatedMozBrowser = false;
|
|
DOMString addonId = "";
|
|
DOMString signedPkg = "";
|
|
};
|
|
dictionary OriginAttributesPatternDictionary {
|
|
unsigned long appId;
|
|
unsigned long userContextId;
|
|
boolean inIsolatedMozBrowser;
|
|
DOMString addonId;
|
|
DOMString signedPkg;
|
|
};
|