ios/web/public/browser_state.h

// Copyright 2013 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 IOS_WEB_PUBLIC_BROWSER_STATE_H_
#define IOS_WEB_PUBLIC_BROWSER_STATE_H_

#include "base/supports_user_data.h"
#include "services/service_manager/embedder/embedded_service_info.h"

namespace base {
class FilePath;
}

namespace net {
class URLRequestContextGetter;
}

namespace service_manager {
class Connector;
}

namespace web {
class ActiveStateManager;
class CertificatePolicyCache;
class ServiceManagerConnection;
class URLDataManagerIOS;
class URLDataManagerIOSBackend;
class URLRequestChromeJob;

// This class holds the context needed for a browsing session.
// It lives on the UI thread. All these methods must only be called on the UI
// thread.
class BrowserState : public base::SupportsUserData {
 public:
  ~BrowserState() override;

  // static
  static scoped_refptr<CertificatePolicyCache> GetCertificatePolicyCache(
      BrowserState* browser_state);

  // Returns whether |browser_state| has an associated ActiveStateManager.
  // Must only be accessed from main thread.
  static bool HasActiveStateManager(BrowserState* browser_state);

  // Returns the ActiveStateManager associated with |browser_state.|
  // Lazily creates one if an ActiveStateManager is not already associated with
  // the |browser_state|. |browser_state| cannot be a nullptr.  Must be accessed
  // only from the main thread.
  static ActiveStateManager* GetActiveStateManager(BrowserState* browser_state);

  // Returns whether this BrowserState is incognito. Default is false.
  virtual bool IsOffTheRecord() const = 0;

  // Returns the path where the BrowserState data is stored.
  // Unlike Profile::GetPath(), incognito BrowserState do not share their path
  // with their original BrowserState.
  virtual base::FilePath GetStatePath() const = 0;

  // Returns the request context information associated with this
  // BrowserState.
  virtual net::URLRequestContextGetter* GetRequestContext() = 0;

  // Safely cast a base::SupportsUserData to a BrowserState. Returns nullptr
  // if |supports_user_data| is not a BrowserState.
  static BrowserState* FromSupportsUserData(
      base::SupportsUserData* supports_user_data);

  // Returns a Service User ID associated with this BrowserState. This ID is
  // not persistent across runs. See
  // services/service_manager/public/interfaces/connector.mojom. By default,
  // this user id is randomly generated when Initialize() is called.
  static const std::string& GetServiceUserIdFor(BrowserState* browser_state);

  // Returns a Connector associated with this BrowserState, which can be used
  // to connect to service instances bound as this user.
  static service_manager::Connector* GetConnectorFor(
      BrowserState* browser_state);

  // Returns a ServiceManagerConnection associated with this BrowserState,
  // which can be used to connect to service instances bound as this user.
  static ServiceManagerConnection* GetServiceManagerConnectionFor(
      BrowserState* browser_state);

  using StaticServiceMap =
      std::map<std::string, service_manager::EmbeddedServiceInfo>;

  // Registers per-browser-state services to be loaded by the Service Manager.
  virtual void RegisterServices(StaticServiceMap* services) {}

 protected:
  BrowserState();

  // Makes the Service Manager aware of this BrowserState, and assigns a user
  // ID number to it. Must be called for each BrowserState created. |path|
  // should be the same path that would be returned by GetStatePath().
  static void Initialize(BrowserState* browser_state,
                         const base::FilePath& path);

 private:
  friend class URLDataManagerIOS;
  friend class URLRequestChromeJob;

  // Returns the URLDataManagerIOSBackend instance associated with this
  // BrowserState, creating it if necessary. Should only be called on the IO
  // thread.
  // Not intended for usage outside of //web.
  URLDataManagerIOSBackend* GetURLDataManagerIOSBackendOnIOThread();

  // The URLDataManagerIOSBackend instance associated with this BrowserState.
  // Created and destroyed on the IO thread, and should be accessed only from
  // the IO thread.
  URLDataManagerIOSBackend* url_data_manager_ios_backend_;
};

}  // namespace web

#endif  // IOS_WEB_PUBLIC_BROWSER_STATE_H_