/* -*- 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 Effective TLD Service * * The Initial Developer of the Original Code is * Google Inc. * Portions created by the Initial Developer are Copyright (C) 2006 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Pamela Greene (original author) * Daniel Witte * * 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 nsIURI; [scriptable, uuid(6852369e-baa9-4c9a-bbcd-5123fc54a297)] interface nsIEffectiveTLDService : nsISupports { /** * Returns the public suffix of a URI. A public suffix is the highest-level domain * under which individual domains may be registered; it may therefore contain one * or more dots. For example, the public suffix for "www.bbc.co.uk" is "co.uk", * because the .uk TLD does not allow the registration of domains at the * second level ("bbc.uk" is forbidden). * * The public suffix will be returned encoded in ASCII/ACE and will be normalized * according to RFC 3454, i.e. the same encoding returned by nsIURI::GetAsciiHost(). * If consumers wish to compare the result of this method against the host from * another nsIURI, the host should be obtained using nsIURI::GetAsciiHost(). * In the case of nested URIs, the innermost URI will be used. * * @param aURI The URI to be analyzed * * @returns the public suffix * * @throws NS_ERROR_UNEXPECTED * or other error returned by nsIIDNService::normalize when * the hostname contains characters disallowed in URIs * @throws NS_ERROR_HOST_IS_IP_ADDRESS * if the host is a numeric IPv4 or IPv6 address (as determined by * the success of a call to PR_StringToNetAddr()). */ ACString getPublicSuffix(in nsIURI aURI); /** * Returns the base domain of a URI; that is, the public suffix with a given * number of additional domain name parts. For example, the result of this method * for "www.bbc.co.uk", depending on the value of aAdditionalParts parameter, will * be: * * 0 (default) -> bbc.co.uk * 1 -> www.bbc.co.uk * * Similarly, the public suffix for "www.developer.mozilla.org" is "org", and the base * domain will be: * * 0 (default) -> mozilla.org * 1 -> developer.mozilla.org * 2 -> www.developer.mozilla.org * * The base domain will be returned encoded in ASCII/ACE and will be normalized * according to RFC 3454, i.e. the same encoding returned by nsIURI::GetAsciiHost(). * If consumers wish to compare the result of this method against the host from * another nsIURI, the host should be obtained using nsIURI::GetAsciiHost(). * In the case of nested URIs, the innermost URI will be used. * * @param aURI The URI to be analyzed * @param aAdditionalParts Number of domain name parts to be * returned in addition to the public suffix * * @returns the base domain (public suffix plus the requested number of additional parts) * * @throws NS_ERROR_UNEXPECTED * or other error returned by nsIIDNService::normalize when * the hostname contains characters disallowed in URIs * @throws NS_ERROR_INSUFFICIENT_DOMAIN_LEVELS * when there are insufficient subdomain levels in the hostname to satisfy the * requested aAdditionalParts value. * @throws NS_ERROR_HOST_IS_IP_ADDRESS * if aHost is a numeric IPv4 or IPv6 address (as determined by * the success of a call to PR_StringToNetAddr()). * * @see getPublicSuffix() */ ACString getBaseDomain(in nsIURI aURI, [optional] in PRUint32 aAdditionalParts); /** * NOTE: It is strongly recommended to use getPublicSuffix() above if a suitable * nsIURI is available. Only use this method if this is not the case. * * Returns the public suffix of a host string. Otherwise identical to getPublicSuffix(). * * @param aHost The host to be analyzed. Any additional parts (e.g. scheme, * port, or path) will cause this method to throw. ASCII/ACE and * UTF8 encodings are acceptable as input; normalization will * be performed as specified in getBaseDomain(). * * @see getPublicSuffix() */ ACString getPublicSuffixFromHost(in AUTF8String aHost); /** * NOTE: It is strongly recommended to use getBaseDomain() above if a suitable * nsIURI is available. Only use this method if this is not the case. * * Returns the base domain of a host string. Otherwise identical to getBaseDomain(). * * @param aHost The host to be analyzed. Any additional parts (e.g. scheme, * port, or path) will cause this method to throw. ASCII/ACE and * UTF8 encodings are acceptable as input; normalization will * be performed as specified in getBaseDomain(). * * @see getBaseDomain() */ ACString getBaseDomainFromHost(in AUTF8String aHost, [optional] in PRUint32 aAdditionalParts); };