e97d9a4303510b15da2a7bef7b107a875fd663b9
[WebKit-https.git] / Source / WebCore / contentextensions / ContentExtensionsBackend.h
1 /*
2  * Copyright (C) 2014, 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 ContentExtensionsBackend_h
27 #define ContentExtensionsBackend_h
28
29 #if ENABLE(CONTENT_EXTENSIONS)
30
31 #include "ContentExtensionRule.h"
32 #include "DFA.h"
33 #include "DFABytecode.h"
34 #include "UserContentController.h"
35 #include <wtf/HashMap.h>
36 #include <wtf/text/StringHash.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 class URL;
42
43 namespace ContentExtensions {
44
45 // The ContentExtensionsBackend is the internal model of all the content extensions.
46 //
47 // It provides two services:
48 // 1) It stores the rules for each content extension.
49 // 2) It provides APIs for the WebCore interfaces to use those rules efficiently.
50 class ContentExtensionsBackend {
51 public:
52     // - Rule management interface. This can be used by upper layer.
53
54     // Set a list of rules for a given name. If there were existing rules for the name, they are overriden.
55     // The identifier cannot be empty.
56     void setRuleList(const String& identifier, const Vector<ContentExtensionRule>&);
57     void removeRuleList(const String& identifier);
58     void removeAllRuleLists();
59
60     // - Internal WebCore Interface.
61     ContentFilterAction actionForURL(const URL&);
62
63 private:
64     struct CompiledContentExtension {
65         Vector<DFABytecode> bytecode;
66         Vector<ContentExtensionRule> ruleList;
67     };
68
69     HashMap<String, CompiledContentExtension> m_ruleLists;
70 };
71
72 } // namespace ContentExtensions
73
74 } // namespace WebCore
75
76 #endif // ENABLE(CONTENT_EXTENSIONS)
77
78 #endif // ContentExtensionsBackend_h