OOPIFs: Transitioning MHTML generation from view-oriented to frame-oriented.

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 15 matching lines @@
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef WebPageSerializer_h
 #define WebPageSerializer_h
 
 #include "../platform/WebCString.h"
 #include "../platform/WebCommon.h"
+#include "../platform/WebData.h"
+#include "../platform/WebString.h"
 #include "../platform/WebURL.h"
-#include "WebFrame.h"
+#include "../platform/WebVector.h"
+
+#include <utility>
 
 namespace blink {
 
 class WebPageSerializerClient;
-class WebString;
-class WebView;
+class WebFrame;
+class WebLocalFrame;
 template <typename T> class WebVector;
 
-// Get html data by serializing all frames of current page with lists
-// which contain all resource links that have local copy.
+// Serialization of frame contents into html or mhtml.
+// TODO(lukasza): Rename this class to WebFrameSerializer?
 class WebPageSerializer {
 public:
-    // Serializes the WebView contents to a MHTML representation.
-    BLINK_EXPORT static WebCString serializeToMHTML(WebView*);
+    // Generates and returns an MHTML header.
+    //
+    // Contents of the header (i.e. title and mime type) will be based
+    // on |topLevelFrame|.
+    //
+    // Same |boundary| needs to used for all generateMHTMLHeader and
+    // generateMHTMLParts and generateMHTMLFooter calls that belong to the same
+    // MHTML document (see also generateMHTMLBoundary method).
+    BLINK_EXPORT static WebData generateMHTMLHeader(
+        const WebString& boundary, WebLocalFrame* topLevelFrame);

[dcheng, 2015/12/09 08:02:37]

Omit topLevelFrame here: I mostly find it confusing to mention it here.

[Łukasz Anforowicz, 2015/12/09 17:33:57]

Done.  OTOH, I've expanded the doc comment to explain that this typically should
be the main, top-level frame.  I hope this is ok.

When editing the comment I've also realized that I didn't remove remaining
references to generateMHTMLBoundary after removing this method.  So I've done
this as well.

 
-    // Similar to serializeToMHTML but uses binary encoding for the MHTML parts.
-    // This results in a smaller MHTML file but it might not be supported by other browsers.
-    BLINK_EXPORT static WebCString serializeToMHTMLUsingBinaryEncoding(WebView*);
+    // Generates and returns MHTML parts for the given frame and all 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 generateMHTMLBoundary method).
+    //
+    // |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);
+
+    // 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 generateMHTMLBoundary method).
+    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.
     //
     // Return false means if no data has been serialized (i.e. because
@@ skipping 22 matching lines @@
     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