chrome/browser/ash/login/screens/recommend_apps/recommend_apps_fetcher_impl.h - chromium/src - Git at Google

 // Copyright 2018 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_ASH_LOGIN_SCREENS_RECOMMEND_APPS_RECOMMEND_APPS_FETCHER_IMPL_H_
 #define CHROME_BROWSER_ASH_LOGIN_SCREENS_RECOMMEND_APPS_RECOMMEND_APPS_FETCHER_IMPL_H_

 #include <memory>
 #include <string>
 #include <vector>

 #include "ash/components/arc/arc_features_parser.h"
 #include "ash/public/mojom/cros_display_config.mojom.h"
 #include "base/callback.h"
 #include "base/memory/weak_ptr.h"
 #include "base/time/time.h"
 #include "base/timer/timer.h"
 #include "chrome/browser/ash/login/screens/recommend_apps/device_configuration.pb.h"
 #include "chrome/browser/ash/login/screens/recommend_apps/recommend_apps_fetcher.h"
 #include "extensions/browser/api/system_display/display_info_provider.h"
 #include "mojo/public/cpp/bindings/pending_remote.h"
 #include "mojo/public/cpp/bindings/remote.h"
 #include "services/data_decoder/public/cpp/data_decoder.h"

 namespace base {
 class Value;
 }

 namespace gpu {
 struct GPUInfo;
 }

 namespace network {
 namespace mojom {
 class URLLoaderFactory;
 }

 class SimpleURLLoader;
 }  // namespace network

 namespace ash {
 class RecommendAppsFetcherDelegate;

 // This class handles the network request for the Recommend Apps screen. It is
 // supposed to run on the UI thread. The request requires the following headers:
 // 1. X-Device-Config
 // 2. X-Sdk-Version
 // Play requires Android device config information to filter apps.
 // device_configuration.proto is used to encode all the info. The following
 // fields will be retrieved and sent:
 // 1. touch_screen
 // 2. keyboard
 // 3. navigation
 // 4. screen_layout
 // 5. has_hard_keyboard
 // 6. has_five_way_navigation
 // 7. screen_density
 // 8. screen_width
 // 9. screen_height
 // 10. gl_es_version
 // 11. system_available_feature
 // 12. native_platform
 // 13. gl_extension
 class RecommendAppsFetcherImpl : public RecommendAppsFetcher {
  public:
   class ScopedGpuInfoForTest {
    public:
     explicit ScopedGpuInfoForTest(const gpu::GPUInfo* gpu_info);
     ~ScopedGpuInfoForTest();
   };

   RecommendAppsFetcherImpl(
       RecommendAppsFetcherDelegate* delegate,
       mojo::PendingRemote<mojom::CrosDisplayConfigController> display_config,
       network::mojom::URLLoaderFactory* url_loader_factory);

   RecommendAppsFetcherImpl(const RecommendAppsFetcherImpl&) = delete;
   RecommendAppsFetcherImpl& operator=(const RecommendAppsFetcherImpl&) = delete;

   ~RecommendAppsFetcherImpl() override;

   // Provide a retry method to download the app list again.
   // RecommendAppsFetcher:
   void Start() override;
   void Retry() override;

   using ArcFeaturesGetter = base::RepeatingCallback<void(
       base::OnceCallback<void(absl::optional<arc::ArcFeatures> callback)>)>;
   void set_arc_features_getter_for_testing(const ArcFeaturesGetter& getter) {
     arc_features_getter_ = getter;
   }

  private:
   // Populate the required device config info.
   void PopulateDeviceConfig();

   // Start the connection to ash. Send the request to get display unit info
   // list.
   void StartAshRequest();

   // Start to compress and encode the proto message if we finish ash request
   // and ARC feature is read.
   void MaybeStartCompressAndEncodeProtoMessage();

   // Callback function called when display unit info list is retrieved from ash.
   // It will populate the device config info related to the screen density.
   void OnAshResponse(std::vector<mojom::DisplayUnitInfoPtr> all_displays_info);

   // Callback function called when ARC features are read by the parser.
   // It will populate the device config info related to ARC features.
   void OnArcFeaturesRead(absl::optional<arc::ArcFeatures> read_result);

   // Callback function called when the proto message has been compressed and
   // encoded.
   void OnProtoMessageCompressedAndEncoded(
       std::string encoded_device_configuration_proto);

   // Start downloading the recommended app list.
   void StartDownload();

   // Abort the attempt to download the recommended app list if it takes too
   // long.
   void OnDownloadTimeout();

   // Callback function called when SimpleURLLoader completes.
   void OnDownloaded(std::unique_ptr<std::string> response_body);

   // If the response is not a valid JSON, return absl::nullopt.
   // If the response contains no app, return absl::nullopt;
   // Value output, in true, is a list containing:
   // 1. name: the title of the app.
   // 2. package_name
   // 3. Possibly an Icon URL.
   // Parses an input string that looks somewhat like this:
   // [{"title_" : {"name_" : {title of app"}},
   //   "id_" : {"id_" : {com.package.name"}},
   //  "icon_": {"url_": {"privateDoNotAccessOrElseSafeUrlWrappedValue_":
   //  "http://icon_url.com/url"}}},
   //  {"title_" : "title of second app",
   //   "packageName_": "second package name.",
   //  }]
   absl::optional<base::Value> ParseResponse(const base::Value& parsed_json);

   void OnJsonParsed(data_decoder::DataDecoder::ValueOrError result);

   device_configuration::DeviceConfigurationProto device_config_;

   std::string android_sdk_version_;

   std::string play_store_version_;

   std::string encoded_device_configuration_proto_;

   bool ash_ready_ = false;
   bool arc_features_ready_ = false;
   bool has_started_proto_processing_ = false;
   bool proto_compressed_and_encoded_ = false;

   RecommendAppsFetcherDelegate* delegate_;

   network::mojom::URLLoaderFactory* url_loader_factory_;
   std::unique_ptr<network::SimpleURLLoader> app_list_loader_;

   // Timer that enforces a custom (shorter) timeout on the attempt to download
   // the recommended app list.
   base::OneShotTimer download_timer_;

   base::TimeTicks start_time_;

   ArcFeaturesGetter arc_features_getter_;

   mojo::Remote<mojom::CrosDisplayConfigController> cros_display_config_;
   base::WeakPtrFactory<RecommendAppsFetcherImpl> weak_ptr_factory_{this};
 };

 }  // namespace ash

 #endif  // CHROME_BROWSER_ASH_LOGIN_SCREENS_RECOMMEND_APPS_RECOMMEND_APPS_FETCHER_IMPL_H_
	// Copyright 2018 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_ASH_LOGIN_SCREENS_RECOMMEND_APPS_RECOMMEND_APPS_FETCHER_IMPL_H_
	#define CHROME_BROWSER_ASH_LOGIN_SCREENS_RECOMMEND_APPS_RECOMMEND_APPS_FETCHER_IMPL_H_

	#include <memory>
	#include <string>
	#include <vector>

	#include "ash/components/arc/arc_features_parser.h"
	#include "ash/public/mojom/cros_display_config.mojom.h"
	#include "base/callback.h"
	#include "base/memory/weak_ptr.h"
	#include "base/time/time.h"
	#include "base/timer/timer.h"
	#include "chrome/browser/ash/login/screens/recommend_apps/device_configuration.pb.h"
	#include "chrome/browser/ash/login/screens/recommend_apps/recommend_apps_fetcher.h"
	#include "extensions/browser/api/system_display/display_info_provider.h"
	#include "mojo/public/cpp/bindings/pending_remote.h"
	#include "mojo/public/cpp/bindings/remote.h"
	#include "services/data_decoder/public/cpp/data_decoder.h"

	namespace base {
	class Value;
	}

	namespace gpu {
	struct GPUInfo;
	}

	namespace network {
	namespace mojom {
	class URLLoaderFactory;
	}

	class SimpleURLLoader;
	} // namespace network

	namespace ash {
	class RecommendAppsFetcherDelegate;

	// This class handles the network request for the Recommend Apps screen. It is
	// supposed to run on the UI thread. The request requires the following headers:
	// 1. X-Device-Config
	// 2. X-Sdk-Version
	// Play requires Android device config information to filter apps.
	// device_configuration.proto is used to encode all the info. The following
	// fields will be retrieved and sent:
	// 1. touch_screen
	// 2. keyboard
	// 3. navigation
	// 4. screen_layout
	// 5. has_hard_keyboard
	// 6. has_five_way_navigation
	// 7. screen_density
	// 8. screen_width
	// 9. screen_height
	// 10. gl_es_version
	// 11. system_available_feature
	// 12. native_platform
	// 13. gl_extension
	class RecommendAppsFetcherImpl : public RecommendAppsFetcher {
	public:
	class ScopedGpuInfoForTest {
	public:
	explicit ScopedGpuInfoForTest(const gpu::GPUInfo* gpu_info);
	~ScopedGpuInfoForTest();
	};

	RecommendAppsFetcherImpl(
	RecommendAppsFetcherDelegate* delegate,
	mojo::PendingRemote<mojom::CrosDisplayConfigController> display_config,
	network::mojom::URLLoaderFactory* url_loader_factory);

	RecommendAppsFetcherImpl(const RecommendAppsFetcherImpl&) = delete;
	RecommendAppsFetcherImpl& operator=(const RecommendAppsFetcherImpl&) = delete;

	~RecommendAppsFetcherImpl() override;

	// Provide a retry method to download the app list again.
	// RecommendAppsFetcher:
	void Start() override;
	void Retry() override;

	using ArcFeaturesGetter = base::RepeatingCallback<void(
	base::OnceCallback<void(absl::optional<arc::ArcFeatures> callback)>)>;
	void set_arc_features_getter_for_testing(const ArcFeaturesGetter& getter) {
	arc_features_getter_ = getter;
	}

	private:
	// Populate the required device config info.
	void PopulateDeviceConfig();

	// Start the connection to ash. Send the request to get display unit info
	// list.
	void StartAshRequest();

	// Start to compress and encode the proto message if we finish ash request
	// and ARC feature is read.
	void MaybeStartCompressAndEncodeProtoMessage();

	// Callback function called when display unit info list is retrieved from ash.
	// It will populate the device config info related to the screen density.
	void OnAshResponse(std::vector<mojom::DisplayUnitInfoPtr> all_displays_info);

	// Callback function called when ARC features are read by the parser.
	// It will populate the device config info related to ARC features.
	void OnArcFeaturesRead(absl::optional<arc::ArcFeatures> read_result);

	// Callback function called when the proto message has been compressed and
	// encoded.
	void OnProtoMessageCompressedAndEncoded(
	std::string encoded_device_configuration_proto);

	// Start downloading the recommended app list.
	void StartDownload();

	// Abort the attempt to download the recommended app list if it takes too
	// long.
	void OnDownloadTimeout();

	// Callback function called when SimpleURLLoader completes.
	void OnDownloaded(std::unique_ptr<std::string> response_body);

	// If the response is not a valid JSON, return absl::nullopt.
	// If the response contains no app, return absl::nullopt;
	// Value output, in true, is a list containing:
	// 1. name: the title of the app.
	// 2. package_name
	// 3. Possibly an Icon URL.
	// Parses an input string that looks somewhat like this:
	// [{"title_" : {"name_" : {title of app"}},
	// "id_" : {"id_" : {com.package.name"}},
	// "icon_": {"url_": {"privateDoNotAccessOrElseSafeUrlWrappedValue_":
	// "http://icon_url.com/url"}}},
	// {"title_" : "title of second app",
	// "packageName_": "second package name.",
	// }]
	absl::optional<base::Value> ParseResponse(const base::Value& parsed_json);

	void OnJsonParsed(data_decoder::DataDecoder::ValueOrError result);

	device_configuration::DeviceConfigurationProto device_config_;

	std::string android_sdk_version_;

	std::string play_store_version_;

	std::string encoded_device_configuration_proto_;

	bool ash_ready_ = false;
	bool arc_features_ready_ = false;
	bool has_started_proto_processing_ = false;
	bool proto_compressed_and_encoded_ = false;

	RecommendAppsFetcherDelegate* delegate_;

	network::mojom::URLLoaderFactory* url_loader_factory_;
	std::unique_ptr<network::SimpleURLLoader> app_list_loader_;

	// Timer that enforces a custom (shorter) timeout on the attempt to download
	// the recommended app list.
	base::OneShotTimer download_timer_;

	base::TimeTicks start_time_;

	ArcFeaturesGetter arc_features_getter_;

	mojo::Remote<mojom::CrosDisplayConfigController> cros_display_config_;
	base::WeakPtrFactory<RecommendAppsFetcherImpl> weak_ptr_factory_{this};
	};

	} // namespace ash

	#endif // CHROME_BROWSER_ASH_LOGIN_SCREENS_RECOMMEND_APPS_RECOMMEND_APPS_FETCHER_IMPL_H_