9208c2d920273e22709d56c899067b3a12af40e3
[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 "ContentFilter.h"
30 #include "SharedBuffer.h"
31 #include <objc/NSObjCRuntime.h>
32 #include <wtf/Compiler.h>
33 #include <wtf/OSObjectPtr.h>
34 #include <wtf/Ref.h>
35 #include <wtf/RetainPtr.h>
36
37 #define HAVE_NETWORK_EXTENSION PLATFORM(IOS) || (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000 && CPU(X86_64))
38
39 enum NEFilterSourceStatus : NSInteger;
40
41 OBJC_CLASS NEFilterSource;
42 OBJC_CLASS NSData;
43 OBJC_CLASS NSDictionary;
44 OBJC_CLASS NSMutableData;
45
46 namespace WebCore {
47
48 class NetworkExtensionContentFilter final : public ContentFilter {
49     WTF_MAKE_FAST_ALLOCATED;
50     WTF_MAKE_NONCOPYABLE(NetworkExtensionContentFilter);
51     friend std::unique_ptr<NetworkExtensionContentFilter> std::make_unique<NetworkExtensionContentFilter>(const ResourceResponse&);
52
53 public:
54     static bool canHandleResponse(const ResourceResponse&);
55     static std::unique_ptr<NetworkExtensionContentFilter> create(const ResourceResponse&);
56
57     void addData(const char* data, int length) override;
58     void finishedAddingData() override;
59     bool needsMoreData() const override;
60     bool didBlockData() const override;
61     const char* getReplacementData(int& length) const override;
62     ContentFilterUnblockHandler unblockHandler() const override;
63
64 private:
65     explicit NetworkExtensionContentFilter(const ResourceResponse&);
66     void handleDecision(NEFilterSourceStatus, NSData *replacementData);
67
68     NEFilterSourceStatus m_status;
69     OSObjectPtr<dispatch_queue_t> m_queue;
70     OSObjectPtr<dispatch_semaphore_t> m_semaphore;
71     Ref<SharedBuffer> m_originalData;
72     RetainPtr<NSData> m_replacementData;
73     RetainPtr<NEFilterSource> m_neFilterSource;
74 };
75
76 } // namespace WebCore
77
78 #endif // NetworkExtensionContentFilter_h