Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / page / UserContentProvider.h
1 /*
2  * Copyright (C) 2016 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 #include <functional>
29 #include <wtf/Forward.h>
30 #include <wtf/Function.h>
31 #include <wtf/HashSet.h>
32 #include <wtf/RefCounted.h>
33
34 #if ENABLE(CONTENT_EXTENSIONS)
35 #include "ContentExtensionActions.h"
36 #include "ContentExtensionsBackend.h"
37 #endif
38
39 namespace WebCore {
40
41 class DOMWrapperWorld;
42 class DocumentLoader;
43 class Page;
44 class ResourceRequest;
45 class UserMessageHandlerDescriptor;
46 class UserScript;
47 class UserStyleSheet;
48
49 enum class ResourceType : uint16_t;
50
51 struct ResourceLoadInfo;
52
53 namespace ContentExtensions {
54 class ContentExtensionsBackend;
55 struct Action;
56 }
57
58 class UserContentProvider;
59
60 class UserContentProviderInvalidationClient {
61 public:
62     virtual ~UserContentProviderInvalidationClient()
63     {
64     }
65     
66     virtual void didInvalidate(UserContentProvider&) = 0;
67 };
68
69 class UserContentProvider : public RefCounted<UserContentProvider> {
70 public:
71     WEBCORE_EXPORT UserContentProvider();
72     WEBCORE_EXPORT virtual ~UserContentProvider();
73
74     virtual void forEachUserScript(Function<void(DOMWrapperWorld&, const UserScript&)>&&) const = 0;
75     virtual void forEachUserStyleSheet(Function<void(const UserStyleSheet&)>&&) const = 0;
76 #if ENABLE(USER_MESSAGE_HANDLERS)
77     virtual void forEachUserMessageHandler(Function<void(const UserMessageHandlerDescriptor&)>&&) const = 0;
78 #endif
79 #if ENABLE(CONTENT_EXTENSIONS)
80     virtual ContentExtensions::ContentExtensionsBackend& userContentExtensionBackend() = 0;
81 #endif
82
83     void registerForUserMessageHandlerInvalidation(UserContentProviderInvalidationClient&);
84     void unregisterForUserMessageHandlerInvalidation(UserContentProviderInvalidationClient&);
85
86     void addPage(Page&);
87     void removePage(Page&);
88
89 #if ENABLE(CONTENT_EXTENSIONS)
90     // FIXME: These don't really belong here. They should probably bundled up in the ContentExtensionsBackend
91     // which should always exist.
92     ContentExtensions::BlockedStatus processContentExtensionRulesForLoad(const URL&, ResourceType, DocumentLoader& initiatingDocumentLoader);
93     std::pair<Vector<ContentExtensions::Action>, Vector<String>> actionsForResourceLoad(const ResourceLoadInfo&, DocumentLoader& initiatingDocumentLoader);
94     WEBCORE_EXPORT void forEachContentExtension(const WTF::Function<void(const String&, ContentExtensions::ContentExtension&)>&, DocumentLoader& initiatingDocumentLoader);
95 #endif
96
97 protected:
98     WEBCORE_EXPORT void invalidateAllRegisteredUserMessageHandlerInvalidationClients();
99     WEBCORE_EXPORT void invalidateInjectedStyleSheetCacheInAllFramesInAllPages();
100
101 private:
102     HashSet<Page*> m_pages;
103     HashSet<UserContentProviderInvalidationClient*> m_userMessageHandlerInvalidationClients;
104 };
105
106 } // namespace WebCore