зеркало из https://github.com/mozilla/gecko-dev.git
143 строки
5.5 KiB
Plaintext
143 строки
5.5 KiB
Plaintext
/* -*- Mode: C++; 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 mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 2003
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* 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 "nsICookieManager.idl"
|
|
|
|
interface nsICookie2;
|
|
interface nsIFile;
|
|
|
|
/**
|
|
* Additions to the frozen nsICookieManager
|
|
*/
|
|
|
|
[scriptable, uuid(94628d1d-8b31-4baa-b474-9c872c440f90)]
|
|
interface nsICookieManager2 : nsICookieManager
|
|
{
|
|
/**
|
|
* Add a cookie. nsICookieService is the normal way to do this. This
|
|
* method is something of a backdoor.
|
|
*
|
|
* @param aHost
|
|
* the host or domain for which the cookie is set. presence of a
|
|
* leading dot indicates a domain cookie; otherwise, the cookie
|
|
* is treated as a non-domain cookie (see RFC2109). The host string
|
|
* will be normalized to ASCII or ACE; any trailing dot will be
|
|
* stripped. To be a domain cookie, the host must have at least two
|
|
* subdomain parts (e.g. '.foo.com', not '.com'), otherwise an
|
|
* exception will be thrown. An empty string is acceptable
|
|
* (e.g. file:// URI's).
|
|
* @param aPath
|
|
* path within the domain for which the cookie is valid
|
|
* @param aName
|
|
* cookie name
|
|
* @param aValue
|
|
* cookie data
|
|
* @param aIsSecure
|
|
* true if the cookie should only be sent over a secure connection.
|
|
* @param aIsHttpOnly
|
|
* true if the cookie should only be sent to, and can only be
|
|
* modified by, an http connection.
|
|
* @param aIsSession
|
|
* true if the cookie should exist for the current session only.
|
|
* see aExpiry.
|
|
* @param aExpiry
|
|
* expiration date, in seconds since midnight (00:00:00), January 1,
|
|
* 1970 UTC. note that expiry time will also be honored for session cookies;
|
|
* in this way, the more restrictive of the two will take effect.
|
|
*/
|
|
void add(in AUTF8String aHost,
|
|
in AUTF8String aPath,
|
|
in ACString aName,
|
|
in ACString aValue,
|
|
in boolean aIsSecure,
|
|
in boolean aIsHttpOnly,
|
|
in boolean aIsSession,
|
|
in PRInt64 aExpiry);
|
|
|
|
/**
|
|
* Find whether a given cookie already exists.
|
|
*
|
|
* @param aCookie
|
|
* the cookie to look for
|
|
*
|
|
* @return true if a cookie was found which matches the host, path, and name
|
|
* fields of aCookie
|
|
*/
|
|
boolean cookieExists(in nsICookie2 aCookie);
|
|
|
|
/**
|
|
* Count how many cookies exist within the base domain of 'aHost'.
|
|
* Thus, for a host "weather.yahoo.com", the base domain would be "yahoo.com",
|
|
* and any host or domain cookies for "yahoo.com" and its subdomains would be
|
|
* counted.
|
|
*
|
|
* @param aHost
|
|
* the host string to search for, e.g. "google.com". this should consist
|
|
* of only the host portion of a URI. see @add for a description of
|
|
* acceptable host strings.
|
|
*
|
|
* @return the number of cookies found.
|
|
*/
|
|
unsigned long countCookiesFromHost(in AUTF8String aHost);
|
|
|
|
/**
|
|
* Returns an enumerator of cookies that exist within the base domain of
|
|
* 'aHost'. Thus, for a host "weather.yahoo.com", the base domain would be
|
|
* "yahoo.com", and any host or domain cookies for "yahoo.com" and its
|
|
* subdomains would be returned.
|
|
*
|
|
* @param aHost
|
|
* the host string to search for, e.g. "google.com". this should consist
|
|
* of only the host portion of a URI. see @add for a description of
|
|
* acceptable host strings.
|
|
*
|
|
* @return an nsISimpleEnumerator of nsICookie2 objects.
|
|
*
|
|
* @see countCookiesFromHost
|
|
*/
|
|
nsISimpleEnumerator getCookiesFromHost(in AUTF8String aHost);
|
|
|
|
/**
|
|
* Import an old-style cookie file. Imported cookies will be added to the
|
|
* existing database. If the database contains any cookies the same as those
|
|
* being imported (i.e. domain, name, and path match), they will be replaced.
|
|
*
|
|
* @param aCookieFile the file to import, usually cookies.txt
|
|
*/
|
|
void importCookies(in nsIFile aCookieFile);
|
|
};
|