chrome/browser/profiles/profile_statistics.h

// Copyright 2015 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 CHROME_BROWSER_PROFILES_PROFILE_STATISTICS_H_
#define CHROME_BROWSER_PROFILES_PROFILE_STATISTICS_H_

#include <string>
#include <utility>
#include <vector>
#include "base/files/file_path.h"
#include "base/task/cancelable_task_tracker.h"
#include "chrome/browser/profiles/profile.h"

namespace profiles {

// Constants for the categories in ProfileCategoryStats
extern const char kProfileStatisticsBrowsingHistory[];
extern const char kProfileStatisticsPasswords[];
extern const char kProfileStatisticsBookmarks[];
extern const char kProfileStatisticsSettings[];

// Definition of a single return value of |ProfileStatisticsCallback|. If
// |success| is false, the statistics failed to load and |count| is undefined.
// The data look like these: {"BrowsingHistory", 912, true},
// {"Passwords", 71, true}, {"Bookmarks", 120, true}, {"Settings", 200, true}
struct ProfileCategoryStat {
  std::string category;
  int count;
  bool success;
};

// Definition of the return value of |ProfileStatisticsCallback|.
using ProfileCategoryStats = std::vector<ProfileCategoryStat>;

// Definition of the callback function. Note that a copy of
// |ProfileCategoryStats| is made each time the callback is called.
using ProfileStatisticsCallback = base::Callback<void(ProfileCategoryStats)>;

// Profile Statistics ----------------------------------------------------------

// This function collects statistical information about |profile|, also returns
// the information via |callback| if |callback| is not null. The statistical
// information is also copied to ProfileInfoCache. Currently bookmarks, history,
// logins and preferences are counted. The callback function will probably be
// called more than once, so binding parameters with bind::Passed() is
// prohibited. Most of the async tasks involved in this function can be
// cancelled if |tracker| is not null.
void GatherProfileStatistics(Profile* profile,
                             const ProfileStatisticsCallback& callback,
                             base::CancelableTaskTracker* tracker);

// ProfileInfoCache ------------------------------------------------------------

// Gets statistical information from ProfileInfoCache.
ProfileCategoryStats GetProfileStatisticsFromCache(
    const base::FilePath& profile_path);

// Sets an individual statistic to ProfileInfoCache.
void SetProfileStatisticsInCache(const base::FilePath& profile_path,
                                 const std::string& category, int count);

}  // namespace profiles

#endif  // CHROME_BROWSER_PROFILES_PROFILE_STATISTICS_H_