Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-29 15:52:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 553489 - Part1: new callback interface and better idl docs. r=sdwilsh sr=vlad

Browse Source
This commit is contained in:
Marco Bonardo 2010-03-25 12:34:28 +01:00
parent 98dd63c4e4
commit 327f0a143c
2 changed files with 142 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

229
toolkit/components/places/public/nsIFaviconService.idl
View File

@ -21,6 +21,7 @@
*
* Contributor(s):
* Brett Wilson <brettw@gmail.com>
* Marco Bonardo <mak77@bonardo.net>
*
* 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
@ -39,6 +40,7 @@
#include "nsISupports.idl"
interface nsIURI;
interface nsIFaviconDataCallback;
[scriptable, uuid(66f6b992-e2d3-43da-ba2a-d966e34a7654)]
interface nsIFaviconService : nsISupports
@ -46,47 +48,44 @@ interface nsIFaviconService : nsISupports
/**
* Declares that a given page uses a favicon with the given URI.
*
* You needn't have specified any data at this point. An entry linking the
* favicon with the page will be create with no data. You can populate it
* later with SetFaviconData. However, any favicons not associated with a
* visited web page, a bookmark, or a "place:" URI will be expired when
* history cleanup is done * (typically at app shutdown, but also possibly
* if the user clears their * cache or history).
* Will create an entry linking the favicon URI to the page, regardless
* the fact we have data for that icon. You can populate it later with
* SetFaviconData. However, remember that any favicons not associated with a
* visited web page, a bookmark, or a "place:" URI, will be removed during
* expiration runs.
*
* This will send out history notifications if the new favicon has any data.
* This means that you should try to set data first if you have it, otherwise
* the page might not get a notification sent for it since data setting does
* not send notifications.
* 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.
*/
void setFaviconUrlForPage(in nsIURI aPageURI, in nsIURI aFaviconURI);
void setFaviconUrlForPage(in nsIURI aPageURI,
in nsIURI aFaviconURI);
/**
* Same as SetFaviconUrlForPage except that this also attempts to set the
* data by loading the favicon URI. An async request will be created for
* this URI and if the data is available, it will asynchronously get
* saved in the database without any further work from the caller.
* 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 from the net (or more likely the cache). 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 remove the favicon from the failed
* cache. If it then fails again, it will be re-added to the failed cache.
* 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.
*
* SetFaviconUrlForPage and SetFaviconData will take any URI you provide
* and save it. This function is intended for automatic usage, and will
* only save favicons for "good" URIs, as defined by what gets added to
* history. For "bad" URIs, this function will succeed and do nothing.
* This function will also ignore the error page favicon URI
* (chrome://global/skin/icons/warning-16.png). Icons that fail to load
* will automatically be added to the failed favicon cache.
* 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 (expiration time is 0 days). The rest of the functions
* history is disabled. The rest of the functions
* here will always store favicons even when history is disabled.
*
* @param aPageURI
@ -98,42 +97,36 @@ interface nsIFaviconService : nsISupports
* if we don't have it or if it has expired from the cache. If set,
* it will always try to reload the favicon.
*/
void setAndLoadFaviconForPage(in nsIURI aPageURI, in nsIURI aFaviconURI,
void setAndLoadFaviconForPage(in nsIURI aPageURI,
in nsIURI aFaviconURI,
in boolean aForceReload);
/**
* Stores the data of a given favicon. You must specify the MIME type
* unless you're clearing the data.
* 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 cleanup is done. This might
* be done at any time on a timer, so you should not let the message loop
* run between calls or your icon may get deleted.
* 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.
* This will make the notifications more efficient since the icon will
* already have data when the set favicon observer messages goes out.
* 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.
*
* The expiration time is stored. This will be used if you call
* SetAndLoadFaviconForPage to see whether the data needs reloading.
*
* Do not use this function for chrome: icon URIs. You should reference the
* chrome image yourself. The GetFaviconLinkForIcon/Page will ignore any
* associated data if the favicon URI is "chrome:" and just return the same
* chrome URI.
* 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.
* Potentially, many pages could be referencing the favicon and they could
* be visible in a history view or toolbar. But sending out those
* notifications is very intensive. Those pages will keep the old icon
* until they have been refreshed by other means.
* 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 defined limit we will try to convert it to a 16x16 png image. If the
* conversion fails and favicon is bigger than our max accepted favicon size
* we will fail and the favicon won't be saved.
* 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.
@ -143,7 +136,8 @@ interface nsIFaviconService : nsISupports
* 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.
* 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.
@ -152,18 +146,14 @@ interface nsIFaviconService : nsISupports
*/
void setFaviconData(in nsIURI aFaviconURI,
[const,array,size_is(aDataLen)] in octet aData,
in unsigned long aDataLen, in AUTF8String aMimeType,
in unsigned long aDataLen,
in AUTF8String aMimeType,
in PRTime aExpiration);
/**
* Stores the data of a given favicon. The data is provided by a string
* Same as setFaviconData but the data is provided by a string
* containing a data URL.
*
* This function tries to optimize the favicon size, if it is bigger
* than defined limit we will try to convert it to a 16x16 png image. If the
* conversion fails and favicon is bigger than our max accepted favicon size
* we will fail and the favicon won't be saved.
*
* @see setFaviconData
*
* @param aFaviconURI
@ -177,7 +167,8 @@ interface nsIFaviconService : nsISupports
* @throws NS_ERROR_FAILURE
* Thrown if the favicon is overbloated and won't be saved to the db.
*/
void setFaviconDataFromDataURL(in nsIURI aFaviconURI, in AString aDataURL,
void setFaviconDataFromDataURL(in nsIURI aFaviconURI,
in AString aDataURL,
in PRTime aExpiration);
/**
@ -205,17 +196,13 @@ interface nsIFaviconService : nsISupports
[array,retval,size_is(aDataLen)] out octet aData);
/**
* Retrieves the given favicon data as a data URL. Throws if we don't
* have data.
*
* If there is no data but we have an entry for this favicon, the return
* value will be NULL.
* 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
* @returns A data URL containing the data of the favicon. This will be
* @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.
@ -227,7 +214,7 @@ interface nsIFaviconService : nsISupports
*
* @param aPageURI
* URI of the page whose favicon is desired
* @returns The URI of the favicon associated with that page. Returning a
* @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
@ -236,49 +223,46 @@ interface nsIFaviconService : nsISupports
nsIURI getFaviconForPage(in nsIURI aPageURI);
/**
* For a given page, this will give you a URI that, when displayed in chrome,
* will result in the given page's favicon. Unlike the other get functions,
* we needn't have heard of the page or its favicon: the default one will
* be returned in this case.
* 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
* This function only adds the extra level of indirection, looking up
* the favicon based on the page URI and using the default if not found.
*
* @param aPageURI
* URI of the page whose favicon is desired
* @returns A URI that will give you the icon image. This is NOT the URI of
* @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 from this
* service. For pages where we don't have a favicon, this will be a
* chrome URI of the default icon for a web page.
* 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, this will do nothing
* and return the input URI.
* 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.
* @returns A URI that will load the desired icon. 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 from this
* service. For pages where we don't have a favicon, this will be a
* chrome URI of the default icon for a web page. For chrome, the
* @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.
*
* 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 detect most invalid icons and it will resolve to
* the default icon, although without caching. For invalid chrome
* URIs, you'll get a broken image.
*/
nsIURI getFaviconLinkForIcon(in nsIURI aFaviconURI);
@ -295,25 +279,33 @@ interface nsIFaviconService : nsISupports
* 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 to if you use setAndLoadFaviconForPage and it
* encounters an error.
* will also be written when setAndLoadFaviconForPage hits an error while
* fetching an icon.
*
* @see isFailedFavicon
* @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, this function will silently succeed.
* 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 this favicon is in the failed favicon cache. Returns true
* if the favicon is in the failed cache, meaning you probably shouldn't try
* to load it. A false return value means that it's worth trying to load it.
* 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);
@ -323,11 +315,48 @@ interface nsIFaviconService : nsISupports
readonly attribute nsIURI defaultFavicon;
};
[scriptable, function, uuid(22ebd780-f4ab-11de-8a39-0800200c9a66)]
interface nsIFaviconDataCallback : nsISupports
{
/**
* Called when the required favicon's information is available.
*
* This callback will be called only if the operation is successful, otherwise
* you won't get notified.
*
* 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 aURI
* Depending on caller method it could be:
* - a dataURI: has "data:" scheme, with base64 encoded icon data.
* - a faviconURI: the URI of the icon in the favicon service.
* - a faviconLinkURI: has "moz-anno" scheme, used to get data async.
* @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, null if aDataLen is 0.
* @param aMimeType
* Mime type of the icon, null if aDataLen is 0.
*/
void onFaviconDataAvailable(in nsIURI aURI,
in unsigned long aDataLen,
[const,array,size_is(aDataLen)] in octet aData,
in AUTF8String aMimeType);
};
%{C++
/**
* Notification sent when favicons are expired.
* 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"
%}

2
toolkit/components/places/src/nsFaviconService.h
View File

@ -187,6 +187,4 @@ private:
bool mShuttingDown;
};
#define FAVICON_DEFAULT_URL "chrome://mozapps/skin/places/defaultFavicon.png"
#define FAVICON_ERRORPAGE_URL "chrome://global/skin/icons/warning-16.png"
#define FAVICON_ANNOTATION_NAME "favicon"