Extract AppBannerDataFetcher into an InstallableManager.

chrome/browser/installable/installable_manager.h

+// Copyright 2016 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_BROWSER_INSTALLABLE_INSTALLABLE_MANAGER_H_
+#define CHROME_BROWSER_INSTALLABLE_INSTALLABLE_MANAGER_H_
+
+#include <map>
+#include <memory>
+#include <utility>
+#include <vector>
+
+#include "base/callback_forward.h"
+#include "base/gtest_prod_util.h"
+#include "base/macros.h"
+#include "base/memory/weak_ptr.h"
+#include "chrome/browser/installable/installable_logging.h"
+#include "content/public/browser/web_contents_observer.h"
+#include "content/public/browser/web_contents_user_data.h"
+#include "content/public/common/manifest.h"
+#include "third_party/skia/include/core/SkBitmap.h"
+#include "url/gurl.h"
+
+// This struct specifies the work to be done by the InstallableManager.
+// Data is cached and fetched in the order specified in this struct. A web app
+// manifest will always be fetched first.
+struct InstallableParams {
+  // The ideal icon size to fetch. Used only if |fetch_valid_icon| is true.
+  int ideal_icon_size_in_dp = -1;
+
+  // The minimum icon size to fetch. Used only if |fetch_valid_icon| is true.
+  int minimum_icon_size_in_dp = -1;
+
+  // Check whether the site is installable. That is, it has a manifest valid for
+  // a web app and a service worker controlling the manifest start URL and the
+  // current URL.
+  bool check_installable = false;
+
+  // Check whether there is an icon in the manifest conforming to the icon size
+  // parameters, and that the icon can be fetched and isn't an empty bitmap.
+  bool fetch_valid_icon = false;
+};
+
+// This struct is passed to an InstallableCallback when the InstallableManager
+// has finished working. Each reference is owned by InstallableManager, and
+// callers should copy any objects which they wish to use later. Non-requested
+// fields will be set to null, empty, or false.
+struct InstallableData {
+  // NO_ERROR_DETECTED if there were no issues.
+  const InstallableErrorCode error_code;
+
+  // Empty if the site has no <link rel="manifest"> tag.
+  const GURL& manifest_url;
+
+  // Empty if the site has an unparseable manifest.
+  const content::Manifest& manifest;
+
+  // Empty if no icon was requested.
+  const GURL& icon_url;
+
+  // nullptr if the most appropriate icon couldn't be determined or downloaded.
+  // The underlying icon is owned by the InstallableManager; clients must copy
+  // the bitmap if they want to to use it. If fetch_valid_icon was true and an
+  // icon could not be retrieved, the reason will be in error_code.
+  const SkBitmap* icon;
+
+  // true if the site has a service worker and a viable web app manifest. If
+  // check_installable was true and the site isn't installable, the reason will
+  // be in error_code.
+  const bool is_installable;
+};
+
+using InstallableCallback = base::Callback<void(const InstallableData&)>;
+
+// This class is responsible for fetching the resources required to check and
+// install a site.
+class InstallableManager
+    : public content::WebContentsObserver,
+      public content::WebContentsUserData<InstallableManager> {
+ public:
+  explicit InstallableManager(content::WebContents* web_contents);
+  ~InstallableManager() override;
+
+  // Returns the minimum icon size in pixels for a site to be installable.
+  // TODO(dominickn): consolidate this concept with minimum_icon_size_in_dp
+  // across all platforms.
+  static int GetMinimumIconSizeInPx();
+
+  // Get the installable data, fetching the resources specified in |params|.
+  // |callback| is invoked synchronously (i.e. no via PostTask on the UI thread
+  // when the data is ready; the synchronous execution ensures that the
+  // references |callback| receives in its InstallableData argument are valid.
+  //
+  // Calls requesting data that is already fetched will return the cached data.
+  // This method is marked virtual so clients may mock this object in tests.
+  virtual void GetData(const InstallableParams& params,
+                       const InstallableCallback& callback);
+
+ private:
+  friend class InstallableManagerUnitTest;
+  FRIEND_TEST_ALL_PREFIXES(InstallableManagerBrowserTest,
+                           ManagerBeginsInEmptyState);
+  FRIEND_TEST_ALL_PREFIXES(InstallableManagerBrowserTest, CheckWebapp);
+
+  using Task = std::pair<InstallableParams, InstallableCallback>;
+  using IconParams = std::pair<int, int>;
+
+  struct ManifestProperty;
+  struct InstallableProperty;
+  struct IconProperty;
+
+  // Returns the IconProperty matching |params|. Creates if it doesn't exist.
+  IconProperty& GetIcon(const InstallableParams& params);
+
+  // Returns true if the icon sizes in |params| matches any fetched icon. false
+  // if no icon has been requested yet or there is no match.
+  bool IsIconFetched(const InstallableParams& params) const;
+
+  // Sets the icon parameters in |params| as being fetched.
+  void SetIconFetched(const InstallableParams& params);
+
+  // Returns the error code associated with the resources requested in |params|,
+  // or NO_ERROR_DETECTED if there is no error.
+  InstallableErrorCode GetErrorCode(const InstallableParams& params);
+
+  // Gets/sets parts of particular properties. Exposed for testing.
+  InstallableErrorCode manifest_error() const;
+  InstallableErrorCode installable_error() const;
+  void set_installable_error(InstallableErrorCode error_code);
+  InstallableErrorCode icon_error(const IconParams& icon_params);
+  GURL& icon_url(const IconParams& icon_params);
+  const SkBitmap* icon(const IconParams& icon);
+
+  // Returns the WebContents to which this object is attached, or nullptr if the
+  // WebContents doesn't exist or is currently being destroyed.
+  content::WebContents* GetWebContents();
+
+  // Returns true if |params| requires no more work to be done.
+  bool IsComplete(const InstallableParams& params) const;
+
+  // Resets members to empty and removes all queued tasks.
+  // Called when navigating to a new page or if the WebContents is destroyed
+  // whilst waiting for a callback.
+  void Reset();
+
+  // Sets the fetched bit on the installable and icon subtasks.
+  // Called if no manifest (or an empty manifest) was fetched from the site.
+  void SetManifestDependentTasksComplete();
+
+  // Methods coordinating and dispatching work for the current task.
+  void RunCallback(const Task& task, InstallableErrorCode error);
+  void StartNextTask();
+  void WorkOnTask();
+
+  // Data retrieval methods.
+  void FetchManifest();
+  void OnDidGetManifest(const GURL& manifest_url,
+                        const content::Manifest& manifest);
+
+  void CheckInstallable();
+  bool IsManifestValidForWebApp(const content::Manifest& manifest);
+  void CheckServiceWorker();
+  void OnDidCheckHasServiceWorker(bool has_service_worker);
+
+  void CheckAndFetchBestIcon();
+  void OnAppIconFetched(const GURL icon_url, const SkBitmap& bitmap);
+
+  // content::WebContentsObserver overrides
+  void DidFinishNavigation(content::NavigationHandle* handle) override;
+  void WebContentsDestroyed() override;
+
+  const GURL& manifest_url() const;
+  const content::Manifest& manifest() const;
+  bool is_installable() const;
+
+  // The list of <params, callback> pairs that have come from a call to GetData.
+  std::vector<Task> tasks_;
+
+  // Installable properties cached on this object.
+  std::unique_ptr<ManifestProperty> manifest_;
+  std::unique_ptr<InstallableProperty> installable_;
+  std::map<IconParams, IconProperty> icons_;
+
+  bool is_active_;
+
+  base::WeakPtrFactory<InstallableManager> weak_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(InstallableManager);
+};
+
+#endif  // CHROME_BROWSER_INSTALLABLE_INSTALLABLE_MANAGER_H_