939b4cf7e05742d36e13077c0ca6632ff3e5dcf2
[WebKit-https.git] / Source / WebKitLegacy / mac / Storage / WebDatabaseManagerPrivate.h
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 extern NSString *WebDatabaseDirectoryDefaultsKey;
30
31 extern NSString *WebDatabaseDisplayNameKey;
32 extern NSString *WebDatabaseExpectedSizeKey;
33 extern NSString *WebDatabaseUsageKey;
34
35 // Posted with an origin is created from scratch, gets a new database, has a database deleted, has a quota change, etc
36 // The notification object will be a WebSecurityOrigin object corresponding to the origin.
37 extern NSString *WebDatabaseDidModifyOriginNotification;
38
39 // Posted when a database is created, its size increases, its display name changes, or its estimated size changes, or the database is removed
40 // The notification object will be a WebSecurityOrigin object corresponding to the origin.
41 // The notification userInfo will have a WebDatabaseNameKey whose value is the database name.
42 extern NSString *WebDatabaseDidModifyDatabaseNotification;
43 extern NSString *WebDatabaseIdentifierKey;
44
45 #if TARGET_OS_IPHONE
46 #import <WebKitLegacy/WebUIKitSupport.h>
47
48 // Posted when origins have changed.
49 extern CFStringRef WebDatabaseOriginsDidChangeNotification;
50 #endif
51
52 @class WebSecurityOrigin;
53
54 @interface WebDatabaseManager : NSObject
55
56 + (WebDatabaseManager *)sharedWebDatabaseManager;
57
58 // Will return an array of WebSecurityOrigin objects.
59 - (NSArray *)origins;
60
61 // Will return an array of strings, the identifiers of each database in the given origin.
62 - (NSArray *)databasesWithOrigin:(WebSecurityOrigin *)origin;
63
64 // Will return the dictionary describing everything about the database for the passed identifier and origin.
65 - (NSDictionary *)detailsForDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
66
67 - (void)deleteAllDatabases; // Deletes all databases and all origins.
68 - (BOOL)deleteOrigin:(WebSecurityOrigin *)origin;
69 - (BOOL)deleteDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
70
71 // For DumpRenderTree support only
72 - (void)deleteAllIndexedDatabases;
73
74 #if TARGET_OS_IPHONE
75 + (void)scheduleEmptyDatabaseRemoval;
76 #endif
77 @end