1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_PRINTING_PRINT_JOB_WORKER_H_
#define CHROME_BROWSER_PRINTING_PRINT_JOB_WORKER_H_
#include <memory>
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/task/sequenced_task_runner.h"
#include "base/threading/thread.h"
#include "build/build_config.h"
#include "components/enterprise/buildflags/buildflags.h"
#include "content/public/browser/browser_thread.h"
#include "printing/mojom/print.mojom.h"
#include "printing/page_number.h"
#include "printing/printing_context.h"
namespace printing {
class PrintJob;
class PrintedDocument;
class PrintedPage;
// Worker thread code. It manages the PrintingContext, which can be blocking
// and/or run a message loop. This object calls back into the PrintJob in order
// to update the print job status. The callbacks all happen on the UI thread.
// PrintJob always outlives its worker instance.
class PrintJobWorker {
public:
PrintJobWorker(
std::unique_ptr<PrintingContext::Delegate> printing_context_delegate,
std::unique_ptr<PrintingContext> printing_context,
PrintJob* print_job);
PrintJobWorker(const PrintJobWorker&) = delete;
PrintJobWorker& operator=(const PrintJobWorker&) = delete;
virtual ~PrintJobWorker();
// Starts the printing loop. Every pages are printed as soon as the data is
// available. Makes sure the new_document is the right one.
virtual void StartPrinting(PrintedDocument* new_document);
// Updates the printed document.
void OnDocumentChanged(PrintedDocument* new_document);
// Dequeues waiting pages. Called when PrintJob receives a
// NOTIFY_PRINTED_DOCUMENT_UPDATED notification. It's time to look again if
// the next page can be printed.
void OnNewPage();
// Cancels the job.
virtual void Cancel();
#if BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
// The job is canceled due to content analysis denying printing. Called
// only from UI thread, before any platform calls are made for the job.
// Performs any extra cleanup for this particular case that can't be safely
// safely done from within Cancel().
virtual void CleanupAfterContentAnalysisDenial();
#endif
// Returns true if the thread has been started, and not yet stopped.
bool IsRunning() const;
// Posts the given task to be run.
bool PostTask(const base::Location& from_here, base::OnceClosure task);
// Signals the thread to exit in the near future.
void StopSoon();
// Signals the thread to exit and returns once the thread has exited.
void Stop();
// Starts the thread.
bool Start();
protected:
// Sanity check that it is okay to proceed with starting a print job.
bool StartPrintingSanityCheck(const PrintedDocument* new_document) const;
// Get the document name to be used when initiating printing.
std::u16string GetDocumentName(const PrintedDocument* new_document) const;
// Setup the document in preparation for printing.
bool SetupDocument(const std::u16string& document_name);
// Get the document. Only to be called from the worker thread.
PrintedDocument* document() {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
return document_.get();
}
#if BUILDFLAG(IS_WIN)
// Renders a page in the printer. Returns false if any errors occur.
// This is applicable when using the Windows GDI print API.
virtual bool SpoolPage(PrintedPage* page);
#endif
// Renders the document to the printer. Returns false if any errors occur.
virtual bool SpoolDocument();
// Internal state verification that spooling of the document is complete.
void CheckDocumentSpoolingComplete();
// Closes the job since spooling is done.
virtual void OnDocumentDone();
// Helper function for document done processing.
virtual void FinishDocumentDone(int job_id);
// Notifies the owning PrintJob that a cancel request has occurred during
// processing of the job.
virtual void OnCancel();
// Discards the current document, the current page and cancels the printing
// context.
virtual void OnFailure();
PrintingContext* printing_context() { return printing_context_.get(); }
PrintJob* print_job() { return print_job_; }
const PageNumber& page_number() { return page_number_; }
base::SequencedTaskRunner* task_runner() { return task_runner_.get(); }
private:
// Posts a task to call OnNewPage(). Used to wait for pages/document to be
// available.
void PostWaitForPage();
#if BUILDFLAG(IS_WIN)
// Windows print GDI-specific handling for OnNewPage().
bool OnNewPageHelperGdi();
#endif // BUILDFLAG(IS_WIN)
// Printing context delegate.
const std::unique_ptr<PrintingContext::Delegate> printing_context_delegate_;
// Information about the printer setting.
const std::unique_ptr<PrintingContext> printing_context_;
// The printed document. Only has read-only access.
// Only accessed from worker thread.
scoped_refptr<PrintedDocument> document_;
// The print job owning this worker thread. It is guaranteed to outlive this
// object and should be set with SetPrintJob().
raw_ptr<PrintJob> print_job_ = nullptr;
// Current page number to print.
PageNumber page_number_;
// Thread to run worker tasks.
base::Thread thread_;
// Thread-safe pointer to task runner of the `thread_`.
scoped_refptr<base::SequencedTaskRunner> task_runner_;
// Used to generate a WeakPtr for callbacks.
base::WeakPtrFactory<PrintJobWorker> weak_factory_{this};
};
} // namespace printing
#endif // CHROME_BROWSER_PRINTING_PRINT_JOB_WORKER_H_
|
