93d3777aa1a9f079f7104c9745d7da1ccbbfd580
[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 "MainFrame.h"
52 #include "MarkupAccumulator.h"
53 #include "Page.h"
54 #include "RenderElement.h"
55 #include "StyleCachedImage.h"
56 #include "StyleImage.h"
57 #include "StyleProperties.h"
58 #include "StyleRule.h"
59 #include "StyleSheetContents.h"
60 #include "Text.h"
61 #include "TextEncoding.h"
62 #include <wtf/text/CString.h>
63 #include <wtf/text/StringBuilder.h>
64 #include <wtf/text/WTFString.h>
65
66 namespace WebCore {
67
68 static bool isCharsetSpecifyingNode(const Node& node)
69 {
70     if (!is<HTMLElement>(node))
71         return false;
72
73     const HTMLElement& element = downcast<HTMLElement>(node);
74     if (!element.hasTagName(HTMLNames::metaTag))
75         return false;
76     HTMLMetaCharsetParser::AttributeList attributes;
77     if (element.hasAttributes()) {
78         for (const Attribute& attribute : element.attributesIterator()) {
79             // FIXME: We should deal appropriately with the attribute if they have a namespace.
80             attributes.append(std::make_pair(attribute.name().toString(), attribute.value().string()));
81         }
82     }
83     return HTMLMetaCharsetParser::encodingFromMetaAttributes(attributes).isValid();
84 }
85
86 static bool shouldIgnoreElement(const Element& element)
87 {
88     return element.hasTagName(HTMLNames::scriptTag) || element.hasTagName(HTMLNames::noscriptTag) || isCharsetSpecifyingNode(element);
89 }
90
91 static const QualifiedName& frameOwnerURLAttributeName(const HTMLFrameOwnerElement& frameOwner)
92 {
93     // FIXME: We should support all frame owners including applets.
94     return is<HTMLObjectElement>(frameOwner) ? HTMLNames::dataAttr : HTMLNames::srcAttr;
95 }
96
97 class PageSerializer::SerializerMarkupAccumulator final : public WebCore::MarkupAccumulator {
98 public:
99     SerializerMarkupAccumulator(PageSerializer&, Document&, Vector<Node*>*);
100
101 private:
102     PageSerializer& m_serializer;
103     Document& m_document;
104
105     void appendText(StringBuilder&, const Text&) override;
106     void appendElement(StringBuilder&, const Element&, Namespaces*) override;
107     void appendCustomAttributes(StringBuilder&, const Element&, Namespaces*) override;
108     void appendEndTag(const Element&) override;
109 };
110
111 PageSerializer::SerializerMarkupAccumulator::SerializerMarkupAccumulator(PageSerializer& serializer, Document& document, Vector<Node*>* nodes)
112     : MarkupAccumulator(nodes, ResolveAllURLs)
113     , m_serializer(serializer)
114     , m_document(document)
115 {
116     // MarkupAccumulator does not serialize the <?xml ... line, so we add it explicitely to ensure the right encoding is specified.
117     if (m_document.isXMLDocument() || m_document.xmlStandalone())
118         appendString("<?xml version=\"" + m_document.xmlVersion() + "\" encoding=\"" + m_document.charset() + "\"?>");
119 }
120
121 void PageSerializer::SerializerMarkupAccumulator::appendText(StringBuilder& out, const Text& text)
122 {
123     Element* parent = text.parentElement();
124     if (parent && !shouldIgnoreElement(*parent))
125         MarkupAccumulator::appendText(out, text);
126 }
127
128 void PageSerializer::SerializerMarkupAccumulator::appendElement(StringBuilder& out, const Element& element, Namespaces* namespaces)
129 {
130     if (!shouldIgnoreElement(element))
131         MarkupAccumulator::appendElement(out, element, namespaces);
132
133     if (element.hasTagName(HTMLNames::headTag)) {
134         out.appendLiteral("<meta charset=\"");
135         out.append(m_document.charset());
136         out.appendLiteral("\">");
137     }
138
139     // FIXME: For object (plugins) tags and video tag we could replace them by an image of their current contents.
140 }
141
142 void PageSerializer::SerializerMarkupAccumulator::appendCustomAttributes(StringBuilder& out, const Element& element, Namespaces* namespaces)
143 {
144     if (!is<HTMLFrameOwnerElement>(element))
145         return;
146
147     const HTMLFrameOwnerElement& frameOwner = downcast<HTMLFrameOwnerElement>(element);
148     Frame* frame = frameOwner.contentFrame();
149     if (!frame)
150         return;
151
152     URL url = frame->document()->url();
153     if (url.isValid() && !url.isBlankURL())
154         return;
155
156     // We need to give a fake location to blank frames so they can be referenced by the serialized frame.
157     url = m_serializer.urlForBlankFrame(frame);
158     appendAttribute(out, element, Attribute(frameOwnerURLAttributeName(frameOwner), url.string()), namespaces);
159 }
160
161 void PageSerializer::SerializerMarkupAccumulator::appendEndTag(const Element& element)
162 {
163     if (!shouldIgnoreElement(element))
164         MarkupAccumulator::appendEndTag(element);
165 }
166
167 PageSerializer::PageSerializer(Vector<PageSerializer::Resource>& resources)
168     : m_resources(resources)
169 {
170 }
171
172 void PageSerializer::serialize(Page& page)
173 {
174     serializeFrame(&page.mainFrame());
175 }
176
177 void PageSerializer::serializeFrame(Frame* frame)
178 {
179     Document* document = frame->document();
180     URL url = document->url();
181     if (!url.isValid() || url.isBlankURL()) {
182         // For blank frames we generate a fake URL so they can be referenced by their containing frame.
183         url = urlForBlankFrame(frame);
184     }
185
186     if (m_resourceURLs.contains(url)) {
187         // FIXME: We could have 2 frame with the same URL but which were dynamically changed and have now
188         // different content. So we should serialize both and somehow rename the frame src in the containing
189         // frame. Arg!
190         return;
191     }
192
193     Vector<Node*> nodes;
194     SerializerMarkupAccumulator accumulator(*this, *document, &nodes);
195     TextEncoding textEncoding(document->charset());
196     CString data;
197     if (!textEncoding.isValid()) {
198         // FIXME: iframes used as images trigger this. We should deal with them correctly.
199         return;
200     }
201     String text = accumulator.serializeNodes(*document->documentElement(), IncludeNode);
202     CString frameHTML = textEncoding.encode(text, EntitiesForUnencodables);
203     m_resources.append({ url, document->suggestedMIMEType(), SharedBuffer::create(frameHTML.data(), frameHTML.length()) });
204     m_resourceURLs.add(url);
205
206     for (auto& node : nodes) {
207         if (!is<Element>(*node))
208             continue;
209
210         Element& element = downcast<Element>(*node);
211         // We have to process in-line style as it might contain some resources (typically background images).
212         if (is<StyledElement>(element))
213             retrieveResourcesForProperties(downcast<StyledElement>(element).inlineStyle(), document);
214
215         if (is<HTMLImageElement>(element)) {
216             HTMLImageElement& imageElement = downcast<HTMLImageElement>(element);
217             URL url = document->completeURL(imageElement.attributeWithoutSynchronization(HTMLNames::srcAttr));
218             CachedImage* cachedImage = imageElement.cachedImage();
219             addImageToResources(cachedImage, imageElement.renderer(), url);
220         } else if (is<HTMLLinkElement>(element)) {
221             HTMLLinkElement& linkElement = downcast<HTMLLinkElement>(element);
222             if (CSSStyleSheet* sheet = linkElement.sheet()) {
223                 URL url = document->completeURL(linkElement.attributeWithoutSynchronization(HTMLNames::hrefAttr));
224                 serializeCSSStyleSheet(sheet, url);
225                 ASSERT(m_resourceURLs.contains(url));
226             }
227         } else if (is<HTMLStyleElement>(element)) {
228             if (CSSStyleSheet* sheet = downcast<HTMLStyleElement>(element).sheet())
229                 serializeCSSStyleSheet(sheet, URL());
230         }
231     }
232
233     for (Frame* childFrame = frame->tree().firstChild(); childFrame; childFrame = childFrame->tree().nextSibling())
234         serializeFrame(childFrame);
235 }
236
237 void PageSerializer::serializeCSSStyleSheet(CSSStyleSheet* styleSheet, const URL& url)
238 {
239     StringBuilder cssText;
240     for (unsigned i = 0; i < styleSheet->length(); ++i) {
241         CSSRule* rule = styleSheet->item(i);
242         String itemText = rule->cssText();
243         if (!itemText.isEmpty()) {
244             cssText.append(itemText);
245             if (i < styleSheet->length() - 1)
246                 cssText.appendLiteral("\n\n");
247         }
248         Document* document = styleSheet->ownerDocument();
249         // Some rules have resources associated with them that we need to retrieve.
250         if (is<CSSImportRule>(*rule)) {
251             CSSImportRule& importRule = downcast<CSSImportRule>(*rule);
252             URL importURL = document->completeURL(importRule.href());
253             if (m_resourceURLs.contains(importURL))
254                 continue;
255             serializeCSSStyleSheet(importRule.styleSheet(), importURL);
256         } else if (is<CSSFontFaceRule>(*rule)) {
257             // FIXME: Add support for font face rule. It is not clear to me at this point if the actual otf/eot file can
258             // be retrieved from the CSSFontFaceRule object.
259         } else if (is<CSSStyleRule>(*rule))
260             retrieveResourcesForRule(downcast<CSSStyleRule>(*rule).styleRule(), document);
261     }
262
263     if (url.isValid() && !m_resourceURLs.contains(url)) {
264         // FIXME: We should check whether a charset has been specified and if none was found add one.
265         TextEncoding textEncoding(styleSheet->contents().charset());
266         ASSERT(textEncoding.isValid());
267         String textString = cssText.toString();
268         CString text = textEncoding.encode(textString, EntitiesForUnencodables);
269         m_resources.append({ url, ASCIILiteral { "text/css" }, SharedBuffer::create(text.data(), text.length()) });
270         m_resourceURLs.add(url);
271     }
272 }
273
274 void PageSerializer::addImageToResources(CachedImage* image, RenderElement* imageRenderer, const URL& url)
275 {
276     if (!url.isValid() || m_resourceURLs.contains(url))
277         return;
278
279     if (!image || image->image() == Image::nullImage())
280         return;
281
282     RefPtr<SharedBuffer> data = imageRenderer ? image->imageForRenderer(imageRenderer)->data() : 0;
283     if (!data)
284         data = image->image()->data();
285
286     if (!data) {
287         LOG_ERROR("No data for image %s", url.string().utf8().data());
288         return;
289     }
290
291     m_resources.append({ url, image->response().mimeType(), WTFMove(data) });
292     m_resourceURLs.add(url);
293 }
294
295 void PageSerializer::retrieveResourcesForRule(StyleRule& rule, Document* document)
296 {
297     retrieveResourcesForProperties(&rule.properties(), document);
298 }
299
300 void PageSerializer::retrieveResourcesForProperties(const StyleProperties* styleDeclaration, Document* document)
301 {
302     if (!styleDeclaration)
303         return;
304
305     // The background-image and list-style-image (for ul or ol) are the CSS properties
306     // that make use of images. We iterate to make sure we include any other
307     // image properties there might be.
308     unsigned propertyCount = styleDeclaration->propertyCount();
309     for (unsigned i = 0; i < propertyCount; ++i) {
310         RefPtr<CSSValue> cssValue = styleDeclaration->propertyAt(i).value();
311         if (!is<CSSImageValue>(*cssValue))
312             continue;
313
314         auto* image = downcast<CSSImageValue>(*cssValue).cachedImage();
315         if (!image)
316             continue;
317
318         addImageToResources(image, nullptr, document->completeURL(image->url()));
319     }
320 }
321
322 URL PageSerializer::urlForBlankFrame(Frame* frame)
323 {
324     auto iter = m_blankFrameURLs.find(frame);
325     if (iter != m_blankFrameURLs.end())
326         return iter->value;
327     String url = "wyciwyg://frame/" + String::number(m_blankFrameCounter++);
328     URL fakeURL(ParsedURLString, url);
329     m_blankFrameURLs.add(frame, fakeURL);
330     return fakeURL;
331 }
332
333 }