Parse and handle Ad Click Attribution attributes in HTMLAnchorElement::handleClick()
[WebKit-https.git] / Source / WebCore / html / HTMLAnchorElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Simon Hausmann <hausmann@kde.org>
5  * Copyright (C) 2007-2016 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #pragma once
25
26 #include "HTMLElement.h"
27 #include "HTMLNames.h"
28 #include "SharedStringHash.h"
29 #include "URLUtils.h"
30 #include <wtf/OptionSet.h>
31 #include <wtf/Optional.h>
32
33 namespace WebCore {
34
35 class AdClickAttribution;
36 class DOMTokenList;
37
38 // Link relation bitmask values.
39 enum class Relation {
40     NoReferrer = 1 << 0,
41     NoOpener = 1 << 1,
42     Opener = 1 << 2,
43 };
44
45 class HTMLAnchorElement : public HTMLElement, public URLUtils<HTMLAnchorElement> {
46     WTF_MAKE_ISO_ALLOCATED(HTMLAnchorElement);
47 public:
48     static Ref<HTMLAnchorElement> create(Document&);
49     static Ref<HTMLAnchorElement> create(const QualifiedName&, Document&);
50
51     virtual ~HTMLAnchorElement();
52
53     WEBCORE_EXPORT URL href() const;
54     void setHref(const AtomicString&);
55
56     const AtomicString& name() const;
57
58     WEBCORE_EXPORT String origin() const;
59
60     WEBCORE_EXPORT String text();
61     void setText(const String&);
62
63     bool isLiveLink() const;
64
65     bool willRespondToMouseClickEvents() final;
66
67     bool hasRel(Relation) const;
68     
69     SharedStringHash visitedLinkHash() const;
70     void invalidateCachedVisitedLinkHash() { m_cachedVisitedLinkHash = 0; }
71
72     WEBCORE_EXPORT DOMTokenList& relList() const;
73
74 #if USE(SYSTEM_PREVIEW)
75     WEBCORE_EXPORT bool isSystemPreviewLink() const;
76 #endif
77
78 protected:
79     HTMLAnchorElement(const QualifiedName&, Document&);
80
81     void parseAttribute(const QualifiedName&, const AtomicString&) override;
82
83 private:
84     bool supportsFocus() const override;
85     bool isMouseFocusable() const override;
86     bool isKeyboardFocusable(KeyboardEvent*) const override;
87     void defaultEventHandler(Event&) final;
88     void setActive(bool active = true, bool pause = false) final;
89     void accessKeyAction(bool sendMouseEvents) final;
90     bool isURLAttribute(const Attribute&) const final;
91     bool canStartSelection() const final;
92     String target() const override;
93     int tabIndex() const final;
94     bool draggable() const final;
95
96     String effectiveTarget() const;
97
98     void sendPings(const URL& destinationURL);
99
100     Optional<AdClickAttribution> parseAdClickAttribution() const;
101
102     void handleClick(Event&);
103
104     enum EventType {
105         MouseEventWithoutShiftKey,
106         MouseEventWithShiftKey,
107         NonMouseEvent,
108     };
109     static EventType eventType(Event&);
110     bool treatLinkAsLiveForEventType(EventType) const;
111
112     Element* rootEditableElementForSelectionOnMouseDown() const;
113     void setRootEditableElementForSelectionOnMouseDown(Element*);
114     void clearRootEditableElementForSelectionOnMouseDown();
115
116     bool m_hasRootEditableElementForSelectionOnMouseDown;
117     bool m_wasShiftKeyDownOnMouseDown;
118     OptionSet<Relation> m_linkRelations;
119     mutable SharedStringHash m_cachedVisitedLinkHash;
120
121     mutable std::unique_ptr<DOMTokenList> m_relList;
122 };
123
124 inline SharedStringHash HTMLAnchorElement::visitedLinkHash() const
125 {
126     if (!m_cachedVisitedLinkHash)
127         m_cachedVisitedLinkHash = computeVisitedLinkHash(document().baseURL(), attributeWithoutSynchronization(HTMLNames::hrefAttr));
128     return m_cachedVisitedLinkHash; 
129 }
130
131 // Functions shared with the other anchor elements (i.e., SVG).
132
133 bool isEnterKeyKeydownEvent(Event&);
134 bool shouldProhibitLinks(Element*);
135
136 } // namespace WebCore