mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
345 lines
14 KiB
Plaintext
345 lines
14 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* 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/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIURI;
|
|
interface nsIFaviconDataCallback;
|
|
|
|
[scriptable, uuid(2cf188f4-3c96-4bca-b668-36b25aaf7c1d)]
|
|
interface nsIFaviconService : nsISupports
|
|
{
|
|
/**
|
|
* Declares that a given page uses a favicon with the given URI.
|
|
*
|
|
* Will create an entry linking the favicon URI to the page, regardless
|
|
* of whether we have data for that icon. You can populate it later with
|
|
* SetFaviconData. However, remember that favicons must only be associated
|
|
* with a visited web page, a bookmark, or a "place:" URI. Trying to
|
|
* associate the icon to any other page will throw.
|
|
*
|
|
* This will send out history pageChanged notification if the new favicon has
|
|
* any data and it's different from the old associated favicon. This means
|
|
* that you should try to set data before calling this method if you have it,
|
|
* otherwise it won't fire any notifications.
|
|
*
|
|
* @param aPageURI
|
|
* URI of the page whose favicon is being set.
|
|
* @param aFaviconURI
|
|
* URI of the favicon to associate with the page.
|
|
* @throws NS_ERROR_NOT_AVAILABLE if aPageURI doesn't exist in the database.
|
|
*/
|
|
void setFaviconUrlForPage(in nsIURI aPageURI,
|
|
in nsIURI aFaviconURI);
|
|
|
|
/**
|
|
* Same as SetFaviconUrlForPage except that this also attempts to fetch and
|
|
* save the icon data by loading the favicon URI through an async network
|
|
* request.
|
|
*
|
|
* If the icon data already exists, we won't normally try to re-load the
|
|
* icon. If the icon is in the failed favicon cache we won't do anything.
|
|
* Use forceReload to force a reload of the data. This will also eventually
|
|
* remove the favicon from the failed cache, if the reload succeeds.
|
|
*
|
|
* This function will only save favicons for "good" URIs, as defined by what
|
|
* gets added to history or is a bookmark. For "bad" URIs, this function
|
|
* will succeed but do nothing. This function will also ignore the error page
|
|
* favicon URI (see FAVICON_ERRORPAGE_URL below).
|
|
* Icons that fail to load will automatically be added to the failed favicon
|
|
* cache.
|
|
*
|
|
* This function will not save favicons for non-bookmarked URIs when
|
|
* history is disabled. The rest of the functions
|
|
* here will always store favicons even when history is disabled.
|
|
*
|
|
* @param aPageURI
|
|
* URI of the page whose favicon is being set.
|
|
* @param aFaviconURI
|
|
* URI of the favicon to associate with the page.
|
|
* @param aForceReload
|
|
* Unset is normal behavior, we will only try to reload the favicon
|
|
* if we don't have it or if it has expired from the cache. If set,
|
|
* it will always try to reload the favicon.
|
|
* @param aCallback
|
|
* Once we're done setting and/or loading the favicon, we invoke this
|
|
* callback.
|
|
*
|
|
* @deprecated Use the identical function
|
|
* mozIAsyncFavicons::setAndFetchFaviconForPage.
|
|
*/
|
|
[deprecated]
|
|
void setAndLoadFaviconForPage(in nsIURI aPageURI,
|
|
in nsIURI aFaviconURI,
|
|
in boolean aForceReload,
|
|
[optional] in nsIFaviconDataCallback aCallback);
|
|
|
|
/**
|
|
* Stores the data for a given favicon URI.
|
|
*
|
|
* You can set the data even if you haven't called SetFaviconUrlForPage
|
|
* yet. It will be stored but will not be associated with any page.
|
|
* However, any favicons not associated with a visited web page, bookmark,
|
|
* or "place:" URI will be expired when history expiration runs. This might
|
|
* happen at any time, so you should not let the message loop run before
|
|
* you associate the icon or it may get deleted.
|
|
*
|
|
* It is best to set the favicon data, and then associate it with a page using
|
|
* setFaviconUrlForPage, otherwise it won't notify about the change.
|
|
*
|
|
* It's better to not use this function for chrome: icon URIs since you can
|
|
* reference the chrome image yourself. GetFaviconLinkForIcon/Page will ignore
|
|
* any associated data if the favicon URI is "chrome:" and just return the
|
|
* same chrome URI.
|
|
*
|
|
* This function does NOT send out notifications that the data has changed.
|
|
* Pages using this favicons that are visible in history or bookmarks views
|
|
* will keep the old icon until they have been refreshed by other means.
|
|
*
|
|
* This function tries to optimize the favicon size, if it is bigger
|
|
* than a defined limit we will try to convert it to a 16x16 png image.
|
|
* If the conversion fails and favicon is still bigger than our max accepted
|
|
* size it won't be saved.
|
|
*
|
|
* @param aFaviconURI
|
|
* URI of the favicon whose data is being set.
|
|
* @param aData
|
|
* Binary contents of the favicon to save
|
|
* @param aDataLength
|
|
* Length of binary data
|
|
* @param aMimeType
|
|
* MIME type of the data to store. This is important so that we know
|
|
* what to report when the favicon is used. You should always set this
|
|
* param unless you are clearing an icon.
|
|
* @param aExpiration
|
|
* Time in microseconds since the epoch when this favicon expires.
|
|
* Until this time, we won't try to load it again.
|
|
* @throws NS_ERROR_FAILURE
|
|
* Thrown if the favicon is overbloated and won't be saved to the db.
|
|
*
|
|
* @deprecated Use mozIAsyncFavicons::replaceFaviconData
|
|
*/
|
|
void setFaviconData(in nsIURI aFaviconURI,
|
|
[const,array,size_is(aDataLen)] in octet aData,
|
|
in unsigned long aDataLen,
|
|
in AUTF8String aMimeType,
|
|
in PRTime aExpiration);
|
|
|
|
/**
|
|
* Same as setFaviconData but the data is provided by a string
|
|
* containing a data URL.
|
|
*
|
|
* @see setFaviconData
|
|
*
|
|
* @param aFaviconURI
|
|
* URI of the favicon whose data is being set.
|
|
* @param aDataURL
|
|
* string containing a data URL that represents the contents of
|
|
* the favicon to save
|
|
* @param aExpiration
|
|
* Time in microseconds since the epoch when this favicon expires.
|
|
* Until this time, we won't try to load it again.
|
|
* @throws NS_ERROR_FAILURE
|
|
* Thrown if the favicon is overbloated and won't be saved to the db.
|
|
*
|
|
* @deprecated Use mozIAsyncFavicons::replaceFaviconDataFromDataURL
|
|
*/
|
|
void setFaviconDataFromDataURL(in nsIURI aFaviconURI,
|
|
in AString aDataURL,
|
|
in PRTime aExpiration);
|
|
|
|
/**
|
|
* Retrieves the given favicon data. Throws if we don't have data.
|
|
*
|
|
* If there is no data but we have an entry for this favicon, aDataLen will
|
|
* be 0 and aData will be NULL.
|
|
*
|
|
* @param aFaviconURI
|
|
* URI of the favicon whose data is being read
|
|
* @param aData
|
|
* Output parameter where the binary favicon data will be placed.
|
|
* This will be null if we have this URI but have no data associated
|
|
* with it.
|
|
* @param aDataLen
|
|
* Output parameter where the size of the binary data will be placed.
|
|
* @param aMimeType
|
|
* Output parameter where the MIME type will be placed.
|
|
* @throws NS_ERROR_NOT_AVAILABLE
|
|
* Thrown when we have never heard of this favicon URI.
|
|
*/
|
|
void getFaviconData(in nsIURI aFaviconURI,
|
|
out AUTF8String aMimeType,
|
|
[optional] out unsigned long aDataLen,
|
|
[array,retval,size_is(aDataLen)] out octet aData);
|
|
|
|
/**
|
|
* Same as getFaviconData, but returns data as a string containing a data url.
|
|
*
|
|
* @see getFaviconData
|
|
*
|
|
* @param aFaviconURI
|
|
* URI of the favicon whose data is being read
|
|
* @return A data URL containing the data of the favicon. This will be
|
|
* null if we have this URL but have no data associated with it.
|
|
* @throws NS_ERROR_NOT_AVAILABLE
|
|
* Thrown when we have never heard of this favicon URL.
|
|
*/
|
|
AString getFaviconDataAsDataURL(in nsIURI aFaviconURI);
|
|
|
|
/**
|
|
* Retrieves the URI of the favicon for the given page.
|
|
*
|
|
* @param aPageURI
|
|
* URI of the page whose favicon is desired
|
|
* @return The URI of the favicon associated with that page. Returning a
|
|
* URI here does NOT mean that we have data for this favicon, only
|
|
* that we know what the favicon should be.
|
|
* @throws NS_ERROR_NOT_AVAILABLE
|
|
* When the page is not found or it has no favicon.
|
|
*/
|
|
nsIURI getFaviconForPage(in nsIURI aPageURI);
|
|
|
|
/**
|
|
* Same as getFaviconLinkForIcon but this adds an extra level of indirection,
|
|
* looking up the favicon based on the page URI and using the default if not
|
|
* found.
|
|
*
|
|
* @see getFaviconLinkForIcon
|
|
*
|
|
* @param aPageURI
|
|
* URI of the page whose favicon is desired
|
|
* @return A URI that will give you the icon image. This is NOT the URI of
|
|
* the icon as set on the page, but a URI that will give you the
|
|
* data out of the favicon service. For a normal page with a
|
|
* favicon we've stored, this will be an annotation URI which will
|
|
* then cause the corresponding favicon data to be loaded async from
|
|
* this service. For pages where we don't have a favicon, this will
|
|
* be a chrome URI of the default icon. For chrome URIs, the
|
|
* output will be the same as the input.
|
|
*/
|
|
nsIURI getFaviconImageForPage(in nsIURI aPageURI);
|
|
|
|
/**
|
|
* For a given icon URI, this will return a URI that will result in the image.
|
|
* In most cases, this is an annotation URI. For chrome URIs, this will do
|
|
* nothing but returning the input URI.
|
|
*
|
|
* No validity checking is done. If you pass an icon URI that we've never
|
|
* seen, you'll get back a URI that references an invalid icon. The moz-anno
|
|
* protocol handler's special case for "favicon" annotations will resolve
|
|
* invalid icons to the default icon, although without caching.
|
|
* For invalid chrome URIs, you'll get a broken image.
|
|
*
|
|
* @param aFaviconURI
|
|
* The URI of an icon in the favicon service.
|
|
* @return A URI that will give you the icon image. This is NOT the URI of
|
|
* the icon as set on the page, but a URI that will give you the
|
|
* data out of the favicon service. For a normal page with a
|
|
* favicon we've stored, this will be an annotation URI which will
|
|
* then cause the corresponding favicon data to be loaded async from
|
|
* this service. For pages where we don't have a favicon, this will
|
|
* be a chrome URI of the default icon. For chrome URIs, the
|
|
* output will be the same as the input.
|
|
*/
|
|
nsIURI getFaviconLinkForIcon(in nsIURI aFaviconURI);
|
|
|
|
/**
|
|
* Expire all known favicons from the database.
|
|
*
|
|
* @note This is an async method.
|
|
* On successful completion a "places-favicons-expired" notification is
|
|
* dispatched through observer's service.
|
|
*/
|
|
void expireAllFavicons();
|
|
|
|
/**
|
|
* Adds a given favicon's URI to the failed favicon cache.
|
|
*
|
|
* The lifespan of the favicon cache is up to the caching system. This cache
|
|
* will also be written when setAndLoadFaviconForPage hits an error while
|
|
* fetching an icon.
|
|
*
|
|
* @param aFaviconURI
|
|
* The URI of an icon in the favicon service.
|
|
*/
|
|
void addFailedFavicon(in nsIURI aFaviconURI);
|
|
|
|
/**
|
|
* Removes the given favicon from the failed favicon cache. If the icon is
|
|
* not in the cache, it will silently succeed.
|
|
*
|
|
* @param aFaviconURI
|
|
* The URI of an icon in the favicon service.
|
|
*/
|
|
void removeFailedFavicon(in nsIURI aFaviconURI);
|
|
|
|
/**
|
|
* Checks to see if a favicon is in the failed favicon cache.
|
|
* A positive return value means the icon is in the failed cache and you
|
|
* probably shouldn't try to load it. A false return value means that it's
|
|
* worth trying to load it.
|
|
* This allows you to avoid trying to load "foo.com/favicon.ico" for every
|
|
* page on a site that doesn't have a favicon.
|
|
*
|
|
* @param aFaviconURI
|
|
* The URI of an icon in the favicon service.
|
|
*/
|
|
boolean isFailedFavicon(in nsIURI aFaviconURI);
|
|
|
|
/**
|
|
* The default favicon URI
|
|
*/
|
|
readonly attribute nsIURI defaultFavicon;
|
|
};
|
|
|
|
[scriptable, function, uuid(c85e5c82-b70f-4621-9528-beb2aa47fb44)]
|
|
interface nsIFaviconDataCallback : nsISupports
|
|
{
|
|
/**
|
|
* Called when the required favicon's information is available.
|
|
*
|
|
* It's up to the invoking method to state if the callback is always invoked,
|
|
* or called on success only. Check the method documentation to ensure that.
|
|
*
|
|
* The caller will receive the most information we can gather on the icon,
|
|
* but it's not guaranteed that all of them will be set. For some method
|
|
* we could not know the favicon's data (it could just be too expensive to
|
|
* get it, or the method does not require we actually have any data).
|
|
* It's up to the caller to check aDataLen > 0 before using any data-related
|
|
* information like mime-type or data itself.
|
|
*
|
|
* @param aFaviconURI
|
|
* Receives the "favicon URI" (not the "favicon link URI") associated
|
|
* to the requested page. This can be null if there is no associated
|
|
* favicon URI, or the callback is notifying a failure.
|
|
* @param aDataLen
|
|
* Size of the icon data in bytes. Notice that a value of 0 does not
|
|
* necessarily mean that we don't have an icon.
|
|
* @param aData
|
|
* Icon data, or an empty array if aDataLen is 0.
|
|
* @param aMimeType
|
|
* Mime type of the icon, or an empty string if aDataLen is 0.
|
|
*
|
|
* @note If you want to open a network channel to access the favicon, it's
|
|
* recommended that you call the getFaviconLinkForIcon method to convert
|
|
* the "favicon URI" into a "favicon link URI".
|
|
*/
|
|
void onComplete(in nsIURI aFaviconURI,
|
|
in unsigned long aDataLen,
|
|
[const,array,size_is(aDataLen)] in octet aData,
|
|
in AUTF8String aMimeType);
|
|
};
|
|
|
|
%{C++
|
|
|
|
/**
|
|
* Notification sent when all favicons are expired.
|
|
*/
|
|
#define NS_PLACES_FAVICONS_EXPIRED_TOPIC_ID "places-favicons-expired"
|
|
#define FAVICON_DEFAULT_URL "chrome://mozapps/skin/places/defaultFavicon.png"
|
|
#define FAVICON_ERRORPAGE_URL "chrome://global/skin/icons/warning-16.png"
|
|
|
|
%}
|