802372b12d145c4ab0ab5192f28446a5f5beb99d
[WebKit-https.git] / Source / WebKit2 / Shared / Network / CustomProtocols / CustomProtocolManager.h
1 /*
2  * Copyright (C) 2012, 2013 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 CustomProtocolManager_h
27 #define CustomProtocolManager_h
28
29 #include "Connection.h"
30 #include "NetworkProcessSupplement.h"
31 #include "WebProcessSupplement.h"
32 #include "WorkQueue.h"
33 #include <wtf/text/WTFString.h>
34
35 #if PLATFORM(COCOA)
36 #include <wtf/HashMap.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/RetainPtr.h>
39 #include <wtf/Threading.h>
40 OBJC_CLASS WKCustomProtocol;
41 #else
42 #include "CustomProtocolManagerImpl.h"
43 #endif
44
45
46 namespace IPC {
47 class DataReference;
48 } // namespace IPC
49
50 namespace WebCore {
51 class ResourceError;
52 class ResourceResponse;
53 } // namespace WebCore
54
55 namespace WebKit {
56
57 class ChildProcess;
58 struct NetworkProcessCreationParameters;
59
60 class CustomProtocolManager : public WebProcessSupplement, public NetworkProcessSupplement, public IPC::Connection::WorkQueueMessageReceiver {
61     WTF_MAKE_NONCOPYABLE(CustomProtocolManager);
62 public:
63     explicit CustomProtocolManager(ChildProcess*);
64
65     static const char* supplementName();
66
67     ChildProcess* childProcess() const { return m_childProcess; }
68
69     void registerScheme(const String&);
70     void unregisterScheme(const String&);
71     bool supportsScheme(const String&);
72     
73 #if PLATFORM(COCOA)
74     void addCustomProtocol(WKCustomProtocol *);
75     void removeCustomProtocol(WKCustomProtocol *);
76 #endif
77
78 private:
79     // ChildProcessSupplement
80     void initializeConnection(IPC::Connection*) override;
81
82     // WebProcessSupplement
83     void initialize(const WebProcessCreationParameters&) override;
84
85 #if ENABLE(NETWORK_PROCESS)
86     // NetworkProcessSupplement
87     void initialize(const NetworkProcessCreationParameters&) override;
88 #endif
89
90     // IPC::MessageReceiver
91     virtual void didReceiveMessage(IPC::Connection*, IPC::MessageDecoder&) override;
92
93     void didFailWithError(uint64_t customProtocolID, const WebCore::ResourceError&);
94     void didLoadData(uint64_t customProtocolID, const IPC::DataReference&);
95     void didReceiveResponse(uint64_t customProtocolID, const WebCore::ResourceResponse&, uint32_t cacheStoragePolicy);
96     void didFinishLoading(uint64_t customProtocolID);
97
98     ChildProcess* m_childProcess;
99     RefPtr<WorkQueue> m_messageQueue;
100
101 #if PLATFORM(COCOA)
102     HashSet<String> m_registeredSchemes;
103     Mutex m_registeredSchemesMutex;
104
105     typedef HashMap<uint64_t, RetainPtr<WKCustomProtocol>> CustomProtocolMap;
106     CustomProtocolMap m_customProtocolMap;
107     Mutex m_customProtocolMapMutex;
108     
109     // WKCustomProtocol objects can be removed from the m_customProtocolMap from multiple threads.
110     // We return a RetainPtr here because it is unsafe to return a raw pointer since the object might immediately be destroyed from a different thread.
111     RetainPtr<WKCustomProtocol> protocolForID(uint64_t customProtocolID);
112 #else
113     // FIXME: Move mac specific code to CustomProtocolManagerImpl.
114     std::unique_ptr<CustomProtocolManagerImpl> m_impl;
115 #endif
116 };
117
118 } // namespace WebKit
119
120 #endif // CustomProtocolManager_h