1/*
2 * Copyright (C) 2012 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 AbstractDatabaseServer_h
27#define AbstractDatabaseServer_h
28
29#if ENABLE(SQL_DATABASE)
30
31#include "DatabaseBasicTypes.h"
32#include "DatabaseDetails.h"
33#include "DatabaseError.h"
34#include <wtf/RefPtr.h>
35#include <wtf/Vector.h>
36#include <wtf/text/WTFString.h>
37
38namespace WebCore {
39
40class DatabaseBackendBase;
41class DatabaseBackendContext;
42class DatabaseManagerClient;
43class SecurityOrigin;
44
45class AbstractDatabaseServer {
46public:
47    virtual void initialize(const String& databasePath) = 0;
48
49    virtual void setClient(DatabaseManagerClient*) = 0;
50    virtual String databaseDirectoryPath() const = 0;
51    virtual void setDatabaseDirectoryPath(const String&) = 0;
52
53    virtual String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true) = 0;
54
55    enum OpenAttempt {
56        FirstTryToOpenDatabase,
57        RetryOpenDatabase
58    };
59
60    virtual PassRefPtr<DatabaseBackendBase> openDatabase(RefPtr<DatabaseBackendContext>&, DatabaseType,
61        const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize,
62        bool setVersionInNewDatabase, DatabaseError&, String& errorMessage, OpenAttempt = FirstTryToOpenDatabase) = 0;
63
64    virtual bool hasEntryForOrigin(SecurityOrigin*) = 0;
65    virtual void origins(Vector<RefPtr<SecurityOrigin>>& result) = 0;
66    virtual bool databaseNamesForOrigin(SecurityOrigin*, Vector<String>& result) = 0;
67    virtual DatabaseDetails detailsForNameAndOrigin(const String&, SecurityOrigin*) = 0;
68
69    virtual unsigned long long usageForOrigin(SecurityOrigin*) = 0;
70    virtual unsigned long long quotaForOrigin(SecurityOrigin*) = 0;
71
72    virtual void setQuota(SecurityOrigin*, unsigned long long) = 0;
73
74    virtual void deleteAllDatabases() = 0;
75    virtual bool deleteOrigin(SecurityOrigin*) = 0;
76    virtual bool deleteDatabase(SecurityOrigin*, const String& name) = 0;
77
78    virtual void interruptAllDatabasesForContext(const DatabaseBackendContext*) = 0;
79
80protected:
81    AbstractDatabaseServer() { }
82    virtual ~AbstractDatabaseServer() { }
83};
84
85} // namespace WebCore
86
87#endif // ENABLE(SQL_DATABASE)
88
89#endif // AbstractDatabaseServer_h
90