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

content/renderer/render_frame_impl.cc

 // 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.
 
 #include "content/renderer/render_frame_impl.h"
 
 #include <map>
 #include <string>
+#include <vector>
 
 #include "base/auto_reset.h"
 #include "base/command_line.h"
 #include "base/debug/alias.h"
 #include "base/debug/asan_invalid_access.h"
 #include "base/debug/dump_without_crashing.h"
+#include "base/files/file.h"
 #include "base/i18n/char_iterator.h"
+#include "base/logging.h"
 #include "base/memory/weak_ptr.h"
 #include "base/metrics/histogram.h"
 #include "base/process/process.h"
 #include "base/strings/string16.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/thread_task_runner_handle.h"
 #include "base/time/time.h"
 #include "cc/base/switches.h"
 #include "components/scheduler/renderer/renderer_scheduler.h"
 #include "content/child/appcache/appcache_dispatcher.h"
@@ skipping 101 matching lines @@
 #include "media/base/media_log.h"
 #include "media/base/media_switches.h"
 #include "media/blink/webencryptedmediaclient_impl.h"
 #include "media/blink/webmediaplayer_impl.h"
 #include "media/renderers/gpu_video_accelerator_factories.h"
 #include "mojo/common/url_type_converters.h"
 #include "net/base/data_url.h"
 #include "net/base/net_errors.h"
 #include "net/base/registry_controlled_domains/registry_controlled_domain.h"
 #include "net/http/http_util.h"
+#include "third_party/WebKit/public/platform/WebData.h"
 #include "third_party/WebKit/public/platform/WebStorageQuotaCallbacks.h"
 #include "third_party/WebKit/public/platform/WebString.h"
 #include "third_party/WebKit/public/platform/WebURL.h"
 #include "third_party/WebKit/public/platform/WebURLError.h"
 #include "third_party/WebKit/public/platform/WebURLResponse.h"
 #include "third_party/WebKit/public/platform/WebVector.h"
 #include "third_party/WebKit/public/platform/modules/webusb/WebUSBClient.h"
 #include "third_party/WebKit/public/web/WebColorSuggestion.h"
 #include "third_party/WebKit/public/web/WebDocument.h"
 #include "third_party/WebKit/public/web/WebFrameWidget.h"
@@ skipping 1096 matching lines @@
     IPC_MESSAGE_HANDLER(FrameMsg_SetFrameOwnerProperties,
                         OnSetFrameOwnerProperties)
     IPC_MESSAGE_HANDLER(FrameMsg_SetTextTrackSettings,
                         OnTextTrackSettingsChanged)
     IPC_MESSAGE_HANDLER(FrameMsg_PostMessageEvent, OnPostMessageEvent)
     IPC_MESSAGE_HANDLER(FrameMsg_FailedNavigation, OnFailedNavigation)
     IPC_MESSAGE_HANDLER(FrameMsg_GetSavableResourceLinks,
                         OnGetSavableResourceLinks)
     IPC_MESSAGE_HANDLER(FrameMsg_GetSerializedHtmlWithLocalLinks,
                         OnGetSerializedHtmlWithLocalLinks)
+    IPC_MESSAGE_HANDLER(FrameMsg_SerializeAsMHTML, OnSerializeAsMHTML)
 #if defined(OS_ANDROID)
     IPC_MESSAGE_HANDLER(FrameMsg_SelectPopupMenuItems, OnSelectPopupMenuItems)
 #elif defined(OS_MACOSX)
     IPC_MESSAGE_HANDLER(FrameMsg_SelectPopupMenuItem, OnSelectPopupMenuItem)
     IPC_MESSAGE_HANDLER(InputMsg_CopyToFindPboard, OnCopyToFindPboard)
 #endif
   IPC_END_MESSAGE_MAP()
 
   return handled;
 }
@@ skipping 3432 matching lines @@
   for (size_t i = 0; i < equivalent_local_paths.size(); i++)
     webstring_paths[i] = equivalent_local_paths[i].AsUTF16Unsafe();
 
   // Serialize the frame (without recursing into subframes).
   WebPageSerializer::serialize(GetWebFrame(),
                                this,   // WebPageSerializerClient.
                                weburl_links, webstring_paths,
                                local_directory_path.AsUTF16Unsafe());
 }
 
+void RenderFrameImpl::OnSerializeAsMHTML(
+    int job_id,
+    IPC::PlatformFileForTransit file_for_transit,
+    const std::string& std_mhtml_boundary,
+    const std::map<int, std::string>& frame_routing_id_to_content_id,
+    bool is_last_frame) {
+  // Unpack IPC payload.
+  base::File file = IPC::PlatformFileForTransitToFile(file_for_transit);
+  WebString mhtml_boundary = WebString::fromUTF8(std_mhtml_boundary);
+  std::vector<std::pair<WebFrame*, WebString>> web_frame_to_content_id;
+  for (const auto& it : frame_routing_id_to_content_id) {
+    const std::string& content_id = it.second;
+    WebFrame* web_frame = GetWebFrameFromRoutingIdForFrameOrProxy(it.first);
+    if (!web_frame)
+      continue;
+
+    web_frame_to_content_id.push_back(
+        std::make_pair(web_frame, WebString::fromUTF8(content_id)));
+  }
+
+  WebData data;
+  bool success = true;
+
+  // Generate MHTML header if needed.
+  if (success && IsMainFrame()) {

[dcheng, 2015/12/08 06:22:27]

Isn't success always true here?

[Łukasz Anforowicz, 2015/12/08 21:26:43]

Yes - it is always true.  I've written this way for symmetry between the 3
cases.  I can remove it.

+    data =
+        WebPageSerializer::generateMHTMLHeader(mhtml_boundary, GetWebFrame());
+    if (file.WriteAtCurrentPos(data.data(), data.size()) < 0) {
+      success = false;
+    }
+  }
+  DCHECK(!mhtml_boundary.isEmpty());

[dcheng, 2015/12/08 06:22:27]

Seems like this should probably go with where it's unpacked, for clarity
(otherwise, it looks like generateMHTMLHeader could mutate it). Also make it
const for good measure?

[Łukasz Anforowicz, 2015/12/08 21:26:43]

Good point.  Done.

+
+  // Generate MHTML parts.
+  if (success) {
+    data = WebPageSerializer::generateMHTMLParts(
+        mhtml_boundary, GetWebFrame(), false, web_frame_to_content_id);
+    // TODO(jcivelli): write the chunks in deferred tasks to give a chance to
+    //                 the message loop to process other events.
+    if (file.WriteAtCurrentPos(data.data(), data.size()) < 0) {
+      success = false;
+    }
+  }
+
+  // Generate MHTML footer if needed.
+  if (success && is_last_frame) {
+    data = WebPageSerializer::generateMHTMLFooter(mhtml_boundary);
+    if (file.WriteAtCurrentPos(data.data(), data.size()) < 0) {
+      success = false;
+    }
+  }
+
+  // Cleanup and notify the browser process about completion.
+  file.Close();  // Need to flush file contents before sending IPC response.
+  Send(new FrameHostMsg_SerializeAsMHTMLResponse(routing_id_, job_id, success));
+}
+
 void RenderFrameImpl::OpenURL(const GURL& url,
                               const Referrer& referrer,
                               WebNavigationPolicy policy,
                               bool should_replace_current_entry,
                               bool is_history_navigation_in_new_child) {
   FrameHostMsg_OpenURL_Params params;
   params.url = url;
   params.referrer = referrer;
   params.disposition = RenderViewImpl::NavigationPolicyToDisposition(policy);
 
@@ skipping 777 matching lines @@
       media::ConvertToSwitchOutputDeviceCB(web_callbacks);
   scoped_refptr<media::AudioOutputDevice> device =
       AudioDeviceFactory::NewOutputDevice(routing_id_, 0, sink_id.utf8(),
                                           security_origin);
   media::OutputDeviceStatus status = device->GetDeviceStatus();
   device->Stop();
   callback.Run(status);
 }
 
 }  // namespace content