[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / html / HTMLAnchorElement.cpp
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) 2003-2016 Apple Inc. All rights reserved.
6  *           (C) 2006 Graham Dennis (graham.dennis@gmail.com)
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25 #include "HTMLAnchorElement.h"
26
27 #include "DOMTokenList.h"
28 #include "ElementIterator.h"
29 #include "EventHandler.h"
30 #include "EventNames.h"
31 #include "Frame.h"
32 #include "FrameLoader.h"
33 #include "FrameLoaderClient.h"
34 #include "FrameLoaderTypes.h"
35 #include "FrameSelection.h"
36 #include "HTMLCanvasElement.h"
37 #include "HTMLImageElement.h"
38 #include "HTMLParserIdioms.h"
39 #include "KeyboardEvent.h"
40 #include "MouseEvent.h"
41 #include "PingLoader.h"
42 #include "PlatformMouseEvent.h"
43 #include "RenderImage.h"
44 #include "ResourceRequest.h"
45 #include "RuntimeEnabledFeatures.h"
46 #include "SVGImage.h"
47 #include "ScriptController.h"
48 #include "SecurityOrigin.h"
49 #include "SecurityPolicy.h"
50 #include "Settings.h"
51 #include "URLUtils.h"
52 #include <wtf/text/StringBuilder.h>
53
54 namespace WebCore {
55
56 using namespace HTMLNames;
57
58 HTMLAnchorElement::HTMLAnchorElement(const QualifiedName& tagName, Document& document)
59     : HTMLElement(tagName, document)
60     , m_hasRootEditableElementForSelectionOnMouseDown(false)
61     , m_wasShiftKeyDownOnMouseDown(false)
62     , m_cachedVisitedLinkHash(0)
63 {
64 }
65
66 Ref<HTMLAnchorElement> HTMLAnchorElement::create(Document& document)
67 {
68     return adoptRef(*new HTMLAnchorElement(aTag, document));
69 }
70
71 Ref<HTMLAnchorElement> HTMLAnchorElement::create(const QualifiedName& tagName, Document& document)
72 {
73     return adoptRef(*new HTMLAnchorElement(tagName, document));
74 }
75
76 HTMLAnchorElement::~HTMLAnchorElement()
77 {
78     clearRootEditableElementForSelectionOnMouseDown();
79 }
80
81 bool HTMLAnchorElement::supportsFocus() const
82 {
83     if (hasEditableStyle())
84         return HTMLElement::supportsFocus();
85     // If not a link we should still be able to focus the element if it has tabIndex.
86     return isLink() || HTMLElement::supportsFocus();
87 }
88
89 bool HTMLAnchorElement::isMouseFocusable() const
90 {
91     // Only allow links with tabIndex or contentEditable to be mouse focusable.
92     if (isLink())
93         return HTMLElement::supportsFocus();
94
95     return HTMLElement::isMouseFocusable();
96 }
97
98 static bool hasNonEmptyBox(RenderBoxModelObject* renderer)
99 {
100     if (!renderer)
101         return false;
102
103     // Before calling absoluteRects, check for the common case where borderBoundingBox
104     // is non-empty, since this is a faster check and almost always returns true.
105     // FIXME: Why do we need to call absoluteRects at all?
106     if (!renderer->borderBoundingBox().isEmpty())
107         return true;
108
109     // FIXME: Since all we are checking is whether the rects are empty, could we just
110     // pass in 0,0 for the layout point instead of calling localToAbsolute?
111     Vector<IntRect> rects;
112     renderer->absoluteRects(rects, flooredLayoutPoint(renderer->localToAbsolute()));
113     for (auto& rect : rects) {
114         if (!rect.isEmpty())
115             return true;
116     }
117
118     return false;
119 }
120
121 bool HTMLAnchorElement::isKeyboardFocusable(KeyboardEvent& event) const
122 {
123     if (!isLink())
124         return HTMLElement::isKeyboardFocusable(event);
125
126     if (!isFocusable())
127         return false;
128     
129     if (!document().frame())
130         return false;
131
132     if (!document().frame()->eventHandler().tabsToLinks(&event))
133         return false;
134
135     if (!renderer() && ancestorsOfType<HTMLCanvasElement>(*this).first())
136         return true;
137
138     return hasNonEmptyBox(renderBoxModelObject());
139 }
140
141 static void appendServerMapMousePosition(StringBuilder& url, Event& event)
142 {
143     if (!is<MouseEvent>(event))
144         return;
145     auto& mouseEvent = downcast<MouseEvent>(event);
146
147     ASSERT(mouseEvent.target());
148     auto* target = mouseEvent.target()->toNode();
149     ASSERT(target);
150     if (!is<HTMLImageElement>(*target))
151         return;
152
153     auto& imageElement = downcast<HTMLImageElement>(*target);
154     if (!imageElement.isServerMap())
155         return;
156
157     auto* renderer = imageElement.renderer();
158     if (!is<RenderImage>(renderer))
159         return;
160
161     // FIXME: This should probably pass UseTransforms in the MapCoordinatesFlags.
162     auto absolutePosition = downcast<RenderImage>(*renderer).absoluteToLocal(FloatPoint(mouseEvent.pageX(), mouseEvent.pageY()));
163     url.append('?');
164     url.appendNumber(std::lround(absolutePosition.x()));
165     url.append(',');
166     url.appendNumber(std::lround(absolutePosition.y()));
167 }
168
169 void HTMLAnchorElement::defaultEventHandler(Event& event)
170 {
171     if (isLink()) {
172         if (focused() && isEnterKeyKeydownEvent(event) && treatLinkAsLiveForEventType(NonMouseEvent)) {
173             event.setDefaultHandled();
174             dispatchSimulatedClick(&event);
175             return;
176         }
177
178         if (MouseEvent::canTriggerActivationBehavior(event) && treatLinkAsLiveForEventType(eventType(event))) {
179             handleClick(event);
180             return;
181         }
182
183         if (hasEditableStyle()) {
184             // This keeps track of the editable block that the selection was in (if it was in one) just before the link was clicked
185             // for the LiveWhenNotFocused editable link behavior
186             if (event.type() == eventNames().mousedownEvent && is<MouseEvent>(event) && downcast<MouseEvent>(event).button() != RightButton && document().frame()) {
187                 setRootEditableElementForSelectionOnMouseDown(document().frame()->selection().selection().rootEditableElement());
188                 m_wasShiftKeyDownOnMouseDown = downcast<MouseEvent>(event).shiftKey();
189             } else if (event.type() == eventNames().mouseoverEvent) {
190                 // These are cleared on mouseover and not mouseout because their values are needed for drag events,
191                 // but drag events happen after mouse out events.
192                 clearRootEditableElementForSelectionOnMouseDown();
193                 m_wasShiftKeyDownOnMouseDown = false;
194             }
195         }
196     }
197
198     HTMLElement::defaultEventHandler(event);
199 }
200
201 void HTMLAnchorElement::setActive(bool down, bool pause)
202 {
203     if (hasEditableStyle()) {
204         EditableLinkBehavior editableLinkBehavior = EditableLinkDefaultBehavior;
205         if (Settings* settings = document().settings())
206             editableLinkBehavior = settings->editableLinkBehavior();
207             
208         switch (editableLinkBehavior) {
209             default:
210             case EditableLinkDefaultBehavior:
211             case EditableLinkAlwaysLive:
212                 break;
213
214             case EditableLinkNeverLive:
215                 return;
216
217             // Don't set the link to be active if the current selection is in the same editable block as
218             // this link
219             case EditableLinkLiveWhenNotFocused:
220                 if (down && document().frame() && document().frame()->selection().selection().rootEditableElement() == rootEditableElement())
221                     return;
222                 break;
223             
224             case EditableLinkOnlyLiveWithShiftKey:
225                 return;
226         }
227
228     }
229     
230     HTMLElement::setActive(down, pause);
231 }
232
233 void HTMLAnchorElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
234 {
235     if (name == hrefAttr) {
236         bool wasLink = isLink();
237         setIsLink(!value.isNull() && !shouldProhibitLinks(this));
238         if (wasLink != isLink())
239             invalidateStyleForSubtree();
240         if (isLink()) {
241             String parsedURL = stripLeadingAndTrailingHTMLSpaces(value);
242             if (document().isDNSPrefetchEnabled() && document().frame()) {
243                 if (protocolIsInHTTPFamily(parsedURL) || parsedURL.startsWith("//"))
244                     document().frame()->loader().client().prefetchDNS(document().completeURL(parsedURL).host());
245             }
246         }
247         invalidateCachedVisitedLinkHash();
248     } else if (name == nameAttr || name == titleAttr) {
249         // Do nothing.
250     } else if (name == relAttr) {
251         // Update HTMLAnchorElement::relList() if more rel attributes values are supported.
252         static NeverDestroyed<AtomicString> noReferrer("noreferrer", AtomicString::ConstructFromLiteral);
253         static NeverDestroyed<AtomicString> noOpener("noopener", AtomicString::ConstructFromLiteral);
254         const bool shouldFoldCase = true;
255         SpaceSplitString relValue(value, shouldFoldCase);
256         if (relValue.contains(noReferrer))
257             m_linkRelations |= Relation::NoReferrer;
258         if (relValue.contains(noOpener))
259             m_linkRelations |= Relation::NoOpener;
260         if (m_relList)
261             m_relList->associatedAttributeValueChanged(value);
262     }
263     else
264         HTMLElement::parseAttribute(name, value);
265 }
266
267 void HTMLAnchorElement::accessKeyAction(bool sendMouseEvents)
268 {
269     dispatchSimulatedClick(0, sendMouseEvents ? SendMouseUpDownEvents : SendNoEvents);
270 }
271
272 bool HTMLAnchorElement::isURLAttribute(const Attribute& attribute) const
273 {
274     return attribute.name().localName() == hrefAttr || HTMLElement::isURLAttribute(attribute);
275 }
276
277 bool HTMLAnchorElement::canStartSelection() const
278 {
279     if (!isLink())
280         return HTMLElement::canStartSelection();
281     return hasEditableStyle();
282 }
283
284 bool HTMLAnchorElement::draggable() const
285 {
286     const AtomicString& value = attributeWithoutSynchronization(draggableAttr);
287     if (equalLettersIgnoringASCIICase(value, "true"))
288         return true;
289     if (equalLettersIgnoringASCIICase(value, "false"))
290         return false;
291     return hasAttributeWithoutSynchronization(hrefAttr);
292 }
293
294 URL HTMLAnchorElement::href() const
295 {
296     return document().completeURL(stripLeadingAndTrailingHTMLSpaces(attributeWithoutSynchronization(hrefAttr)));
297 }
298
299 void HTMLAnchorElement::setHref(const AtomicString& value)
300 {
301     setAttributeWithoutSynchronization(hrefAttr, value);
302 }
303
304 bool HTMLAnchorElement::hasRel(Relation relation) const
305 {
306     return m_linkRelations.contains(relation);
307 }
308
309 DOMTokenList& HTMLAnchorElement::relList()
310 {
311     if (!m_relList) 
312         m_relList = std::make_unique<DOMTokenList>(*this, HTMLNames::relAttr, [](StringView token) {
313             return equalIgnoringASCIICase(token, "noreferrer") || equalIgnoringASCIICase(token, "noopener");
314         });
315     return *m_relList;
316 }
317
318 const AtomicString& HTMLAnchorElement::name() const
319 {
320     return getNameAttribute();
321 }
322
323 int HTMLAnchorElement::tabIndex() const
324 {
325     // Skip the supportsFocus check in HTMLElement.
326     return Element::tabIndex();
327 }
328
329 String HTMLAnchorElement::target() const
330 {
331     return attributeWithoutSynchronization(targetAttr);
332 }
333
334 String HTMLAnchorElement::origin() const
335 {
336     return SecurityOrigin::create(href()).get().toString();
337 }
338
339 String HTMLAnchorElement::text()
340 {
341     return textContent();
342 }
343
344 void HTMLAnchorElement::setText(const String& text)
345 {
346     setTextContent(text);
347 }
348
349 bool HTMLAnchorElement::isLiveLink() const
350 {
351     return isLink() && treatLinkAsLiveForEventType(m_wasShiftKeyDownOnMouseDown ? MouseEventWithShiftKey : MouseEventWithoutShiftKey);
352 }
353
354 void HTMLAnchorElement::sendPings(const URL& destinationURL)
355 {
356     if (!hasAttributeWithoutSynchronization(pingAttr) || !document().settings() || !document().settings()->hyperlinkAuditingEnabled())
357         return;
358
359     SpaceSplitString pingURLs(attributeWithoutSynchronization(pingAttr), false);
360     for (unsigned i = 0; i < pingURLs.size(); i++)
361         PingLoader::sendPing(*document().frame(), document().completeURL(pingURLs[i]), destinationURL);
362 }
363
364 void HTMLAnchorElement::handleClick(Event& event)
365 {
366     event.setDefaultHandled();
367
368     Frame* frame = document().frame();
369     if (!frame)
370         return;
371
372     StringBuilder url;
373     url.append(stripLeadingAndTrailingHTMLSpaces(attributeWithoutSynchronization(hrefAttr)));
374     appendServerMapMousePosition(url, event);
375     URL completedURL = document().completeURL(url.toString());
376
377     auto downloadAttribute = nullAtom;
378 #if ENABLE(DOWNLOAD_ATTRIBUTE)
379     if (RuntimeEnabledFeatures::sharedFeatures().downloadAttributeEnabled()) {
380         // Ignore the download attribute completely if the href URL is cross origin.
381         bool isSameOrigin = completedURL.protocolIsData() || document().securityOrigin()->canRequest(completedURL);
382         if (isSameOrigin)
383             downloadAttribute = attributeWithoutSynchronization(downloadAttr);
384         else if (hasAttributeWithoutSynchronization(downloadAttr))
385             document().addConsoleMessage(MessageSource::Security, MessageLevel::Warning, "The download attribute on anchor was ignored because its href URL has a different security origin.");
386         // If the a element has a download attribute and the algorithm is not triggered by user activation
387         // then abort these steps.
388         // https://html.spec.whatwg.org/#the-a-element:triggered-by-user-activation
389         if (!downloadAttribute.isNull() && !event.isTrusted() && !ScriptController::processingUserGesture()) {
390             // The specification says to throw an InvalidAccessError but other browsers do not.
391             document().addConsoleMessage(MessageSource::Security, MessageLevel::Warning, "Non user-triggered activations of anchors that have a download attribute are ignored.");
392             return;
393         }
394     }
395 #endif
396
397     ShouldSendReferrer shouldSendReferrer = hasRel(Relation::NoReferrer) ? NeverSendReferrer : MaybeSendReferrer;
398     auto newFrameOpenerPolicy = hasRel(Relation::NoOpener) ? std::make_optional(NewFrameOpenerPolicy::Suppress) : std::nullopt;
399     frame->loader().urlSelected(completedURL, target(), &event, LockHistory::No, LockBackForwardList::No, shouldSendReferrer, document().shouldOpenExternalURLsPolicyToPropagate(), newFrameOpenerPolicy, downloadAttribute);
400
401     sendPings(completedURL);
402 }
403
404 HTMLAnchorElement::EventType HTMLAnchorElement::eventType(Event& event)
405 {
406     if (!is<MouseEvent>(event))
407         return NonMouseEvent;
408     return downcast<MouseEvent>(event).shiftKey() ? MouseEventWithShiftKey : MouseEventWithoutShiftKey;
409 }
410
411 bool HTMLAnchorElement::treatLinkAsLiveForEventType(EventType eventType) const
412 {
413     if (!hasEditableStyle())
414         return true;
415
416     Settings* settings = document().settings();
417     if (!settings)
418         return true;
419
420     switch (settings->editableLinkBehavior()) {
421     case EditableLinkDefaultBehavior:
422     case EditableLinkAlwaysLive:
423         return true;
424
425     case EditableLinkNeverLive:
426         return false;
427
428     // If the selection prior to clicking on this link resided in the same editable block as this link,
429     // and the shift key isn't pressed, we don't want to follow the link.
430     case EditableLinkLiveWhenNotFocused:
431         return eventType == MouseEventWithShiftKey || (eventType == MouseEventWithoutShiftKey && rootEditableElementForSelectionOnMouseDown() != rootEditableElement());
432
433     case EditableLinkOnlyLiveWithShiftKey:
434         return eventType == MouseEventWithShiftKey;
435     }
436
437     ASSERT_NOT_REACHED();
438     return false;
439 }
440
441 bool isEnterKeyKeydownEvent(Event& event)
442 {
443     return event.type() == eventNames().keydownEvent && is<KeyboardEvent>(event) && downcast<KeyboardEvent>(event).keyIdentifier() == "Enter";
444 }
445
446 bool shouldProhibitLinks(Element* element)
447 {
448     return isInSVGImage(element);
449 }
450
451 bool HTMLAnchorElement::willRespondToMouseClickEvents()
452 {
453     return isLink() || HTMLElement::willRespondToMouseClickEvents();
454 }
455
456 typedef HashMap<const HTMLAnchorElement*, RefPtr<Element>> RootEditableElementMap;
457
458 static RootEditableElementMap& rootEditableElementMap()
459 {
460     static NeverDestroyed<RootEditableElementMap> map;
461     return map;
462 }
463
464 Element* HTMLAnchorElement::rootEditableElementForSelectionOnMouseDown() const
465 {
466     if (!m_hasRootEditableElementForSelectionOnMouseDown)
467         return 0;
468     return rootEditableElementMap().get(this);
469 }
470
471 void HTMLAnchorElement::clearRootEditableElementForSelectionOnMouseDown()
472 {
473     if (!m_hasRootEditableElementForSelectionOnMouseDown)
474         return;
475     rootEditableElementMap().remove(this);
476     m_hasRootEditableElementForSelectionOnMouseDown = false;
477 }
478
479 void HTMLAnchorElement::setRootEditableElementForSelectionOnMouseDown(Element* element)
480 {
481     if (!element) {
482         clearRootEditableElementForSelectionOnMouseDown();
483         return;
484     }
485
486     rootEditableElementMap().set(this, element);
487     m_hasRootEditableElementForSelectionOnMouseDown = true;
488 }
489
490 }