summaryrefslogtreecommitdiff
path: root/chromium/third_party/blink/renderer/modules/storage/storage_area.h
blob: c3de6fcb30131934a157b75fd82387171b0e1c63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * Copyright (C) 2008 Apple Inc. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_STORAGE_STORAGE_AREA_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_STORAGE_STORAGE_AREA_H_

#include "base/memory/scoped_refptr.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_binding_for_core.h"
#include "third_party/blink/renderer/core/dom/context_lifecycle_observer.h"
#include "third_party/blink/renderer/modules/storage/cached_storage_area.h"
#include "third_party/blink/renderer/platform/bindings/script_wrappable.h"
#include "third_party/blink/renderer/platform/heap/handle.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"

namespace blink {

class ExceptionState;
class LocalFrame;
class WebStorageArea;
class WebStorageNamespace;

class StorageArea final : public ScriptWrappable,
                          public ContextClient,
                          public CachedStorageArea::Source {
  DEFINE_WRAPPERTYPEINFO();
  USING_GARBAGE_COLLECTED_MIXIN(StorageArea);

 public:
  enum class StorageType { kLocalStorage, kSessionStorage };

  // TODO(dmurph): Remove this after onion souping. crbug.com/781870
  static StorageArea* Create(LocalFrame*,
                             std::unique_ptr<WebStorageArea>,
                             StorageType);

  // Creates the onion-souped version.
  static StorageArea* Create(LocalFrame*,
                             scoped_refptr<CachedStorageArea>,
                             StorageType);

  // This storage area doesn't enqueue any events. This avoids duplicate event
  // dispatch when an inspector agent is present.
  static StorageArea* CreateForInspectorAgent(LocalFrame*,
                                              scoped_refptr<CachedStorageArea>,
                                              StorageType);

  // TODO(dmurph): Remove this after onion souping. crbug.com/781870
  StorageArea(LocalFrame*, std::unique_ptr<WebStorageArea>, StorageType);

  StorageArea(LocalFrame*,
              scoped_refptr<CachedStorageArea>,
              StorageType,
              bool should_enqueue_events);

  unsigned length(ExceptionState&) const;
  String key(unsigned index, ExceptionState&) const;
  String getItem(const String& key, ExceptionState&) const;
  bool setItem(const String& key, const String& value, ExceptionState&);
  DeleteResult removeItem(const String& key, ExceptionState&);
  void clear(ExceptionState&);
  bool Contains(const String& key, ExceptionState& ec) const;

  WebStorageArea* Area() const { return storage_area_.get(); }

  void NamedPropertyEnumerator(Vector<String>&, ExceptionState&);
  bool NamedPropertyQuery(const AtomicString&, ExceptionState&);

  bool CanAccessStorage() const;

  void Trace(blink::Visitor*) override;

  // CachedStorageArea::Source:
  KURL GetPageUrl() const override;
  bool EnqueueStorageEvent(const String& key,
                           const String& old_value,
                           const String& new_value,
                           const String& url) override;

  blink::WebScopedVirtualTimePauser CreateWebScopedVirtualTimePauser(
      const char* name,
      WebScopedVirtualTimePauser::VirtualTaskDuration duration) override;

  // TODO(dmurph): Remove this after onion souping. crbug.com/781870
  static void DispatchLocalStorageEvent(const String& key,
                                        const String& old_value,
                                        const String& new_value,
                                        const SecurityOrigin*,
                                        const KURL& page_url,
                                        WebStorageArea* source_area_instance);
  // TODO(dmurph): Remove this after onion souping. crbug.com/781870
  static void DispatchSessionStorageEvent(const String& key,
                                          const String& old_value,
                                          const String& new_value,
                                          const SecurityOrigin*,
                                          const KURL& page_url,
                                          const WebStorageNamespace&,
                                          WebStorageArea* source_area_instance);

 private:
  // TODO(dmurph): Remove this after onion souping. crbug.com/781870
  std::unique_ptr<WebStorageArea> storage_area_;

  scoped_refptr<CachedStorageArea> cached_area_;
  StorageType storage_type_;
  const bool should_enqueue_events_;

  mutable bool did_check_can_access_storage_ = false;
  mutable bool can_access_storage_cached_result_ = false;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_STORAGE_STORAGE_AREA_H_