Delete WebMetal implementation in favor of WebGPU
[WebKit-https.git] / Source / WebCore / platform / ContentFilterUnblockHandler.h
1 /*
2  * Copyright (C) 2015-2019 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 #pragma once
27
28 #if ENABLE(CONTENT_FILTERING)
29
30 #include <functional>
31 #include <wtf/RetainPtr.h>
32 #include <wtf/URL.h>
33 #include <wtf/text/WTFString.h>
34
35 OBJC_CLASS NSCoder;
36
37 #if PLATFORM(IOS_FAMILY)
38 OBJC_CLASS WebFilterEvaluator;
39 #endif
40
41 namespace WebCore {
42
43 class ResourceRequest;
44
45 class ContentFilterUnblockHandler {
46 public:
47     using DecisionHandlerFunction = std::function<void(bool unblocked)>;
48     using UnblockRequesterFunction = std::function<void(DecisionHandlerFunction)>;
49
50     ContentFilterUnblockHandler() = default;
51     WEBCORE_EXPORT ContentFilterUnblockHandler(String unblockURLHost, UnblockRequesterFunction);
52 #if HAVE(PARENTAL_CONTROLS_WITH_UNBLOCK_HANDLER)
53     ContentFilterUnblockHandler(String unblockURLHost, RetainPtr<WebFilterEvaluator>);
54 #endif
55
56     WEBCORE_EXPORT bool needsUIProcess() const;
57     WEBCORE_EXPORT void encode(NSCoder *) const;
58     WEBCORE_EXPORT static bool decode(NSCoder *, ContentFilterUnblockHandler&);
59     WEBCORE_EXPORT bool canHandleRequest(const ResourceRequest&) const;
60     WEBCORE_EXPORT void requestUnblockAsync(DecisionHandlerFunction) const;
61     void wrapWithDecisionHandler(const DecisionHandlerFunction&);
62
63     const String& unblockURLHost() const { return m_unblockURLHost; }
64     const URL& unreachableURL() const { return m_unreachableURL; }
65     void setUnreachableURL(const URL& url) { m_unreachableURL = url; }
66
67 private:
68     String m_unblockURLHost;
69     URL m_unreachableURL;
70     UnblockRequesterFunction m_unblockRequester;
71 #if HAVE(PARENTAL_CONTROLS_WITH_UNBLOCK_HANDLER)
72     RetainPtr<WebFilterEvaluator> m_webFilterEvaluator;
73 #endif
74 };
75
76 } // namespace WebCore
77
78 #endif // ENABLE(CONTENT_FILTERING)