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#ifndef StorageAreaImpl_h
27#define StorageAreaImpl_h
28
29#if ENABLE(DOM_STORAGE)
30
31#include "StorageArea.h"
32
33#include <wtf/PassRefPtr.h>
34#include <wtf/RefPtr.h>
35
36namespace WebCore {
37
38    class SecurityOrigin;
39    class StorageMap;
40    class StorageAreaSync;
41
42    class StorageAreaImpl : public StorageArea {
43    public:
44        static PassRefPtr<StorageAreaImpl> create(StorageType, PassRefPtr<SecurityOrigin>, PassRefPtr<StorageSyncManager>, unsigned quota);
45        virtual ~StorageAreaImpl();
46
47        // The HTML5 DOM Storage API (and contains)
48        virtual unsigned length() const;
49        virtual String key(unsigned index) const;
50        virtual String getItem(const String& key) const;
51        virtual String setItem(const String& key, const String& value, ExceptionCode& ec, Frame* sourceFrame);
52        virtual String removeItem(const String& key, Frame* sourceFrame);
53        virtual bool clear(Frame* sourceFrame);
54        virtual bool contains(const String& key) const;
55
56        PassRefPtr<StorageAreaImpl> copy();
57        void close();
58
59        // Only called from a background thread.
60        void importItem(const String& key, const String& value);
61
62        // Used to clear a StorageArea and close db before backing db file is deleted.
63        void clearForOriginDeletion();
64
65        void sync();
66
67    private:
68        StorageAreaImpl(StorageType, PassRefPtr<SecurityOrigin>, PassRefPtr<StorageSyncManager>, unsigned quota);
69        StorageAreaImpl(StorageAreaImpl*);
70
71        void blockUntilImportComplete() const;
72
73        StorageType m_storageType;
74        RefPtr<SecurityOrigin> m_securityOrigin;
75        RefPtr<StorageMap> m_storageMap;
76
77        RefPtr<StorageAreaSync> m_storageAreaSync;
78        RefPtr<StorageSyncManager> m_storageSyncManager;
79
80#ifndef NDEBUG
81        bool m_isShutdown;
82#endif
83    };
84
85} // namespace WebCore
86
87#endif // ENABLE(DOM_STORAGE)
88
89#endif // StorageAreaImpl_h
90