Handle meta viewport in HTMLPreloadScanner
[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             unsigned sourceSize = 0;
115 #if ENABLE(PICTURE_SIZES)
116             sourceSize = parseSizesAttribute(m_sizesAttribute, document.renderView(), document.frame());
117 #else
118             UNUSED_PARAM(document);
119 #endif
120             ImageCandidate imageCandidate = bestFitSourceForImageAttributes(m_deviceScaleFactor, m_urlToLoad, m_srcSetAttribute, sourceSize);
121             setUrlToLoad(imageCandidate.string.toString(), true);
122         }
123
124         if (m_metaIsViewport && !m_metaContent.isNull())
125             document.processViewport(m_metaContent, ViewportArguments::ViewportMeta);
126     }
127
128     std::unique_ptr<PreloadRequest> createPreloadRequest(const URL& predictedBaseURL)
129     {
130         if (!shouldPreload())
131             return nullptr;
132
133         auto request = std::make_unique<PreloadRequest>(initiatorFor(m_tagId), m_urlToLoad, predictedBaseURL, resourceType(), m_mediaAttribute);
134
135         request->setCrossOriginModeAllowsCookies(crossOriginModeAllowsCookies());
136         request->setCharset(charset());
137         return request;
138     }
139
140     static bool match(const AtomicString& name, const QualifiedName& qName)
141     {
142         ASSERT(isMainThread());
143         return qName.localName() == name;
144     }
145
146 private:
147     template<typename NameType>
148     void processAttribute(const NameType& attributeName, const String& attributeValue)
149     {
150         if (match(attributeName, charsetAttr))
151             m_charset = attributeValue;
152
153         if (m_tagId == TagId::Script || m_tagId == TagId::Img) {
154             if (match(attributeName, srcAttr))
155                 setUrlToLoad(attributeValue);
156             else if (match(attributeName, srcsetAttr) && m_srcSetAttribute.isNull())
157                 m_srcSetAttribute = attributeValue;
158 #if ENABLE(PICTURE_SIZES)
159             else if (match(attributeName, sizesAttr) && m_sizesAttribute.isNull())
160                 m_sizesAttribute = attributeValue;
161 #endif
162             else if (match(attributeName, crossoriginAttr) && !attributeValue.isNull())
163                 m_crossOriginMode = stripLeadingAndTrailingHTMLSpaces(attributeValue);
164         } else if (m_tagId == TagId::Link) {
165             if (match(attributeName, hrefAttr))
166                 setUrlToLoad(attributeValue);
167             else if (match(attributeName, relAttr))
168                 m_linkIsStyleSheet = relAttributeIsStyleSheet(attributeValue);
169             else if (match(attributeName, mediaAttr))
170                 m_mediaAttribute = attributeValue;
171         } else if (m_tagId == TagId::Input) {
172             if (match(attributeName, srcAttr))
173                 setUrlToLoad(attributeValue);
174             else if (match(attributeName, typeAttr))
175                 m_inputIsImage = equalIgnoringCase(attributeValue, InputTypeNames::image());
176         } else if (m_tagId == TagId::Meta) {
177             if (match(attributeName, contentAttr))
178                 m_metaContent = attributeValue;
179             else if (match(attributeName, nameAttr))
180                 m_metaIsViewport = equalIgnoringCase(attributeValue, "viewport");
181         }
182     }
183
184     static bool relAttributeIsStyleSheet(const String& attributeValue)
185     {
186         LinkRelAttribute parsedAttribute { attributeValue };
187         return parsedAttribute.isStyleSheet && !parsedAttribute.isAlternate && parsedAttribute.iconType == InvalidIcon && !parsedAttribute.isDNSPrefetch;
188     }
189
190     void setUrlToLoad(const String& value, bool allowReplacement = false)
191     {
192         // We only respect the first src/href, per HTML5:
193         // http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#attribute-name-state
194         if (!allowReplacement && !m_urlToLoad.isEmpty())
195             return;
196         String url = stripLeadingAndTrailingHTMLSpaces(value);
197         if (url.isEmpty())
198             return;
199         m_urlToLoad = url;
200     }
201
202     const String& charset() const
203     {
204         // FIXME: Its not clear that this if is needed, the loader probably ignores charset for image requests anyway.
205         if (m_tagId == TagId::Img)
206             return emptyString();
207         return m_charset;
208     }
209
210     CachedResource::Type resourceType() const
211     {
212         if (m_tagId == TagId::Script)
213             return CachedResource::Script;
214         if (m_tagId == TagId::Img || (m_tagId == TagId::Input && m_inputIsImage))
215             return CachedResource::ImageResource;
216         if (m_tagId == TagId::Link && m_linkIsStyleSheet)
217             return CachedResource::CSSStyleSheet;
218         ASSERT_NOT_REACHED();
219         return CachedResource::RawResource;
220     }
221
222     bool shouldPreload()
223     {
224         if (m_urlToLoad.isEmpty())
225             return false;
226
227         if (m_tagId == TagId::Link && !m_linkIsStyleSheet)
228             return false;
229
230         if (m_tagId == TagId::Input && !m_inputIsImage)
231             return false;
232
233         return true;
234     }
235
236     bool crossOriginModeAllowsCookies()
237     {
238         return m_crossOriginMode.isNull() || equalIgnoringCase(m_crossOriginMode, "use-credentials");
239     }
240
241     TagId m_tagId;
242     String m_urlToLoad;
243     String m_srcSetAttribute;
244 #if ENABLE(PICTURE_SIZES)
245     String m_sizesAttribute;
246 #endif
247     String m_charset;
248     String m_crossOriginMode;
249     bool m_linkIsStyleSheet;
250     String m_mediaAttribute;
251     String m_metaContent;
252     bool m_metaIsViewport;
253     bool m_inputIsImage;
254     float m_deviceScaleFactor;
255 };
256
257 TokenPreloadScanner::TokenPreloadScanner(const URL& documentURL, float deviceScaleFactor)
258     : m_documentURL(documentURL)
259     , m_deviceScaleFactor(deviceScaleFactor)
260 {
261 }
262
263 void TokenPreloadScanner::scan(const HTMLToken& token, Vector<std::unique_ptr<PreloadRequest>>& requests, Document& document)
264 {
265     switch (token.type()) {
266     case HTMLToken::Character:
267         if (!m_inStyle)
268             return;
269         m_cssScanner.scan(token.characters(), requests);
270         return;
271
272     case HTMLToken::EndTag: {
273         TagId tagId = tagIdFor(token.name());
274 #if ENABLE(TEMPLATE_ELEMENT)
275         if (tagId == TagId::Template) {
276             if (m_templateCount)
277                 --m_templateCount;
278             return;
279         }
280 #endif
281         if (tagId == TagId::Style) {
282             if (m_inStyle)
283                 m_cssScanner.reset();
284             m_inStyle = false;
285         }
286         return;
287     }
288
289     case HTMLToken::StartTag: {
290 #if ENABLE(TEMPLATE_ELEMENT)
291         if (m_templateCount)
292             return;
293 #endif
294         TagId tagId = tagIdFor(token.name());
295 #if ENABLE(TEMPLATE_ELEMENT)
296         if (tagId == TagId::Template) {
297             ++m_templateCount;
298             return;
299         }
300 #endif
301         if (tagId == TagId::Style) {
302             m_inStyle = true;
303             return;
304         }
305         if (tagId == TagId::Base) {
306             // The first <base> element is the one that wins.
307             if (!m_predictedBaseElementURL.isEmpty())
308                 return;
309             updatePredictedBaseURL(token);
310             return;
311         }
312
313         StartTagScanner scanner(tagId, m_deviceScaleFactor);
314         scanner.processAttributes(token.attributes(), document);
315         if (auto request = scanner.createPreloadRequest(m_predictedBaseElementURL))
316             requests.append(WTF::move(request));
317         return;
318     }
319
320     default:
321         return;
322     }
323 }
324
325 void TokenPreloadScanner::updatePredictedBaseURL(const HTMLToken& token)
326 {
327     ASSERT(m_predictedBaseElementURL.isEmpty());
328     if (auto* hrefAttribute = findAttribute(token.attributes(), hrefAttr.localName().string()))
329         m_predictedBaseElementURL = URL(m_documentURL, stripLeadingAndTrailingHTMLSpaces(StringImpl::create8BitIfPossible(hrefAttribute->value))).isolatedCopy();
330 }
331
332 HTMLPreloadScanner::HTMLPreloadScanner(const HTMLParserOptions& options, const URL& documentURL, float deviceScaleFactor)
333     : m_scanner(documentURL, deviceScaleFactor)
334     , m_tokenizer(options)
335 {
336 }
337
338 void HTMLPreloadScanner::appendToEnd(const SegmentedString& source)
339 {
340     m_source.append(source);
341 }
342
343 void HTMLPreloadScanner::scan(HTMLResourcePreloader& preloader, Document& document)
344 {
345     ASSERT(isMainThread()); // HTMLTokenizer::updateStateFor only works on the main thread.
346
347     const URL& startingBaseElementURL = document.baseElementURL();
348
349     // When we start scanning, our best prediction of the baseElementURL is the real one!
350     if (!startingBaseElementURL.isEmpty())
351         m_scanner.setPredictedBaseElementURL(startingBaseElementURL);
352
353     PreloadRequestStream requests;
354
355     while (auto token = m_tokenizer.nextToken(m_source)) {
356         if (token->type() == HTMLToken::StartTag)
357             m_tokenizer.updateStateFor(AtomicString(token->name()));
358         m_scanner.scan(*token, requests, document);
359     }
360
361     preloader.preload(WTF::move(requests));
362 }
363
364 bool testPreloadScannerViewportSupport(Document* document)
365 {
366     ASSERT(document);
367     HTMLParserOptions options(*document);
368     HTMLPreloadScanner scanner(options, document->url());
369     HTMLResourcePreloader preloader(*document);
370     scanner.appendToEnd(String("<meta name=viewport content='width=400'>"));
371     scanner.scan(preloader, *document);
372     return (document->viewportArguments().width == 400);
373 }
374
375 }