| // Copyright (c) 2012 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 CONTENT_RENDERER_DOM_STORAGE_DOM_STORAGE_CACHED_AREA_H_ |
| #define CONTENT_RENDERER_DOM_STORAGE_DOM_STORAGE_CACHED_AREA_H_ |
| |
| #include <stddef.h> |
| #include <stdint.h> |
| |
| #include <map> |
| |
| #include "base/memory/ref_counted.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/strings/nullable_string16.h" |
| #include "content/common/content_export.h" |
| #include "third_party/blink/public/platform/web_scoped_virtual_time_pauser.h" |
| #include "url/gurl.h" |
| |
| namespace blink { |
| namespace scheduler { |
| class WebThreadScheduler; |
| } |
| } // namespace blink |
| |
| namespace content { |
| |
| class DOMStorageMap; |
| class DOMStorageProxy; |
| |
| // Unlike the other classes in the dom_storage library, this one is intended |
| // for use in renderer processes. It maintains a complete cache of the |
| // origin's Map of key/value pairs for fast access. The cache is primed on |
| // first access and changes are written to the backend thru the |proxy|. |
| // Mutations originating in other processes are applied to the cache via |
| // the ApplyMutation method. |
| class CONTENT_EXPORT DOMStorageCachedArea |
| : public base::RefCounted<DOMStorageCachedArea> { |
| public: |
| DOMStorageCachedArea( |
| const std::string& namespace_id, |
| const GURL& origin, |
| DOMStorageProxy* proxy, |
| blink::scheduler::WebThreadScheduler* main_thread_scheduler); |
| |
| const std::string& namespace_id() const { return namespace_id_; } |
| const GURL& origin() const { return origin_; } |
| |
| unsigned GetLength(int connection_id); |
| // See DOMStorageMap for the meaning of |did_decrease_iterator|. |
| base::NullableString16 GetKey(int connection_id, |
| unsigned index, |
| bool* did_decrease_iterator = nullptr); |
| base::NullableString16 GetItem(int connection_id, const base::string16& key); |
| bool SetItem(int connection_id, |
| const base::string16& key, |
| const base::string16& value, |
| const GURL& page_url); |
| void RemoveItem(int connection_id, |
| const base::string16& key, |
| const GURL& page_url); |
| void Clear(int connection_id, const GURL& page_url); |
| |
| void ApplyMutation(const base::NullableString16& key, |
| const base::NullableString16& new_value); |
| |
| private: |
| friend class DOMStorageCachedAreaTest; |
| friend class base::RefCounted<DOMStorageCachedArea>; |
| ~DOMStorageCachedArea(); |
| |
| // Primes the cache, loading all values for the area. |
| void Prime(int connection_id); |
| void PrimeIfNeeded(int connection_id) { |
| if (!map_.get()) |
| Prime(connection_id); |
| } |
| |
| // Resets the object back to its newly constructed state. |
| void Reset(); |
| |
| // Async completion callbacks for proxied operations. |
| // These are used to maintain cache consistency by preventing |
| // mutation events from other processes from overwriting local |
| // changes made after the mutation. |
| void OnLoadComplete(bool success); |
| void OnSetItemComplete(const base::string16& key, |
| blink::WebScopedVirtualTimePauser virtual_time_pauser, |
| bool success); |
| void OnClearComplete(blink::WebScopedVirtualTimePauser virtual_time_pauser, |
| bool success); |
| void OnRemoveItemComplete( |
| const base::string16& key, |
| blink::WebScopedVirtualTimePauser virtual_time_pauser, |
| bool success); |
| |
| bool should_ignore_key_mutation(const base::string16& key) const { |
| return ignore_key_mutations_.find(key) != ignore_key_mutations_.end(); |
| } |
| |
| bool ignore_all_mutations_; |
| std::map<base::string16, int> ignore_key_mutations_; |
| |
| std::string namespace_id_; |
| GURL origin_; |
| scoped_refptr<DOMStorageMap> map_; |
| scoped_refptr<DOMStorageProxy> proxy_; |
| |
| // Not owned. |
| blink::scheduler::WebThreadScheduler* main_thread_scheduler_; |
| |
| base::WeakPtrFactory<DOMStorageCachedArea> weak_factory_; |
| }; |
| |
| } // namespace content |
| |
| #endif // CONTENT_RENDERER_DOM_STORAGE_DOM_STORAGE_CACHED_AREA_H_ |