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

#include "components/metrics/drive_metrics_provider.h"

#include "base/base_paths.h"
#include "base/check_op.h"
#include "base/files/drive_info.h"
#include "base/files/file_path.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/location.h"
#include "base/metrics/histogram_functions.h"
#include "base/path_service.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "base/threading/scoped_blocking_call.h"
#include "components/metrics/metrics_pref_names.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"

namespace metrics {

namespace {
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX)
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
// LINT.IfChange(OptionalBoolRecord)
enum class OptionalBoolRecord {
  kUnknown = 0,
  kFalse = 1,
  kTrue = 2,
  kMaxValue = kTrue,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/uma/enums.xml:OptionalBoolRecord)

void RecordTriStateMetric(const char* name, std::optional<bool> sample) {
  base::UmaHistogramEnumeration(
      name, !sample.has_value() ? OptionalBoolRecord::kUnknown
                                : (*sample ? OptionalBoolRecord::kTrue
                                           : OptionalBoolRecord::kFalse));
}
#endif
}  // namespace

DriveMetricsProvider::DriveMetricsProvider(int local_state_path_key,
                                           PrefService* local_state)
    : local_state_path_key_(local_state_path_key), local_state_(local_state) {
  CHECK(local_state_);
}

DriveMetricsProvider::~DriveMetricsProvider() = default;

void DriveMetricsProvider::ProvideSystemProfileMetrics(
    metrics::SystemProfileProto* system_profile_proto) {
  auto* hardware = system_profile_proto->mutable_hardware();
  FillDriveMetrics(metrics_.app_drive, hardware->mutable_app_drive(),
                   prefs::kMetricsAppDriveHasSeekPenalty);
  FillDriveMetrics(metrics_.user_data_drive,
                   hardware->mutable_user_data_drive(),
                   prefs::kMetricsUserDataDriveHasSeekPenalty);
}

// static
void DriveMetricsProvider::RegisterPrefs(PrefRegistrySimple* registry) {
  registry->RegisterBooleanPref(prefs::kMetricsAppDriveHasSeekPenalty, false);
  registry->RegisterBooleanPref(prefs::kMetricsUserDataDriveHasSeekPenalty,
                                false);
}

void DriveMetricsProvider::AsyncInit(base::OnceClosure done_callback) {
  base::ThreadPool::PostTaskAndReplyWithResult(
      FROM_HERE,
      {base::MayBlock(), base::TaskPriority::BEST_EFFORT,
       base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN},
      base::BindOnce(&DriveMetricsProvider::GetDriveMetricsOnBackgroundThread,
                     local_state_path_key_),
      base::BindOnce(&DriveMetricsProvider::GotDriveMetrics,
                     weak_ptr_factory_.GetWeakPtr(), std::move(done_callback)));
}

DriveMetricsProvider::SeekPenaltyResponse::SeekPenaltyResponse() = default;

// static
DriveMetricsProvider::DriveMetrics
DriveMetricsProvider::GetDriveMetricsOnBackgroundThread(
    int local_state_path_key) {
  base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
                                                base::BlockingType::WILL_BLOCK);

  DriveMetricsProvider::DriveMetrics metrics;
  QuerySeekPenalty(base::FILE_EXE, &metrics.app_drive);
  QuerySeekPenalty(local_state_path_key, &metrics.user_data_drive);
  return metrics;
}

// static
void DriveMetricsProvider::QuerySeekPenalty(
    int path_service_key,
    DriveMetricsProvider::SeekPenaltyResponse* response) {
  DCHECK(response);

  base::FilePath path;
  if (!base::PathService::Get(path_service_key, &path))
    return;

  std::optional<base::DriveInfo> drive_info = base::GetFileDriveInfo(path);
  if (drive_info.has_value()) {
    response->has_seek_penalty = drive_info->has_seek_penalty;
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC)
    response->is_removable = drive_info->is_removable;
    response->is_usb = drive_info->is_usb;
#endif
  }
}

void DriveMetricsProvider::GotDriveMetrics(
    base::OnceClosure done_callback,
    const DriveMetricsProvider::DriveMetrics& metrics) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  metrics_ = metrics;
  std::move(done_callback).Run();
}

void DriveMetricsProvider::FillDriveMetrics(
    const DriveMetricsProvider::SeekPenaltyResponse& response,
    metrics::SystemProfileProto::Hardware::Drive* drive,
    const char* pref_name) {
  if (response.has_seek_penalty.has_value()) {
    drive->set_has_seek_penalty(*response.has_seek_penalty);
    local_state_->SetBoolean(pref_name, *response.has_seek_penalty);
  } else if (local_state_->HasPrefPath(pref_name)) {
    // If the async task hasn't finished, read the value from the local state.
    drive->set_has_seek_penalty(local_state_->GetBoolean(pref_name));
  }

#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC) || BUILDFLAG(IS_LINUX)
  RecordTriStateMetric("UMA.DriveIsRemovableResult", response.is_removable);
#endif
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC)
  RecordTriStateMetric("UMA.DriveIsUSBResult", response.is_usb);
#endif
}

}  // namespace metrics