2356b8e21ddc939cdb89db0fb3d45f20b295a21a
[WebKit-https.git] / Source / WebCore / html / parser / HTMLPreloadScanner.cpp
1 /*
2  * Copyright (C) 2008 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 "CachedResourceLoader.h"
32 #include "Document.h"
33 #include "HTMLDocumentParser.h"
34 #include "HTMLTokenizer.h"
35 #include "HTMLNames.h"
36 #include "HTMLParserIdioms.h"
37 #include "HTMLParserOptions.h"
38 #include "InputTypeNames.h"
39 #include "LinkRelAttribute.h"
40 #include "MediaList.h"
41 #include "MediaQueryEvaluator.h"
42
43 namespace WebCore {
44
45 using namespace HTMLNames;
46
47 class PreloadTask {
48 public:
49     explicit PreloadTask(const HTMLToken& token)
50         : m_tagName(token.name().data(), token.name().size())
51         , m_linkIsStyleSheet(false)
52         , m_linkMediaAttributeIsScreen(true)
53         , m_inputIsImage(false)
54     {
55         processAttributes(token.attributes());
56     }
57
58     void processAttributes(const HTMLToken::AttributeList& attributes)
59     {
60         if (m_tagName != imgTag
61             && m_tagName != inputTag
62             && m_tagName != linkTag
63             && m_tagName != scriptTag
64             && m_tagName != baseTag)
65             return;
66
67         for (HTMLToken::AttributeList::const_iterator iter = attributes.begin();
68              iter != attributes.end(); ++iter) {
69             AtomicString attributeName(iter->m_name.data(), iter->m_name.size());
70             String attributeValue = StringImpl::create8BitIfPossible(iter->m_value.data(), iter->m_value.size());
71
72             if (attributeName == charsetAttr)
73                 m_charset = attributeValue;
74
75             if (m_tagName == scriptTag || m_tagName == imgTag) {
76                 if (attributeName == srcAttr)
77                     setUrlToLoad(attributeValue);
78                 else if (attributeName == crossoriginAttr && !attributeValue.isNull())
79                     m_crossOriginMode = stripLeadingAndTrailingHTMLSpaces(attributeValue);
80             } else if (m_tagName == linkTag) {
81                 if (attributeName == hrefAttr)
82                     setUrlToLoad(attributeValue);
83                 else if (attributeName == relAttr)
84                     m_linkIsStyleSheet = relAttributeIsStyleSheet(attributeValue);
85                 else if (attributeName == mediaAttr)
86                     m_linkMediaAttributeIsScreen = linkMediaAttributeIsScreen(attributeValue);
87             } else if (m_tagName == inputTag) {
88                 if (attributeName == srcAttr)
89                     setUrlToLoad(attributeValue);
90                 else if (attributeName == typeAttr)
91                     m_inputIsImage = equalIgnoringCase(attributeValue, InputTypeNames::image());
92             } else if (m_tagName == baseTag) {
93                 if (attributeName == hrefAttr)
94                     m_baseElementHref = stripLeadingAndTrailingHTMLSpaces(attributeValue);
95             }
96         }
97     }
98
99     static bool relAttributeIsStyleSheet(const String& attributeValue)
100     {
101         LinkRelAttribute rel(attributeValue);
102         return rel.m_isStyleSheet && !rel.m_isAlternate && rel.m_iconType == InvalidIcon && !rel.m_isDNSPrefetch;
103     }
104
105     static bool linkMediaAttributeIsScreen(const String& attributeValue)
106     {
107         if (attributeValue.isEmpty())
108             return true;
109         RefPtr<MediaQuerySet> mediaQueries = MediaQuerySet::createAllowingDescriptionSyntax(attributeValue);
110     
111         // Only preload screen media stylesheets. Used this way, the evaluator evaluates to true for any 
112         // rules containing complex queries (full evaluation is possible but it requires a frame and a style selector which
113         // may be problematic here).
114         MediaQueryEvaluator mediaQueryEvaluator("screen");
115         return mediaQueryEvaluator.eval(mediaQueries.get());
116     }
117
118     void setUrlToLoad(const String& attributeValue)
119     {
120         // We only respect the first src/href, per HTML5:
121         // http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#attribute-name-state
122         if (!m_urlToLoad.isEmpty())
123             return;
124         m_urlToLoad = stripLeadingAndTrailingHTMLSpaces(attributeValue);
125     }
126
127     void preload(Document* document, const KURL& baseURL)
128     {
129         if (m_urlToLoad.isEmpty())
130             return;
131
132         CachedResourceLoader* cachedResourceLoader = document->cachedResourceLoader();
133         CachedResourceRequest request(ResourceRequest(document->completeURL(m_urlToLoad, baseURL)));
134         request.setInitiator(tagName());
135         if (m_tagName == scriptTag) {
136             request.mutableResourceRequest().setAllowCookies(crossOriginModeAllowsCookies());
137             cachedResourceLoader->preload(CachedResource::Script, request, m_charset);
138         }
139         else if (m_tagName == imgTag || (m_tagName == inputTag && m_inputIsImage))
140             cachedResourceLoader->preload(CachedResource::ImageResource, request, String());
141         else if (m_tagName == linkTag && m_linkIsStyleSheet && m_linkMediaAttributeIsScreen) 
142             cachedResourceLoader->preload(CachedResource::CSSStyleSheet, request, m_charset);
143     }
144
145     const AtomicString& tagName() const { return m_tagName; }
146     const String& baseElementHref() const { return m_baseElementHref; }
147
148 private:
149
150     bool crossOriginModeAllowsCookies()
151     {
152         return m_crossOriginMode.isNull() || equalIgnoringCase(m_crossOriginMode, "use-credentials");
153     }
154
155     AtomicString m_tagName;
156     String m_urlToLoad;
157     String m_charset;
158     String m_baseElementHref;
159     String m_crossOriginMode;
160     bool m_linkIsStyleSheet;
161     bool m_linkMediaAttributeIsScreen;
162     bool m_inputIsImage;
163 };
164
165 HTMLPreloadScanner::HTMLPreloadScanner(Document* document, const HTMLParserOptions& options)
166     : m_document(document)
167     , m_cssScanner(document)
168     , m_tokenizer(HTMLTokenizer::create(options))
169     , m_inStyle(false)
170 #if ENABLE(TEMPLATE_ELEMENT)
171     , m_templateCount(0)
172 #endif
173 {
174 }
175
176 void HTMLPreloadScanner::appendToEnd(const SegmentedString& source)
177 {
178     m_source.append(source);
179 }
180
181 void HTMLPreloadScanner::scan()
182 {
183     // When we start scanning, our best prediction of the baseElementURL is the real one!
184     m_predictedBaseElementURL = m_document->baseElementURL();
185
186     // FIXME: We should save and re-use these tokens in HTMLDocumentParser if
187     // the pending script doesn't end up calling document.write.
188     while (m_tokenizer->nextToken(m_source, m_token)) {
189         processToken();
190         m_token.clear();
191     }
192 }
193
194 void HTMLPreloadScanner::processToken()
195 {
196     if (m_inStyle) {
197         if (m_token.type() == HTMLTokenTypes::Character)
198             m_cssScanner.scan(m_token);
199         else if (m_token.type() == HTMLTokenTypes::EndTag) {
200             m_inStyle = false;
201             m_cssScanner.reset();
202         }
203     }
204
205     if (m_token.type() != HTMLTokenTypes::StartTag) {
206 #if ENABLE(TEMPLATE_ELEMENT)
207         if (m_templateCount && m_token.type() == HTMLTokenTypes::EndTag && AtomicString(m_token.name().data()) == templateTag)
208             m_templateCount--;
209 #endif
210         return;
211     }
212
213     PreloadTask task(m_token);
214     m_tokenizer->updateStateFor(task.tagName());
215
216 #if ENABLE(TEMPLATE_ELEMENT)
217     if (task.tagName() == templateTag)
218         m_templateCount++;
219 #endif
220
221     if (task.tagName() == styleTag)
222         m_inStyle = true;
223
224     if (task.tagName() == baseTag)
225         updatePredictedBaseElementURL(KURL(m_document->url(), task.baseElementHref()));
226
227     bool preload = true;
228
229 #if ENABLE(TEMPLATE_ELEMENT)
230     if (m_templateCount)
231         preload = false;
232 #endif
233
234     if (preload)
235         task.preload(m_document, m_predictedBaseElementURL.isEmpty() ? m_document->baseURL() : m_predictedBaseElementURL);
236 }
237
238 void HTMLPreloadScanner::updatePredictedBaseElementURL(const KURL& baseElementURL)
239 {
240     // The first <base> element is the one that wins.
241     if (!m_predictedBaseElementURL.isEmpty())
242         return;
243     m_predictedBaseElementURL = baseElementURL;
244 }
245
246 }