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