components/offline_pages/core/client_policy_controller.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 COMPONENTS_OFFLINE_PAGES_CORE_CLIENT_POLICY_CONTROLLER_H_
#define COMPONENTS_OFFLINE_PAGES_CORE_CLIENT_POLICY_CONTROLLER_H_

#include <map>
#include <string>
#include <vector>

#include "components/offline_pages/core/offline_page_client_policy.h"

namespace offline_pages {

// This is the class which is a singleton for offline page model
// to get client policies based on namespaces.
class ClientPolicyController {
 public:
  ClientPolicyController();
  ClientPolicyController(const ClientPolicyController&) = delete;
  ~ClientPolicyController();

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

  // Get the client policy for |name_space|.
  const OfflinePageClientPolicy& GetPolicy(const std::string& name_space) const;

  // Returns a list of all known namespaces.
  std::vector<std::string> GetAllNamespaces() const;

  // Returns whether pages for |name_space| are temporary.
  bool IsTemporary(const std::string& name_space) const;

  // Returns a list of all temporary namespaces.
  const std::vector<std::string>& GetTemporaryNamespaces() const;

  // Returns whether pages for |name_space| persistent.
  bool IsPersistent(const std::string& name_space) const;

  // Returns a list of all persistent namespaces.
  const std::vector<std::string>& GetPersistentNamespaces() const;

  // Returns whether pages for |name_space| are shown in Download UI.
  bool IsSupportedByDownload(const std::string& name_space) const;

  // Returns whether pages for |name_space| should only be opened in a
  // specifically assigned tab.
  // Note: For this restriction to work offline pages saved to this namespace
  // must have the respective tab id set to their ClientId::id field.
  bool IsRestrictedToTabFromClientId(const std::string& name_space) const;

  // Returns whether pages for |name_space| can be saved only if specific user
  // settings are properly set. See
  // FeaturePolicy::requires_specific_user_settings for details).
  bool RequiresSpecificUserSettings(const std::string& name_space) const;

  // Returns whether pages for |name_space| originate from suggested URLs and
  // are downloaded on behalf of user.
  bool IsSuggested(const std::string& name_space) const;

  // Returns whether we should allow background downloads of pages for
  // |name_space| to be converted to regular file downloads.
  bool AllowsConversionToBackgroundFileDownload(
      const std::string& name_space) const;

 private:
  // The map from name_space to a client policy. Will be generated
  // as pre-defined values for now.
  std::map<std::string, OfflinePageClientPolicy> policies_;

  std::vector<std::string> temporary_namespaces_;
  std::vector<std::string> persistent_namespaces_;
};

}  // namespace offline_pages

#endif  // COMPONENTS_OFFLINE_PAGES_CORE_CLIENT_POLICY_CONTROLLER_H_