0d2a62186b5a54e2b851ff96d528101f8466f405
[WebKit.git] / Source / WebCore / platform / cocoa / ParentalControlsContentFilter.mm
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 #import "config.h"
27 #import "ParentalControlsContentFilter.h"
28
29 #if HAVE(PARENTAL_CONTROLS)
30
31 #import "ContentFilterUnblockHandler.h"
32 #import "Logging.h"
33 #import "ResourceResponse.h"
34 #import "SharedBuffer.h"
35 #import <objc/runtime.h>
36 #import <pal/spi/cocoa/WebFilterEvaluatorSPI.h>
37 #import <wtf/SoftLinking.h>
38
39 SOFT_LINK_PRIVATE_FRAMEWORK(WebContentAnalysis);
40 SOFT_LINK_CLASS(WebContentAnalysis, WebFilterEvaluator);
41
42 namespace WebCore {
43
44 bool ParentalControlsContentFilter::enabled()
45 {
46     bool enabled = [getWebFilterEvaluatorClass() isManagedSession];
47     LOG(ContentFiltering, "ParentalControlsContentFilter is %s.\n", enabled ? "enabled" : "not enabled");
48     return enabled;
49 }
50
51 std::unique_ptr<ParentalControlsContentFilter> ParentalControlsContentFilter::create()
52 {
53     return makeUnique<ParentalControlsContentFilter>();
54 }
55
56 static inline bool canHandleResponse(const ResourceResponse& response)
57 {
58 #if PLATFORM(MAC) || PLATFORM(MACCATALYST)
59     return response.url().protocolIs("https");
60 #else
61     return response.url().protocolIsInHTTPFamily();
62 #endif
63 }
64
65 void ParentalControlsContentFilter::responseReceived(const ResourceResponse& response)
66 {
67     ASSERT(!m_webFilterEvaluator);
68
69     if (!canHandleResponse(response) || !enabled()) {
70         m_state = State::Allowed;
71         return;
72     }
73
74     m_webFilterEvaluator = adoptNS([allocWebFilterEvaluatorInstance() initWithResponse:response.nsURLResponse()]);
75     updateFilterState();
76 }
77
78 void ParentalControlsContentFilter::addData(const char* data, int length)
79 {
80     ASSERT(![m_replacementData.get() length]);
81     m_replacementData = [m_webFilterEvaluator addData:[NSData dataWithBytesNoCopy:(void*)data length:length freeWhenDone:NO]];
82     updateFilterState();
83     ASSERT(needsMoreData() || [m_replacementData.get() length]);
84 }
85
86 void ParentalControlsContentFilter::finishedAddingData()
87 {
88     ASSERT(![m_replacementData.get() length]);
89     m_replacementData = [m_webFilterEvaluator dataComplete];
90     updateFilterState();
91 }
92
93 Ref<SharedBuffer> ParentalControlsContentFilter::replacementData() const
94 {
95     ASSERT(didBlockData());
96     return SharedBuffer::create(m_replacementData.get());
97 }
98
99 #if ENABLE(CONTENT_FILTERING)
100 ContentFilterUnblockHandler ParentalControlsContentFilter::unblockHandler() const
101 {
102 #if HAVE(PARENTAL_CONTROLS_WITH_UNBLOCK_HANDLER)
103     return ContentFilterUnblockHandler { "unblock"_s, m_webFilterEvaluator };
104 #else
105     return { };
106 #endif
107 }
108 #endif
109
110 void ParentalControlsContentFilter::updateFilterState()
111 {
112     switch ([m_webFilterEvaluator filterState]) {
113     case kWFEStateAllowed:
114     case kWFEStateEvaluating:
115         m_state = State::Allowed;
116         break;
117     case kWFEStateBlocked:
118         m_state = State::Blocked;
119         break;
120     case kWFEStateBuffering:
121         m_state = State::Filtering;
122         break;
123     }
124
125 #if !LOG_DISABLED
126     if (!needsMoreData())
127         LOG(ContentFiltering, "ParentalControlsContentFilter stopped buffering with state %d and replacement data length %zu.\n", m_state, [m_replacementData length]);
128 #endif
129 }
130
131 } // namespace WebCore
132
133 #endif // HAVE(PARENTAL_CONTROLS)