Unreviewed, rolling out r205344.
[WebKit-https.git] / Source / WebCore / page / PageSerializer.cpp
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "PageSerializer.h"
33
34 #include "CSSFontFaceRule.h"
35 #include "CSSImageValue.h"
36 #include "CSSImportRule.h"
37 #include "CSSStyleRule.h"
38 #include "CachedImage.h"
39 #include "Document.h"
40 #include "Element.h"
41 #include "HTMLFrameOwnerElement.h"
42 #include "HTMLHeadElement.h"
43 #include "HTMLImageElement.h"
44 #include "HTMLLinkElement.h"
45 #include "HTMLMetaCharsetParser.h"
46 #include "HTMLNames.h"
47 #include "HTMLObjectElement.h"
48 #include "HTMLStyleElement.h"
49 #include "HTTPParsers.h"
50 #include "Image.h"
51 #include "MIMETypeRegistry.h"
52 #include "MainFrame.h"
53 #include "MarkupAccumulator.h"
54 #include "Page.h"
55 #include "RenderElement.h"
56 #include "StyleCachedImage.h"
57 #include "StyleImage.h"
58 #include "StyleProperties.h"
59 #include "StyleRule.h"
60 #include "StyleSheetContents.h"
61 #include "Text.h"
62 #include "TextEncoding.h"
63 #include <wtf/text/CString.h>
64 #include <wtf/text/StringBuilder.h>
65 #include <wtf/text/WTFString.h>
66
67 namespace WebCore {
68
69 static bool isCharsetSpecifyingNode(const Node& node)
70 {
71     if (!is<HTMLElement>(node))
72         return false;
73
74     const HTMLElement& element = downcast<HTMLElement>(node);
75     if (!element.hasTagName(HTMLNames::metaTag))
76         return false;
77     HTMLMetaCharsetParser::AttributeList attributes;
78     if (element.hasAttributes()) {
79         for (const Attribute& attribute : element.attributesIterator()) {
80             // FIXME: We should deal appropriately with the attribute if they have a namespace.
81             attributes.append(std::make_pair(attribute.name().toString(), attribute.value().string()));
82         }
83     }
84     TextEncoding textEncoding = HTMLMetaCharsetParser::encodingFromMetaAttributes(attributes);
85     return textEncoding.isValid();
86 }
87
88 static bool shouldIgnoreElement(const Element& element)
89 {
90     return element.hasTagName(HTMLNames::scriptTag) || element.hasTagName(HTMLNames::noscriptTag) || isCharsetSpecifyingNode(element);
91 }
92
93 static const QualifiedName& frameOwnerURLAttributeName(const HTMLFrameOwnerElement& frameOwner)
94 {
95     // FIXME: We should support all frame owners including applets.
96     return is<HTMLObjectElement>(frameOwner) ? HTMLNames::dataAttr : HTMLNames::srcAttr;
97 }
98
99 class SerializerMarkupAccumulator final : public WebCore::MarkupAccumulator {
100 public:
101     SerializerMarkupAccumulator(PageSerializer&, Document&, Vector<Node*>*);
102     virtual ~SerializerMarkupAccumulator();
103
104 private:
105     PageSerializer& m_serializer;
106     Document& m_document;
107
108     void appendText(StringBuilder&, const Text&) override;
109     void appendElement(StringBuilder&, const Element&, Namespaces*) override;
110     void appendCustomAttributes(StringBuilder&, const Element&, Namespaces*) override;
111     void appendEndTag(const Element&) override;
112 };
113
114 SerializerMarkupAccumulator::SerializerMarkupAccumulator(PageSerializer& serializer, Document& document, Vector<Node*>* nodes)
115     : MarkupAccumulator(nodes, ResolveAllURLs)
116     , m_serializer(serializer)
117     , m_document(document)
118 {
119     // MarkupAccumulator does not serialize the <?xml ... line, so we add it explicitely to ensure the right encoding is specified.
120     if (m_document.isXMLDocument() || m_document.xmlStandalone())
121         appendString("<?xml version=\"" + m_document.xmlVersion() + "\" encoding=\"" + m_document.charset() + "\"?>");
122 }
123
124 SerializerMarkupAccumulator::~SerializerMarkupAccumulator()
125 {
126 }
127
128 void SerializerMarkupAccumulator::appendText(StringBuilder& out, const Text& text)
129 {
130     Element* parent = text.parentElement();
131     if (parent && !shouldIgnoreElement(*parent))
132         MarkupAccumulator::appendText(out, text);
133 }
134
135 void SerializerMarkupAccumulator::appendElement(StringBuilder& out, const Element& element, Namespaces* namespaces)
136 {
137     if (!shouldIgnoreElement(element))
138         MarkupAccumulator::appendElement(out, element, namespaces);
139
140     if (element.hasTagName(HTMLNames::headTag)) {
141         out.appendLiteral("<meta charset=\"");
142         out.append(m_document.charset());
143         out.appendLiteral("\">");
144     }
145
146     // FIXME: For object (plugins) tags and video tag we could replace them by an image of their current contents.
147 }
148
149 void SerializerMarkupAccumulator::appendCustomAttributes(StringBuilder& out, const Element& element, Namespaces* namespaces)
150 {
151     if (!is<HTMLFrameOwnerElement>(element))
152         return;
153
154     const HTMLFrameOwnerElement& frameOwner = downcast<HTMLFrameOwnerElement>(element);
155     Frame* frame = frameOwner.contentFrame();
156     if (!frame)
157         return;
158
159     URL url = frame->document()->url();
160     if (url.isValid() && !url.isBlankURL())
161         return;
162
163     // We need to give a fake location to blank frames so they can be referenced by the serialized frame.
164     url = m_serializer.urlForBlankFrame(frame);
165     appendAttribute(out, element, Attribute(frameOwnerURLAttributeName(frameOwner), url.string()), namespaces);
166 }
167
168 void SerializerMarkupAccumulator::appendEndTag(const Element& element)
169 {
170     if (!shouldIgnoreElement(element))
171         MarkupAccumulator::appendEndTag(element);
172 }
173
174 PageSerializer::Resource::Resource()
175 {
176 }
177
178 PageSerializer::Resource::Resource(const URL& url, const String& mimeType, PassRefPtr<SharedBuffer> data)
179     : url(url)
180     , mimeType(mimeType)
181     , data(data)
182 {
183 }
184
185 PageSerializer::PageSerializer(Vector<PageSerializer::Resource>* resources)
186     : m_resources(resources)
187     , m_blankFrameCounter(0)
188 {
189 }
190
191 void PageSerializer::serialize(Page* page)
192 {
193     serializeFrame(&page->mainFrame());
194 }
195
196 void PageSerializer::serializeFrame(Frame* frame)
197 {
198     Document* document = frame->document();
199     URL url = document->url();
200     if (!url.isValid() || url.isBlankURL()) {
201         // For blank frames we generate a fake URL so they can be referenced by their containing frame.
202         url = urlForBlankFrame(frame);
203     }
204
205     if (m_resourceURLs.contains(url)) {
206         // FIXME: We could have 2 frame with the same URL but which were dynamically changed and have now
207         // different content. So we should serialize both and somehow rename the frame src in the containing
208         // frame. Arg!
209         return;
210     }
211
212     Vector<Node*> nodes;
213     SerializerMarkupAccumulator accumulator(*this, *document, &nodes);
214     TextEncoding textEncoding(document->charset());
215     CString data;
216     if (!textEncoding.isValid()) {
217         // FIXME: iframes used as images trigger this. We should deal with them correctly.
218         return;
219     }
220     String text = accumulator.serializeNodes(*document->documentElement(), IncludeNode);
221     CString frameHTML = textEncoding.encode(text, EntitiesForUnencodables);
222     m_resources->append(Resource(url, document->suggestedMIMEType(), SharedBuffer::create(frameHTML.data(), frameHTML.length())));
223     m_resourceURLs.add(url);
224
225     for (auto& node : nodes) {
226         if (!is<Element>(*node))
227             continue;
228
229         Element& element = downcast<Element>(*node);
230         // We have to process in-line style as it might contain some resources (typically background images).
231         if (is<StyledElement>(element))
232             retrieveResourcesForProperties(downcast<StyledElement>(element).inlineStyle(), document);
233
234         if (is<HTMLImageElement>(element)) {
235             HTMLImageElement& imageElement = downcast<HTMLImageElement>(element);
236             URL url = document->completeURL(imageElement.attributeWithoutSynchronization(HTMLNames::srcAttr));
237             CachedImage* cachedImage = imageElement.cachedImage();
238             addImageToResources(cachedImage, imageElement.renderer(), url);
239         } else if (is<HTMLLinkElement>(element)) {
240             HTMLLinkElement& linkElement = downcast<HTMLLinkElement>(element);
241             if (CSSStyleSheet* sheet = linkElement.sheet()) {
242                 URL url = document->completeURL(linkElement.attributeWithoutSynchronization(HTMLNames::hrefAttr));
243                 serializeCSSStyleSheet(sheet, url);
244                 ASSERT(m_resourceURLs.contains(url));
245             }
246         } else if (is<HTMLStyleElement>(element)) {
247             if (CSSStyleSheet* sheet = downcast<HTMLStyleElement>(element).sheet())
248                 serializeCSSStyleSheet(sheet, URL());
249         }
250     }
251
252     for (Frame* childFrame = frame->tree().firstChild(); childFrame; childFrame = childFrame->tree().nextSibling())
253         serializeFrame(childFrame);
254 }
255
256 void PageSerializer::serializeCSSStyleSheet(CSSStyleSheet* styleSheet, const URL& url)
257 {
258     StringBuilder cssText;
259     for (unsigned i = 0; i < styleSheet->length(); ++i) {
260         CSSRule* rule = styleSheet->item(i);
261         String itemText = rule->cssText();
262         if (!itemText.isEmpty()) {
263             cssText.append(itemText);
264             if (i < styleSheet->length() - 1)
265                 cssText.appendLiteral("\n\n");
266         }
267         Document* document = styleSheet->ownerDocument();
268         // Some rules have resources associated with them that we need to retrieve.
269         if (is<CSSImportRule>(*rule)) {
270             CSSImportRule& importRule = downcast<CSSImportRule>(*rule);
271             URL importURL = document->completeURL(importRule.href());
272             if (m_resourceURLs.contains(importURL))
273                 continue;
274             serializeCSSStyleSheet(importRule.styleSheet(), importURL);
275         } else if (is<CSSFontFaceRule>(*rule)) {
276             // FIXME: Add support for font face rule. It is not clear to me at this point if the actual otf/eot file can
277             // be retrieved from the CSSFontFaceRule object.
278         } else if (is<CSSStyleRule>(*rule))
279             retrieveResourcesForRule(downcast<CSSStyleRule>(*rule).styleRule(), document);
280     }
281
282     if (url.isValid() && !m_resourceURLs.contains(url)) {
283         // FIXME: We should check whether a charset has been specified and if none was found add one.
284         TextEncoding textEncoding(styleSheet->contents().charset());
285         ASSERT(textEncoding.isValid());
286         String textString = cssText.toString();
287         CString text = textEncoding.encode(textString, EntitiesForUnencodables);
288         m_resources->append(Resource(url, String("text/css"), SharedBuffer::create(text.data(), text.length())));
289         m_resourceURLs.add(url);
290     }
291 }
292
293 void PageSerializer::addImageToResources(CachedImage* image, RenderElement* imageRenderer, const URL& url)
294 {
295     if (!url.isValid() || m_resourceURLs.contains(url))
296         return;
297
298     if (!image || image->image() == Image::nullImage())
299         return;
300
301     RefPtr<SharedBuffer> data = imageRenderer ? image->imageForRenderer(imageRenderer)->data() : 0;
302     if (!data)
303         data = image->image()->data();
304
305     if (!data) {
306         LOG_ERROR("No data for image %s", url.string().utf8().data());
307         return;
308     }
309
310     String mimeType = image->response().mimeType();
311     m_resources->append(Resource(url, mimeType, data));
312     m_resourceURLs.add(url);
313 }
314
315 void PageSerializer::retrieveResourcesForRule(StyleRule& rule, Document* document)
316 {
317     retrieveResourcesForProperties(&rule.properties(), document);
318 }
319
320 void PageSerializer::retrieveResourcesForProperties(const StyleProperties* styleDeclaration, Document* document)
321 {
322     if (!styleDeclaration)
323         return;
324
325     // The background-image and list-style-image (for ul or ol) are the CSS properties
326     // that make use of images. We iterate to make sure we include any other
327     // image properties there might be.
328     unsigned propertyCount = styleDeclaration->propertyCount();
329     for (unsigned i = 0; i < propertyCount; ++i) {
330         RefPtr<CSSValue> cssValue = styleDeclaration->propertyAt(i).value();
331         if (!is<CSSImageValue>(*cssValue))
332             continue;
333
334         auto& styleImage = downcast<CSSImageValue>(*cssValue).styleImage();
335
336         auto* image = styleImage.cachedImage();
337         if (!image)
338             continue;
339
340         URL url = document->completeURL(image->url());
341         addImageToResources(image, nullptr, url);
342     }
343 }
344
345 URL PageSerializer::urlForBlankFrame(Frame* frame)
346 {
347     HashMap<Frame*, URL>::iterator iter = m_blankFrameURLs.find(frame);
348     if (iter != m_blankFrameURLs.end())
349         return iter->value;
350     String url = "wyciwyg://frame/" + String::number(m_blankFrameCounter++);
351     URL fakeURL(ParsedURLString, url);
352     m_blankFrameURLs.add(frame, fakeURL);
353
354     return fakeURL;
355 }
356
357 }