Merge page serializers [11/12]

Source/core/page/PageSerializer.cpp

 /*
  * Copyright (C) 2011 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 80 matching lines @@
 {
     return isHTMLScriptElement(element) || isHTMLNoScriptElement(element) || isCharsetSpecifyingNode(element);
 }
 
 static const QualifiedName& frameOwnerURLAttributeName(const HTMLFrameOwnerElement& frameOwner)
 {
     // FIXME: We should support all frame owners including applets.
     return isHTMLObjectElement(frameOwner) ? HTMLNames::dataAttr : HTMLNames::srcAttr;
 }
 
-class SerializerMarkupAccumulator final : public MarkupAccumulator {
+class SerializerMarkupAccumulator : public MarkupAccumulator {
     STACK_ALLOCATED();
 public:
     SerializerMarkupAccumulator(PageSerializer*, const Document&, WillBeHeapVector<RawPtrWillBeMember<Node>>&);
     virtual ~SerializerMarkupAccumulator();
 
 protected:
     virtual void appendText(StringBuilder& out, Text&) override;
     virtual bool shouldIgnoreAttribute(const Attribute&) override;
     virtual void appendElement(StringBuilder& out, Element&, Namespaces*) override;
     virtual void appendCustomAttributes(StringBuilder& out, const Element&, Namespaces*) override;
     virtual void appendStartTag(Node&, Namespaces* = nullptr) override;
     virtual void appendEndTag(const Element&) override;
 
-private:
     PageSerializer* m_serializer;
     RawPtrWillBeMember<const Document> m_document;

[hajimehoshi, 2015/06/11 01:55:32]

Create a getter and make member variables private.

[Tiger (Sony Mobile), 2015/06/11 14:15:10]

Done.

 
     // FIXME: |PageSerializer| uses |m_nodes| for collecting nodes in document
     // included into serialized text then extracts image, object, etc. The size
     // of this vector isn't small for large document. It is better to use
     // callback like functionality.
     WillBeHeapVector<RawPtrWillBeMember<Node>>& m_nodes;
 };
 
 SerializerMarkupAccumulator::SerializerMarkupAccumulator(PageSerializer* serializer, const Document& document, WillBeHeapVector<RawPtrWillBeMember<Node>>& nodes)
     : MarkupAccumulator(ResolveAllURLs)
@@ skipping 68 matching lines @@
     MarkupAccumulator::appendStartTag(node, namespaces);
     m_nodes.append(&node);
 }
 
 void SerializerMarkupAccumulator::appendEndTag(const Element& element)
 {
     if (!shouldIgnoreElement(element))
         MarkupAccumulator::appendEndTag(element);
 }
 
-PageSerializer::PageSerializer(Vector<SerializedResource>* resources, PassOwnPtr<Delegate> delegate)
+class LinkChangeSerializerMarkupAccumulator : public SerializerMarkupAccumulator {
+public:
+    LinkChangeSerializerMarkupAccumulator(PageSerializer*, const Document&, WillBeHeapVector<RawPtrWillBeMember<Node>>&, LinkLocalPathMap*, String);
+
+protected:
+    virtual void appendElement(StringBuilder&, Element&, Namespaces*) override;
+    virtual void appendAttribute(StringBuilder&, const Element&, const Attribute&, Namespaces*) override;
+
+private:
+    // m_replaceLinks include all pair of local resource path and corresponding original link.
+    LinkLocalPathMap* m_replaceLinks;
+    String m_directoryName;
+};
+
+LinkChangeSerializerMarkupAccumulator::LinkChangeSerializerMarkupAccumulator(PageSerializer* serializer,  const Document& document, WillBeHeapVector<RawPtrWillBeMember<Node>>& nodes, LinkLocalPathMap* links, String directoryName)
+    : SerializerMarkupAccumulator(serializer, document, nodes)
+    , m_replaceLinks(links)
+    , m_directoryName(directoryName)
+{
+}
+
+void LinkChangeSerializerMarkupAccumulator::appendElement(StringBuilder& result, Element& element, Namespaces* namespaces)
+{
+    // FIXME: We could move the uncommenting to appendOpenTag and appendCloseTag, or just remove it

[hajimehoshi, 2015/06/11 01:55:33]

Use TODO(yourname)

[Tiger (Sony Mobile), 2015/06/11 14:15:10]

Done.

+    if (element.hasTagName(HTMLNames::baseTag)) {
+        // Comment the BASE tag when serializing dom.
+        result.appendLiteral("<!--");

[hajimehoshi, 2015/06/11 01:55:33]

Can you avoid appending <base> element instead of commenting out in this case?

[Tiger (Sony Mobile), 2015/06/11 12:23:29]

It was done like this in the old serializer, but yes - I don't actually think it
is worth commenting out the old base tag. I'll add it to the shouldIgnoreElement
function instead.

[Tiger (Sony Mobile), 2015/06/11 14:15:10]

Done.

+    } else if (element.hasTagName(HTMLNames::htmlTag)) {
+        // Add MOTW (Mark of the Web) declaration before html tag.
+        // See http://msdn2.microsoft.com/en-us/library/ms537628(VS.85).aspx.
+        result.append(String::format("\n<!-- saved from url=(%04d)%s -->\n",

[hajimehoshi, 2015/06/11 01:55:32]

Use MarkupFormatter::appendComment

+            static_cast<int>(m_document->url().string().utf8().length()),
+            m_document->url().string().utf8().data()));
+    }
+
+    SerializerMarkupAccumulator::appendElement(result, element, namespaces);
+
+    if (element.hasTagName(HTMLNames::baseTag)) {
+        // Comment the BASE tag when serializing dom.
+        result.appendLiteral("-->");
+
+        // FIXME: Refactor MarkupAccumulator so it is easier to append an element like this, without special cases for XHTML

[hajimehoshi, 2015/06/11 01:55:32]

Use TODO(yourname)

[Tiger (Sony Mobile), 2015/06/11 14:15:10]

Done.

+        // Append a new base tag declaration.
+        result.appendLiteral("<base href=\".\"");
+        if (!m_document->baseTarget().isEmpty()) {
+            result.appendLiteral(" target=\"");
+            result.append(m_document->baseTarget());

[hajimehoshi, 2015/06/11 01:55:32]

Use MarkupFormatter::appendAttributeValue

[Tiger (Sony Mobile), 2015/06/11 14:15:10]

Done.

+            result.append('"');
+        }
+        if (m_document->isXHTMLDocument())
+            result.appendLiteral(" />");
+        else
+            result.appendLiteral(">");
+    }
+}
+
+void LinkChangeSerializerMarkupAccumulator::appendAttribute(StringBuilder& result, const Element& element, const Attribute& attribute, Namespaces* namespaces)
+{
+    if (m_replaceLinks && element.isURLAttribute(attribute) && !element.isJavaScriptURLAttribute(attribute)) {
+
+        String completeURL = m_document->completeURL(attribute.value());
+
+        if (m_replaceLinks->contains(completeURL)) {
+            // FIXME: Refactor MarkupAccumulator so it is easier to append an attribute like this.
+            result.append(' ');
+            result.append(attribute.name().toString());
+            result.appendLiteral("=\"");
+            if (!m_directoryName.isEmpty()) {
+                result.appendLiteral("./");
+                result.append(m_directoryName);
+                result.append('/');
+            }
+            result.append(m_replaceLinks->get(completeURL));

[hajimehoshi, 2015/06/11 01:55:32]

Use MarkupFormatter::appendAttributeValue

[Tiger (Sony Mobile), 2015/06/11 14:15:10]

Done.

+            result.appendLiteral("\"");
+            return;
+        }
+    }
+    MarkupAccumulator::appendAttribute(result, element, attribute, namespaces);
+}
+
+
+PageSerializer::PageSerializer(Vector<SerializedResource>* resources, PassOwnPtr<Delegate> delegate, LinkLocalPathMap* urls, String directory)
     : m_resources(resources)
+    , m_URLs(urls)
+    , m_directory(directory)
     , m_blankFrameCounter(0)
     , m_delegate(delegate)
 {
 }
 
 void PageSerializer::serialize(Page* page)
 {
     serializeFrame(page->deprecatedLocalMainFrame());
 }
 
@@ skipping 16 matching lines @@
     }
 
     // If frame is an image document, add the image and don't continue
     if (document.isImageDocument()) {
         ImageDocument& imageDocument = toImageDocument(document);
         addImageToResources(imageDocument.cachedImage(), imageDocument.imageElement()->layoutObject(), url);
         return;
     }
 
     WillBeHeapVector<RawPtrWillBeMember<Node>> serializedNodes;
-    SerializerMarkupAccumulator accumulator(this, document, serializedNodes);
-    String text = serializeNodes<EditingStrategy>(accumulator, document, IncludeNode);
+    String text;
+    if (m_URLs) {
+        LinkChangeSerializerMarkupAccumulator accumulator(this, document, serializedNodes, m_URLs, m_directory);
+        text = serializeNodes<EditingStrategy>(accumulator, document, IncludeNode);
+    } else {
+        SerializerMarkupAccumulator accumulator(this, document, serializedNodes);
+        text = serializeNodes<EditingStrategy>(accumulator, document, IncludeNode);
+    }
+
     WTF::TextEncoding textEncoding(document.charset());
     CString frameHTML = textEncoding.normalizeAndEncode(text, WTF::EntitiesForUnencodables);
     m_resources->append(SerializedResource(url, document.suggestedMIMEType(), SharedBuffer::create(frameHTML.data(), frameHTML.length())));
     m_resourceURLs.add(url);
 
     for (Node* node: serializedNodes) {
         ASSERT(node);
         if (!node->isElementNode())
             continue;
 
@@ skipping 168 matching lines @@
 
     return fakeURL;
 }
 
 PageSerializer::Delegate* PageSerializer::delegate()
 {
     return m_delegate.get();
 }
 
 } // namespace blink