983b7035b700ec18fb93ad1a3248d1115e3d9d21
[WebKit-https.git] / Source / WebCore / platform / cocoa / NetworkExtensionContentFilter.h
1 /*
2  * Copyright (C) 2015 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 NetworkExtensionContentFilter_h
27 #define NetworkExtensionContentFilter_h
28
29 #include "PlatformContentFilter.h"
30 #include <objc/NSObjCRuntime.h>
31 #include <wtf/Compiler.h>
32 #include <wtf/OSObjectPtr.h>
33 #include <wtf/RetainPtr.h>
34
35 enum NEFilterSourceStatus : NSInteger;
36
37 OBJC_CLASS NEFilterSource;
38 OBJC_CLASS NSData;
39
40 namespace WebCore {
41
42 class URL;
43
44 class NetworkExtensionContentFilter final : public PlatformContentFilter {
45     friend std::unique_ptr<NetworkExtensionContentFilter> std::make_unique<NetworkExtensionContentFilter>();
46
47 public:
48     static std::unique_ptr<NetworkExtensionContentFilter> create();
49
50     void willSendRequest(ResourceRequest&, const ResourceResponse&) override;
51     void responseReceived(const ResourceResponse&) override;
52     void addData(const char* data, int length) override;
53     void finishedAddingData() override;
54     Ref<SharedBuffer> replacementData() const override;
55 #if ENABLE(CONTENT_FILTERING)
56     ContentFilterUnblockHandler unblockHandler() const override;
57 #endif
58
59 private:
60     static bool enabled();
61
62     NetworkExtensionContentFilter() = default;
63     void initialize(const URL* = nullptr);
64     void handleDecision(NEFilterSourceStatus, NSData *replacementData);
65
66     OSObjectPtr<dispatch_queue_t> m_queue;
67     OSObjectPtr<dispatch_semaphore_t> m_semaphore;
68     RetainPtr<NSData> m_replacementData;
69     RetainPtr<NEFilterSource> m_neFilterSource;
70 };
71
72 } // namespace WebCore
73
74 #endif // NetworkExtensionContentFilter_h