No need to guard the sizes attribute against PICTURE_SIZES in preload scanner.
[WebKit-https.git] / Source / WebCore / html / parser / HTMLPreloadScanner.cpp
1 /*
2  * Copyright (C) 2008, 2014 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2009 Torch Mobile, Inc. http://www.torchmobile.com/
4  * Copyright (C) 2010 Google Inc. All Rights Reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #include "config.h"
29 #include "HTMLPreloadScanner.h"
30
31 #include "HTMLNames.h"
32 #include "HTMLParserIdioms.h"
33 #include "HTMLSrcsetParser.h"
34 #include "HTMLTokenizer.h"
35 #include "InputTypeNames.h"
36 #include "LinkRelAttribute.h"
37 #include "SourceSizeList.h"
38 #include <wtf/MainThread.h>
39
40 namespace WebCore {
41
42 using namespace HTMLNames;
43
44 TokenPreloadScanner::TagId TokenPreloadScanner::tagIdFor(const HTMLToken::DataVector& data)
45 {
46     AtomicString tagName(data);
47     if (tagName == imgTag)
48         return TagId::Img;
49     if (tagName == inputTag)
50         return TagId::Input;
51     if (tagName == linkTag)
52         return TagId::Link;
53     if (tagName == scriptTag)
54         return TagId::Script;
55     if (tagName == styleTag)
56         return TagId::Style;
57     if (tagName == baseTag)
58         return TagId::Base;
59     if (tagName == templateTag)
60         return TagId::Template;
61     if (tagName == metaTag)
62         return TagId::Meta;
63     return TagId::Unknown;
64 }
65
66 String TokenPreloadScanner::initiatorFor(TagId tagId)
67 {
68     switch (tagId) {
69     case TagId::Img:
70         return "img";
71     case TagId::Input:
72         return "input";
73     case TagId::Link:
74         return "link";
75     case TagId::Script:
76         return "script";
77     case TagId::Unknown:
78     case TagId::Style:
79     case TagId::Base:
80     case TagId::Template:
81     case TagId::Meta:
82         ASSERT_NOT_REACHED();
83         return "unknown";
84     }
85     ASSERT_NOT_REACHED();
86     return "unknown";
87 }
88
89 class TokenPreloadScanner::StartTagScanner {
90 public:
91     explicit StartTagScanner(TagId tagId, float deviceScaleFactor = 1.0)
92         : m_tagId(tagId)
93         , m_linkIsStyleSheet(false)
94         , m_metaIsViewport(false)
95         , m_inputIsImage(false)
96         , m_deviceScaleFactor(deviceScaleFactor)
97     {
98     }
99
100     void processAttributes(const HTMLToken::AttributeList& attributes, Document& document)
101     {
102         ASSERT(isMainThread());
103         if (m_tagId >= TagId::Unknown)
104             return;
105
106         for (HTMLToken::AttributeList::const_iterator iter = attributes.begin(); iter != attributes.end(); ++iter) {
107             AtomicString attributeName(iter->name);
108             String attributeValue = StringImpl::create8BitIfPossible(iter->value);
109             processAttribute(attributeName, attributeValue);
110         }
111
112         // Resolve between src and srcSet if we have them and the tag is img.
113         if (m_tagId == TagId::Img && !m_srcSetAttribute.isEmpty()) {
114             float sourceSize = 0;
115             sourceSize = parseSizesAttribute(m_sizesAttribute, document.renderView(), document.frame());
116             ImageCandidate imageCandidate = bestFitSourceForImageAttributes(m_deviceScaleFactor, m_urlToLoad, m_srcSetAttribute, sourceSize);
117             setUrlToLoad(imageCandidate.string.toString(), true);
118         }
119
120         if (m_metaIsViewport && !m_metaContent.isNull())
121             document.processViewport(m_metaContent, ViewportArguments::ViewportMeta);
122     }
123
124     std::unique_ptr<PreloadRequest> createPreloadRequest(const URL& predictedBaseURL)
125     {
126         if (!shouldPreload())
127             return nullptr;
128
129         auto request = std::make_unique<PreloadRequest>(initiatorFor(m_tagId), m_urlToLoad, predictedBaseURL, resourceType(), m_mediaAttribute);
130
131         request->setCrossOriginModeAllowsCookies(crossOriginModeAllowsCookies());
132         request->setCharset(charset());
133         return request;
134     }
135
136     static bool match(const AtomicString& name, const QualifiedName& qName)
137     {
138         ASSERT(isMainThread());
139         return qName.localName() == name;
140     }
141
142 private:
143     template<typename NameType>
144     void processAttribute(const NameType& attributeName, const String& attributeValue)
145     {
146         if (match(attributeName, charsetAttr))
147             m_charset = attributeValue;
148
149         if (m_tagId == TagId::Script || m_tagId == TagId::Img) {
150             if (match(attributeName, srcAttr))
151                 setUrlToLoad(attributeValue);
152             else if (match(attributeName, srcsetAttr) && m_srcSetAttribute.isNull())
153                 m_srcSetAttribute = attributeValue;
154             else if (match(attributeName, sizesAttr) && m_sizesAttribute.isNull())
155                 m_sizesAttribute = attributeValue;
156             else if (match(attributeName, crossoriginAttr) && !attributeValue.isNull())
157                 m_crossOriginMode = stripLeadingAndTrailingHTMLSpaces(attributeValue);
158         } else if (m_tagId == TagId::Link) {
159             if (match(attributeName, hrefAttr))
160                 setUrlToLoad(attributeValue);
161             else if (match(attributeName, relAttr))
162                 m_linkIsStyleSheet = relAttributeIsStyleSheet(attributeValue);
163             else if (match(attributeName, mediaAttr))
164                 m_mediaAttribute = attributeValue;
165         } else if (m_tagId == TagId::Input) {
166             if (match(attributeName, srcAttr))
167                 setUrlToLoad(attributeValue);
168             else if (match(attributeName, typeAttr))
169                 m_inputIsImage = equalIgnoringCase(attributeValue, InputTypeNames::image());
170         } else if (m_tagId == TagId::Meta) {
171             if (match(attributeName, contentAttr))
172                 m_metaContent = attributeValue;
173             else if (match(attributeName, nameAttr))
174                 m_metaIsViewport = equalIgnoringCase(attributeValue, "viewport");
175         }
176     }
177
178     static bool relAttributeIsStyleSheet(const String& attributeValue)
179     {
180         LinkRelAttribute parsedAttribute { attributeValue };
181         return parsedAttribute.isStyleSheet && !parsedAttribute.isAlternate && parsedAttribute.iconType == InvalidIcon && !parsedAttribute.isDNSPrefetch;
182     }
183
184     void setUrlToLoad(const String& value, bool allowReplacement = false)
185     {
186         // We only respect the first src/href, per HTML5:
187         // http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#attribute-name-state
188         if (!allowReplacement && !m_urlToLoad.isEmpty())
189             return;
190         String url = stripLeadingAndTrailingHTMLSpaces(value);
191         if (url.isEmpty())
192             return;
193         m_urlToLoad = url;
194     }
195
196     const String& charset() const
197     {
198         // FIXME: Its not clear that this if is needed, the loader probably ignores charset for image requests anyway.
199         if (m_tagId == TagId::Img)
200             return emptyString();
201         return m_charset;
202     }
203
204     CachedResource::Type resourceType() const
205     {
206         if (m_tagId == TagId::Script)
207             return CachedResource::Script;
208         if (m_tagId == TagId::Img || (m_tagId == TagId::Input && m_inputIsImage))
209             return CachedResource::ImageResource;
210         if (m_tagId == TagId::Link && m_linkIsStyleSheet)
211             return CachedResource::CSSStyleSheet;
212         ASSERT_NOT_REACHED();
213         return CachedResource::RawResource;
214     }
215
216     bool shouldPreload()
217     {
218         if (m_urlToLoad.isEmpty())
219             return false;
220
221         if (m_tagId == TagId::Link && !m_linkIsStyleSheet)
222             return false;
223
224         if (m_tagId == TagId::Input && !m_inputIsImage)
225             return false;
226
227         return true;
228     }
229
230     bool crossOriginModeAllowsCookies()
231     {
232         return m_crossOriginMode.isNull() || equalIgnoringCase(m_crossOriginMode, "use-credentials");
233     }
234
235     TagId m_tagId;
236     String m_urlToLoad;
237     String m_srcSetAttribute;
238 #if ENABLE(PICTURE_SIZES)
239     String m_sizesAttribute;
240 #endif
241     String m_charset;
242     String m_crossOriginMode;
243     bool m_linkIsStyleSheet;
244     String m_mediaAttribute;
245     String m_metaContent;
246     bool m_metaIsViewport;
247     bool m_inputIsImage;
248     float m_deviceScaleFactor;
249 };
250
251 TokenPreloadScanner::TokenPreloadScanner(const URL& documentURL, float deviceScaleFactor)
252     : m_documentURL(documentURL)
253     , m_deviceScaleFactor(deviceScaleFactor)
254 {
255 }
256
257 void TokenPreloadScanner::scan(const HTMLToken& token, Vector<std::unique_ptr<PreloadRequest>>& requests, Document& document)
258 {
259     switch (token.type()) {
260     case HTMLToken::Character:
261         if (!m_inStyle)
262             return;
263         m_cssScanner.scan(token.characters(), requests);
264         return;
265
266     case HTMLToken::EndTag: {
267         TagId tagId = tagIdFor(token.name());
268 #if ENABLE(TEMPLATE_ELEMENT)
269         if (tagId == TagId::Template) {
270             if (m_templateCount)
271                 --m_templateCount;
272             return;
273         }
274 #endif
275         if (tagId == TagId::Style) {
276             if (m_inStyle)
277                 m_cssScanner.reset();
278             m_inStyle = false;
279         }
280         return;
281     }
282
283     case HTMLToken::StartTag: {
284 #if ENABLE(TEMPLATE_ELEMENT)
285         if (m_templateCount)
286             return;
287 #endif
288         TagId tagId = tagIdFor(token.name());
289 #if ENABLE(TEMPLATE_ELEMENT)
290         if (tagId == TagId::Template) {
291             ++m_templateCount;
292             return;
293         }
294 #endif
295         if (tagId == TagId::Style) {
296             m_inStyle = true;
297             return;
298         }
299         if (tagId == TagId::Base) {
300             // The first <base> element is the one that wins.
301             if (!m_predictedBaseElementURL.isEmpty())
302                 return;
303             updatePredictedBaseURL(token);
304             return;
305         }
306
307         StartTagScanner scanner(tagId, m_deviceScaleFactor);
308         scanner.processAttributes(token.attributes(), document);
309         if (auto request = scanner.createPreloadRequest(m_predictedBaseElementURL))
310             requests.append(WTF::move(request));
311         return;
312     }
313
314     default:
315         return;
316     }
317 }
318
319 void TokenPreloadScanner::updatePredictedBaseURL(const HTMLToken& token)
320 {
321     ASSERT(m_predictedBaseElementURL.isEmpty());
322     if (auto* hrefAttribute = findAttribute(token.attributes(), hrefAttr.localName().string()))
323         m_predictedBaseElementURL = URL(m_documentURL, stripLeadingAndTrailingHTMLSpaces(StringImpl::create8BitIfPossible(hrefAttribute->value))).isolatedCopy();
324 }
325
326 HTMLPreloadScanner::HTMLPreloadScanner(const HTMLParserOptions& options, const URL& documentURL, float deviceScaleFactor)
327     : m_scanner(documentURL, deviceScaleFactor)
328     , m_tokenizer(options)
329 {
330 }
331
332 void HTMLPreloadScanner::appendToEnd(const SegmentedString& source)
333 {
334     m_source.append(source);
335 }
336
337 void HTMLPreloadScanner::scan(HTMLResourcePreloader& preloader, Document& document)
338 {
339     ASSERT(isMainThread()); // HTMLTokenizer::updateStateFor only works on the main thread.
340
341     const URL& startingBaseElementURL = document.baseElementURL();
342
343     // When we start scanning, our best prediction of the baseElementURL is the real one!
344     if (!startingBaseElementURL.isEmpty())
345         m_scanner.setPredictedBaseElementURL(startingBaseElementURL);
346
347     PreloadRequestStream requests;
348
349     while (auto token = m_tokenizer.nextToken(m_source)) {
350         if (token->type() == HTMLToken::StartTag)
351             m_tokenizer.updateStateFor(AtomicString(token->name()));
352         m_scanner.scan(*token, requests, document);
353     }
354
355     preloader.preload(WTF::move(requests));
356 }
357
358 bool testPreloadScannerViewportSupport(Document* document)
359 {
360     ASSERT(document);
361     HTMLParserOptions options(*document);
362     HTMLPreloadScanner scanner(options, document->url());
363     HTMLResourcePreloader preloader(*document);
364     scanner.appendToEnd(String("<meta name=viewport content='width=400'>"));
365     scanner.scan(preloader, *document);
366     return (document->viewportArguments().width == 400);
367 }
368
369 }