blob: e53d2acd91d569362199916f6edfe3f9be6ed3c4 [file] [log] [blame]
// Copyright (c) 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.
#include <string>
#include <utility>
#include <vector>
#include "base/basictypes.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/prefs/session_startup_pref.h"
#include "chrome/browser/profile_resetter/profile_resetter.h"
namespace base {
class ListValue;
// ResettableSettingsSnapshot captures some settings values at constructor. It
// can calculate the difference between two snapshots. That is, modified fields.
class ResettableSettingsSnapshot {
// ExtensionList is a vector of pairs. The first component is the extension
// id, the second is the name.
typedef std::vector<std::pair<std::string, std::string> > ExtensionList;
// All types of settings handled by this class.
enum Field {
STARTUP_MODE = 1 << 0,
HOMEPAGE = 1 << 1,
DSE_URL = 1 << 2,
EXTENSIONS = 1 << 3,
SHORTCUTS = 1 << 4,
explicit ResettableSettingsSnapshot(Profile* profile);
// Getters.
const std::vector<GURL>& startup_urls() const { return startup_.urls; }
SessionStartupPref::Type startup_type() const { return startup_.type; }
const std::string& homepage() const { return homepage_; }
bool homepage_is_ntp() const { return homepage_is_ntp_; }
const std::string& dse_url() const { return dse_url_; }
const ExtensionList& enabled_extensions() const {
return enabled_extensions_;
const std::vector<ShortcutCommand>& shortcuts() const {
return shortcuts_;
bool shortcuts_determined() const {
return shortcuts_determined_;
// Substitutes |enabled_extensions_| with
// |enabled_extensions_|\|snapshot.enabled_extensions_|.
void Subtract(const ResettableSettingsSnapshot& snapshot);
// For each member 'm' compares |this->m| with |snapshot.m| and sets the
// corresponding |ResetableSettingsSnapshot::Field| bit to 1 in case of
// difference.
// The return value is a bit mask of Field values signifying which members
// were different.
int FindDifferentFields(const ResettableSettingsSnapshot& snapshot) const;
// Collects the shortcuts asynchronously and calls |callback|. If the request
// has been made already, noop.
void RequestShortcuts(const base::Closure& callback);
// Fills the |shortcuts_| member and calls |callback|.
void SetShortcutsAndReport(
const base::Closure& callback,
const std::vector<ShortcutCommand>& shortcuts);
// Startup pages. URLs are always stored sorted.
SessionStartupPref startup_;
std::string homepage_;
bool homepage_is_ntp_;
// Default search engine.
std::string dse_url_;
// List of pairs [id, name] for enabled extensions. Always sorted.
ExtensionList enabled_extensions_;
// Chrome shortcuts (e.g. icons on the Windows desktop, etc.) with non-empty
// arguments.
std::vector<ShortcutCommand> shortcuts_;
// |shortcuts_| were retrieved.
bool shortcuts_determined_;
// The flag to cancel shortcuts retrieving.
scoped_refptr<SharedCancellationFlag> cancellation_flag_;
base::WeakPtrFactory<ResettableSettingsSnapshot> weak_ptr_factory_;
// The caller of ResettableSettingsSnapshot.
enum SnapshotCaller {
// Serializes specified |snapshot| members to JSON format. |field_mask| is a bit
// mask of ResettableSettingsSnapshot::Field values.
std::string SerializeSettingsReport(const ResettableSettingsSnapshot& snapshot,
int field_mask);
// Sends |report| as a feedback. |report| is supposed to be result of
// SerializeSettingsReport().
void SendSettingsFeedback(const std::string& report,
Profile* profile,
SnapshotCaller caller);
// Returns list of key/value pairs for all available reported information
// from the |profile| and some additional fields.
scoped_ptr<base::ListValue> GetReadableFeedbackForSnapshot(
Profile* profile,
const ResettableSettingsSnapshot& snapshot);