File: WebExtensionSQLiteDatabase.h

package info (click to toggle)
webkit2gtk 2.48.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 429,764 kB
  • sloc: cpp: 3,697,587; javascript: 194,444; ansic: 169,997; python: 46,499; asm: 19,295; ruby: 18,528; perl: 16,602; xml: 4,650; yacc: 2,360; sh: 2,098; java: 1,993; lex: 1,327; pascal: 366; makefile: 298
file content (105 lines) | stat: -rw-r--r-- 3,496 bytes parent folder | download | duplicates (6)
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
/*
 * Copyright (C) 2024 Igalia, S.L. 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. AND ITS CONTRIBUTORS ``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 ITS 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.
 */

#pragma once

#include "APIError.h"
#include <sqlite3.h>
#include <wtf/Forward.h>
#include <wtf/Noncopyable.h>
#include <wtf/RefPtr.h>
#include <wtf/URL.h>
#include <wtf/WorkQueue.h>

struct sqlite3;

namespace WebKit {

class WebExtensionSQLiteStatement;
class WebExtensionSQLiteStore;

class WebExtensionSQLiteDatabase final : public RefCounted<WebExtensionSQLiteDatabase> {
    WTF_MAKE_NONCOPYABLE(WebExtensionSQLiteDatabase);
    WTF_MAKE_TZONE_ALLOCATED(WebExtensionSQLiteDatabase);

    friend class WebExtensionSQLiteStatement;
    friend class WebExtensionSQLiteStore;

public:
    template<typename... Args>
    static Ref<WebExtensionSQLiteDatabase> create(Args&&... args)
    {
        return adoptRef(*new WebExtensionSQLiteDatabase(std::forward<Args>(args)...));
    }

    explicit WebExtensionSQLiteDatabase(const URL&, Ref<WorkQueue>&&);
    ~WebExtensionSQLiteDatabase()
    {
        ASSERT(!m_db);
    }

    static URL inMemoryDatabaseURL();

    enum class AccessType : uint8_t {
        ReadOnly = 0,
        ReadWrite,
        ReadWriteCreate
    };

    // This enum is only applicable on iOS and has no effect on other platforms.
    // ProtectionType::Default sets the protection to class C.
    enum class ProtectionType : uint8_t {
        Default = 0,
        CompleteUntilFirstUserAuthentication,
        CompleteUnlessOpen,
        Complete
    };

    bool openWithAccessType(AccessType, ProtectionType = { }, const String& vfs = { }, RefPtr<API::Error> = nullptr);
    bool enableWAL(RefPtr<API::Error>&);

    void reportErrorWithCode(int, const String& query, RefPtr<API::Error> = nullptr);
    void reportErrorWithCode(int, sqlite3_stmt* statement, RefPtr<API::Error> = nullptr);

    int close();

    sqlite3* sqlite3Handle() const { return m_db; };
    void assertQueue();
    Ref<WorkQueue> queue() const { return m_queue; };

private:
    RefPtr<API::Error> errorWithSQLiteErrorCode(int errorCode);
    URL privateOnDiskDatabaseURL();

    sqlite3* m_db { nullptr };
    URL m_url;

    int m_lastErrorCode;
    CString m_lastErrorMessage;

    Ref<WorkQueue> m_queue;
};

}; // namespace WebKit