chrome/browser/profile_resetter/profile_resetter.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_PROFILE_RESETTER_PROFILE_RESETTER_H_
   6 #define CHROME_BROWSER_PROFILE_RESETTER_PROFILE_RESETTER_H_
   7
   8 #include <utility>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/callback.h"
  13 #include "base/files/file_path.h"
  14 #include "base/memory/ref_counted.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "base/strings/string16.h"
  18 #include "base/threading/non_thread_safe.h"
  19 #include "chrome/browser/browsing_data/browsing_data_remover.h"
  20 #include "chrome/browser/profile_resetter/brandcoded_default_settings.h"
  21 #include "chrome/browser/search_engines/template_url_service.h"
  22
  23 class Profile;
  24
  25 namespace base {
  26 class CancellationFlag;
  27 }
  28
  29 // This class allows resetting certain aspects of a profile to default values.
  30 // It is used in case the profile has been damaged due to malware or bad user
  31 // settings.
  32 class ProfileResetter : public base::NonThreadSafe,
  33                         public BrowsingDataRemover::Observer {
  34  public:
  35   // Flags indicating what aspects of a profile shall be reset.
  36   enum Resettable {
  37     DEFAULT_SEARCH_ENGINE = 1 << 0,
  38     HOMEPAGE = 1 << 1,
  39     CONTENT_SETTINGS = 1 << 2,
  40     COOKIES_AND_SITE_DATA = 1 << 3,
  41     EXTENSIONS = 1 << 4,
  42     STARTUP_PAGES = 1 << 5,
  43     PINNED_TABS = 1 << 6,
  44     SHORTCUTS = 1 << 7,
  45     // Update ALL if you add new values and check whether the type of
  46     // ResettableFlags needs to be enlarged.
  47     ALL = DEFAULT_SEARCH_ENGINE | HOMEPAGE | CONTENT_SETTINGS |
  48           COOKIES_AND_SITE_DATA | EXTENSIONS | STARTUP_PAGES | PINNED_TABS |
  49           SHORTCUTS
  50   };
  51
  52   // Bit vector for Resettable enum.
  53   typedef uint32 ResettableFlags;
  54
  55   COMPILE_ASSERT(sizeof(ResettableFlags) == sizeof(Resettable),
  56                  type_ResettableFlags_doesnt_match_Resettable);
  57
  58   explicit ProfileResetter(Profile* profile);
  59   virtual ~ProfileResetter();
  60
  61   // Resets |resettable_flags| and calls |callback| on the UI thread on
  62   // completion. |default_settings| allows the caller to specify some default
  63   // settings. |default_settings| shouldn't be NULL.
  64   void Reset(ResettableFlags resettable_flags,
  65              scoped_ptr<BrandcodedDefaultSettings> master_settings,
  66              const base::Closure& callback);
  67
  68   bool IsActive() const;
  69
  70  private:
  71   // Marks |resettable| as done and triggers |callback_| if all pending jobs
  72   // have completed.
  73   void MarkAsDone(Resettable resettable);
  74
  75   void ResetDefaultSearchEngine();
  76   void ResetHomepage();
  77   void ResetContentSettings();
  78   void ResetCookiesAndSiteData();
  79   void ResetExtensions();
  80   void ResetStartupPages();
  81   void ResetPinnedTabs();
  82   void ResetShortcuts();
  83
  84   // BrowsingDataRemover::Observer:
  85   virtual void OnBrowsingDataRemoverDone() OVERRIDE;
  86
  87   // Callback for when TemplateURLService has loaded.
  88   void OnTemplateURLServiceLoaded();
  89
  90   Profile* const profile_;
  91   scoped_ptr<BrandcodedDefaultSettings> master_settings_;
  92   TemplateURLService* template_url_service_;
  93
  94   // Flags of a Resetable indicating which reset operations we are still waiting
  95   // for.
  96   ResettableFlags pending_reset_flags_;
  97
  98   // Called on UI thread when reset has been completed.
  99   base::Closure callback_;
 100
 101   // If non-null it means removal is in progress. BrowsingDataRemover takes care
 102   // of deleting itself when done.
 103   BrowsingDataRemover* cookies_remover_;
 104
 105   scoped_ptr<TemplateURLService::Subscription> template_url_service_sub_;
 106
 107   base::WeakPtrFactory<ProfileResetter> weak_ptr_factory_;
 108
 109   DISALLOW_COPY_AND_ASSIGN(ProfileResetter);
 110 };
 111
 112 // Path to shortcut and command line arguments.
 113 typedef std::pair<base::FilePath, base::string16> ShortcutCommand;
 114
 115 typedef base::RefCountedData<base::CancellationFlag> SharedCancellationFlag;
 116
 117 // On Windows returns all the shortcuts which launch Chrome and corresponding
 118 // arguments. |cancel| can be passed to abort the operation earlier.
 119 // Call on FILE thread.
 120 std::vector<ShortcutCommand> GetChromeLaunchShortcuts(
 121     const scoped_refptr<SharedCancellationFlag>& cancel);
 122
 123 #endif  // CHROME_BROWSER_PROFILE_RESETTER_PROFILE_RESETTER_H_