451929f7b1ac452d500a1b424410e1f37ad27d7d
[WebKit-https.git] / Source / WebCore / page / UserContentController.h
1 /*
2  * Copyright (C) 2014 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 UserContentController_h
27 #define UserContentController_h
28
29 #include "UserScriptTypes.h"
30 #include "UserStyleSheetTypes.h"
31 #include <wtf/HashSet.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34
35 #if ENABLE(USER_MESSAGE_HANDLERS)
36 #include "UserMessageHandlerDescriptorTypes.h"
37 #endif
38
39 namespace WebCore {
40
41 class DOMWrapperWorld;
42 class Page;
43 class URL;
44 class UserScript;
45 class UserStyleSheet;
46 class UserMessageHandlerDescriptor;
47
48 namespace ContentExtensions {
49 class ContentExtensionsBackend;
50 }
51
52 enum class ContentFilterAction {
53     Load,
54     Block,
55     BlockCookies
56 };
57
58 class UserContentController : public RefCounted<UserContentController> {
59 public:
60     WEBCORE_EXPORT static RefPtr<UserContentController> create();
61     WEBCORE_EXPORT ~UserContentController();
62
63     void addPage(Page&);
64     void removePage(Page&);
65
66     const UserScriptMap* userScripts() const { return m_userScripts.get(); }
67
68     WEBCORE_EXPORT void addUserScript(DOMWrapperWorld&, std::unique_ptr<UserScript>);
69     WEBCORE_EXPORT void removeUserScript(DOMWrapperWorld&, const URL&);
70     WEBCORE_EXPORT void removeUserScripts(DOMWrapperWorld&);
71
72     const UserStyleSheetMap* userStyleSheets() const { return m_userStyleSheets.get(); }
73
74     WEBCORE_EXPORT void addUserStyleSheet(DOMWrapperWorld&, std::unique_ptr<UserStyleSheet>, UserStyleInjectionTime);
75     WEBCORE_EXPORT void removeUserStyleSheet(DOMWrapperWorld&, const URL&);
76     WEBCORE_EXPORT void removeUserStyleSheets(DOMWrapperWorld&);
77
78     WEBCORE_EXPORT void removeAllUserContent();
79
80 #if ENABLE(USER_MESSAGE_HANDLERS)
81     const UserMessageHandlerDescriptorMap* userMessageHandlerDescriptors() const { return m_userMessageHandlerDescriptors.get(); }
82
83     WEBCORE_EXPORT void addUserMessageHandlerDescriptor(UserMessageHandlerDescriptor&);
84     WEBCORE_EXPORT void removeUserMessageHandlerDescriptor(UserMessageHandlerDescriptor&);
85 #endif
86
87 #if ENABLE(CONTENT_EXTENSIONS)
88     // FIXME: This should really take a pointer to a compiled UserContentFilter.
89     WEBCORE_EXPORT void addUserContentFilter(const String& name, const String& ruleList);
90     WEBCORE_EXPORT void removeUserContentFilter(const String& name);
91     WEBCORE_EXPORT void removeAllUserContentFilters();
92     
93     // FIXME: Consider putting this (and other future content filter predicates) in its own class.
94     ContentFilterAction actionForURL(const URL&);
95 #endif
96
97 private:
98     UserContentController();
99
100     void invalidateInjectedStyleSheetCacheInAllFrames();
101
102     HashSet<Page*> m_pages;
103
104     std::unique_ptr<UserScriptMap> m_userScripts;
105     std::unique_ptr<UserStyleSheetMap> m_userStyleSheets;
106 #if ENABLE(USER_MESSAGE_HANDLERS)
107     std::unique_ptr<UserMessageHandlerDescriptorMap> m_userMessageHandlerDescriptors;
108 #endif
109 #if ENABLE(CONTENT_EXTENSIONS)
110     std::unique_ptr<ContentExtensions::ContentExtensionsBackend> m_contentExtensionBackend;
111 #endif
112 };
113
114 } // namespace WebCore
115
116 #endif // UserContentController_h