OOPIFs: Deduplicating MHTML parts across frames.

content/browser/download/mhtml_generation_manager.cc

 // Copyright (c) 2012 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/browser/download/mhtml_generation_manager.h"
 
 #include <map>
 #include <queue>
 #include <sstream>
 
 #include "base/bind.h"
 #include "base/files/file.h"
 #include "base/guid.h"
 #include "base/scoped_observer.h"
 #include "base/stl_util.h"
 #include "content/browser/frame_host/frame_tree_node.h"
 #include "content/common/frame_messages.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_process_host_observer.h"
 #include "content/public/browser/web_contents.h"
+#include "crypto/sha2.h"
+#include "url/gurl.h"
 
 namespace content {
 
 // The class and all of its members live on the UI thread.  Only static methods
 // are executed on other threads.
 class MHTMLGenerationManager::Job : public RenderProcessHostObserver {
  public:
   Job(int job_id, WebContents* web_contents, GenerateMHTMLCallback callback);
   ~Job() override;
 
   void set_browser_file(base::File file) { browser_file_ = file.Pass(); }
 
   GenerateMHTMLCallback callback() const { return callback_; }
 
-  // Sends IPC to the renderer, asking for MHTML generation of the next frame.
-  //
-  // Returns true if the message was sent successfully; false otherwise.
-  //
-  // See FrameMsg_SerializeAsMHTML IPC message for description of
-  // |mhtml_boundary_marker| parameter.
-  bool SendToNextRenderFrame(const std::string& mhtml_boundary_marker);
+  // Sends IPC to the renderer of the first frame, asking it to start
+  // MHTML serialization.
+  // Returns |true| upon success; |false| otherwise.
+  bool SendToFirstFrame();
 
-  // Indicates if more calls to SendToNextRenderFrame are needed.
+  // Handler for ViewHostMsg_SavedPageAsMHTML (a notification from the renderer
+  // that the MHTML generation for previous frame has finished).
+  // Returns |true| upon success; |false| otherwise.
+  bool OnSavedPageAsMHTML(std::string mhtml_boundary_marker,
+                          const std::set<GURL>& uris_of_generated_mhtml_parts);
+
+  // Indicates if the job has completed.
   bool GotMoreFramesToProcess() {
     return !pending_frame_tree_node_ids_.empty();
   }
 
   // Close the file on the file thread and respond back on the UI thread with
   // file size.
   void CloseFile(base::Callback<void(int64 file_size)> callback);
 
   // RenderProcessHostObserver:
   void RenderProcessExited(RenderProcessHost* host,
                            base::TerminationStatus status,
                            int exit_code) override;
   void RenderProcessHostDestroyed(RenderProcessHost* host) override;
 
  private:
   static int64 CloseFileOnFileThread(base::File file);
   void AddFrame(RenderFrameHost* render_frame_host);
 
   // Translates |frame_tree_node_to_content_id_| into
   // a |site_instance|-specific, routing-id-based map.
   std::map<int, std::string> CreateFrameRoutingIdToContentId(
       SiteInstance* site_instance);
 
+  // Sends IPC to the renderer, asking for MHTML generation of the next frame.
+  //
+  // Returns true if the message was sent successfully; false otherwise.
+  //
+  // See FrameMsg_SerializeAsMHTML IPC message for description of
+  // |mhtml_boundary_marker| parameter.
+  bool SendToNextRenderFrame(const std::string& mhtml_boundary_marker);
+
   // Id used to map renderer responses to jobs.
   // See also MHTMLGenerationManager::id_to_job_ map.
   int job_id_;
 
   // The handle to the file the MHTML is saved to for the browser process.
   base::File browser_file_;
 
   // The IDs of frames we still need to process.
   std::queue<int> pending_frame_tree_node_ids_;
 
   // Map from frames into content ids (see WebPageSerializer::generateMHTMLParts
   // for more details about what "content ids" are and how they are used).
   std::map<int, std::string> frame_tree_node_to_content_id_;
 
+  // URIs of already generated MHTML parts.
+  std::set<GURL> already_serialized_uris_;
+
   // The callback to call once generation is complete.
   GenerateMHTMLCallback callback_;
 
   // RAII helper for registering this Job as a RenderProcessHost observer.
   ScopedObserver<RenderProcessHost, MHTMLGenerationManager::Job>
       observed_renderer_process_host_;
 
   DISALLOW_COPY_AND_ASSIGN(Job);
 };
 
@@ skipping 38 matching lines @@
     result[routing_id] = content_id;
   }
   return result;
 }
 
 bool MHTMLGenerationManager::Job::SendToNextRenderFrame(
     const std::string& mhtml_boundary_marker) {
   DCHECK(browser_file_.IsValid());
   DCHECK_LT(0u, pending_frame_tree_node_ids_.size());
 
+  FrameMsg_SerializeAsMHTML_Params ipc_params;
+  ipc_params.job_id = job_id_;
+  ipc_params.mhtml_boundary_marker = mhtml_boundary_marker;
+
   int frame_tree_node_id = pending_frame_tree_node_ids_.front();
   pending_frame_tree_node_ids_.pop();
-  bool is_last_frame = pending_frame_tree_node_ids_.empty();
+  ipc_params.is_last_frame = pending_frame_tree_node_ids_.empty();
 
   FrameTreeNode* ftn = FrameTreeNode::GloballyFindByID(frame_tree_node_id);
   if (!ftn)  // The contents went away.
     return false;
   RenderFrameHost* rfh = ftn->current_frame_host();
 
   // Get notified if the target of the IPC message dies between responding.
   observed_renderer_process_host_.RemoveAll();
   observed_renderer_process_host_.Add(rfh->GetProcess());
 
-  IPC::PlatformFileForTransit renderer_file = IPC::GetFileHandleForProcess(
+  // Tell the renderer to skip (= deduplicate) already covered MHTML parts.
+  std::set<std::string> digests_of_uris_to_skip;

[ncarter (slow), 2015/12/04 21:52:39]

This is unused.

[Łukasz Anforowicz, 2015/12/04 22:55:43]

Thanks for catching this.  I must have missed this when converting things to use
FrameMsg_SerializeAsMHTML_Params.  Removed.

+  ipc_params.salt = base::GenerateGUID();
+  for (const GURL& uri : already_serialized_uris_) {
+    std::string digest = crypto::SHA256HashString(ipc_params.salt + uri.spec());
+    ipc_params.digests_of_uris_to_skip.insert(digest);
+  }
+
+  ipc_params.destination_file = IPC::GetFileHandleForProcess(
       browser_file_.GetPlatformFile(), rfh->GetProcess()->GetHandle(),
       false);  // |close_source_handle|.
-  rfh->Send(new FrameMsg_SerializeAsMHTML(
-      rfh->GetRoutingID(), job_id_, renderer_file, mhtml_boundary_marker,
-      CreateFrameRoutingIdToContentId(rfh->GetSiteInstance()), is_last_frame));
+  ipc_params.frame_routing_id_to_content_id =
+      CreateFrameRoutingIdToContentId(rfh->GetSiteInstance());
+  rfh->Send(new FrameMsg_SerializeAsMHTML(rfh->GetRoutingID(), ipc_params));
   return true;
 }
 
 void MHTMLGenerationManager::Job::RenderProcessExited(
     RenderProcessHost* host,
     base::TerminationStatus status,
     int exit_code) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   MHTMLGenerationManager::GetInstance()->RenderProcessExited(this);
 }
@@ skipping 25 matching lines @@
     return;
   }
 
   BrowserThread::PostTaskAndReplyWithResult(
       BrowserThread::FILE, FROM_HERE,
       base::Bind(&MHTMLGenerationManager::Job::CloseFileOnFileThread,
                  base::Passed(browser_file_.Pass())),
       callback);
 }
 
+bool MHTMLGenerationManager::Job::SendToFirstFrame() {
+  // We don't yet have an mhtml boundary marker when serializing the 1st frame.
+  std::string initial_mhtml_boundary_marker = "";
+
+  return SendToNextRenderFrame(initial_mhtml_boundary_marker);
+}
+
+bool MHTMLGenerationManager::Job::OnSavedPageAsMHTML(
+    std::string mhtml_boundary_marker,
+    const std::set<GURL>& uris_of_generated_mhtml_parts) {
+  bool success = true;
+
+  already_serialized_uris_.insert(uris_of_generated_mhtml_parts.begin(),
+                                  uris_of_generated_mhtml_parts.end());
+
+  if (GotMoreFramesToProcess())
+    success = SendToNextRenderFrame(mhtml_boundary_marker);
+
+  return success;
+}
+
 // static
 int64 MHTMLGenerationManager::Job::CloseFileOnFileThread(base::File file) {
   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
   DCHECK(file.IsValid());
   int64 file_size = file.GetLength();
   file.Close();
   return file_size;
 }
 
 MHTMLGenerationManager* MHTMLGenerationManager::GetInstance() {
@@ skipping 17 matching lines @@
       BrowserThread::FILE, FROM_HERE,
       base::Bind(&MHTMLGenerationManager::CreateFile, file_path),
       base::Bind(&MHTMLGenerationManager::OnFileAvailable,
                  base::Unretained(this),  // Safe b/c |this| is a singleton.
                  job_id));
 }
 
 void MHTMLGenerationManager::OnSavedPageAsMHTML(
     int job_id,
     bool mhtml_generation_in_renderer_succeeded,
-    const std::string& mhtml_boundary_marker) {
+    const std::string& mhtml_boundary_marker,
+    const std::set<GURL>& uris_of_generated_mhtml_parts) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
   if (!mhtml_generation_in_renderer_succeeded) {
     JobFinished(job_id, JobStatus::FAILURE);
     return;
   }
 
   Job* job = FindJob(job_id);
   if (!job)
     return;
 
-  if (job->GotMoreFramesToProcess()) {
-    if (!job->SendToNextRenderFrame(mhtml_boundary_marker)) {
-      JobFinished(job_id, JobStatus::FAILURE);
-    }
+  if (!job->GotMoreFramesToProcess()) {
+    JobFinished(job_id, JobStatus::SUCCESS);
     return;
   }
 
-  JobFinished(job_id, JobStatus::SUCCESS);
+  if (!job->OnSavedPageAsMHTML(mhtml_boundary_marker,
+                               uris_of_generated_mhtml_parts)) {
+    JobFinished(job_id, JobStatus::FAILURE);
+  }
 }
 
 // static
 base::File MHTMLGenerationManager::CreateFile(const base::FilePath& file_path) {
   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
 
   // SECURITY NOTE: A file descriptor to the file created below will be passed
   // to multiple renderer processes which (in out-of-process iframes mode) can
   // act on behalf of separate web principals.  Therefore it is important to
   // only allow writing to the file and forbid reading from the file (as this
@@ skipping 18 matching lines @@
     JobFinished(job_id, JobStatus::FAILURE);
     return;
   }
 
   Job* job = FindJob(job_id);
   if (!job)
     return;
 
   job->set_browser_file(browser_file.Pass());
 
-  // We don't yet have an mhtml boundary marker when serializing the 1st frame.
-  std::string initial_mhtml_boundary_marker = "";
-  if (!job->SendToNextRenderFrame(initial_mhtml_boundary_marker)) {
+  if (!job->SendToFirstFrame()) {
     JobFinished(job_id, JobStatus::FAILURE);
   }
 }
 
 void MHTMLGenerationManager::JobFinished(int job_id, JobStatus job_status) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
   Job* job = FindJob(job_id);
   if (!job)
     return;
@@ skipping 46 matching lines @@
        ++it) {
     if (it->second == job) {
       JobFinished(it->first, JobStatus::FAILURE);
       return;
     }
   }
   NOTREACHED();
 }
 
 }  // namespace content