Make printing work better with OOPIF.

components/printing/renderer/print_web_view_helper.h

 // 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.
 
 #ifndef COMPONENTS_PRINTING_RENDERER_PRINT_WEB_VIEW_HELPER_H_
 #define COMPONENTS_PRINTING_RENDERER_PRINT_WEB_VIEW_HELPER_H_
 
 #include <memory>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/shared_memory.h"
 #include "base/memory/weak_ptr.h"
 #include "base/time/time.h"
 #include "build/build_config.h"
-#include "content/public/renderer/render_view_observer.h"
-#include "content/public/renderer/render_view_observer_tracker.h"
+#include "content/public/renderer/render_frame_observer.h"
+#include "content/public/renderer/render_frame_observer_tracker.h"
 #include "printing/pdf_metafile_skia.h"
 #include "third_party/WebKit/public/platform/WebCanvas.h"
 #include "third_party/WebKit/public/web/WebNode.h"
 #include "third_party/WebKit/public/web/WebPrintParams.h"
 #include "ui/gfx/geometry/size.h"
 
 struct PrintMsg_Print_Params;
 struct PrintMsg_PrintPage_Params;
 struct PrintMsg_PrintPages_Params;
 struct PrintHostMsg_SetOptionsFromDocument_Params;
@@ skipping 40 matching lines @@
 
  private:
   blink::WebView* view_;
   blink::WebLocalFrame* frame_;
 };
 
 // PrintWebViewHelper handles most of the printing grunt work for RenderView.
 // We plan on making print asynchronous and that will require copying the DOM
 // of the document and creating a new WebView with the contents.
 class PrintWebViewHelper
-    : public content::RenderViewObserver,
-      public content::RenderViewObserverTracker<PrintWebViewHelper> {
+    : public content::RenderFrameObserver,
+      public content::RenderFrameObserverTracker<PrintWebViewHelper> {
  public:
   class Delegate {
    public:
     virtual ~Delegate() {}
 
     // Cancels prerender if it's currently in progress and returns |true| if
     // the cancellation was done with success.
-    virtual bool CancelPrerender(content::RenderView* render_view,
+    virtual bool CancelPrerender(content::RenderFrame* render_frame,
                                  int routing_id) = 0;
 
     // Returns the element to be printed. Returns a null WebElement if
     // a pdf plugin element can't be extracted from the frame.
     virtual blink::WebElement GetPdfElement(blink::WebLocalFrame* frame) = 0;
 
     virtual bool IsPrintPreviewEnabled() = 0;
 
     // If true, the user can be asked to provide print settings.
     // The default implementation returns |true|.
     virtual bool IsAskPrintSettingsEnabled();
 
     // If false, window.print() won't do anything.
     // The default implementation returns |true|.
     virtual bool IsScriptedPrintEnabled();
 
     // Returns true if printing is overridden and the default behavior should be
     // skipped for |frame|.
     virtual bool OverridePrint(blink::WebLocalFrame* frame) = 0;
   };
 
-  PrintWebViewHelper(content::RenderView* render_view,
+  PrintWebViewHelper(content::RenderFrame* render_frame,
                      std::unique_ptr<Delegate> delegate);
   ~PrintWebViewHelper() override;
 
   // Disable print preview and switch to system dialog printing even if full
   // printing is build-in. This method is used by CEF.
   static void DisablePreview();
 
-  bool IsPrintingEnabled();
+  bool IsPrintingEnabled() const;
 
   void PrintNode(const blink::WebNode& node);
 
  private:
   friend class PrintWebViewHelperTestBase;
   FRIEND_TEST_ALL_PREFIXES(MAYBE_PrintWebViewHelperPreviewTest,
                            BlockScriptInitiatedPrinting);
   FRIEND_TEST_ALL_PREFIXES(MAYBE_PrintWebViewHelperTest, OnPrintPages);
   FRIEND_TEST_ALL_PREFIXES(MAYBE_PrintWebViewHelperTest,
                            BlockScriptInitiatedPrinting);
@@ skipping 25 matching lines @@
     PREVIEW_ERROR_LAST_ENUM  // Always last.
   };
 
   enum PrintPreviewRequestType {
     PRINT_PREVIEW_USER_INITIATED_ENTIRE_FRAME,
     PRINT_PREVIEW_USER_INITIATED_SELECTION,
     PRINT_PREVIEW_USER_INITIATED_CONTEXT_NODE,
     PRINT_PREVIEW_SCRIPTED  // triggered by window.print().
   };
 
-  // RenderViewObserver implementation.
+  // RenderFrameObserver implementation.
   bool OnMessageReceived(const IPC::Message& message) override;
-  void PrintPage(blink::WebLocalFrame* frame, bool user_initiated) override;
+  void ScriptedPrint(bool user_initiated) override;
   void DidStartLoading() override;
   void DidStopLoading() override;
   void OnDestruct() override;
 
   // Message handlers ---------------------------------------------------------
 #if defined(ENABLE_BASIC_PRINTING)
   void OnPrintPages();
   void OnPrintForSystemDialog();
   void OnPrintForPrintPreview(const base::DictionaryValue& job_settings);
 #endif  // defined(ENABLE_BASIC_PRINTING)
 #if defined(ENABLE_PRINT_PREVIEW)
-  void OnInitiatePrintPreview(bool selection_only);
+  void OnInitiatePrintPreview(bool has_selection);
   void OnPrintPreview(const base::DictionaryValue& settings);
 #endif  // defined(ENABLE_PRINT_PREVIEW)
   void OnPrintingDone(bool success);
 
   // Get |page_size| and |content_area| information from
   // |page_layout_in_points|.
   void GetPageSizeAndContentAreaFromPageLayout(
       const PageSizeMargins& page_layout_in_points,
       gfx::Size* page_size,
       gfx::Rect* content_area);
@@ skipping 13 matching lines @@
 
   // Renders a print preview page. |page_number| is 0-based.
   // Returns true if print preview should continue, false on failure.
   bool RenderPreviewPage(int page_number,
                          const PrintMsg_Print_Params& print_params);
 
   // Finalize the print ready preview document.
   bool FinalizePrintReadyDocument();
 #endif  // defined(ENABLE_PRINT_PREVIEW)
 
-  // Enable/Disable window.print calls.  If |blocked| is true window.print
-  // calls will silently fail.  Call with |blocked| set to false to reenable.
-  void SetScriptedPrintBlocked(bool blocked);
+  // Enable/Disable printing.
+  void SetPrintingEnabled(bool enabled);
 
   // Main printing code -------------------------------------------------------
 
 #if defined(ENABLE_BASIC_PRINTING)
   // |is_scripted| should be true when the call is coming from window.print()
   void Print(blink::WebLocalFrame* frame,
              const blink::WebNode& node,
              bool is_scripted);
 #endif  // defined(ENABLE_BASIC_PRINTING)
 
@@ skipping 102 matching lines @@
   // and footers using strings from |header_footer_info| on to the canvas.
   static void PrintHeaderAndFooter(blink::WebCanvas* canvas,
                                    int page_number,
                                    int total_pages,
                                    const blink::WebFrame& source_frame,
                                    float webkit_scale_factor,
                                    const PageSizeMargins& page_layout_in_points,
                                    const PrintMsg_Print_Params& params);
 #endif  // defined(ENABLE_PRINT_PREVIEW)
 
-  bool GetPrintFrame(blink::WebLocalFrame** frame);
-
   // Script Initiated Printing ------------------------------------------------
 
   // Return true if script initiated printing is currently
   // allowed. |user_initiated| should be true when a user event triggered the
   // script, most likely by pressing a print button on the page.
   bool IsScriptInitiatedPrintAllowed(blink::WebFrame* frame,
                                      bool user_initiated);
 
 #if defined(ENABLE_PRINT_PREVIEW)
   // Shows scripted print preview when options from plugin are available.
@@ skipping 16 matching lines @@
   void SetPrintPagesParams(const PrintMsg_PrintPages_Params& settings);
 
   // WebView used only to print the selection.
   std::unique_ptr<PrepareFrameAndViewForPrint> prep_frame_view_;
   bool reset_prep_frame_view_;
 
   std::unique_ptr<PrintMsg_PrintPages_Params> print_pages_params_;
   bool is_print_ready_metafile_sent_;
   bool ignore_css_margins_;
 
-  // Used for scripted initiated printing blocking.
-  bool is_scripted_printing_blocked_;
+  bool is_printing_enabled_;
 
   // Let the browser process know of a printing failure. Only set to false when
   // the failure came from the browser in the first place.
   bool notify_browser_of_print_failure_;
 
   // True, when printing from print preview.
   bool print_for_preview_;
 
   // Used to check the prerendering status.
   const std::unique_ptr<Delegate> delegate_;
@@ skipping 138 matching lines @@
   base::Closure on_stop_loading_closure_;
 
   base::WeakPtrFactory<PrintWebViewHelper> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(PrintWebViewHelper);
 };
 
 }  // namespace printing
 
 #endif  // COMPONENTS_PRINTING_RENDERER_PRINT_WEB_VIEW_HELPER_H_