Use SecurityOriginData more consistently in Service Worker code
[WebKit-https.git] / Source / WebKitLegacy / Storage / StorageAreaImpl.h
1 /*
2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <WebCore/SecurityOriginData.h>
29 #include <WebCore/StorageArea.h>
30 #include <WebCore/Timer.h>
31 #include <wtf/HashMap.h>
32 #include <wtf/RefPtr.h>
33
34 namespace WebCore {
35 class SecurityOrigin;
36 class StorageMap;
37 }
38
39 namespace WebKit {
40
41 class StorageAreaSync;
42
43 class StorageAreaImpl : public WebCore::StorageArea {
44 public:
45     static Ref<StorageAreaImpl> create(WebCore::StorageType, const WebCore::SecurityOriginData&, RefPtr<WebCore::StorageSyncManager>&&, unsigned quota);
46     virtual ~StorageAreaImpl();
47
48     unsigned length() override;
49     String key(unsigned index) override;
50     String item(const String& key) override;
51     void setItem(WebCore::Frame* sourceFrame, const String& key, const String& value, bool& quotaException) override;
52     void removeItem(WebCore::Frame* sourceFrame, const String& key) override;
53     void clear(WebCore::Frame* sourceFrame) override;
54     bool contains(const String& key) override;
55
56     WebCore::StorageType storageType() const override;
57
58     size_t memoryBytesUsedByCache() override;
59
60     void incrementAccessCount() override;
61     void decrementAccessCount() override;
62     void closeDatabaseIfIdle() override;
63
64     const WebCore::SecurityOriginData& securityOrigin() const override { return m_securityOrigin; }
65
66     Ref<StorageAreaImpl> copy();
67     void close();
68
69     // Only called from a background thread.
70     void importItems(const HashMap<String, String>& items);
71
72     // Used to clear a StorageArea and close db before backing db file is deleted.
73     void clearForOriginDeletion();
74
75     void sync();
76
77 private:
78     StorageAreaImpl(WebCore::StorageType, const WebCore::SecurityOriginData&, RefPtr<WebCore::StorageSyncManager>&&, unsigned quota);
79     explicit StorageAreaImpl(const StorageAreaImpl&);
80
81     void blockUntilImportComplete() const;
82     void closeDatabaseTimerFired();
83
84     void dispatchStorageEvent(const String& key, const String& oldValue, const String& newValue, WebCore::Frame* sourceFrame);
85
86     WebCore::StorageType m_storageType;
87     WebCore::SecurityOriginData m_securityOrigin;
88     RefPtr<WebCore::StorageMap> m_storageMap;
89
90     RefPtr<StorageAreaSync> m_storageAreaSync;
91     RefPtr<WebCore::StorageSyncManager> m_storageSyncManager;
92
93 #ifndef NDEBUG
94     bool m_isShutdown;
95 #endif
96     unsigned m_accessCount;
97     WebCore::Timer m_closeDatabaseTimer;
98 };
99
100 } // namespace WebCore