Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebKit2 / NetworkProcess / 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 <wtf/WorkQueue.h>
32 #include <wtf/text/WTFString.h>
33
34 #if PLATFORM(COCOA)
35 #include <wtf/HashMap.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/RetainPtr.h>
38 #include <wtf/Threading.h>
39 #include <wtf/text/StringHash.h>
40 OBJC_CLASS NSURLSessionConfiguration;
41 OBJC_CLASS WKCustomProtocol;
42 #else
43 #include "CustomProtocolManagerImpl.h"
44 #endif
45
46
47 namespace IPC {
48 class DataReference;
49 } // namespace IPC
50
51 namespace WebCore {
52 class ResourceError;
53 class ResourceRequest;
54 class ResourceResponse;
55 } // namespace WebCore
56
57 namespace WebKit {
58
59 class ChildProcess;
60 struct NetworkProcessCreationParameters;
61
62 class CustomProtocolManager : public NetworkProcessSupplement, public IPC::Connection::WorkQueueMessageReceiver {
63     WTF_MAKE_NONCOPYABLE(CustomProtocolManager);
64 public:
65     explicit CustomProtocolManager(ChildProcess*);
66
67     static const char* supplementName();
68
69     ChildProcess* childProcess() const { return m_childProcess; }
70
71     void registerScheme(const String&);
72     void unregisterScheme(const String&);
73     bool supportsScheme(const String&);
74     
75 #if PLATFORM(COCOA)
76     void addCustomProtocol(WKCustomProtocol *);
77     void removeCustomProtocol(WKCustomProtocol *);
78 #if USE(NETWORK_SESSION)
79     void registerProtocolClass(NSURLSessionConfiguration *);
80 #endif
81 #endif
82
83 private:
84     // ChildProcessSupplement
85     void initializeConnection(IPC::Connection*) override;
86
87     // NetworkProcessSupplement
88     void initialize(const NetworkProcessCreationParameters&) override;
89
90     // IPC::MessageReceiver
91     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     void wasRedirectedToRequest(uint64_t customProtocolID, const WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse);
98
99     ChildProcess* m_childProcess;
100     RefPtr<WorkQueue> m_messageQueue;
101
102 #if PLATFORM(COCOA)
103     HashSet<String, ASCIICaseInsensitiveHash> m_registeredSchemes;
104     Lock m_registeredSchemesMutex;
105
106     typedef HashMap<uint64_t, RetainPtr<WKCustomProtocol>> CustomProtocolMap;
107     CustomProtocolMap m_customProtocolMap;
108     Lock m_customProtocolMapMutex;
109     
110     // WKCustomProtocol objects can be removed from the m_customProtocolMap from multiple threads.
111     // 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.
112     RetainPtr<WKCustomProtocol> protocolForID(uint64_t customProtocolID);
113 #else
114     // FIXME: Move mac specific code to CustomProtocolManagerImpl.
115     std::unique_ptr<CustomProtocolManagerImpl> m_impl;
116 #endif
117 };
118
119 } // namespace WebKit
120
121 #endif // CustomProtocolManager_h