1/*
2 * Copyright (C) 2011 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. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef WebIconDatabase_h
27#define WebIconDatabase_h
28
29#include "APIObject.h"
30
31#include "Connection.h"
32#include "WebIconDatabaseClient.h"
33#include <WebCore/IconDatabaseClient.h>
34#include <wtf/Forward.h>
35#include <wtf/PassRefPtr.h>
36#include <wtf/RefPtr.h>
37#include <wtf/Vector.h>
38#include <wtf/text/StringHash.h>
39
40namespace CoreIPC {
41class ArgumentDecoder;
42class DataReference;
43class MessageID;
44}
45
46namespace WebCore {
47class IconDatabase;
48class Image;
49}
50
51namespace WebKit {
52
53class WebContext;
54
55class WebIconDatabase : public APIObject, public WebCore::IconDatabaseClient {
56public:
57    static const Type APIType = TypeIconDatabase;
58
59    static PassRefPtr<WebIconDatabase> create(WebContext*);
60    virtual ~WebIconDatabase();
61
62    void invalidate();
63    void clearContext() { m_webContext = 0; }
64    void setDatabasePath(const String&);
65    void enableDatabaseCleanup();
66
67    void retainIconForPageURL(const String&);
68    void releaseIconForPageURL(const String&);
69    void setIconURLForPageURL(const String&, const String&);
70    void setIconDataForIconURL(const CoreIPC::DataReference&, const String&);
71
72    void synchronousIconDataForPageURL(const String&, CoreIPC::DataReference&);
73    void synchronousIconURLForPageURL(const String&, String&);
74    void synchronousIconDataKnownForIconURL(const String&, bool&) const;
75    void synchronousLoadDecisionForIconURL(const String&, int&) const;
76
77    void getLoadDecisionForIconURL(const String&, uint64_t callbackID);
78
79    WebCore::Image* imageForPageURL(const String&);
80
81    void removeAllIcons();
82    void checkIntegrityBeforeOpening();
83    void close();
84
85    void initializeIconDatabaseClient(const WKIconDatabaseClient*);
86
87    // WebCore::IconDatabaseClient
88    virtual bool performImport();
89    virtual void didImportIconURLForPageURL(const String&);
90    virtual void didImportIconDataForPageURL(const String&);
91    virtual void didChangeIconForPageURL(const String&);
92    virtual void didRemoveAllIcons();
93    virtual void didFinishURLImport();
94
95    void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
96    CoreIPC::SyncReplyMode didReceiveSyncMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, CoreIPC::ArgumentEncoder*);
97
98private:
99    WebIconDatabase(WebContext*);
100
101    virtual Type type() const { return APIType; }
102
103    void didReceiveWebIconDatabaseMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
104    CoreIPC::SyncReplyMode didReceiveSyncWebIconDatabaseMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, CoreIPC::ArgumentEncoder*);
105
106    WebContext* m_webContext;
107
108    OwnPtr<WebCore::IconDatabase> m_iconDatabaseImpl;
109    bool m_urlImportCompleted;
110    bool m_databaseCleanupDisabled;
111    HashMap<uint64_t, String> m_pendingLoadDecisionURLMap;
112
113    WebIconDatabaseClient m_iconDatabaseClient;
114};
115
116} // namespace WebKit
117
118#endif // WebIconDatabase_h
119