Generating CIDs in Blink during MHTML serialization.

third_party/WebKit/Source/core/page/PageSerializer.h

 /*
  * 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 17 matching lines @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef PageSerializer_h
 #define PageSerializer_h
 
 #include "core/CoreExport.h"
 #include "platform/heap/Handle.h"
 #include "platform/weborigin/KURL.h"
 #include "platform/weborigin/KURLHash.h"
-#include "wtf/HashMap.h"
 #include "wtf/ListHashSet.h"
 #include "wtf/PassOwnPtr.h"
 #include "wtf/Vector.h"
+#include "wtf/text/WTFString.h"
 
 namespace blink {
 
 class Attribute;
-class FontResource;
-class ImageResource;
 class CSSRule;
 class CSSStyleSheet;
 class CSSValue;
 class Document;
+class Element;
+class FontResource;
+class ImageResource;
 class LocalFrame;
 class Page;
 class LayoutObject;
 class Resource;
 class SharedBuffer;
 class StylePropertySet;
 
 struct SerializedResource;
 
 // This class is used to serialize frame's contents back to text (typically HTML).
 // It serializes frame's document and resources such as images and CSS stylesheets.
 // TODO(lukasza): Rename this class to FrameSerializer.
 class CORE_EXPORT PageSerializer final {
     STACK_ALLOCATED();
 public:
     class Delegate {
         USING_FAST_MALLOC(Delegate);
     public:
         virtual ~Delegate() { }
         virtual bool shouldIgnoreAttribute(const Attribute&) = 0;
+
+        // Method allowing the Delegate control which URLs are written into the
+        // generated html document.
+        //
+        // When URL of the element needs to be rewritten, this method should
+        // return true and populate |desiredLink| with a desired value of the

[tkent, 2015/12/02 00:59:59]

desiredLink -> rewrittenLink ?

[Łukasz Anforowicz, 2015/12/02 02:57:08]

Done.  Thanks for catching this.

+        // html attribute value to be used in place of the original link.
+        // (i.e. in place of img.src or iframe.src or object.data).
+        //
+        // If no link rewriting is desired, this method should return false.
+        virtual bool rewriteLink(const Element&, String& rewrittenLink) = 0;
     };
 
-    PageSerializer(Vector<SerializedResource>*, PassOwnPtr<Delegate>);
+    // Constructs a serializer that will write output to the given vector of
+    // SerializedResources and use the optional Delegate for controlling some
+    // serialization aspects.

[tkent, 2015/12/02 00:59:59]

nit: We should note ownership/lifetime of Delegate object.  e.g. Callsites
should own the specified Delegate object and keep it alive until PageSerializer
dies.

[Łukasz Anforowicz, 2015/12/02 02:57:08]

Done.  Good point.

+    PageSerializer(
+        Vector<SerializedResource>&,
+        Delegate*);
 
     // Initiates the serialization of the frame. All serialized content and
     // retrieved resources are added to the Vector passed to the constructor.
     // The first resource in that vector is the frame's serialized content.
     // Subsequent resources are images, css, etc.
     void serializeFrame(const LocalFrame&);
 
-    void registerRewriteURL(const String& from, const String& to);
-    void setRewriteURLFolder(const String&);
-
-    KURL urlForBlankFrame(const LocalFrame&);
-
     Delegate* delegate();
 
     static String markOfTheWebDeclaration(const KURL&);
 
 private:
     // Serializes the stylesheet back to text and adds it to the resources if URL is not-empty.
     // It also adds any resources included in that stylesheet (including any imported stylesheets and their own resources).
     void serializeCSSStyleSheet(CSSStyleSheet&, const KURL&);
 
     // Serializes the css rule (including any imported stylesheets), adding referenced resources.
     void serializeCSSRule(CSSRule*);
 
     bool shouldAddURL(const KURL&);
 
     void addToResources(Resource *, PassRefPtr<SharedBuffer>, const KURL&);
     void addImageToResources(ImageResource*, const KURL&);
     void addFontToResources(FontResource*);
 
     void retrieveResourcesForProperties(const StylePropertySet*, Document&);
     void retrieveResourcesForCSSValue(CSSValue*, Document&);
 
     Vector<SerializedResource>* m_resources;
     ListHashSet<KURL> m_resourceURLs;
 
-    using BlankFrameURLMap = WillBeHeapHashMap<RawPtrWillBeMember<const LocalFrame>, KURL>;
-    BlankFrameURLMap m_blankFrameURLs;
-    HashMap<String, String> m_rewriteURLs;
-    String m_rewriteFolder;
-    unsigned m_blankFrameCounter;
-
-    OwnPtr<Delegate> m_delegate;
+    Delegate* m_delegate;
 };
 
 } // namespace blink
 
 #endif // PageSerializer_h