04139cb72c031c858e58f1cfde3cf11b939adb0b
[WebKit-https.git] / Source / WebCore / html / HTMLLinkElement.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2003, 2006, 2007, 2008, 2009, 2010, 2014 Apple Inc. All rights reserved.
6  * Copyright (C) 2009 Rob Buis (rwlbuis@gmail.com)
7  * Copyright (C) 2011 Google Inc. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #include "config.h"
26 #include "HTMLLinkElement.h"
27
28 #include "Attribute.h"
29 #include "CachedCSSStyleSheet.h"
30 #include "CachedResource.h"
31 #include "CachedResourceLoader.h"
32 #include "CachedResourceRequest.h"
33 #include "Document.h"
34 #include "DocumentStyleSheetCollection.h"
35 #include "Event.h"
36 #include "EventSender.h"
37 #include "Frame.h"
38 #include "FrameLoader.h"
39 #include "FrameLoaderClient.h"
40 #include "FrameTree.h"
41 #include "FrameView.h"
42 #include "HTMLAnchorElement.h"
43 #include "HTMLNames.h"
44 #include "HTMLParserIdioms.h"
45 #include "MediaList.h"
46 #include "MediaQueryEvaluator.h"
47 #include "MouseEvent.h"
48 #include "Page.h"
49 #include "RelList.h"
50 #include "RenderStyle.h"
51 #include "SecurityOrigin.h"
52 #include "Settings.h"
53 #include "StyleInheritedData.h"
54 #include "StyleResolveForDocument.h"
55 #include "StyleSheetContents.h"
56 #include <wtf/Ref.h>
57 #include <wtf/StdLibExtras.h>
58
59 namespace WebCore {
60
61 using namespace HTMLNames;
62
63 static LinkEventSender& linkLoadEventSender()
64 {
65     DEPRECATED_DEFINE_STATIC_LOCAL(LinkEventSender, sharedLoadEventSender, (eventNames().loadEvent));
66     return sharedLoadEventSender;
67 }
68
69 inline HTMLLinkElement::HTMLLinkElement(const QualifiedName& tagName, Document& document, bool createdByParser)
70     : HTMLElement(tagName, document)
71     , m_linkLoader(*this)
72     , m_sizes(DOMSettableTokenList::create())
73     , m_disabledState(Unset)
74     , m_loading(false)
75     , m_createdByParser(createdByParser)
76     , m_isInShadowTree(false)
77     , m_firedLoad(false)
78     , m_loadedSheet(false)
79     , m_pendingSheetType(Unknown)
80 {
81     ASSERT(hasTagName(linkTag));
82 }
83
84 Ref<HTMLLinkElement> HTMLLinkElement::create(const QualifiedName& tagName, Document& document, bool createdByParser)
85 {
86     return adoptRef(*new HTMLLinkElement(tagName, document, createdByParser));
87 }
88
89 HTMLLinkElement::~HTMLLinkElement()
90 {
91     if (m_sheet)
92         m_sheet->clearOwnerNode();
93
94     if (m_cachedSheet)
95         m_cachedSheet->removeClient(this);
96
97     if (inDocument())
98         document().styleSheetCollection().removeStyleSheetCandidateNode(*this);
99
100     linkLoadEventSender().cancelEvent(*this);
101 }
102
103 void HTMLLinkElement::setDisabledState(bool disabled)
104 {
105     DisabledState oldDisabledState = m_disabledState;
106     m_disabledState = disabled ? Disabled : EnabledViaScript;
107     if (oldDisabledState != m_disabledState) {
108         // If we change the disabled state while the sheet is still loading, then we have to
109         // perform three checks:
110         if (styleSheetIsLoading()) {
111             // Check #1: The sheet becomes disabled while loading.
112             if (m_disabledState == Disabled)
113                 removePendingSheet();
114
115             // Check #2: An alternate sheet becomes enabled while it is still loading.
116             if (m_relAttribute.isAlternate && m_disabledState == EnabledViaScript)
117                 addPendingSheet(ActiveSheet);
118
119             // Check #3: A main sheet becomes enabled while it was still loading and
120             // after it was disabled via script. It takes really terrible code to make this
121             // happen (a double toggle for no reason essentially). This happens on
122             // virtualplastic.net, which manages to do about 12 enable/disables on only 3
123             // sheets. :)
124             if (!m_relAttribute.isAlternate && m_disabledState == EnabledViaScript && oldDisabledState == Disabled)
125                 addPendingSheet(ActiveSheet);
126
127             // If the sheet is already loading just bail.
128             return;
129         }
130
131         // Load the sheet, since it's never been loaded before.
132         if (!m_sheet && m_disabledState == EnabledViaScript)
133             process();
134         else
135             document().styleResolverChanged(DeferRecalcStyle); // Update the style selector.
136     }
137 }
138
139 void HTMLLinkElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
140 {
141     if (name == relAttr) {
142         m_relAttribute = LinkRelAttribute(value);
143         if (m_relList)
144             m_relList->updateRelAttribute(value);
145         process();
146         return;
147     }
148     if (name == hrefAttr) {
149         bool wasLink = isLink();
150         setIsLink(!value.isNull() && !shouldProhibitLinks(this));
151         if (wasLink != isLink())
152             setNeedsStyleRecalc();
153         process();
154         return;
155     }
156     if (name == typeAttr) {
157         m_type = value;
158         process();
159         return;
160     }
161     if (name == sizesAttr) {
162         setSizes(value);
163         process();
164         return;
165     }
166     if (name == mediaAttr) {
167         m_media = value.string().lower();
168         process();
169         if (m_sheet && !isDisabled())
170             document().styleResolverChanged(DeferRecalcStyle);
171         return;
172     }
173     if (name == disabledAttr) {
174         setDisabledState(!value.isNull());
175         return;
176     }
177     if (name == titleAttr) {
178         if (m_sheet)
179             m_sheet->setTitle(value);
180         return;
181     }
182     HTMLElement::parseAttribute(name, value);
183 }
184
185 bool HTMLLinkElement::shouldLoadLink()
186 {
187     Ref<Document> originalDocument = document();
188     if (!dispatchBeforeLoadEvent(getNonEmptyURLAttribute(hrefAttr)))
189         return false;
190     // A beforeload handler might have removed us from the document or changed the document.
191     if (!inDocument() || &document() != originalDocument.ptr())
192         return false;
193     return true;
194 }
195
196 void HTMLLinkElement::process()
197 {
198     if (!inDocument() || m_isInShadowTree) {
199         ASSERT(!m_sheet);
200         return;
201     }
202
203     URL url = getNonEmptyURLAttribute(hrefAttr);
204
205     if (!m_linkLoader.loadLink(m_relAttribute, url, document()))
206         return;
207
208     bool treatAsStyleSheet = m_relAttribute.isStyleSheet
209         || (document().settings() && document().settings()->treatsAnyTextCSSLinkAsStylesheet() && m_type.containsIgnoringASCIICase("text/css"));
210
211     if (m_disabledState != Disabled && treatAsStyleSheet && document().frame() && url.isValid()) {
212         AtomicString charset = fastGetAttribute(charsetAttr);
213         if (charset.isEmpty() && document().frame())
214             charset = document().charset();
215         
216         if (m_cachedSheet) {
217             removePendingSheet();
218             m_cachedSheet->removeClient(this);
219             m_cachedSheet = 0;
220         }
221
222         if (!shouldLoadLink())
223             return;
224
225         m_loading = true;
226
227         bool mediaQueryMatches = true;
228         if (!m_media.isEmpty()) {
229             RefPtr<RenderStyle> documentStyle;
230             if (document().hasLivingRenderTree())
231                 documentStyle = Style::resolveForDocument(document());
232             RefPtr<MediaQuerySet> media = MediaQuerySet::createAllowingDescriptionSyntax(m_media);
233             MediaQueryEvaluator evaluator(document().frame()->view()->mediaType(), document().frame(), documentStyle.get());
234             mediaQueryMatches = evaluator.eval(media.get());
235         }
236
237         // Don't hold up render tree construction and script execution on stylesheets
238         // that are not needed for the rendering at the moment.
239         bool isActive = mediaQueryMatches && !isAlternate();
240         addPendingSheet(isActive ? ActiveSheet : InactiveSheet);
241
242         // Load stylesheets that are not needed for the rendering immediately with low priority.
243         Optional<ResourceLoadPriority> priority;
244         if (!isActive)
245             priority = ResourceLoadPriority::VeryLow;
246         CachedResourceRequest request(ResourceRequest(document().completeURL(url)), charset, priority);
247         request.setInitiator(this);
248         m_cachedSheet = document().cachedResourceLoader().requestCSSStyleSheet(request);
249         
250         if (m_cachedSheet)
251             m_cachedSheet->addClient(this);
252         else {
253             // The request may have been denied if (for example) the stylesheet is local and the document is remote.
254             m_loading = false;
255             removePendingSheet();
256         }
257     } else if (m_sheet) {
258         // we no longer contain a stylesheet, e.g. perhaps rel or type was changed
259         clearSheet();
260         document().styleResolverChanged(DeferRecalcStyle);
261     }
262 }
263
264 void HTMLLinkElement::clearSheet()
265 {
266     ASSERT(m_sheet);
267     ASSERT(m_sheet->ownerNode() == this);
268     m_sheet->clearOwnerNode();
269     m_sheet = nullptr;
270 }
271
272 Node::InsertionNotificationRequest HTMLLinkElement::insertedInto(ContainerNode& insertionPoint)
273 {
274     HTMLElement::insertedInto(insertionPoint);
275     if (!insertionPoint.inDocument())
276         return InsertionDone;
277
278     m_isInShadowTree = isInShadowTree();
279     if (m_isInShadowTree)
280         return InsertionDone;
281
282     document().styleSheetCollection().addStyleSheetCandidateNode(*this, m_createdByParser);
283
284     process();
285     return InsertionDone;
286 }
287
288 void HTMLLinkElement::removedFrom(ContainerNode& insertionPoint)
289 {
290     HTMLElement::removedFrom(insertionPoint);
291     if (!insertionPoint.inDocument())
292         return;
293
294     if (m_isInShadowTree) {
295         ASSERT(!m_sheet);
296         return;
297     }
298     document().styleSheetCollection().removeStyleSheetCandidateNode(*this);
299
300     if (m_sheet)
301         clearSheet();
302
303     if (styleSheetIsLoading())
304         removePendingSheet(RemovePendingSheetNotifyLater);
305
306     if (document().hasLivingRenderTree())
307         document().styleResolverChanged(DeferRecalcStyleIfNeeded);
308 }
309
310 void HTMLLinkElement::finishParsingChildren()
311 {
312     m_createdByParser = false;
313     HTMLElement::finishParsingChildren();
314 }
315
316 void HTMLLinkElement::setCSSStyleSheet(const String& href, const URL& baseURL, const String& charset, const CachedCSSStyleSheet* cachedStyleSheet)
317 {
318     if (!inDocument()) {
319         ASSERT(!m_sheet);
320         return;
321     }
322     auto* frame = document().frame();
323     if (!frame)
324         return;
325
326     // Completing the sheet load may cause scripts to execute.
327     Ref<HTMLLinkElement> protect(*this);
328
329     CSSParserContext parserContext(document(), baseURL, charset);
330     auto cachePolicy = frame->loader().subresourceCachePolicy();
331
332     if (RefPtr<StyleSheetContents> restoredSheet = const_cast<CachedCSSStyleSheet*>(cachedStyleSheet)->restoreParsedStyleSheet(parserContext, cachePolicy)) {
333         ASSERT(restoredSheet->isCacheable());
334         ASSERT(!restoredSheet->isLoading());
335
336         m_sheet = CSSStyleSheet::create(restoredSheet.releaseNonNull(), this);
337         m_sheet->setMediaQueries(MediaQuerySet::createAllowingDescriptionSyntax(m_media));
338         m_sheet->setTitle(title());
339
340         m_loading = false;
341         sheetLoaded();
342         notifyLoadedSheetAndAllCriticalSubresources(false);
343         return;
344     }
345
346     Ref<StyleSheetContents> styleSheet(StyleSheetContents::create(href, parserContext));
347     m_sheet = CSSStyleSheet::create(styleSheet.copyRef(), this);
348     m_sheet->setMediaQueries(MediaQuerySet::createAllowingDescriptionSyntax(m_media));
349     m_sheet->setTitle(title());
350
351     styleSheet.get().parseAuthorStyleSheet(cachedStyleSheet, document().securityOrigin());
352
353     m_loading = false;
354     styleSheet.get().notifyLoadedSheet(cachedStyleSheet);
355     styleSheet.get().checkLoaded();
356
357     if (styleSheet.get().isCacheable())
358         const_cast<CachedCSSStyleSheet*>(cachedStyleSheet)->saveParsedStyleSheet(WTF::move(styleSheet));
359 }
360
361 bool HTMLLinkElement::styleSheetIsLoading() const
362 {
363     if (m_loading)
364         return true;
365     if (!m_sheet)
366         return false;
367     return m_sheet->contents().isLoading();
368 }
369
370 void HTMLLinkElement::linkLoaded()
371 {
372     dispatchEvent(Event::create(eventNames().loadEvent, false, false));
373 }
374
375 void HTMLLinkElement::linkLoadingErrored()
376 {
377     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
378 }
379
380 bool HTMLLinkElement::sheetLoaded()
381 {
382     if (!styleSheetIsLoading()) {
383         removePendingSheet();
384         return true;
385     }
386     return false;
387 }
388
389 void HTMLLinkElement::dispatchPendingLoadEvents()
390 {
391     linkLoadEventSender().dispatchPendingEvents();
392 }
393
394 void HTMLLinkElement::dispatchPendingEvent(LinkEventSender* eventSender)
395 {
396     ASSERT_UNUSED(eventSender, eventSender == &linkLoadEventSender());
397     if (m_loadedSheet)
398         linkLoaded();
399     else
400         linkLoadingErrored();
401 }
402
403 DOMTokenList& HTMLLinkElement::relList()
404 {
405     if (!m_relList) 
406         m_relList = std::make_unique<RelList>(*this);
407     return *m_relList;
408 }
409
410 void HTMLLinkElement::notifyLoadedSheetAndAllCriticalSubresources(bool errorOccurred)
411 {
412     if (m_firedLoad)
413         return;
414     m_loadedSheet = !errorOccurred;
415     linkLoadEventSender().dispatchEventSoon(*this);
416     m_firedLoad = true;
417 }
418
419 void HTMLLinkElement::startLoadingDynamicSheet()
420 {
421     // We don't support multiple active sheets.
422     ASSERT(m_pendingSheetType < ActiveSheet);
423     addPendingSheet(ActiveSheet);
424 }
425
426 bool HTMLLinkElement::isURLAttribute(const Attribute& attribute) const
427 {
428     return attribute.name().localName() == hrefAttr || HTMLElement::isURLAttribute(attribute);
429 }
430
431 void HTMLLinkElement::defaultEventHandler(Event* event)
432 {
433     ASSERT(event);
434     if (MouseEvent::canTriggerActivationBehavior(*event)) {
435         handleClick(*event);
436         return;
437     }
438     HTMLElement::defaultEventHandler(event);
439 }
440
441 void HTMLLinkElement::handleClick(Event& event)
442 {
443     event.setDefaultHandled();
444     URL url = href();
445     if (url.isNull())
446         return;
447     Frame* frame = document().frame();
448     if (!frame)
449         return;
450     frame->loader().urlSelected(url, target(), &event, LockHistory::No, LockBackForwardList::No, MaybeSendReferrer, document().shouldOpenExternalURLsPolicyToPropagate());
451 }
452
453 URL HTMLLinkElement::href() const
454 {
455     return document().completeURL(getAttribute(hrefAttr));
456 }
457
458 const AtomicString& HTMLLinkElement::rel() const
459 {
460     return fastGetAttribute(relAttr);
461 }
462
463 String HTMLLinkElement::target() const
464 {
465     return getAttribute(targetAttr);
466 }
467
468 const AtomicString& HTMLLinkElement::type() const
469 {
470     return getAttribute(typeAttr);
471 }
472
473 IconType HTMLLinkElement::iconType() const
474 {
475     return m_relAttribute.iconType;
476 }
477
478 String HTMLLinkElement::iconSizes() const
479 {
480     return m_sizes->toString();
481 }
482
483 void HTMLLinkElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
484 {
485     HTMLElement::addSubresourceAttributeURLs(urls);
486
487     // Favicons are handled by a special case in LegacyWebArchive::create()
488     if (m_relAttribute.iconType != InvalidIcon)
489         return;
490
491     if (!m_relAttribute.isStyleSheet)
492         return;
493     
494     // Append the URL of this link element.
495     addSubresourceURL(urls, href());
496     
497     // Walk the URLs linked by the linked-to stylesheet.
498     if (CSSStyleSheet* styleSheet = const_cast<HTMLLinkElement*>(this)->sheet())
499         styleSheet->contents().addSubresourceStyleURLs(urls);
500 }
501
502 void HTMLLinkElement::addPendingSheet(PendingSheetType type)
503 {
504     if (type <= m_pendingSheetType)
505         return;
506     m_pendingSheetType = type;
507
508     if (m_pendingSheetType == InactiveSheet)
509         return;
510     document().styleSheetCollection().addPendingSheet();
511 }
512
513 void HTMLLinkElement::removePendingSheet(RemovePendingSheetNotificationType notification)
514 {
515     PendingSheetType type = m_pendingSheetType;
516     m_pendingSheetType = Unknown;
517
518     if (type == Unknown)
519         return;
520
521     if (type == InactiveSheet) {
522         // Document just needs to know about the sheet for exposure through document.styleSheets
523         document().styleSheetCollection().updateActiveStyleSheets(DocumentStyleSheetCollection::OptimizedUpdate);
524         return;
525     }
526
527     document().styleSheetCollection().removePendingSheet(
528         notification == RemovePendingSheetNotifyImmediately
529         ? DocumentStyleSheetCollection::RemovePendingSheetNotifyImmediately
530         : DocumentStyleSheetCollection::RemovePendingSheetNotifyLater);
531 }
532
533 void HTMLLinkElement::setSizes(const String& value)
534 {
535     m_sizes->setValue(value);
536 }
537
538 } // namespace WebCore