Add a "block-cookies" rule to the user content filter.
[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 <wtf/text/WTFString.h>
32
33 namespace WebCore {
34
35 namespace ContentExtensions {
36
37 enum class ExtensionActionType {
38     BlockLoad,
39     BlockCookies,
40     IgnorePreviousRules
41 };
42
43 // A ContentExtensionRule is the smallest unit in a ContentExtension.
44 //
45 // It is composed of a trigger and an action. The trigger defines on what kind of content this extension should apply.
46 // The action defines what to perform on that content.
47 class ContentExtensionRule {
48 public:
49     struct Trigger {
50         String urlFilter;
51         bool urlFilterIsCaseSensitive = false;
52     };
53
54     struct Action {
55         ExtensionActionType type;
56     };
57
58     ContentExtensionRule(const Trigger&, const Action&);
59
60     const Trigger& trigger() const { return m_trigger; }
61     const Action& action() const { return m_action; }
62
63 private:
64     Trigger m_trigger;
65     Action m_action;
66 };
67
68 } // namespace ContentExtensions
69
70 } // namespace WebCore
71
72 #endif // ENABLE(CONTENT_EXTENSIONS)
73
74 #endif // ContentExtensionRule_h