efce635bcf6e88efa5fb38c248e40050595af324
[WebKit-https.git] / Source / WebCore / storage / Storage.cpp
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 #include "config.h"
27 #include "Storage.h"
28
29 #include "Document.h"
30 #include "ExceptionCode.h"
31 #include "Frame.h"
32 #include "Page.h"
33 #include "SchemeRegistry.h"
34 #include "SecurityOrigin.h"
35 #include "StorageArea.h"
36 #include <wtf/text/WTFString.h>
37
38 namespace WebCore {
39
40 Ref<Storage> Storage::create(Frame* frame, RefPtr<StorageArea>&& storageArea)
41 {
42     return adoptRef(*new Storage(frame, WTFMove(storageArea)));
43 }
44
45 Storage::Storage(Frame* frame, RefPtr<StorageArea>&& storageArea)
46     : DOMWindowProperty(frame)
47     , m_storageArea(WTFMove(storageArea))
48 {
49     ASSERT(m_frame);
50     ASSERT(m_storageArea);
51
52     m_storageArea->incrementAccessCount();
53 }
54
55 Storage::~Storage()
56 {
57     m_storageArea->decrementAccessCount();
58 }
59
60 ExceptionOr<unsigned> Storage::length() const
61 {
62     if (!m_storageArea->canAccessStorage(m_frame))
63         return Exception { SECURITY_ERR };
64
65     if (isDisabledByPrivateBrowsing())
66         return 0;
67
68     return m_storageArea->length();
69 }
70
71 ExceptionOr<String> Storage::key(unsigned index) const
72 {
73     if (!m_storageArea->canAccessStorage(m_frame))
74         return Exception { SECURITY_ERR };
75
76     if (isDisabledByPrivateBrowsing())
77         return String();
78
79     return m_storageArea->key(index);
80 }
81
82 ExceptionOr<String> Storage::getItem(const String& key) const
83 {
84     if (!m_storageArea->canAccessStorage(m_frame))
85         return Exception { SECURITY_ERR };
86
87     if (isDisabledByPrivateBrowsing())
88         return String();
89
90     return m_storageArea->item(key);
91 }
92
93 ExceptionOr<void> Storage::setItem(const String& key, const String& value)
94 {
95     if (!m_storageArea->canAccessStorage(m_frame))
96         return Exception { SECURITY_ERR };
97
98     if (isDisabledByPrivateBrowsing())
99         return Exception { QUOTA_EXCEEDED_ERR };
100
101     bool quotaException = false;
102     m_storageArea->setItem(m_frame, key, value, quotaException);
103     if (quotaException)
104         return Exception { QUOTA_EXCEEDED_ERR };
105     return { };
106 }
107
108 ExceptionOr<void> Storage::removeItem(const String& key)
109 {
110     if (!m_storageArea->canAccessStorage(m_frame))
111         return Exception { SECURITY_ERR };
112
113     if (isDisabledByPrivateBrowsing())
114         return { };
115
116     m_storageArea->removeItem(m_frame, key);
117     return { };
118 }
119
120 ExceptionOr<void> Storage::clear()
121 {
122     if (!m_storageArea->canAccessStorage(m_frame))
123         return Exception { SECURITY_ERR };
124
125     if (isDisabledByPrivateBrowsing())
126         return { };
127
128     m_storageArea->clear(m_frame);
129     return { };
130 }
131
132 ExceptionOr<bool> Storage::contains(const String& key) const
133 {
134     if (!m_storageArea->canAccessStorage(m_frame))
135         return Exception { SECURITY_ERR };
136
137     if (isDisabledByPrivateBrowsing())
138         return false;
139
140     return m_storageArea->contains(key);
141 }
142
143 bool Storage::isDisabledByPrivateBrowsing() const
144 {
145     if (!m_frame->page()->usesEphemeralSession())
146         return false;
147
148     if (m_storageArea->storageType() == LocalStorage) {
149         if (SchemeRegistry::allowsLocalStorageAccessInPrivateBrowsing(m_frame->document()->securityOrigin()->protocol()))
150             return false;
151     }
152
153     return true;
154 }
155
156 } // namespace WebCore