OOPIFs: Deduplicating MHTML parts across frames.

third_party/WebKit/public/web/WebPageSerializer.h

 /*
  * Copyright (C) 2009 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 45 matching lines @@
     // Contents of the header (i.e. title and mime type) will be based
     // on the frame passed as an argument (which typically should be
     // the main, top-level frame).
     //
     // Same |boundary| needs to used for all generateMHTMLHeader and
     // generateMHTMLParts and generateMHTMLFooter calls that belong to the same
     // MHTML document (see also rfc1341, section 7.2.1, "boundary" description).
     BLINK_EXPORT static WebData generateMHTMLHeader(
         const WebString& boundary, WebLocalFrame*);
 
-    // Generates and returns MHTML parts for the given frame and all the
+    // Delegate for controling the behavior of generateMHTMLParts method.
+    class MHTMLPartsGenerationDelegate {
+    public:
+        // Tells whether to skip serialization of a subresource with a given URI.
+        // Used to deduplicate resources across multiple frames.
+        virtual bool shouldSkipResource(const WebURL&) = 0;
+
+        // Returns a Content-ID to be used for the given frame.
+        // See rfc2557 - section 8.3 - "Use of the Content-ID header and CID URLs".
+        // Format note - the returned string should be of the form "<foo@bar.com>"
+        // (i.e. the strings should include the angle brackets).
+        virtual WebString getContentID(const WebFrame&) = 0;
+    };
+
+    // Generates and returns MHTML parts for the given frame and the
     // savable resources underneath.
     //
     // Same |boundary| needs to used for all generateMHTMLHeader and
     // generateMHTMLParts and generateMHTMLFooter calls that belong to the same
     // MHTML document (see also rfc1341, section 7.2.1, "boundary" description).
-    //
-    // |frameToContentID| is used for 1) emitting cid: scheme uri links for
-    // subframes and 2) emitting MIME Content-ID headers.
-    // See rfc2557 - section 8.3 - "Use of the Content-ID header and CID URLs".
-    // Format note - |frameToContentID| should contain strings of the form
-    // "<foo@bar.com>" (i.e. the strings should include the angle brackets).
     BLINK_EXPORT static WebData generateMHTMLParts(
         const WebString& boundary, WebLocalFrame*, bool useBinaryEncoding,
-        const WebVector<std::pair<WebFrame*, WebString>>& frameToContentID);
+        MHTMLPartsGenerationDelegate&);
 
     // Generates and returns an MHTML footer.
     //
     // Same |boundary| needs to used for all generateMHTMLHeader and
     // generateMHTMLParts and generateMHTMLFooter calls that belong to the same
     // MHTML document (see also rfc1341, section 7.2.1, "boundary" description).
     BLINK_EXPORT static WebData generateMHTMLFooter(const WebString& boundary);
 
     // IMPORTANT:
     // The API below is an older implementation of a pageserialization that
     // will be removed soon.
 
     // This function will serialize the specified frame to HTML data.
     // We have a data buffer to temporary saving generated html data. We will
-    // sequentially call WebPageSeriazlierClient once the data buffer is full.
+    // sequentially call WebPageSerializerClient once the data buffer is full.
     //
     // Return false means if no data has been serialized (i.e. because
     // the target frame didn't have a valid url).
     //
     // The parameter frame specifies which frame need to be serialized.
     // The parameter client specifies the pointer of interface
     // WebPageSerializerClient providing a sink interface to receive the
     // individual chunks of data to be saved.
     // The parameter urlsToLocalPaths contains a mapping between original URLs
     // of saved resources and corresponding local file paths.
     BLINK_EXPORT static bool serialize(
         WebLocalFrame*,
         WebPageSerializerClient*,
         const WebVector<std::pair<WebURL, WebString>>& urlsToLocalPaths);
 
     // FIXME: The following are here for unit testing purposes. Consider
     // changing the unit tests instead.
 
     // Generate the META for charset declaration.
     BLINK_EXPORT static WebString generateMetaCharsetDeclaration(const WebString& charset);
     // Generate the MOTW declaration.
     BLINK_EXPORT static WebString generateMarkOfTheWebDeclaration(const WebURL&);
     // Generate the default base tag declaration.
     BLINK_EXPORT static WebString generateBaseTagDeclaration(const WebString& baseTarget);
 };
 
 } // namespace blink
 
 #endif