components/safety_check/safety_check.h

// Copyright 2020 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_SAFETY_CHECK_SAFETY_CHECK_H_
#define COMPONENTS_SAFETY_CHECK_SAFETY_CHECK_H_

#include "base/observer_list.h"
#include "base/observer_list_types.h"
#include "components/prefs/pref_service.h"

namespace safety_check {

// Class for performing browser safety checks common to desktop, Android, and
// iOS. Platform-specific checks, such as updates and extensions, are
// implemented in handlers.
class SafetyCheck {
 public:
  // The following enums represent the state of each component (common among
  // desktop, Android, and iOS) of the safety check and should be kept in sync
  // with the JS frontend (safety_check_browser_proxy.js) and |SafetyCheck*|
  // metrics enums in enums.xml.
  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.safety_check
  enum class PasswordsStatus {
    kChecking = 0,
    kSafe = 1,
    kCompromisedExist = 2,
    kOffline = 3,
    kNoPasswords = 4,
    kSignedOut = 5,
    kQuotaLimit = 6,
    kError = 7,
    kFeatureUnavailable = 8,
    // New enum values must go above here.
    kMaxValue = kFeatureUnavailable,
  };

  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.safety_check
  enum class SafeBrowsingStatus {
    kChecking = 0,
    kEnabled = 1,
    kDisabled = 2,
    kDisabledByAdmin = 3,
    kDisabledByExtension = 4,
    kEnabledStandard = 5,
    kEnabledEnhanced = 6,
    kEnabledStandardAvailableEnhanced = 7,
    // New enum values must go above here.
    kMaxValue = kEnabledStandardAvailableEnhanced,
  };

  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.safety_check
  enum class UpdateStatus {
    kChecking = 0,
    kUpdated = 1,
    kUpdating = 2,
    kRelaunch = 3,
    kDisabledByAdmin = 4,
    kFailedOffline = 5,
    kFailed = 6,
    // Non-Google branded browsers cannot check for updates using
    // VersionUpdater.
    kUnknown = 7,
    // Only used in Android where the user is directed to the Play Store.
    kOutdated = 8,
    // New enum values must go above here.
    kMaxValue = kOutdated,
  };

  class SafetyCheckHandlerInterface {
   public:
    virtual void OnSafeBrowsingCheckResult(SafeBrowsingStatus status) = 0;
  };

  explicit SafetyCheck(SafetyCheckHandlerInterface* handler);
  ~SafetyCheck();

  // Gets the status of Safe Browsing from the PrefService and invokes
  // OnSafeBrowsingCheckResult on each Observer with results.
  void CheckSafeBrowsing(PrefService* pref_service);

 private:
  SafetyCheckHandlerInterface* handler_;
};

}  // namespace safety_check

#endif  // COMPONENTS_SAFETY_CHECK_SAFETY_CHECK_H_