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

content/common/frame_messages.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // IPC messages for interacting with frames.
 // Multiply-included message file, hence no include guard.
 
 #include "cc/surfaces/surface_id.h"
 #include "cc/surfaces/surface_sequence.h"
 #include "content/common/content_export.h"
@@ skipping 11 matching lines @@
 #include "content/public/common/context_menu_params.h"
 #include "content/public/common/frame_navigate_params.h"
 #include "content/public/common/javascript_message_type.h"
 #include "content/public/common/message_port_types.h"
 #include "content/public/common/page_importance_signals.h"
 #include "content/public/common/page_state.h"
 #include "content/public/common/resource_response.h"
 #include "content/public/common/three_d_api_types.h"
 #include "content/public/common/transition_element.h"
 #include "ipc/ipc_message_macros.h"
+#include "ipc/ipc_platform_file.h"
 #include "third_party/WebKit/public/platform/WebFocusType.h"
 #include "third_party/WebKit/public/web/WebFrameOwnerProperties.h"
 #include "third_party/WebKit/public/web/WebTreeScopeType.h"
 #include "ui/gfx/ipc/gfx_param_traits.h"
 #include "url/gurl.h"
 #include "url/origin.h"
 
 #if defined(ENABLE_PLUGINS)
 #include "content/common/pepper_renderer_instance_data.h"
 #endif
@@ skipping 671 matching lines @@
 // Note: this covers only the immediate frame / doesn't cover subframes.
 IPC_MESSAGE_ROUTED0(FrameMsg_GetSavableResourceLinks)
 
 // Get html data by serializing the target frame and replacing all resource
 // links with a path to the local copy passed in the message payload.
 using FrameMsg_GetSerializedHtmlWithLocalLinks_Map =
     std::map<GURL, base::FilePath>;
 IPC_MESSAGE_ROUTED1(FrameMsg_GetSerializedHtmlWithLocalLinks,
                     FrameMsg_GetSerializedHtmlWithLocalLinks_Map);
 
+// Serialize target frame and its resources into MHTML and write it into the
+// provided destination file handle.
+//
+// When starting generation of a new MHTML document, one needs to start by
+// sending FrameMsg_SerializeAsMHTML for the *main* frame (main frame needs to
+// be the first part in the MHTML document + main frame will trigger generation
+// of the MHTML header).
+//
+// The same |mhtml_boundary_marker| should be used for serialization of each
+// frame (this string will be used as a mime multipart boundary within the mhtml
+// document).
+//
+// For more details about frame to content id map please see
+// WebPageSerializer::generateMHTMLParts method.
+//
+// |is_last_frame| controls whether the serializer in the renderer will
+// emit the MHTML footer.

[Randy Smith (Not in Mondays), 2015/12/10 23:07:55]

nit, suggestion/question: Why not emit the header/footer from the browser
process and keep the IPC interface simpler?

[lukasza, 2015/12/11 00:29:03]

I wasn't sure about that, but it felt better to keep all the MHTML
parsing/generation code (and test code) close together in Blink.

[ncarter (slow), 2015/12/11 17:21:42]

Also, you can't do file IO on the UI thread where the coordination code lives,
so you'd have to farm it off on the file thread or the blocking pool, and that's
more complicated than just getting the child process to do it.

[Randy Smith (Not in Mondays), 2015/12/14 02:47:04]

Acknowledged.

[Randy Smith (Not in Mondays), 2015/12/14 02:47:04]

Acknowledged.

+using FrameRoutingIdToContentIdMap = std::map<int, std::string>;
+IPC_MESSAGE_ROUTED5(FrameMsg_SerializeAsMHTML,
+                    int /* job_id (used to match responses to requests) */,
+                    IPC::PlatformFileForTransit /* destination file handle */,
+                    std::string /* mhtml boundary marker */,
+                    FrameRoutingIdToContentIdMap,
+                    bool /* is last frame */)
+
 IPC_MESSAGE_ROUTED1(FrameMsg_SetFrameOwnerProperties,
                     blink::WebFrameOwnerProperties /* frame_owner_properties */)
 
 // Request to continue running the sequential focus navigation algorithm in
 // this frame.  |source_routing_id| identifies the frame that issued this
 // request.  This message is sent when pressing <tab> or <shift-tab> needs to
 // find the next focusable element in a cross-process frame.
 IPC_MESSAGE_ROUTED2(FrameMsg_AdvanceFocus,
                     blink::WebFocusType /* type */,
                     int32_t /* source_routing_id */)
@@ skipping 504 matching lines @@
 // Response to FrameMsg_GetSavableResourceLinks in case the frame contains
 // non-savable content (i.e. from a non-savable scheme) or if there were
 // errors gathering the links.
 IPC_MESSAGE_ROUTED0(FrameHostMsg_SavableResourceLinksError)
 
 // Response to FrameMsg_GetSerializedHtmlWithLocalLinks.
 IPC_MESSAGE_ROUTED2(FrameHostMsg_SerializedHtmlWithLocalLinksResponse,
                     std::string /* data buffer */,
                     bool /* end of data? */)
 
+// Response to FrameMsg_SerializeAsMHTML.
+IPC_MESSAGE_ROUTED2(FrameHostMsg_SerializeAsMHTMLResponse,
+                    int /* job_id (used to match responses to requests) */,
+                    bool /* true if success, false if error */)
+
 // Sent when the renderer updates hint for importance of a tab.
 IPC_MESSAGE_ROUTED1(FrameHostMsg_UpdatePageImportanceSignals,
                     content::PageImportanceSignals)
 
 // This message is sent from a RenderFrameProxy when sequential focus
 // navigation needs to advance into its actual frame.  |source_routing_id|
 // identifies the frame that issued this request.  This is used when pressing
 // <tab> or <shift-tab> hits an out-of-process iframe when searching for the
 // next focusable element.
 IPC_MESSAGE_ROUTED2(FrameHostMsg_AdvanceFocus,
                     blink::WebFocusType /* type */,
                     int32_t /* source_routing_id */)
 
 #if defined(OS_MACOSX) || defined(OS_ANDROID)
 
 // Message to show/hide a popup menu using native controls.
 IPC_MESSAGE_ROUTED1(FrameHostMsg_ShowPopup,
                     FrameHostMsg_ShowPopup_Params)
 IPC_MESSAGE_ROUTED0(FrameHostMsg_HidePopup)
 
 #endif
 
 // Adding a new message? Stick to the sort order above: first platform
 // independent FrameMsg, then ifdefs for platform specific FrameMsg, then
 // platform independent FrameHostMsg, then ifdefs for platform specific
 // FrameHostMsg.