OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CONTENT_PUBLIC_BROWSER_BROWSER_CONTEXT_H_ | 5 #ifndef CONTENT_PUBLIC_BROWSER_BROWSER_CONTEXT_H_ |
6 #define CONTENT_PUBLIC_BROWSER_BROWSER_CONTEXT_H_ | 6 #define CONTENT_PUBLIC_BROWSER_BROWSER_CONTEXT_H_ |
7 | 7 |
8 #include "base/callback_forward.h" | 8 #include "base/callback_forward.h" |
9 #include "base/containers/hash_tables.h" | 9 #include "base/containers/hash_tables.h" |
10 #include "base/memory/scoped_ptr.h" | 10 #include "base/memory/scoped_ptr.h" |
(...skipping 20 matching lines...) Expand all Loading... |
31 | 31 |
32 namespace content { | 32 namespace content { |
33 | 33 |
34 class DownloadManager; | 34 class DownloadManager; |
35 class DownloadManagerDelegate; | 35 class DownloadManagerDelegate; |
36 class GeolocationPermissionContext; | 36 class GeolocationPermissionContext; |
37 class IndexedDBContext; | 37 class IndexedDBContext; |
38 class ResourceContext; | 38 class ResourceContext; |
39 class SiteInstance; | 39 class SiteInstance; |
40 class StoragePartition; | 40 class StoragePartition; |
| 41 struct CookieStoreConfig; |
41 | 42 |
42 // This class holds the context needed for a browsing session. | 43 // This class holds the context needed for a browsing session. |
43 // It lives on the UI thread. All these methods must only be called on the UI | 44 // It lives on the UI thread. All these methods must only be called on the UI |
44 // thread. | 45 // thread. |
| 46 // |
| 47 // TODO(jam): Pure virtual methods should be converted to ones with empty or |
| 48 // trivial default implementations. |
45 class CONTENT_EXPORT BrowserContext : public base::SupportsUserData { | 49 class CONTENT_EXPORT BrowserContext : public base::SupportsUserData { |
46 public: | 50 public: |
47 static DownloadManager* GetDownloadManager(BrowserContext* browser_context); | 51 static DownloadManager* GetDownloadManager(BrowserContext* browser_context); |
48 | 52 |
49 // Returns BrowserContext specific external mount points. It may return NULL | 53 // Returns BrowserContext specific external mount points. It may return NULL |
50 // if the context doesn't have any BrowserContext specific external mount | 54 // if the context doesn't have any BrowserContext specific external mount |
51 // points. Currenty, non-NULL value is returned only on ChromeOS. | 55 // points. Currenty, non-NULL value is returned only on ChromeOS. |
52 static fileapi::ExternalMountPoints* GetMountPoints(BrowserContext* context); | 56 static fileapi::ExternalMountPoints* GetMountPoints(BrowserContext* context); |
53 | 57 |
54 static content::StoragePartition* GetStoragePartition( | 58 static content::StoragePartition* GetStoragePartition( |
55 BrowserContext* browser_context, SiteInstance* site_instance); | 59 BrowserContext* browser_context, SiteInstance* site_instance); |
56 static content::StoragePartition* GetStoragePartitionForSite( | 60 static content::StoragePartition* GetStoragePartitionForSite( |
57 BrowserContext* browser_context, const GURL& site); | 61 BrowserContext* browser_context, const GURL& site); |
58 typedef base::Callback<void(StoragePartition*)> StoragePartitionCallback; | 62 typedef base::Callback<void(StoragePartition*)> StoragePartitionCallback; |
59 static void ForEachStoragePartition( | 63 static void ForEachStoragePartition( |
60 BrowserContext* browser_context, | 64 BrowserContext* browser_context, |
61 const StoragePartitionCallback& callback); | 65 const StoragePartitionCallback& callback); |
62 static void AsyncObliterateStoragePartition( | 66 static void AsyncObliterateStoragePartition( |
63 BrowserContext* browser_context, | 67 BrowserContext* browser_context, |
64 const GURL& site, | 68 const GURL& site, |
65 const base::Closure& on_gc_required); | 69 const base::Closure& on_gc_required); |
66 | 70 |
67 // This function clears the contents of |active_paths| but does not take | 71 // This function clears the contents of |active_paths| but does not take |
68 // ownership of the pointer. | 72 // ownership of the pointer. |
69 static void GarbageCollectStoragePartitions( | 73 static void GarbageCollectStoragePartitions( |
70 BrowserContext* browser_context, | 74 BrowserContext* browser_context, |
71 scoped_ptr<base::hash_set<base::FilePath> > active_paths, | 75 scoped_ptr<base::hash_set<base::FilePath> > active_paths, |
72 const base::Closure& done); | 76 const base::Closure& done); |
73 | 77 |
74 // DON'T USE THIS. GetDefaultStoragePartition() is going away. | 78 // Prefer GetStoragePartition() or GetStoragePartitionForSite() above. Only |
75 // Use GetStoragePartition() instead. Ask ajwong@ if you have problems. | 79 // use this if it is 100% certain that the cookie store, cache, etc., that |
| 80 // is returned by this will be the correct one. |
76 static content::StoragePartition* GetDefaultStoragePartition( | 81 static content::StoragePartition* GetDefaultStoragePartition( |
77 BrowserContext* browser_context); | 82 BrowserContext* browser_context); |
78 | 83 |
79 // Ensures that the corresponding ResourceContext is initialized. Normally the | 84 // Ensures that the corresponding ResourceContext is initialized. Normally the |
80 // BrowserContext initializs the corresponding getters when its objects are | 85 // BrowserContext initializs the corresponding getters when its objects are |
81 // created, but if the embedder wants to pass the ResourceContext to another | 86 // created, but if the embedder wants to pass the ResourceContext to another |
82 // thread before they use BrowserContext, they should call this to make sure | 87 // thread before they use BrowserContext, they should call this to make sure |
83 // that the ResourceContext is ready. | 88 // that the ResourceContext is ready. |
84 static void EnsureResourceContextInitialized(BrowserContext* browser_context); | 89 static void EnsureResourceContextInitialized(BrowserContext* browser_context); |
85 | 90 |
86 // Tells the HTML5 objects on this context to persist their session state | 91 // Tells the HTML5 objects on this context to persist their session state |
87 // across the next restart. | 92 // across the next restart. |
88 static void SaveSessionState(BrowserContext* browser_context); | 93 static void SaveSessionState(BrowserContext* browser_context); |
89 | 94 |
90 // Tells the HTML5 objects on this context to purge any uneeded memory. | 95 // Tells the HTML5 objects on this context to purge any uneeded memory. |
91 static void PurgeMemory(BrowserContext* browser_context); | 96 static void PurgeMemory(BrowserContext* browser_context); |
92 | 97 |
93 virtual ~BrowserContext(); | 98 virtual ~BrowserContext(); |
94 | 99 |
95 // Returns the path of the directory where this context's data is stored. | 100 // Returns the path of the directory where this context's data is stored. |
96 virtual base::FilePath GetPath() const = 0; | 101 virtual base::FilePath GetPath() const = 0; |
97 | 102 |
98 // Return whether this context is incognito. Default is false. | 103 // Return whether this context is incognito. Default is false. |
99 virtual bool IsOffTheRecord() const = 0; | 104 virtual bool IsOffTheRecord() const; |
| 105 |
| 106 // kDefaultCookieScheme is used in place of a scheme to specify the |
| 107 // CookieStoreConfig for the http, https, and possibly file scheme. |
| 108 // |
| 109 // The http and https scheme must share a single cookie jar in order for |
| 110 // the web to function properly. The legacy setup also has the file scheme |
| 111 // share the same cookie jar when file cookies are enabled. |
| 112 static const char kDefaultCookieScheme[]; |
| 113 typedef std::map<std::string, CookieStoreConfig> CookieSchemeMap; |
| 114 |
| 115 // Allows embedder to change how the Cookie stores are configured. |
| 116 virtual void OverrideCookieStoreConfigs( |
| 117 const base::FilePath& partition_path, |
| 118 bool in_memory_partition, |
| 119 bool is_default_partition, |
| 120 CookieSchemeMap* configs) {} |
100 | 121 |
101 // Returns the request context information associated with this context. Call | 122 // Returns the request context information associated with this context. Call |
102 // this only on the UI thread, since it can send notifications that should | 123 // this only on the UI thread, since it can send notifications that should |
103 // happen on the UI thread. | 124 // happen on the UI thread. |
104 // TODO(creis): Remove this version in favor of the one below. | 125 // TODO(creis): Remove this version in favor of the one below. |
105 virtual net::URLRequestContextGetter* GetRequestContext() = 0; | 126 virtual net::URLRequestContextGetter* GetRequestContext() = 0; |
106 | 127 |
107 // Returns the request context appropriate for the given renderer. If the | 128 // Returns the request context appropriate for the given renderer. If the |
108 // renderer process doesn't have an associated installed app, or if the | 129 // renderer process doesn't have an associated installed app, or if the |
109 // installed app doesn't have isolated storage, this is equivalent to calling | 130 // installed app doesn't have isolated storage, this is equivalent to calling |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
160 struct hash<content::BrowserContext*> { | 181 struct hash<content::BrowserContext*> { |
161 std::size_t operator()(content::BrowserContext* const& p) const { | 182 std::size_t operator()(content::BrowserContext* const& p) const { |
162 return reinterpret_cast<std::size_t>(p); | 183 return reinterpret_cast<std::size_t>(p); |
163 } | 184 } |
164 }; | 185 }; |
165 | 186 |
166 } // namespace BASE_HASH_NAMESPACE | 187 } // namespace BASE_HASH_NAMESPACE |
167 #endif | 188 #endif |
168 | 189 |
169 #endif // CONTENT_PUBLIC_BROWSER_BROWSER_CONTEXT_H_ | 190 #endif // CONTENT_PUBLIC_BROWSER_BROWSER_CONTEXT_H_ |
OLD | NEW |