Drop ResourceLoadPriorityUnresolved resource load priority and use Optional<> instead
[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.m_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.m_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     } else if (name == hrefAttr) {
147         bool wasLink = isLink();
148         setIsLink(!value.isNull() && !shouldProhibitLinks(this));
149         if (wasLink != isLink())
150             setNeedsStyleRecalc();
151         process();
152     } else if (name == typeAttr) {
153         m_type = value;
154         process();
155     } else if (name == sizesAttr) {
156         setSizes(value);
157         process();
158     } else if (name == mediaAttr) {
159         m_media = value.string().lower();
160         process();
161     } else if (name == disabledAttr)
162         setDisabledState(!value.isNull());
163     else if (name == onbeforeloadAttr)
164         setAttributeEventListener(eventNames().beforeloadEvent, name, value);
165     else {
166         if (name == titleAttr && m_sheet)
167             m_sheet->setTitle(value);
168         HTMLElement::parseAttribute(name, value);
169     }
170 }
171
172 bool HTMLLinkElement::shouldLoadLink()
173 {
174     Ref<Document> originalDocument(document());
175     if (!dispatchBeforeLoadEvent(getNonEmptyURLAttribute(hrefAttr)))
176         return false;
177     // A beforeload handler might have removed us from the document or changed the document.
178     if (!inDocument() || &document() != originalDocument.ptr())
179         return false;
180     return true;
181 }
182
183 void HTMLLinkElement::process()
184 {
185     if (!inDocument() || m_isInShadowTree) {
186         ASSERT(!m_sheet);
187         return;
188     }
189
190     String type = m_type.lower();
191     URL url = getNonEmptyURLAttribute(hrefAttr);
192
193     if (!m_linkLoader.loadLink(m_relAttribute, type, m_sizes->toString(), url, &document()))
194         return;
195
196     bool acceptIfTypeContainsTextCSS = document().page() && document().page()->settings().treatsAnyTextCSSLinkAsStylesheet();
197
198     if (m_disabledState != Disabled && (m_relAttribute.m_isStyleSheet || (acceptIfTypeContainsTextCSS && type.contains("text/css")))
199         && document().frame() && url.isValid()) {
200         
201         AtomicString charset = fastGetAttribute(charsetAttr);
202         if (charset.isEmpty() && document().frame())
203             charset = document().charset();
204         
205         if (m_cachedSheet) {
206             removePendingSheet();
207             m_cachedSheet->removeClient(this);
208             m_cachedSheet = 0;
209         }
210
211         if (!shouldLoadLink())
212             return;
213
214         m_loading = true;
215
216         bool mediaQueryMatches = true;
217         if (!m_media.isEmpty()) {
218             RefPtr<RenderStyle> documentStyle;
219             if (document().hasLivingRenderTree())
220                 documentStyle = Style::resolveForDocument(document());
221             RefPtr<MediaQuerySet> media = MediaQuerySet::createAllowingDescriptionSyntax(m_media);
222             MediaQueryEvaluator evaluator(document().frame()->view()->mediaType(), document().frame(), documentStyle.get());
223             mediaQueryMatches = evaluator.eval(media.get());
224         }
225
226         // Don't hold up render tree construction and script execution on stylesheets
227         // that are not needed for the rendering at the moment.
228         bool isActive = mediaQueryMatches && !isAlternate();
229         addPendingSheet(isActive ? ActiveSheet : InactiveSheet);
230
231         // Load stylesheets that are not needed for the rendering immediately with low priority.
232         Optional<ResourceLoadPriority> priority;
233         if (!isActive)
234             priority = ResourceLoadPriorityVeryLow;
235         CachedResourceRequest request(ResourceRequest(document().completeURL(url)), charset, priority);
236         request.setInitiator(this);
237         m_cachedSheet = document().cachedResourceLoader().requestCSSStyleSheet(request);
238         
239         if (m_cachedSheet)
240             m_cachedSheet->addClient(this);
241         else {
242             // The request may have been denied if (for example) the stylesheet is local and the document is remote.
243             m_loading = false;
244             removePendingSheet();
245         }
246     } else if (m_sheet) {
247         // we no longer contain a stylesheet, e.g. perhaps rel or type was changed
248         clearSheet();
249         document().styleResolverChanged(DeferRecalcStyle);
250     }
251 }
252
253 void HTMLLinkElement::clearSheet()
254 {
255     ASSERT(m_sheet);
256     ASSERT(m_sheet->ownerNode() == this);
257     m_sheet->clearOwnerNode();
258     m_sheet = 0;
259 }
260
261 Node::InsertionNotificationRequest HTMLLinkElement::insertedInto(ContainerNode& insertionPoint)
262 {
263     HTMLElement::insertedInto(insertionPoint);
264     if (!insertionPoint.inDocument())
265         return InsertionDone;
266
267     m_isInShadowTree = isInShadowTree();
268     if (m_isInShadowTree)
269         return InsertionDone;
270
271     document().styleSheetCollection().addStyleSheetCandidateNode(*this, m_createdByParser);
272
273     process();
274     return InsertionDone;
275 }
276
277 void HTMLLinkElement::removedFrom(ContainerNode& insertionPoint)
278 {
279     HTMLElement::removedFrom(insertionPoint);
280     if (!insertionPoint.inDocument())
281         return;
282
283     m_linkLoader.released();
284
285     if (m_isInShadowTree) {
286         ASSERT(!m_sheet);
287         return;
288     }
289     document().styleSheetCollection().removeStyleSheetCandidateNode(*this);
290
291     if (m_sheet)
292         clearSheet();
293
294     if (styleSheetIsLoading())
295         removePendingSheet(RemovePendingSheetNotifyLater);
296
297     if (document().hasLivingRenderTree())
298         document().styleResolverChanged(DeferRecalcStyleIfNeeded);
299 }
300
301 void HTMLLinkElement::finishParsingChildren()
302 {
303     m_createdByParser = false;
304     HTMLElement::finishParsingChildren();
305 }
306
307 void HTMLLinkElement::setCSSStyleSheet(const String& href, const URL& baseURL, const String& charset, const CachedCSSStyleSheet* cachedStyleSheet)
308 {
309     if (!inDocument()) {
310         ASSERT(!m_sheet);
311         return;
312     }
313     // Completing the sheet load may cause scripts to execute.
314     Ref<HTMLLinkElement> protect(*this);
315
316     CSSParserContext parserContext(document(), baseURL, charset);
317
318     if (RefPtr<StyleSheetContents> restoredSheet = const_cast<CachedCSSStyleSheet*>(cachedStyleSheet)->restoreParsedStyleSheet(parserContext)) {
319         ASSERT(restoredSheet->isCacheable());
320         ASSERT(!restoredSheet->isLoading());
321
322         m_sheet = CSSStyleSheet::create(restoredSheet.releaseNonNull(), this);
323         m_sheet->setMediaQueries(MediaQuerySet::createAllowingDescriptionSyntax(m_media));
324         m_sheet->setTitle(title());
325
326         m_loading = false;
327         sheetLoaded();
328         notifyLoadedSheetAndAllCriticalSubresources(false);
329         return;
330     }
331
332     Ref<StyleSheetContents> styleSheet(StyleSheetContents::create(href, parserContext));
333     m_sheet = CSSStyleSheet::create(styleSheet.copyRef(), this);
334     m_sheet->setMediaQueries(MediaQuerySet::createAllowingDescriptionSyntax(m_media));
335     m_sheet->setTitle(title());
336
337     styleSheet.get().parseAuthorStyleSheet(cachedStyleSheet, document().securityOrigin());
338
339     m_loading = false;
340     styleSheet.get().notifyLoadedSheet(cachedStyleSheet);
341     styleSheet.get().checkLoaded();
342
343     if (styleSheet.get().isCacheable())
344         const_cast<CachedCSSStyleSheet*>(cachedStyleSheet)->saveParsedStyleSheet(WTF::move(styleSheet));
345 }
346
347 bool HTMLLinkElement::styleSheetIsLoading() const
348 {
349     if (m_loading)
350         return true;
351     if (!m_sheet)
352         return false;
353     return m_sheet->contents().isLoading();
354 }
355
356 void HTMLLinkElement::linkLoaded()
357 {
358     dispatchEvent(Event::create(eventNames().loadEvent, false, false));
359 }
360
361 void HTMLLinkElement::linkLoadingErrored()
362 {
363     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
364 }
365
366 bool HTMLLinkElement::sheetLoaded()
367 {
368     if (!styleSheetIsLoading()) {
369         removePendingSheet();
370         return true;
371     }
372     return false;
373 }
374
375 void HTMLLinkElement::dispatchPendingLoadEvents()
376 {
377     linkLoadEventSender().dispatchPendingEvents();
378 }
379
380 void HTMLLinkElement::dispatchPendingEvent(LinkEventSender* eventSender)
381 {
382     ASSERT_UNUSED(eventSender, eventSender == &linkLoadEventSender());
383     if (m_loadedSheet)
384         linkLoaded();
385     else
386         linkLoadingErrored();
387 }
388
389 DOMTokenList& HTMLLinkElement::relList()
390 {
391     if (!m_relList) 
392         m_relList = std::make_unique<RelList>(*this);
393     return *m_relList;
394 }
395
396 void HTMLLinkElement::notifyLoadedSheetAndAllCriticalSubresources(bool errorOccurred)
397 {
398     if (m_firedLoad)
399         return;
400     m_loadedSheet = !errorOccurred;
401     linkLoadEventSender().dispatchEventSoon(*this);
402     m_firedLoad = true;
403 }
404
405 void HTMLLinkElement::startLoadingDynamicSheet()
406 {
407     // We don't support multiple active sheets.
408     ASSERT(m_pendingSheetType < ActiveSheet);
409     addPendingSheet(ActiveSheet);
410 }
411
412 bool HTMLLinkElement::isURLAttribute(const Attribute& attribute) const
413 {
414     return attribute.name().localName() == hrefAttr || HTMLElement::isURLAttribute(attribute);
415 }
416
417 void HTMLLinkElement::defaultEventHandler(Event* event)
418 {
419     ASSERT(event);
420     if (MouseEvent::canTriggerActivationBehavior(*event)) {
421         handleClick(*event);
422         return;
423     }
424     HTMLElement::defaultEventHandler(event);
425 }
426
427 void HTMLLinkElement::handleClick(Event& event)
428 {
429     event.setDefaultHandled();
430     URL url = href();
431     if (url.isNull())
432         return;
433     Frame* frame = document().frame();
434     if (!frame)
435         return;
436     frame->loader().urlSelected(url, target(), PassRefPtr<Event>(&event), LockHistory::No, LockBackForwardList::No, MaybeSendReferrer);
437 }
438
439 URL HTMLLinkElement::href() const
440 {
441     return document().completeURL(getAttribute(hrefAttr));
442 }
443
444 const AtomicString& HTMLLinkElement::rel() const
445 {
446     return fastGetAttribute(relAttr);
447 }
448
449 String HTMLLinkElement::target() const
450 {
451     return getAttribute(targetAttr);
452 }
453
454 const AtomicString& HTMLLinkElement::type() const
455 {
456     return getAttribute(typeAttr);
457 }
458
459 IconType HTMLLinkElement::iconType() const
460 {
461     return m_relAttribute.m_iconType;
462 }
463
464 String HTMLLinkElement::iconSizes() const
465 {
466     return m_sizes->toString();
467 }
468
469 void HTMLLinkElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
470 {
471     HTMLElement::addSubresourceAttributeURLs(urls);
472
473     // Favicons are handled by a special case in LegacyWebArchive::create()
474     if (m_relAttribute.m_iconType != InvalidIcon)
475         return;
476
477     if (!m_relAttribute.m_isStyleSheet)
478         return;
479     
480     // Append the URL of this link element.
481     addSubresourceURL(urls, href());
482     
483     // Walk the URLs linked by the linked-to stylesheet.
484     if (CSSStyleSheet* styleSheet = const_cast<HTMLLinkElement*>(this)->sheet())
485         styleSheet->contents().addSubresourceStyleURLs(urls);
486 }
487
488 void HTMLLinkElement::addPendingSheet(PendingSheetType type)
489 {
490     if (type <= m_pendingSheetType)
491         return;
492     m_pendingSheetType = type;
493
494     if (m_pendingSheetType == InactiveSheet)
495         return;
496     document().styleSheetCollection().addPendingSheet();
497 }
498
499 void HTMLLinkElement::removePendingSheet(RemovePendingSheetNotificationType notification)
500 {
501     PendingSheetType type = m_pendingSheetType;
502     m_pendingSheetType = Unknown;
503
504     if (type == Unknown)
505         return;
506
507     if (type == InactiveSheet) {
508         // Document just needs to know about the sheet for exposure through document.styleSheets
509         document().styleSheetCollection().updateActiveStyleSheets(DocumentStyleSheetCollection::OptimizedUpdate);
510         return;
511     }
512
513     document().styleSheetCollection().removePendingSheet(
514         notification == RemovePendingSheetNotifyImmediately
515         ? DocumentStyleSheetCollection::RemovePendingSheetNotifyImmediately
516         : DocumentStyleSheetCollection::RemovePendingSheetNotifyLater);
517 }
518
519 void HTMLLinkElement::setSizes(const String& value)
520 {
521     m_sizes->setValue(value);
522 }
523
524 } // namespace WebCore