Content extension with oft-repeated rules can cause slowdown.
[WebKit-https.git] / Source / WebCore / contentextensions / ContentExtensionRule.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 ContentExtensionRule_h
27 #define ContentExtensionRule_h
28
29 #if ENABLE(CONTENT_EXTENSIONS)
30
31 #include "ContentExtensionActions.h"
32 #include "ResourceLoadInfo.h"
33 #include <wtf/text/WTFString.h>
34
35 namespace WebCore {
36
37 namespace ContentExtensions {
38
39 // A ContentExtensionRule is the smallest unit in a ContentExtension.
40 //
41 // It is composed of a trigger and an action. The trigger defines on what kind of content this extension should apply.
42 // The action defines what to perform on that content.
43
44 struct Trigger {
45     String urlFilter;
46     bool urlFilterIsCaseSensitive { false };
47     ResourceFlags flags { 0 };
48     bool operator==(const Trigger& other) const
49     {
50         return urlFilter == other.urlFilter
51             && urlFilterIsCaseSensitive == other.urlFilterIsCaseSensitive
52             && flags == other.flags;
53     }
54 };
55     
56 struct Action {
57     Action()
58         : m_type(ActionType::InvalidAction)
59         , m_actionID(std::numeric_limits<uint32_t>::max())
60     {
61     }
62
63     Action(ActionType type, const String& stringArgument, uint32_t actionID = std::numeric_limits<uint32_t>::max())
64         : m_type(type)
65         , m_actionID(actionID)
66         , m_stringArgument(stringArgument)
67     {
68         ASSERT(type == ActionType::CSSDisplayNoneSelector || type == ActionType::CSSDisplayNoneStyleSheet);
69     }
70
71     Action(ActionType type, uint32_t actionID = std::numeric_limits<uint32_t>::max())
72         : m_type(type)
73         , m_actionID(actionID)
74     {
75         ASSERT(type != ActionType::CSSDisplayNoneSelector && type != ActionType::CSSDisplayNoneStyleSheet);
76     }
77
78     bool operator==(const Action& other) const
79     {
80         return m_type == other.m_type
81             && m_extensionIdentifier == other.m_extensionIdentifier
82             && m_actionID == other.m_actionID
83             && m_stringArgument == other.m_stringArgument;
84     }
85
86     static Action deserialize(const SerializedActionByte* actions, const unsigned actionsLength, uint32_t location);
87
88     void setExtensionIdentifier(const String& extensionIdentifier) { m_extensionIdentifier = extensionIdentifier; }
89     const String& extensionIdentifier() const { return m_extensionIdentifier; }
90     ActionType type() const { return m_type; }
91     uint32_t actionID() const { return m_actionID; }
92     const String& stringArgument() const { return m_stringArgument; }
93
94 private:
95     String m_extensionIdentifier;
96     ActionType m_type;
97     uint32_t m_actionID;
98     String m_stringArgument;
99 };
100     
101 class ContentExtensionRule {
102 public:
103     ContentExtensionRule(const Trigger&, const Action&);
104
105     const Trigger& trigger() const { return m_trigger; }
106     const Action& action() const { return m_action; }
107
108 private:
109     Trigger m_trigger;
110     Action m_action;
111 };
112
113 } // namespace ContentExtensions
114
115 } // namespace WebCore
116
117 #endif // ENABLE(CONTENT_EXTENSIONS)
118
119 #endif // ContentExtensionRule_h