components/manta/manta_service.h

// Copyright 2023 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_MANTA_MANTA_SERVICE_H_
#define COMPONENTS_MANTA_MANTA_SERVICE_H_

#include <memory>
#include <string>

#include "base/component_export.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/version_info/channel.h"
#include "components/keyed_service/core/keyed_service.h"

namespace signin {
class IdentityManager;
}  // namespace signin

namespace network {
class SharedURLLoaderFactory;
}  // namespace network

namespace manta {
enum class FeatureSupportStatus {
  kUnknown = -1,
  kUnsupported = 0,
  kSupported = 1
};

class AnchovyProvider;
class MahiProvider;
class OrcaProvider;
class ScannerProvider;
class SnapperProvider;
class WalrusProvider;

// The MantaService class is a KeyedService for the Chrome/ChromeOS Manta
// project. It serves two main functions:
// 1. It hands clients instances to specific providers for calling and
// interacting with google services relevant to the Manta project.
// 2. It provides utility methods for clients to query specific information
// relevant to the Manta project.
class COMPONENT_EXPORT(MANTA) MantaService : public KeyedService {
 public:
  MantaService(
      scoped_refptr<network::SharedURLLoaderFactory> shared_url_loader_factory,
      signin::IdentityManager* identity_manager,
      bool is_demo_mode,
      bool is_otr_profile,
      const std::string& chrome_version,
      version_info::Channel chrome_channel,
      const std::string& locale);

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

  ~MantaService() override;

  // Returns a unique pointer to an instance of the Providers for the
  // profile associated with the MantaService instance from which this method
  // is called.
  std::unique_ptr<AnchovyProvider> CreateAnchovyProvider();

#if BUILDFLAG(IS_CHROMEOS)
  // Virtual for testing.
  virtual std::unique_ptr<MahiProvider> CreateMahiProvider();
  virtual std::unique_ptr<WalrusProvider> CreateWalrusProvider();

  std::unique_ptr<OrcaProvider> CreateOrcaProvider();
  std::unique_ptr<ScannerProvider> CreateScannerProvider();
  virtual std::unique_ptr<SnapperProvider> CreateSnapperProvider();
#endif  // BUILDFLAG(IS_CHROMEOS)

  // Determines whether the profile for this KeyedService support Orca feature.
  FeatureSupportStatus SupportsOrca();

  // Determines whether the profile for this KeyedService can access Manta
  // features without minor restrictions.
  // If the requirements for which users can access Manta features changes, then
  // per-feature capabilities will need to be added, which will take a few weeks
  // to migrate.
  FeatureSupportStatus CanAccessMantaFeaturesWithoutMinorRestrictions();

  // KeyedService:
  void Shutdown() override;

 private:
  scoped_refptr<network::SharedURLLoaderFactory> shared_url_loader_factory_;
  raw_ptr<signin::IdentityManager> identity_manager_;

  // A particular provider needs some of these attributes as its
  // ProviderParams, e.g. FooProvider may want to use API key for requests
  // on demo mode, and doesn't need version and local info, its
  // ProviderParams is created as
  // {.use_api_key = is_demo_mode_,
  //  .chrome_version = std::string(),
  //  .chrome_channel = chrome_channel_,
  //  .locale = std::string()};
  // Fields like version, channel and locale passed to a provider can be sent to
  // the server.
  const bool is_demo_mode_;
  const bool is_otr_profile_;
  const std::string chrome_version_;
  const version_info::Channel chrome_channel_;
  const std::string locale_;
};

}  // namespace manta

#endif  // COMPONENTS_MANTA_MANTA_SERVICE_H_