1/*
2 * Copyright (C) 2007, 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#if !defined(ENABLE_SQL_DATABASE)
30#define ENABLE_SQL_DATABASE 1
31#endif
32
33#if ENABLE_SQL_DATABASE
34
35extern NSString *WebDatabaseDirectoryDefaultsKey;
36
37extern NSString *WebDatabaseDisplayNameKey;
38extern NSString *WebDatabaseExpectedSizeKey;
39extern NSString *WebDatabaseUsageKey;
40
41// Posted with an origin is created from scratch, gets a new database, has a database deleted, has a quota change, etc
42// The notification object will be a WebSecurityOrigin object corresponding to the origin.
43extern NSString *WebDatabaseDidModifyOriginNotification;
44
45// Posted when a database is created, its size increases, its display name changes, or its estimated size changes, or the database is removed
46// The notification object will be a WebSecurityOrigin object corresponding to the origin.
47// The notification userInfo will have a WebDatabaseNameKey whose value is the database name.
48extern NSString *WebDatabaseDidModifyDatabaseNotification;
49extern NSString *WebDatabaseIdentifierKey;
50
51#if TARGET_OS_IPHONE
52#import <WebKitLegacy/WebUIKitSupport.h>
53
54// Posted when origins have changed.
55extern CFStringRef WebDatabaseOriginsDidChangeNotification;
56#endif
57
58@class WebSecurityOrigin;
59
60@interface WebDatabaseManager : NSObject
61
62+ (WebDatabaseManager *)sharedWebDatabaseManager;
63
64// Will return an array of WebSecurityOrigin objects.
65- (NSArray *)origins;
66
67// Will return an array of strings, the identifiers of each database in the given origin.
68- (NSArray *)databasesWithOrigin:(WebSecurityOrigin *)origin;
69
70// Will return the dictionary describing everything about the database for the passed identifier and origin.
71- (NSDictionary *)detailsForDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
72
73- (void)deleteAllDatabases; // Deletes all databases and all origins.
74- (BOOL)deleteOrigin:(WebSecurityOrigin *)origin;
75- (BOOL)deleteDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
76
77#if TARGET_OS_IPHONE
78+ (void)scheduleEmptyDatabaseRemoval;
79#endif
80@end
81
82#endif // ENABLE_SQL_DATABASE
83