1 // Copyright (c) 2012 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.
5 // This class gathers state related to a single user profile.
7 #ifndef CHROME_BROWSER_PROFILES_PROFILE_H_
8 #define CHROME_BROWSER_PROFILES_PROFILE_H_
12 #include "base/basictypes.h"
13 #include "base/containers/hash_tables.h"
14 #include "base/logging.h"
15 #include "components/domain_reliability/clear_mode.h"
16 #include "content/public/browser/browser_context.h"
17 #include "content/public/browser/content_browser_client.h"
19 class ChromeAppCacheService;
20 class DevToolsNetworkController;
21 class ExtensionSpecialStoragePolicy;
23 class HostContentSettingsMap;
24 class PrefProxyConfigTracker;
27 class ProtocolHandlerRegistry;
31 class TabContentsProvider;
35 class SequencedTaskRunner;
39 namespace chrome_browser_net {
44 class LibCrosServiceLibraryImpl;
45 class ResetDefaultProxyConfigServiceTask;
53 class FileSystemContext;
61 class SSLConfigService;
64 namespace user_prefs {
65 class PrefRegistrySyncable;
68 // Instead of adding more members to Profile, consider creating a
70 // http://dev.chromium.org/developers/design-documents/profile-architecture
71 class Profile : public content::BrowserContext {
73 // Profile services are accessed with the following parameter. This parameter
74 // defines what the caller plans to do with the service.
75 // The caller is responsible for not performing any operation that would
76 // result in persistent implicit records while using an OffTheRecord profile.
77 // This flag allows the profile to perform an additional check.
79 // It also gives us an opportunity to perform further checks in the future. We
80 // could, for example, return an history service that only allow some specific
82 enum ServiceAccessType {
83 // The caller plans to perform a read or write that takes place as a result
84 // of the user input. Use this flag when the operation you are doing can be
85 // performed while incognito. (ex: creating a bookmark)
87 // Since EXPLICIT_ACCESS means "as a result of a user action", this request
91 // The caller plans to call a method that will permanently change some data
92 // in the profile, as part of Chrome's implicit data logging. Use this flag
93 // when you are about to perform an operation which is incompatible with the
99 // Profile services were not created due to a local error (e.g., disk full).
100 CREATE_STATUS_LOCAL_FAIL,
101 // Profile services were not created due to a remote error (e.g., network
102 // down during limited-user registration).
103 CREATE_STATUS_REMOTE_FAIL,
104 // Profile created but before initializing extensions and promo resources.
105 CREATE_STATUS_CREATED,
106 // Profile is created, extensions and promo resources are initialized.
107 CREATE_STATUS_INITIALIZED,
108 // Profile creation (supervised-user registration, generally) was canceled
110 CREATE_STATUS_CANCELED,
111 MAX_CREATE_STATUS // For histogram display.
115 CREATE_MODE_SYNCHRONOUS,
116 CREATE_MODE_ASYNCHRONOUS
120 // A normal shutdown. The user clicked exit/closed last window of the
124 // The exit was the result of the system shutting down.
131 REGULAR_PROFILE, // Login user's normal profile
132 INCOGNITO_PROFILE, // Login user's off-the-record profile
133 GUEST_PROFILE, // Guest session's profile
140 // Called when creation of the profile is finished.
141 virtual void OnProfileCreated(Profile* profile,
143 bool is_new_profile) = 0;
146 // Key used to bind profile to the widget with which it is associated.
147 static const char kProfileKey[];
152 // Profile prefs are registered as soon as the prefs are loaded for the first
154 static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
156 // Create a new profile given a path. If |create_mode| is
157 // CREATE_MODE_ASYNCHRONOUS then the profile is initialized asynchronously.
158 static Profile* CreateProfile(const base::FilePath& path,
160 CreateMode create_mode);
162 // Returns the profile corresponding to the given browser context.
163 static Profile* FromBrowserContext(content::BrowserContext* browser_context);
165 // Returns the profile corresponding to the given WebUI.
166 static Profile* FromWebUI(content::WebUI* web_ui);
168 // content::BrowserContext implementation ------------------------------------
171 virtual TestingProfile* AsTestingProfile();
173 // Returns sequenced task runner where browser context dependent I/O
174 // operations should be performed.
175 virtual scoped_refptr<base::SequencedTaskRunner> GetIOTaskRunner() = 0;
177 // Returns the name associated with this profile. This name is displayed in
178 // the browser frame.
179 virtual std::string GetProfileName() = 0;
181 // Returns the profile type.
182 virtual ProfileType GetProfileType() const = 0;
184 // Return the incognito version of this profile. The returned pointer
185 // is owned by the receiving profile. If the receiving profile is off the
186 // record, the same profile is returned.
188 // WARNING: This will create the OffTheRecord profile if it doesn't already
189 // exist. If this isn't what you want, you need to check
190 // HasOffTheRecordProfile() first.
191 virtual Profile* GetOffTheRecordProfile() = 0;
193 // Destroys the incognito profile.
194 virtual void DestroyOffTheRecordProfile() = 0;
196 // True if an incognito profile exists.
197 virtual bool HasOffTheRecordProfile() = 0;
199 // Return the original "recording" profile. This method returns this if the
200 // profile is not incognito.
201 virtual Profile* GetOriginalProfile() = 0;
203 // Returns whether the profile is supervised (see SupervisedUserService).
204 virtual bool IsSupervised() = 0;
206 // Returns a pointer to the TopSites (thumbnail manager) instance
208 virtual history::TopSites* GetTopSites() = 0;
210 // Variant of GetTopSites that doesn't force creation.
211 virtual history::TopSites* GetTopSitesWithoutCreating() = 0;
213 // Accessor. The instance is created upon first access.
214 virtual ExtensionSpecialStoragePolicy*
215 GetExtensionSpecialStoragePolicy() = 0;
217 // Retrieves a pointer to the PrefService that manages the
218 // preferences for this user profile.
219 virtual PrefService* GetPrefs() = 0;
221 // Retrieves a pointer to the PrefService that manages the preferences
222 // for OffTheRecord Profiles. This PrefService is lazily created the first
223 // time that this method is called.
224 virtual PrefService* GetOffTheRecordPrefs() = 0;
226 // Returns the main request context.
227 virtual net::URLRequestContextGetter* GetRequestContext() = 0;
229 // Returns the request context used for extension-related requests. This
230 // is only used for a separate cookie store currently.
231 virtual net::URLRequestContextGetter* GetRequestContextForExtensions() = 0;
233 // Returns the SSLConfigService for this profile.
234 virtual net::SSLConfigService* GetSSLConfigService() = 0;
236 // Returns the Hostname <-> Content settings map for this profile.
237 virtual HostContentSettingsMap* GetHostContentSettingsMap() = 0;
239 // Return whether 2 profiles are the same. 2 profiles are the same if they
240 // represent the same profile. This can happen if there is pointer equality
241 // or if one profile is the incognito version of another profile (or vice
243 virtual bool IsSameProfile(Profile* profile) = 0;
245 // Returns the time the profile was started. This is not the time the profile
246 // was created, rather it is the time the user started chrome and logged into
247 // this profile. For the single profile case, this corresponds to the time
248 // the user started chrome.
249 virtual base::Time GetStartTime() const = 0;
251 // Creates the main net::URLRequestContextGetter that will be returned by
252 // GetRequestContext(). Should only be called once per ContentBrowserClient
253 // object. This function is exposed because of the circular dependency where
254 // GetStoragePartition() is used to retrieve the request context, but creation
255 // still has to happen in the Profile so the StoragePartition calls
256 // ContextBrowserClient to call this function.
257 // TODO(ajwong): Remove once http://crbug.com/159193 is resolved.
258 virtual net::URLRequestContextGetter* CreateRequestContext(
259 content::ProtocolHandlerMap* protocol_handlers,
260 content::URLRequestInterceptorScopedVector request_interceptors) = 0;
262 // Creates the net::URLRequestContextGetter for a StoragePartition. Should
263 // only be called once per partition_path per ContentBrowserClient object.
264 // This function is exposed because the request context is retrieved from the
265 // StoragePartition, but creation still has to happen in the Profile so the
266 // StoragePartition calls ContextBrowserClient to call this function.
267 // TODO(ajwong): Remove once http://crbug.com/159193 is resolved.
268 virtual net::URLRequestContextGetter* CreateRequestContextForStoragePartition(
269 const base::FilePath& partition_path,
271 content::ProtocolHandlerMap* protocol_handlers,
272 content::URLRequestInterceptorScopedVector request_interceptors) = 0;
274 // Returns the last directory that was chosen for uploading or opening a file.
275 virtual base::FilePath last_selected_directory() = 0;
276 virtual void set_last_selected_directory(const base::FilePath& path) = 0;
278 #if defined(OS_CHROMEOS)
279 enum AppLocaleChangedVia {
280 // Caused by chrome://settings change.
281 APP_LOCALE_CHANGED_VIA_SETTINGS,
282 // Locale has been reverted via LocaleChangeGuard.
283 APP_LOCALE_CHANGED_VIA_REVERT,
284 // From login screen.
285 APP_LOCALE_CHANGED_VIA_LOGIN,
286 // From login to a public session.
287 APP_LOCALE_CHANGED_VIA_PUBLIC_SESSION_LOGIN,
289 APP_LOCALE_CHANGED_VIA_UNKNOWN
292 // Changes application locale for a profile.
293 virtual void ChangeAppLocale(
294 const std::string& locale, AppLocaleChangedVia via) = 0;
296 // Called after login.
297 virtual void OnLogin() = 0;
299 // Initializes Chrome OS's preferences.
300 virtual void InitChromeOSPreferences() = 0;
301 #endif // defined(OS_CHROMEOS)
303 // Returns the helper object that provides the proxy configuration service
304 // access to the the proxy configuration possibly defined by preferences.
305 virtual PrefProxyConfigTracker* GetProxyConfigTracker() = 0;
307 // Returns the Predictor object used for dns prefetch.
308 virtual chrome_browser_net::Predictor* GetNetworkPredictor() = 0;
310 // Returns the DevToolsNetworkController for this profile.
311 virtual DevToolsNetworkController* GetDevToolsNetworkController() = 0;
313 // Deletes all network related data since |time|. It deletes transport
314 // security state since |time| and it also deletes HttpServerProperties data.
315 // Works asynchronously, however if the |completion| callback is non-null, it
316 // will be posted on the UI thread once the removal process completes.
317 // Be aware that theoretically it is possible that |completion| will be
318 // invoked after the Profile instance has been destroyed.
319 virtual void ClearNetworkingHistorySince(base::Time time,
320 const base::Closure& completion) = 0;
322 // Returns the home page for this profile.
323 virtual GURL GetHomePage() = 0;
325 // Returns whether or not the profile was created by a version of Chrome
326 // more recent (or equal to) the one specified.
327 virtual bool WasCreatedByVersionOrLater(const std::string& version) = 0;
329 std::string GetDebugName();
331 // Returns whether it is a guest session.
332 virtual bool IsGuestSession() const;
334 // Did the user restore the last session? This is set by SessionRestore.
335 void set_restored_last_session(bool restored_last_session) {
336 restored_last_session_ = restored_last_session;
338 bool restored_last_session() const {
339 return restored_last_session_;
342 // Sets the ExitType for the profile. This may be invoked multiple times
343 // during shutdown; only the first such change (the transition from
344 // EXIT_CRASHED to one of the other values) is written to prefs, any
345 // later calls are ignored.
347 // NOTE: this is invoked internally on a normal shutdown, but is public so
348 // that it can be invoked when the user logs out/powers down (WM_ENDSESSION),
349 // or to handle backgrounding/foregrounding on mobile.
350 virtual void SetExitType(ExitType exit_type) = 0;
352 // Returns how the last session was shutdown.
353 virtual ExitType GetLastSessionExitType() = 0;
355 // Stop sending accessibility events until ResumeAccessibilityEvents().
356 // Calls to Pause nest; no events will be sent until the number of
357 // Resume calls matches the number of Pause calls received.
358 void PauseAccessibilityEvents() {
359 accessibility_pause_level_++;
362 void ResumeAccessibilityEvents() {
363 DCHECK_GT(accessibility_pause_level_, 0);
364 accessibility_pause_level_--;
367 bool ShouldSendAccessibilityEvents() {
368 return 0 == accessibility_pause_level_;
371 // Returns whether the profile is new. A profile is new if the browser has
372 // not been shut down since the profile was created.
375 // Checks whether sync is configurable by the user. Returns false if sync is
376 // disabled or controlled by configuration management.
377 bool IsSyncAccessible();
379 // Send NOTIFICATION_PROFILE_DESTROYED for this Profile, if it has not
380 // already been sent. It is necessary because most Profiles are destroyed by
381 // ProfileDestroyer, but in tests, some are not.
382 void MaybeSendDestroyedNotification();
384 // Creates an OffTheRecordProfile which points to this Profile.
385 Profile* CreateOffTheRecordProfile();
388 bool restored_last_session_;
390 // Used to prevent the notification that this Profile is destroyed from
392 bool sent_destroyed_notification_;
394 // Accessibility events will only be propagated when the pause
395 // level is zero. PauseAccessibilityEvents and ResumeAccessibilityEvents
396 // increment and decrement the level, respectively, rather than set it to
397 // true or false, so that calls can be nested.
398 int accessibility_pause_level_;
400 DISALLOW_COPY_AND_ASSIGN(Profile);
403 // The comparator for profile pointers as key in a map.
404 struct ProfileCompare {
405 bool operator()(Profile* a, Profile* b) const;
408 #if defined(COMPILER_GCC)
409 namespace BASE_HASH_NAMESPACE {
412 struct hash<Profile*> {
413 std::size_t operator()(Profile* const& p) const {
414 return reinterpret_cast<std::size_t>(p);
418 } // namespace BASE_HASH_NAMESPACE
421 #endif // CHROME_BROWSER_PROFILES_PROFILE_H_