components/image_service/image_service.h

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_IMAGE_SERVICE_IMAGE_SERVICE_H_
#define COMPONENTS_IMAGE_SERVICE_IMAGE_SERVICE_H_

#include <memory>
#include <string>

#include "base/component_export.h"
#include "base/functional/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "components/history/core/browser/history_types.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/omnibox/browser/autocomplete_provider_client.h"
#include "components/sync/driver/sync_service.h"
#include "components/unified_consent/url_keyed_data_collection_consent_helper.h"

namespace image_service {

// Used to get the image URL associated with a cluster. It doesn't actually
// fetch the image, that's up to the UI to do.
class COMPONENT_EXPORT(IMAGE_SERVICE) ImageService : public KeyedService {
 public:
  using ResultCallback = base::OnceCallback<void(const GURL& image_url)>;

  ImageService(
      std::unique_ptr<AutocompleteProviderClient> autocomplete_provider_client,
      syncer::SyncService* sync_service);
  ImageService(const ImageService&) = delete;
  ImageService& operator=(const ImageService&) = delete;

  ~ImageService() override;

  // Gets a weak pointer to this service. Used when UIs want to create an
  // object whose lifetime might exceed the service.
  base::WeakPtr<ImageService> GetWeakPtr();

  // Populates entity images into the `image_url` of any eligible visits within
  // every cluster in `clusters`. `clusters` should be moved into the parameter.
  // `callback` is called when we're done, and it can be called synchronously
  // if there's nothing to do.
  void PopulateEntityImagesFor(
      std::vector<history::Cluster> clusters,
      base::OnceCallback<void(std::vector<history::Cluster>)> callback);

  // Fetches an image appropriate for `search_query` and `entity_id`, returning
  // the result asynchronously to `callback`. Returns false if we can't do it
  // for configuration or privacy reasons.
  bool FetchImageFor(const std::u16string& search_query,
                     const std::string& entity_id,
                     ResultCallback callback);

 private:
  class SuggestEntityImageURLFetcher;

  // Callback for `FetchImageFor`.
  void OnImageFetched(std::unique_ptr<SuggestEntityImageURLFetcher> fetcher,
                      ResultCallback callback,
                      const GURL& image_url);

  std::unique_ptr<AutocompleteProviderClient> autocomplete_provider_client_;
  std::unique_ptr<unified_consent::UrlKeyedDataCollectionConsentHelper>
      url_consent_helper_;

  base::WeakPtrFactory<ImageService> weak_factory_{this};
};

}  // namespace image_service

#endif  // COMPONENTS_IMAGE_SERVICE_IMAGE_SERVICE_H_