Generating CIDs in Blink during MHTML serialization.

third_party/WebKit/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 33 matching lines @@
 #include "core/css/StylePropertySet.h"
 #include "core/css/StyleRule.h"
 #include "core/css/StyleSheetContents.h"
 #include "core/dom/Document.h"
 #include "core/dom/Element.h"
 #include "core/dom/Text.h"
 #include "core/editing/serializers/MarkupAccumulator.h"
 #include "core/fetch/FontResource.h"
 #include "core/fetch/ImageResource.h"
 #include "core/frame/LocalFrame.h"
-#include "core/html/HTMLFrameOwnerElement.h"
+#include "core/html/HTMLFrameElementBase.h"
 #include "core/html/HTMLImageElement.h"
 #include "core/html/HTMLInputElement.h"
 #include "core/html/HTMLLinkElement.h"
 #include "core/html/HTMLMetaElement.h"
 #include "core/html/HTMLStyleElement.h"
 #include "core/html/ImageDocument.h"
 #include "core/html/parser/HTMLParserIdioms.h"
 #include "core/page/Page.h"
 #include "core/style/StyleFetchedImage.h"
 #include "core/style/StyleImage.h"
 #include "platform/SerializedResource.h"
 #include "platform/graphics/Image.h"
+#include "wtf/HashSet.h"
 #include "wtf/OwnPtr.h"
 #include "wtf/text/CString.h"
 #include "wtf/text/StringBuilder.h"
 #include "wtf/text/TextEncoding.h"
 #include "wtf/text/WTFString.h"
 
 namespace blink {
 
 static bool isCharsetSpecifyingNode(const Node& node)
 {
     if (!isHTMLMetaElement(node))
         return false;
 
     const HTMLMetaElement& element = toHTMLMetaElement(node);
     HTMLAttributeList attributeList;
     AttributeCollection attributes = element.attributes();
     for (const Attribute& attr: attributes) {
         // FIXME: We should deal appropriately with the attribute if they have a namespace.
         attributeList.append(std::make_pair(attr.name().localName(), attr.value().string()));
     }
     WTF::TextEncoding textEncoding = encodingFromMetaAttributes(attributeList);
     return textEncoding.isValid();
 }
 
 static bool shouldIgnoreElement(const Element& element)
 {
     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 : public MarkupAccumulator {
     STACK_ALLOCATED();
 public:
     SerializerMarkupAccumulator(PageSerializer*, const Document&, WillBeHeapVector<RawPtrWillBeMember<Node>>&);
     ~SerializerMarkupAccumulator() override;
 
 protected:
     void appendText(StringBuilder& out, Text&) override;
     bool shouldIgnoreAttribute(const Attribute&) override;
     void appendElement(StringBuilder& out, Element&, Namespaces*) override;
-    void appendCustomAttributes(StringBuilder& out, const Element&, Namespaces*) override;
+    void appendAttribute(StringBuilder& out, const Element&, const Attribute&, Namespaces*) override;
     void appendStartTag(Node&, Namespaces* = nullptr) override;
     void appendEndTag(const Element&) override;
 
-    const Document& document();
+private:
+    void appendAttributeValue(StringBuilder& out, const String& attributeValue);
+    void appendRewrittenAttribute(
+        StringBuilder& out,
+        const Element&,
+        const String& attributeName,
+        const String& attributeValue);
 
-private:
     PageSerializer* m_serializer;
     RawPtrWillBeMember<const Document> m_document;
 
     // 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;
+
+    // Elements with links rewritten via appendAttribute method.
+    HashSet<const Element*> m_elementsWithRewrittenLinks;
 };
 
 SerializerMarkupAccumulator::SerializerMarkupAccumulator(PageSerializer* serializer, const Document& document, WillBeHeapVector<RawPtrWillBeMember<Node>>& nodes)
     : MarkupAccumulator(ResolveAllURLs)
     , m_serializer(serializer)
     , m_document(&document)
     , m_nodes(nodes)
 {
 }
 
@@ skipping 18 matching lines @@
 }
 
 void SerializerMarkupAccumulator::appendElement(StringBuilder& result, Element& element, Namespaces* namespaces)
 {
     if (!shouldIgnoreElement(element))
         MarkupAccumulator::appendElement(result, element, namespaces);
 
     // TODO(tiger): Refactor MarkupAccumulator so it is easier to append an element like this, without special cases for XHTML
     if (isHTMLHeadElement(element)) {
         result.appendLiteral("<meta http-equiv=\"Content-Type\" content=\"");
-        MarkupFormatter::appendAttributeValue(result, m_document->suggestedMIMEType(), m_document->isHTMLDocument());
+        appendAttributeValue(result, m_document->suggestedMIMEType());
         result.appendLiteral("; charset=");
-        MarkupFormatter::appendAttributeValue(result, m_document->characterSet(), m_document->isHTMLDocument());
+        appendAttributeValue(result, m_document->characterSet());
         if (m_document->isXHTMLDocument())
             result.appendLiteral("\" />");
         else
             result.appendLiteral("\">");
     }
 
     // FIXME: For object (plugins) tags and video tag we could replace them by an image of their current contents.
 }
 
-void SerializerMarkupAccumulator::appendCustomAttributes(StringBuilder& result, const Element& element, Namespaces* namespaces)
+void SerializerMarkupAccumulator::appendAttribute(
+    StringBuilder& out,
+    const Element& element,
+    const Attribute& attribute,
+    Namespaces* namespaces)
 {
-    if (!element.isFrameOwnerElement())
+    // Check if the delegate wants to rewrite the attribute.
+    PageSerializer::Delegate* delegate = m_serializer->delegate();
+    String newValue = delegate ? delegate->rewriteLink(element) : String();
+    if (newValue.isNull()) {
+        // Fallback to appending the original attribute.
+        MarkupAccumulator::appendAttribute(out, element, attribute, namespaces);
         return;
+    }
 
-    const HTMLFrameOwnerElement& frameOwner = toHTMLFrameOwnerElement(element);
-    Frame* frame = frameOwner.contentFrame();
-    // FIXME: RemoteFrames not currently supported here.
-    if (!frame || !frame->isLocalFrame())
-        return;
-
-    KURL url = toLocalFrame(frame)->document()->url();
-    if (url.isValid() && !url.protocolIsAbout())
-        return;
-
-    // We need to give a fake location to blank frames so they can be referenced by the serialized frame.
-    url = m_serializer->urlForBlankFrame(*toLocalFrame(frame));
-    appendAttribute(result, element, Attribute(frameOwnerURLAttributeName(frameOwner), AtomicString(url.string())), namespaces);
+    if (element.hasLegalLinkAttribute(attribute.name())) {

[yosin_UTC9, 2015/11/25 01:21:55]

nit: early return style is preferred to get rid of else-if.

if ((element.hasLegalLinkAttribute(attribute.name())))
  return appendRewrittenAttribute(...);

if (isHTMLFrameElementBase(&element) && attribute.name() ==
HTMLNames::srcdocAttr) {
  // Emit src instead of srcdoc attribute for frame elements.
  return appendRewrittenAttribute(out, element, HTMLNames::srcAttr.localName(),
newValue);
}

// Please put comment why we don't append attribute.

Note: void foo() { return bar(); } void bar() {} is valid in C++.

[Łukasz Anforowicz, 2015/11/25 17:19:18]

Done.
Done.
Ack, although I am not sure if I understand the significance of your comment wrt
to the changelist :-(

+        // Rewrite element links.
+        appendRewrittenAttribute(out, element, attribute.name().toString(), newValue);
+    } else if (isHTMLFrameElementBase(&element) && attribute.name() == HTMLNames::srcdocAttr) {
+        // Emit src instead of srcdoc attribute for frame elements.
+        appendRewrittenAttribute(out, element, HTMLNames::srcAttr.localName(), newValue);
+    }
 }
 
 void SerializerMarkupAccumulator::appendStartTag(Node& node, Namespaces* namespaces)
 {
     MarkupAccumulator::appendStartTag(node, namespaces);
     m_nodes.append(&node);
 }
 
 void SerializerMarkupAccumulator::appendEndTag(const Element& element)
 {
     if (!shouldIgnoreElement(element))
         MarkupAccumulator::appendEndTag(element);
 }
 
-const Document& SerializerMarkupAccumulator::document()
+void SerializerMarkupAccumulator::appendAttributeValue(
+    StringBuilder& out,
+    const String& attributeValue)
 {
-    return *m_document;
+    MarkupFormatter::appendAttributeValue(out, attributeValue, m_document->isHTMLDocument());
+}
+
+void SerializerMarkupAccumulator::appendRewrittenAttribute(
+    StringBuilder& out,
+    const Element& element,
+    const String& attributeName,
+    const String& attributeValue)
+{
+    if (m_elementsWithRewrittenLinks.contains(&element))
+        return;
+    m_elementsWithRewrittenLinks.add(&element);
+
+    // Append the rewritten attribute.
+    // TODO(tiger): Refactor MarkupAccumulator so it is easier to append an attribute like this.
+    out.append(' ');
+    out.append(attributeName);
+    out.appendLiteral("=\"");
+    appendAttributeValue(out, attributeValue);
+    out.appendLiteral("\"");
 }
 
 // TODO(tiger): Right now there is no support for rewriting URLs inside CSS
 // documents which leads to bugs like <https://crbug.com/251898>. Not being
 // able to rewrite URLs inside CSS documents means that resources imported from
 // url(...) statements in CSS might not work when rewriting links for the
 // "Webpage, Complete" method of saving a page. It will take some work but it
 // needs to be done if we want to continue to support non-MHTML saved pages.
-//
-// Once that is fixed it would make sense to make link rewriting a bit more
-// general. A new method, String& rewriteURL(String&) or similar, could be added
-// to PageSerializer.Delegate that would allow clients to control this. Some of
-// the change link logic could be moved back to WebPageSerializer.
-//
-// The remaining code in LinkChangeSerializerMarkupAccumulator could probably
-// be merged back into SerializerMarkupAccumulator with additional methods in
-// PageSerializer.Delegate to control MOTW and Base tag rewrite.
-class LinkChangeSerializerMarkupAccumulator final : public SerializerMarkupAccumulator {
-    STACK_ALLOCATED();
-public:
-    LinkChangeSerializerMarkupAccumulator(PageSerializer*, const Document&, WillBeHeapVector<RawPtrWillBeMember<Node>>&, HashMap<String, String>& rewriteURLs, const String& rewriteFolder);
 
-private:
-    void appendElement(StringBuilder&, Element&, Namespaces*) override;
-    void appendAttribute(StringBuilder&, const Element&, const Attribute&, Namespaces*) override;
-
-    // m_rewriteURLs include all pairs of local resource paths and corresponding original links.
-    HashMap<String, String> m_rewriteURLs;
-    String m_rewriteFolder;
-};
-
-LinkChangeSerializerMarkupAccumulator::LinkChangeSerializerMarkupAccumulator(PageSerializer* serializer, const Document& document, WillBeHeapVector<RawPtrWillBeMember<Node>>& nodes, HashMap<String, String>& rewriteURLs, const String& rewriteFolder)
-    : SerializerMarkupAccumulator(serializer, document, nodes)
-    , m_rewriteURLs(rewriteURLs)
-    , m_rewriteFolder(rewriteFolder)
-{
-}
-
-void LinkChangeSerializerMarkupAccumulator::appendElement(StringBuilder& result, Element& element, Namespaces* namespaces)
-{
-    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('\n');
-        MarkupFormatter::appendComment(result, PageSerializer::markOfTheWebDeclaration(document().url()));
-        result.append('\n');
-    }
-
-    if (element.hasTagName(HTMLNames::baseTag)) {
-        // TODO(tiger): Refactor MarkupAccumulator so it is easier to append an element like this, without special cases for XHTML
-        // Append a new base tag declaration.
-        result.appendLiteral("<base href=\".\"");
-        if (!document().baseTarget().isEmpty()) {
-            result.appendLiteral(" target=\"");
-            MarkupFormatter::appendAttributeValue(result, document().baseTarget(), document().isHTMLDocument());
-            result.append('"');
-        }
-        if (document().isXHTMLDocument())
-            result.appendLiteral(" />");
-        else
-            result.appendLiteral(">");
-    } else {
-        SerializerMarkupAccumulator::appendElement(result, element, namespaces);
-    }
-}
-
-void LinkChangeSerializerMarkupAccumulator::appendAttribute(StringBuilder& result, const Element& element, const Attribute& attribute, Namespaces* namespaces)
-{
-    if (!m_rewriteURLs.isEmpty() && element.isURLAttribute(attribute)) {
-
-        String completeURL = document().completeURL(attribute.value());
-
-        if (m_rewriteURLs.contains(completeURL)) {
-            // TODO(tiger): Refactor MarkupAccumulator so it is easier to append an attribute like this.
-            result.append(' ');
-            result.append(attribute.name().toString());
-            result.appendLiteral("=\"");
-            if (!m_rewriteFolder.isEmpty())
-                MarkupFormatter::appendAttributeValue(result, m_rewriteFolder + "/", document().isHTMLDocument());
-            MarkupFormatter::appendAttributeValue(result, m_rewriteURLs.get(completeURL), document().isHTMLDocument());
-            result.appendLiteral("\"");
-            return;
-        }
-    }
-    MarkupAccumulator::appendAttribute(result, element, attribute, namespaces);
-}
-
-
-PageSerializer::PageSerializer(Vector<SerializedResource>* resources, PassOwnPtr<Delegate> delegate)
+PageSerializer::PageSerializer(
+    Vector<SerializedResource>* resources,
+    Delegate* delegate)
     : m_resources(resources)
-    , m_blankFrameCounter(0)
     , m_delegate(delegate)
 {
 }
 
 void PageSerializer::serializeFrame(const LocalFrame& frame)
 {
     ASSERT(frame.document());
     Document& document = *frame.document();
     KURL url = document.url();
-    // FIXME: This probably wants isAboutBlankURL? to exclude other about: urls (like about:srcdoc)?
-    if (!url.isValid() || url.protocolIsAbout()) {
-        // For blank frames we generate a fake URL so they can be referenced by their containing frame.
-        url = urlForBlankFrame(frame);
-    }
-
-    if (m_resourceURLs.contains(url)) {
-        // FIXME: We could have 2 frame with the same URL but which were dynamically changed and have now
-        // different content. So we should serialize both and somehow rename the frame src in the containing
-        // frame. Arg!
-        return;
-    }
 
     // If frame is an image document, add the image and don't continue
     if (document.isImageDocument()) {
         ImageDocument& imageDocument = toImageDocument(document);
         addImageToResources(imageDocument.cachedImage(), url);
         return;
     }
 
     WillBeHeapVector<RawPtrWillBeMember<Node>> serializedNodes;
-    String text;
-    if (!m_rewriteURLs.isEmpty()) {
-        LinkChangeSerializerMarkupAccumulator accumulator(this, document, serializedNodes, m_rewriteURLs, m_rewriteFolder);
-        text = serializeNodes<EditingStrategy>(accumulator, document, IncludeNode);
-    } else {
-        SerializerMarkupAccumulator accumulator(this, document, serializedNodes);
-        text = serializeNodes<EditingStrategy>(accumulator, document, IncludeNode);
-    }
+    SerializerMarkupAccumulator accumulator(this, document, serializedNodes);
+    String text = serializeNodes<EditingStrategy>(accumulator, document, IncludeNode);
 
     CString frameHTML = document.encoding().encode(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 181 matching lines @@
         }
 
         addFontToResources(fontFaceSrcValue->fetch(&document));
     } else if (cssValue->isValueList()) {
         CSSValueList* cssValueList = toCSSValueList(cssValue);
         for (unsigned i = 0; i < cssValueList->length(); i++)
             retrieveResourcesForCSSValue(cssValueList->item(i), document);
     }
 }
 
-void PageSerializer::registerRewriteURL(const String& from, const String& to)
-{
-    m_rewriteURLs.set(from, to);
-}
-
-void PageSerializer::setRewriteURLFolder(const String& rewriteFolder)
-{
-    m_rewriteFolder = rewriteFolder;
-}
-
-KURL PageSerializer::urlForBlankFrame(const LocalFrame& frame)
-{
-    BlankFrameURLMap::iterator iter = m_blankFrameURLs.find(&frame);
-    if (iter != m_blankFrameURLs.end())
-        return iter->value;
-    String url = "wyciwyg://frame/" + String::number(m_blankFrameCounter++);
-    KURL fakeURL(ParsedURLString, url);
-    m_blankFrameURLs.add(&frame, fakeURL);
-
-    return fakeURL;
-}
-
 PageSerializer::Delegate* PageSerializer::delegate()
 {
-    return m_delegate.get();
+    return m_delegate;
 }
 
 // Returns MOTW (Mark of the Web) declaration before html tag which is in
 // HTML comment, e.g. "<!-- saved from url=(%04d)%s -->"
 // See http://msdn2.microsoft.com/en-us/library/ms537628(VS.85).aspx.
 String PageSerializer::markOfTheWebDeclaration(const KURL& url)
 {
     StringBuilder builder;
     bool emitsMinus = false;
     CString orignalUrl = url.string().ascii();
     for (const char* string = orignalUrl.data(); *string; ++string) {
         const char ch = *string;
         if (ch == '-' && emitsMinus) {
             builder.append("%2D");
             emitsMinus = false;
             continue;
         }
         emitsMinus = ch == '-';
         builder.append(ch);
     }
     CString escapedUrl = builder.toString().ascii();
     return String::format("saved from url=(%04d)%s", static_cast<int>(escapedUrl.length()), escapedUrl.data());
 }
 
 } // namespace blink