chrome/browser/android/webapps/add_to_homescreen_data_fetcher.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_ANDROID_WEBAPPS_ADD_TO_HOMESCREEN_DATA_FETCHER_H_
   6 #define CHROME_BROWSER_ANDROID_WEBAPPS_ADD_TO_HOMESCREEN_DATA_FETCHER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/task/cancelable_task_tracker.h"
  10 #include "base/timer/timer.h"
  11 #include "chrome/browser/android/shortcut_info.h"
  12 #include "chrome/common/web_application_info.h"
  13 #include "components/favicon_base/favicon_types.h"
  14 #include "content/public/browser/web_contents_observer.h"
  15 #include "content/public/common/manifest.h"
  16
  17 namespace content {
  18 class WebContents;
  19 }  // namespace content
  20
  21 namespace IPC {
  22 class Message;
  23 }
  24
  25 class GURL;
  26
  27 // Aysnchronously fetches and processes data needed to create a shortcut for an
  28 // Android Home screen launcher.
  29 //
  30 // Because of the various asynchronous calls made by this class, it is
  31 // refcounted to prevent the class from being prematurely deleted.  If the
  32 // pointer to the ShortcutHelper becomes invalid, the pipeline should kill
  33 // itself.
  34 class AddToHomescreenDataFetcher
  35     : public base::RefCounted<AddToHomescreenDataFetcher>,
  36       public content::WebContentsObserver {
  37  public:
  38   class Observer {
  39    public:
  40     // Called when the title of the page is available.
  41     virtual void OnUserTitleAvailable(const base::string16& title) = 0;
  42
  43     // Converts the icon into one that can be used on the Android Home screen.
  44     virtual SkBitmap FinalizeLauncherIcon(const SkBitmap& icon,
  45                                           const GURL& url) = 0;
  46
  47     // Called when all the data needed to create a shortcut is available.
  48     virtual void OnDataAvailable(const ShortcutInfo& info,
  49                                  const SkBitmap& icon) = 0;
  50   };
  51
  52   // Initialize the fetcher by requesting the information about the page to the
  53   // renderer process. The initialization is asynchronous and
  54   // OnDidGetWebApplicationInfo is expected to be called when finished.
  55   AddToHomescreenDataFetcher(content::WebContents* web_contents,
  56                              int ideal_splash_image_size_in_dp,
  57                              int ideal_icon_size_in_dp,
  58                              Observer* observer);
  59
  60   // Called to fetch the splash screen image to be stored for the webapp with
  61   // the specified |id|.
  62   void FetchSplashScreenImage(const std::string& id);
  63
  64   // IPC message received when the initialization is finished.
  65   void OnDidGetWebApplicationInfo(const WebApplicationInfo& web_app_info);
  66
  67   // Called when the Manifest has been parsed, or if no Manifest was found.
  68   void OnDidGetManifest(const content::Manifest& manifest);
  69
  70   // Accessors, etc.
  71   void set_weak_observer(Observer* observer) { weak_observer_ = observer; }
  72   bool is_ready() { return is_ready_; }
  73   ShortcutInfo& shortcut_info() { return shortcut_info_; }
  74   const SkBitmap& shortcut_icon() { return shortcut_icon_; }
  75
  76   // WebContentsObserver
  77   bool OnMessageReceived(const IPC::Message& message) override;
  78
  79  private:
  80   ~AddToHomescreenDataFetcher() override;
  81
  82   // Grabs the favicon for the current URL.
  83   void FetchFavicon();
  84   void OnFaviconFetched(
  85       const favicon_base::FaviconRawBitmapResult& bitmap_result);
  86
  87   // Creates the launcher icon from the given bitmap.
  88   void CreateLauncherIcon(
  89       const favicon_base::FaviconRawBitmapResult& bitmap_result);
  90
  91   // Callback run after an attempt to download manifest icon has been made. May
  92   // kick off the download of a favicon if it failed (i.e. the bitmap is empty).
  93   void OnManifestIconFetched(const SkBitmap& icon);
  94
  95   // Notifies the observer that the shortcut data is all available.
  96   void NotifyObserver(const SkBitmap& icon);
  97
  98   Observer* weak_observer_;
  99
 100   bool is_waiting_for_web_application_info_;
 101   bool is_icon_saved_;
 102   bool is_ready_;
 103   base::Timer icon_timeout_timer_;
 104   ShortcutInfo shortcut_info_;
 105   GURL splash_screen_url_;
 106
 107   // The icon must only be set on the UI thread for thread safety.
 108   SkBitmap shortcut_icon_;
 109   base::CancelableTaskTracker favicon_task_tracker_;
 110
 111   const int ideal_splash_image_size_in_dp_;
 112   const int ideal_icon_size_in_dp_;
 113
 114   friend class base::RefCounted<AddToHomescreenDataFetcher>;
 115   DISALLOW_COPY_AND_ASSIGN(AddToHomescreenDataFetcher);
 116 };
 117
 118 #endif  // CHROME_BROWSER_ANDROID_WEBAPPS_ADD_TO_HOMESCREEN_DATA_FETCHER_H_