1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef CHROME_BROWSER_PRINTING_PRINT_VIEW_MANAGER_BASE_H_
6 #define CHROME_BROWSER_PRINTING_PRINT_VIEW_MANAGER_BASE_H_
8 #include "base/memory/ref_counted.h"
9 #include "base/prefs/pref_member.h"
10 #include "base/strings/string16.h"
11 #include "content/public/browser/notification_observer.h"
12 #include "content/public/browser/notification_registrar.h"
13 #include "content/public/browser/web_contents_observer.h"
14 #include "content/public/browser/web_contents_user_data.h"
15 #include "printing/printed_pages_source.h"
17 struct PrintHostMsg_DidPrintPage_Params
;
25 class JobEventDetails
;
27 class PrintJobWorkerOwner
;
28 class PrintQueriesQueue
;
30 // Base class for managing the print commands for a WebContents.
31 class PrintViewManagerBase
: public content::NotificationObserver
,
32 public PrintedPagesSource
,
33 public content::WebContentsObserver
{
35 virtual ~PrintViewManagerBase();
37 // Prints the current document immediately. Since the rendering is
38 // asynchronous, the actual printing will not be completed on the return of
39 // this function. Returns false if printing is impossible at the moment.
40 virtual bool PrintNow();
42 // Whether to block scripted printing for our tab or not.
43 void UpdateScriptedPrintingBlocked();
45 // PrintedPagesSource implementation.
46 virtual base::string16
RenderSourceName() OVERRIDE
;
49 explicit PrintViewManagerBase(content::WebContents
* web_contents
);
51 // Helper method for Print*Now().
52 bool PrintNowInternal(IPC::Message
* message
);
54 // Terminates or cancels the print job if one was pending.
55 virtual void RenderProcessGone(base::TerminationStatus status
) OVERRIDE
;
57 // content::WebContentsObserver implementation.
58 virtual bool OnMessageReceived(const IPC::Message
& message
) OVERRIDE
;
60 // IPC Message handlers.
61 virtual void OnPrintingFailed(int cookie
);
64 // content::NotificationObserver implementation.
65 virtual void Observe(int type
,
66 const content::NotificationSource
& source
,
67 const content::NotificationDetails
& details
) OVERRIDE
;
69 // content::WebContentsObserver implementation.
70 virtual void DidStartLoading(
71 content::RenderViewHost
* render_view_host
) OVERRIDE
;
73 // Cancels the print job.
74 virtual void NavigationStopped() OVERRIDE
;
76 // IPC Message handlers.
77 void OnDidGetPrintedPagesCount(int cookie
, int number_pages
);
78 void OnDidGetDocumentCookie(int cookie
);
79 void OnDidPrintPage(const PrintHostMsg_DidPrintPage_Params
& params
);
80 void OnShowInvalidPrinterSettingsError();
82 // Processes a NOTIFY_PRINT_JOB_EVENT notification.
83 void OnNotifyPrintJobEvent(const JobEventDetails
& event_details
);
85 // Requests the RenderView to render all the missing pages for the print job.
86 // No-op if no print job is pending. Returns true if at least one page has
87 // been requested to the renderer.
88 bool RenderAllMissingPagesNow();
90 // Quits the current message loop if these conditions hold true: a document is
91 // loaded and is complete and waiting_for_pages_to_be_rendered_ is true. This
92 // function is called in DidPrintPage() or on ALL_PAGES_REQUESTED
93 // notification. The inner message loop is created was created by
94 // RenderAllMissingPagesNow().
95 void ShouldQuitFromInnerMessageLoop();
97 // Creates a new empty print job. It has no settings loaded. If there is
98 // currently a print job, safely disconnect from it. Returns false if it is
99 // impossible to safely disconnect from the current print job or it is
100 // impossible to create a new print job.
101 bool CreateNewPrintJob(PrintJobWorkerOwner
* job
);
103 // Makes sure the current print_job_ has all its data before continuing, and
104 // disconnect from it.
105 void DisconnectFromCurrentPrintJob();
107 // Notify that the printing is done.
108 void PrintingDone(bool success
);
110 // Terminates the print job. No-op if no print job has been created. If
111 // |cancel| is true, cancel it instead of waiting for the job to finish. Will
112 // call ReleasePrintJob().
113 void TerminatePrintJob(bool cancel
);
115 // Releases print_job_. Correctly deregisters from notifications. No-op if
116 // no print job has been created.
117 void ReleasePrintJob();
119 // Runs an inner message loop. It will set inside_inner_message_loop_ to true
120 // while the blocking inner message loop is running. This is useful in cases
121 // where the RenderView is about to be destroyed while a printing job isn't
123 bool RunInnerMessageLoop();
125 // In the case of Scripted Printing, where the renderer is controlling the
126 // control flow, print_job_ is initialized whenever possible. No-op is
127 // print_job_ is initialized.
128 bool OpportunisticallyCreatePrintJob(int cookie
);
130 // Release the PrinterQuery associated with our |cookie_|.
131 void ReleasePrinterQuery();
133 content::NotificationRegistrar registrar_
;
135 // Manages the low-level talk to the printer.
136 scoped_refptr
<PrintJob
> print_job_
;
138 // Number of pages to print in the print job.
141 // Indication of success of the print job.
142 bool printing_succeeded_
;
144 // Running an inner message loop inside RenderAllMissingPagesNow(). This means
145 // we are _blocking_ until all the necessary pages have been rendered or the
146 // print settings are being loaded.
147 bool inside_inner_message_loop_
;
149 #if defined(OS_POSIX) && !defined(OS_MACOSX)
150 // Set to true when OnDidPrintPage() should be expecting the first page.
151 bool expecting_first_page_
;
154 // The document cookie of the current PrinterQuery.
157 // Whether printing is enabled.
158 BooleanPrefMember printing_enabled_
;
160 scoped_refptr
<printing::PrintQueriesQueue
> queue_
;
162 DISALLOW_COPY_AND_ASSIGN(PrintViewManagerBase
);
165 } // namespace printing
167 #endif // CHROME_BROWSER_PRINTING_PRINT_VIEW_MANAGER_BASE_H_