The Tor Browser: toolkit/components/places/AsyncFaviconHelpers.h@6474c204b198 (annotated)

toolkit/components/places/AsyncFaviconHelpers.h@6474c204b198 (annotated)

toolkit/components/places/AsyncFaviconHelpers.h

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  * vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
  * 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/. */
 #ifndef AsyncFaviconHelpers_h_
 #define AsyncFaviconHelpers_h_
 #include "nsIFaviconService.h"
 #include "nsIChannelEventSink.h"
 #include "nsIInterfaceRequestor.h"
 #include "nsIStreamListener.h"
 #include "nsThreadUtils.h"
 #include "Database.h"
 #include "mozilla/storage.h"
 #define ICON_STATUS_UNKNOWN 0
 #define ICON_STATUS_CHANGED 1 << 0
 #define ICON_STATUS_SAVED 1 << 1
 #define ICON_STATUS_ASSOCIATED 1 << 2
 #define ICON_STATUS_CACHED 1 << 3
 #define TO_CHARBUFFER(_buffer) \
   reinterpret_cast<char*>(const_cast<uint8_t*>(_buffer))
 #define TO_INTBUFFER(_string) \
   reinterpret_cast<uint8_t*>(const_cast<char*>(_string.get()))
 /**
  * The maximum time we will keep a favicon around.  We always ask the cache, if
  * we can, but default to this value if we do not get a time back, or the time
  * is more in the future than this.
  * Currently set to one week from now.
  */
 #define MAX_FAVICON_EXPIRATION ((PRTime)7 * 24 * 60 * 60 * PR_USEC_PER_SEC)
 namespace mozilla {
 namespace places {
 /**
  * Indicates when a icon should be fetched from network.
  */
 enum AsyncFaviconFetchMode {
   FETCH_NEVER = 0
 , FETCH_IF_MISSING
 , FETCH_ALWAYS
 };
 /**
  * Data cache for a icon entry.
  */
 struct IconData
 {
   IconData()
   : id(0)
   , expiration(0)
   , fetchMode(FETCH_NEVER)
   , status(ICON_STATUS_UNKNOWN)
   {
     guid.SetIsVoid(true);
   }
   int64_t id;
   nsCString spec;
   nsCString data;
   nsCString mimeType;
   PRTime expiration;
   enum AsyncFaviconFetchMode fetchMode;
   uint16_t status; // This is a bitset, see ICON_STATUS_* defines above.
   nsCString guid;
 };
 /**
  * Data cache for a page entry.
  */
 struct PageData
 {
   PageData()
   : id(0)
   , canAddToHistory(true)
   , iconId(0)
   {
     guid.SetIsVoid(true);
   }
   int64_t id;
   nsCString spec;
   nsCString bookmarkedSpec;
   nsString revHost;
   bool canAddToHistory; // False for disabled history and unsupported schemas.
   int64_t iconId;
   nsCString guid;
 };
 /**
  * Base class for events declared in this file.  This class's main purpose is
  * to declare a destructor which releases mCallback on the main thread.
  */
 class AsyncFaviconHelperBase : public nsRunnable
 {
 protected:
   AsyncFaviconHelperBase(nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~AsyncFaviconHelperBase();
   nsRefPtr<Database> mDB;
   // Strong reference since we are responsible for its existence.
   nsCOMPtr<nsIFaviconDataCallback> mCallback;
 };
 /**
  * Async fetches icon from database or network, associates it with the required
  * page and finally notifies the change.
  */
 class AsyncFetchAndSetIconForPage : public AsyncFaviconHelperBase
 {
 public:
   NS_DECL_NSIRUNNABLE
   /**
    * Creates the event and dispatches it to the async thread.
    *
    * @param aFaviconURI
    *        URI of the icon to be fetched and associated.
    * @param aPageURI
    *        URI of the page to which associate the icon.
    * @param aFetchMode
    *        Specifies whether a icon should be fetched from network if not found
    *        in the database.
    * @param aCallback
    *        Function to be called when the fetch-and-associate process finishes.
    */
   static nsresult start(nsIURI* aFaviconURI,
                         nsIURI* aPageURI,
                         enum AsyncFaviconFetchMode aFetchMode,
                         uint32_t aFaviconLoadType,
                         nsIFaviconDataCallback* aCallback);
   /**
    * Constructor.
    *
    * @param aIcon
    *        Icon to be fetched and associated.
    * @param aPage
    *        Page to which associate the icon.
    * @param aCallback
    *        Function to be called when the fetch-and-associate process finishes.
    */
   AsyncFetchAndSetIconForPage(IconData& aIcon,
                               PageData& aPage,
                               uint32_t aFaviconLoadType,
                               nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~AsyncFetchAndSetIconForPage();
 protected:
   IconData mIcon;
   PageData mPage;
   const bool mFaviconLoadPrivate;
 };
 /**
  * If needed will asynchronously fetch the icon from the network.  It will
  * finally dispatch an event to the async thread to associate the icon with
  * the required page.
  */
 class AsyncFetchAndSetIconFromNetwork : public AsyncFaviconHelperBase
                                       , public nsIStreamListener
                                       , public nsIInterfaceRequestor
                                       , public nsIChannelEventSink
 {
 public:
   NS_DECL_NSISTREAMLISTENER
   NS_DECL_NSIINTERFACEREQUESTOR
   NS_DECL_NSICHANNELEVENTSINK
   NS_DECL_NSIREQUESTOBSERVER
   NS_DECL_NSIRUNNABLE
   NS_DECL_ISUPPORTS_INHERITED
   /**
    * Constructor.
    *
    * @param aIcon
    *        Icon to be fetched and associated.
    * @param aPage
    *        Page to which associate the icon.
    * @param aCallback
    *        Function to be called when the fetch-and-associate process finishes.
    */
   AsyncFetchAndSetIconFromNetwork(IconData& aIcon,
                                   PageData& aPage,
                                   bool aFaviconLoadPrivate,
                                   nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~AsyncFetchAndSetIconFromNetwork();
 protected:
   IconData mIcon;
   PageData mPage;
   const bool mFaviconLoadPrivate;
 };
 /**
  * Associates the icon to the required page, finally dispatches an event to the
  * main thread to notify the change to observers.
  */
 class AsyncAssociateIconToPage : public AsyncFaviconHelperBase
 {
 public:
   NS_DECL_NSIRUNNABLE
   /**
    * Constructor.
    *
    * @param aIcon
    *        Icon to be associated.
    * @param aPage
    *        Page to which associate the icon.
    * @param aCallback
    *        Function to be called when the associate process finishes.
    */
   AsyncAssociateIconToPage(IconData& aIcon,
                            PageData& aPage,
                            nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~AsyncAssociateIconToPage();
 protected:
   IconData mIcon;
   PageData mPage;
 };
 /**
  * Asynchronously tries to get the URL of a page's favicon, then notifies the
  * given observer.
  */
 class AsyncGetFaviconURLForPage : public AsyncFaviconHelperBase
 {
 public:
   NS_DECL_NSIRUNNABLE
   /**
    * Creates the event and dispatches it to the I/O thread.
    *
    * @param aPageURI
    *        URL of the page whose favicon's URL we're fetching
    * @param aCallback
    *        function to be called once finished
    */
   static nsresult start(nsIURI* aPageURI,
                         nsIFaviconDataCallback* aCallback);
   /**
    * Constructor.
    *
    * @param aPageSpec
    *        URL of the page whose favicon's URL we're fetching
    * @param aCallback
    *        function to be called once finished
    */
   AsyncGetFaviconURLForPage(const nsACString& aPageSpec,
                             nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~AsyncGetFaviconURLForPage();
 private:
   nsCString mPageSpec;
 };
 /**
  * Asynchronously tries to get the URL and data of a page's favicon, then
  * notifies the given observer.
  */
 class AsyncGetFaviconDataForPage : public AsyncFaviconHelperBase
 {
 public:
   NS_DECL_NSIRUNNABLE
   /**
    * Creates the event and dispatches it to the I/O thread.
    *
    * @param aPageURI
    *        URL of the page whose favicon URL and data we're fetching
    * @param aCallback
    *        function to be called once finished
    */
   static nsresult start(nsIURI* aPageURI,
                         nsIFaviconDataCallback* aCallback);
   /**
    * Constructor.
    *
    * @param aPageSpec
    *        URL of the page whose favicon URL and data we're fetching
    * @param aCallback
    *        function to be called once finished
    */
   AsyncGetFaviconDataForPage(const nsACString& aPageSpec,
                              nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~AsyncGetFaviconDataForPage();
 private:
   nsCString mPageSpec;
 };
 class AsyncReplaceFaviconData : public AsyncFaviconHelperBase
 {
 public:
   NS_DECL_NSIRUNNABLE
   static nsresult start(IconData *aIcon);
   AsyncReplaceFaviconData(IconData &aIcon,
                           nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~AsyncReplaceFaviconData();
 protected:
   IconData mIcon;
 };
 class RemoveIconDataCacheEntry : public AsyncFaviconHelperBase
 {
 public:
   NS_DECL_NSIRUNNABLE
   RemoveIconDataCacheEntry(IconData &aIcon,
                            nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~RemoveIconDataCacheEntry();
 protected:
   IconData mIcon;
 };
 /**
  * Notifies the icon change to favicon observers.
  */
 class NotifyIconObservers : public AsyncFaviconHelperBase
 {
 public:
   NS_DECL_NSIRUNNABLE
   /**
    * Constructor.
    *
    * @param aIcon
    *        Icon information. Can be empty if no icon is associated to the page.
    * @param aPage
    *        Page to which the icon information applies.
    * @param aCallback
    *        Function to be notified in all cases.
    */
   NotifyIconObservers(IconData& aIcon,
                       PageData& aPage,
                       nsCOMPtr<nsIFaviconDataCallback>& aCallback);
   virtual ~NotifyIconObservers();
 protected:
   IconData mIcon;
   PageData mPage;
   void SendGlobalNotifications(nsIURI* aIconURI);
 };
 } // namespace places
 } // namespace mozilla
 #endif // AsyncFaviconHelpers_h_

The Tor Browser / annotate

toolkit/components/places/AsyncFaviconHelpers.h@6474c204b198 (annotated)

toolkit/components/places/AsyncFaviconHelpers.h