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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
|
// Copyright (c) 2010 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 "chrome/service/cloud_print/print_system.h"
#include <windows.h>
#include <objidl.h>
#include <ocidl.h>
#include <olectl.h>
#include <prntvpt.h>
#include <winspool.h>
#include "base/lock.h"
#include "base/object_watcher.h"
#include "base/scoped_bstr_win.h"
#include "base/scoped_comptr_win.h"
#include "base/scoped_handle_win.h"
#include "base/scoped_ptr.h"
#include "base/utf_string_conversions.h"
#pragma comment(lib, "prntvpt.lib")
#pragma comment(lib, "rpcrt4.lib")
namespace {
class DevMode {
public:
DevMode() : dm_(NULL) {}
~DevMode() { Free(); }
void Allocate(int size) {
Free();
dm_ = reinterpret_cast<DEVMODE*>(new char[size]);
}
void Free() {
if (dm_)
delete dm_;
dm_ = NULL;
}
DEVMODE* dm_;
private:
DISALLOW_COPY_AND_ASSIGN(DevMode);
};
bool InitXPSModule() {
HMODULE prntvpt_module = LoadLibrary(L"prntvpt.dll");
return (NULL != prntvpt_module);
}
inline HRESULT GetLastErrorHR() {
LONG error = GetLastError();
return HRESULT_FROM_WIN32(error);
}
HRESULT StreamFromPrintTicket(const std::string& print_ticket,
IStream** stream) {
DCHECK(stream);
HRESULT hr = CreateStreamOnHGlobal(NULL, TRUE, stream);
if (FAILED(hr)) {
return hr;
}
ULONG bytes_written = 0;
(*stream)->Write(print_ticket.c_str(), print_ticket.length(), &bytes_written);
DCHECK(bytes_written == print_ticket.length());
LARGE_INTEGER pos = {0};
ULARGE_INTEGER new_pos = {0};
(*stream)->Seek(pos, STREAM_SEEK_SET, &new_pos);
return S_OK;
}
HRESULT StreamOnHGlobalToString(IStream* stream, std::string* out) {
DCHECK(stream);
DCHECK(out);
HGLOBAL hdata = NULL;
HRESULT hr = GetHGlobalFromStream(stream, &hdata);
if (SUCCEEDED(hr)) {
DCHECK(hdata);
ScopedHGlobal<char> locked_data(hdata);
out->assign(locked_data.release(), locked_data.Size());
}
return hr;
}
HRESULT PrintTicketToDevMode(const std::string& printer_name,
const std::string& print_ticket,
DevMode* dev_mode) {
DCHECK(dev_mode);
ScopedComPtr<IStream> pt_stream;
HRESULT hr = StreamFromPrintTicket(print_ticket, pt_stream.Receive());
if (FAILED(hr))
return hr;
HPTPROVIDER provider = NULL;
hr = PTOpenProvider(UTF8ToWide(printer_name).c_str(), 1, &provider);
if (SUCCEEDED(hr)) {
ULONG size = 0;
DEVMODE* dm = NULL;
hr = PTConvertPrintTicketToDevMode(provider,
pt_stream,
kUserDefaultDevmode,
kPTDocumentScope,
&size,
&dm,
NULL);
if (SUCCEEDED(hr)) {
dev_mode->Allocate(size);
memcpy(dev_mode->dm_, dm, size);
PTReleaseMemory(dm);
}
PTCloseProvider(provider);
}
return hr;
}
HRESULT PrintPdf2DC(HDC dc, const FilePath& pdf_filename) {
HRESULT hr = E_NOTIMPL;
// TODO(sanjeevr): Implement this.
NOTIMPLEMENTED();
return hr;
}
} // namespace
namespace cloud_print {
class PrintSystemWatcherWin
: public base::ObjectWatcher::Delegate {
public:
PrintSystemWatcherWin()
: printer_(NULL), printer_change_(NULL), delegate_(NULL) {
}
~PrintSystemWatcherWin() {
Stop();
}
class Delegate {
public:
virtual void OnPrinterAdded() = 0;
virtual void OnPrinterDeleted() = 0;
virtual void OnPrinterChanged() = 0;
virtual void OnJobChanged() = 0;
};
bool Start(const std::string& printer_name, Delegate* delegate) {
delegate_ = delegate;
// An empty printer name means watch the current server, we need to pass
// NULL to OpenPrinter.
LPTSTR printer_name_to_use = NULL;
std::wstring printer_name_wide;
if (!printer_name.empty()) {
printer_name_wide = UTF8ToWide(printer_name);
printer_name_to_use = const_cast<LPTSTR>(printer_name_wide.c_str());
}
bool ret = false;
OpenPrinter(printer_name_to_use, &printer_, NULL);
if (printer_) {
printer_change_ = FindFirstPrinterChangeNotification(
printer_, PRINTER_CHANGE_PRINTER|PRINTER_CHANGE_JOB, 0, NULL);
if (printer_change_) {
ret = watcher_.StartWatching(printer_change_, this);
}
}
if (!ret) {
Stop();
}
return ret;
}
bool Stop() {
watcher_.StopWatching();
if (printer_) {
ClosePrinter(printer_);
printer_ = NULL;
}
if (printer_change_) {
FindClosePrinterChangeNotification(printer_change_);
printer_change_ = NULL;
}
return true;
}
// base::ObjectWatcher::Delegate method
virtual void OnObjectSignaled(HANDLE object) {
DWORD change = 0;
FindNextPrinterChangeNotification(object, &change, NULL, NULL);
if (change != ((PRINTER_CHANGE_PRINTER|PRINTER_CHANGE_JOB) &
(~PRINTER_CHANGE_FAILED_CONNECTION_PRINTER))) {
// For printer connections, we get spurious change notifications with
// all flags set except PRINTER_CHANGE_FAILED_CONNECTION_PRINTER.
// Ignore these.
if (change & PRINTER_CHANGE_ADD_PRINTER) {
delegate_->OnPrinterAdded();
} else if (change & PRINTER_CHANGE_DELETE_PRINTER) {
delegate_->OnPrinterDeleted();
} else if (change & PRINTER_CHANGE_SET_PRINTER) {
delegate_->OnPrinterChanged();
}
if (change & PRINTER_CHANGE_JOB) {
delegate_->OnJobChanged();
}
}
watcher_.StartWatching(printer_change_, this);
}
bool GetCurrentPrinterInfo(PrinterBasicInfo* printer_info) {
DCHECK(printer_info);
if (!printer_)
return false;
DWORD bytes_needed = 0;
bool ret = false;
GetPrinter(printer_, 2, NULL, 0, &bytes_needed);
if (0 != bytes_needed) {
scoped_ptr<BYTE> printer_info_buffer(new BYTE[bytes_needed]);
if (GetPrinter(printer_, 2, printer_info_buffer.get(),
bytes_needed, &bytes_needed)) {
PRINTER_INFO_2* printer_info_win =
reinterpret_cast<PRINTER_INFO_2*>(printer_info_buffer.get());
printer_info->printer_name = WideToUTF8(printer_info_win->pPrinterName);
printer_info->printer_description =
WideToUTF8(printer_info_win->pComment);
printer_info->printer_status = printer_info_win->Status;
ret = true;
}
}
return ret;
}
private:
base::ObjectWatcher watcher_;
HANDLE printer_; // The printer being watched
HANDLE printer_change_; // Returned by FindFirstPrinterChangeNotifier
Delegate* delegate_; // Delegate to notify
bool did_signal_; // DoneWaiting was called
};
// This typedef is to workaround the issue with certain versions of
// Visual Studio where it gets confused between multiple Delegate.
// In this case, some compilers get confused and inherit
// PrintSystemWin watchers from wrong Delegate, giving C2664 and C2259 errors.
typedef PrintSystemWatcherWin::Delegate PrintSystemWatcherWinDelegate;
class PrintSystemWin : public PrintSystem {
public:
virtual void EnumeratePrinters(PrinterList* printer_list);
virtual bool GetPrinterCapsAndDefaults(const std::string& printer_name,
PrinterCapsAndDefaults* printer_info);
virtual bool ValidatePrintTicket(const std::string& printer_name,
const std::string& print_ticket_data);
virtual bool SpoolPrintJob(const std::string& print_ticket,
const FilePath& print_data_file_path,
const std::string& print_data_mime_type,
const std::string& printer_name,
const std::string& job_title,
PlatformJobId* job_id_ret);
virtual bool GetJobDetails(const std::string& printer_name,
PlatformJobId job_id,
PrintJobDetails *job_details);
virtual bool IsValidPrinter(const std::string& printer_name);
class PrintServerWatcherWin
: public PrintSystem::PrintServerWatcher,
public PrintSystemWatcherWinDelegate {
public:
PrintServerWatcherWin() {}
// PrintSystem::PrintServerWatcher interface
virtual bool StartWatching(
PrintSystem::PrintServerWatcher::Delegate* delegate) {
delegate_ = delegate;
return watcher_.Start(std::string(), this);
}
virtual bool StopWatching() {
bool ret = watcher_.Stop();
delegate_ = NULL;
return ret;
}
// PrintSystemWatcherWin::Delegate interface
virtual void OnPrinterAdded() {
delegate_->OnPrinterAdded();
}
virtual void OnPrinterDeleted() {
NOTREACHED();
}
virtual void OnPrinterChanged() {
NOTREACHED();
}
virtual void OnJobChanged() {
NOTREACHED();
}
private:
PrintSystem::PrintServerWatcher::Delegate* delegate_;
PrintSystemWatcherWin watcher_;
DISALLOW_COPY_AND_ASSIGN(PrintServerWatcherWin);
};
class PrinterWatcherWin
: public PrintSystem::PrinterWatcher,
public PrintSystemWatcherWinDelegate {
public:
explicit PrinterWatcherWin(const std::string& printer_name)
: printer_name_(printer_name) {}
// PrintSystem::PrinterWatcher interface
virtual bool StartWatching(
PrintSystem::PrinterWatcher::Delegate* delegate) {
delegate_ = delegate;
return watcher_.Start(printer_name_, this);
}
virtual bool StopWatching() {
bool ret = watcher_.Stop();
delegate_ = NULL;
return ret;
}
virtual bool GetCurrentPrinterInfo(PrinterBasicInfo* printer_info) {
return watcher_.GetCurrentPrinterInfo(printer_info);
}
// PrintSystemWatcherWin::Delegate interface
virtual void OnPrinterAdded() {
NOTREACHED();
}
virtual void OnPrinterDeleted() {
delegate_->OnPrinterDeleted();
}
virtual void OnPrinterChanged() {
delegate_->OnPrinterChanged();
}
virtual void OnJobChanged() {
delegate_->OnJobChanged();
}
private:
std::string printer_name_;
PrintSystem::PrinterWatcher::Delegate* delegate_;
PrintSystemWatcherWin watcher_;
DISALLOW_COPY_AND_ASSIGN(PrinterWatcherWin);
};
virtual PrintSystem::PrintServerWatcher* CreatePrintServerWatcher();
virtual PrintSystem::PrinterWatcher* CreatePrinterWatcher(
const std::string& printer_name);
};
void PrintSystemWin::EnumeratePrinters(PrinterList* printer_list) {
DCHECK(printer_list);
DWORD bytes_needed = 0;
DWORD count_returned = 0;
BOOL ret = EnumPrinters(PRINTER_ENUM_LOCAL|PRINTER_ENUM_CONNECTIONS, NULL, 2,
NULL, 0, &bytes_needed, &count_returned);
if (0 != bytes_needed) {
scoped_ptr<BYTE> printer_info_buffer(new BYTE[bytes_needed]);
ret = EnumPrinters(PRINTER_ENUM_LOCAL|PRINTER_ENUM_CONNECTIONS, NULL, 2,
printer_info_buffer.get(), bytes_needed, &bytes_needed,
&count_returned);
DCHECK(ret);
PRINTER_INFO_2* printer_info =
reinterpret_cast<PRINTER_INFO_2*>(printer_info_buffer.get());
for (DWORD index = 0; index < count_returned; index++) {
PrinterBasicInfo info;
info.printer_name = WideToUTF8(printer_info[index].pPrinterName);
if (printer_info[index].pComment)
info.printer_description = WideToUTF8(printer_info[index].pComment);
info.printer_status = printer_info[index].Status;
printer_list->push_back(info);
}
}
}
bool PrintSystemWin::GetPrinterCapsAndDefaults(
const std::string& printer_name,
PrinterCapsAndDefaults* printer_info) {
if (!InitXPSModule()) {
// TODO(sanjeevr): Handle legacy proxy case (with no prntvpt.dll)
return false;
}
if (!IsValidPrinter(printer_name)) {
return false;
}
DCHECK(printer_info);
HPTPROVIDER provider = NULL;
std::wstring printer_name_wide = UTF8ToWide(printer_name);
HRESULT hr = PTOpenProvider(printer_name_wide.c_str(), 1, &provider);
DCHECK(SUCCEEDED(hr));
if (provider) {
ScopedComPtr<IStream> print_capabilities_stream;
hr = CreateStreamOnHGlobal(NULL, TRUE,
print_capabilities_stream.Receive());
DCHECK(SUCCEEDED(hr));
if (print_capabilities_stream) {
ScopedBstr error;
hr = PTGetPrintCapabilities(provider, NULL, print_capabilities_stream,
error.Receive());
DCHECK(SUCCEEDED(hr));
if (FAILED(hr)) {
return false;
}
hr = StreamOnHGlobalToString(print_capabilities_stream.get(),
&printer_info->printer_capabilities);
DCHECK(SUCCEEDED(hr));
printer_info->caps_mime_type = "text/xml";
}
// TODO(sanjeevr): Add ScopedPrinterHandle
HANDLE printer_handle = NULL;
OpenPrinter(const_cast<LPTSTR>(printer_name_wide.c_str()), &printer_handle,
NULL);
DCHECK(printer_handle);
if (printer_handle) {
DWORD devmode_size = DocumentProperties(
NULL, printer_handle, const_cast<LPTSTR>(printer_name_wide.c_str()),
NULL, NULL, 0);
DCHECK(0 != devmode_size);
scoped_ptr<BYTE> devmode_out_buffer(new BYTE[devmode_size]);
DEVMODE* devmode_out =
reinterpret_cast<DEVMODE*>(devmode_out_buffer.get());
DocumentProperties(
NULL, printer_handle, const_cast<LPTSTR>(printer_name_wide.c_str()),
devmode_out, NULL, DM_OUT_BUFFER);
ScopedComPtr<IStream> printer_defaults_stream;
hr = CreateStreamOnHGlobal(NULL, TRUE,
printer_defaults_stream.Receive());
DCHECK(SUCCEEDED(hr));
if (printer_defaults_stream) {
hr = PTConvertDevModeToPrintTicket(provider, devmode_size,
devmode_out, kPTJobScope,
printer_defaults_stream);
DCHECK(SUCCEEDED(hr));
if (SUCCEEDED(hr)) {
hr = StreamOnHGlobalToString(printer_defaults_stream.get(),
&printer_info->printer_defaults);
DCHECK(SUCCEEDED(hr));
printer_info->defaults_mime_type = "text/xml";
}
}
ClosePrinter(printer_handle);
}
PTCloseProvider(provider);
}
return true;
}
bool PrintSystemWin::ValidatePrintTicket(
const std::string& printer_name,
const std::string& print_ticket_data) {
if (!InitXPSModule()) {
// TODO(sanjeevr): Handle legacy proxy case (with no prntvpt.dll)
return false;
}
bool ret = false;
HPTPROVIDER provider = NULL;
PTOpenProvider(UTF8ToWide(printer_name.c_str()).c_str(), 1, &provider);
if (provider) {
ScopedComPtr<IStream> print_ticket_stream;
CreateStreamOnHGlobal(NULL, TRUE, print_ticket_stream.Receive());
ULONG bytes_written = 0;
print_ticket_stream->Write(print_ticket_data.c_str(),
print_ticket_data.length(),
&bytes_written);
DCHECK(bytes_written == print_ticket_data.length());
LARGE_INTEGER pos = {0};
ULARGE_INTEGER new_pos = {0};
print_ticket_stream->Seek(pos, STREAM_SEEK_SET, &new_pos);
ScopedBstr error;
ScopedComPtr<IStream> result_ticket_stream;
CreateStreamOnHGlobal(NULL, TRUE, result_ticket_stream.Receive());
ret = SUCCEEDED(PTMergeAndValidatePrintTicket(provider,
print_ticket_stream.get(),
NULL,
kPTJobScope,
result_ticket_stream.get(),
error.Receive()));
PTCloseProvider(provider);
}
return ret;
}
bool PrintSystemWin::SpoolPrintJob(const std::string& print_ticket,
const FilePath& print_data_file_path,
const std::string& print_data_mime_type,
const std::string& printer_name,
const std::string& job_title,
PlatformJobId* job_id_ret) {
if (!InitXPSModule()) {
// TODO(sanjeevr): Handle legacy proxy case (with no prntvpt.dll)
return false;
}
DevMode pt_dev_mode;
HRESULT hr = PrintTicketToDevMode(printer_name, print_ticket, &pt_dev_mode);
if (FAILED(hr)) {
NOTREACHED();
return false;
}
ScopedHDC dc(CreateDC(L"WINSPOOL", UTF8ToWide(printer_name).c_str(), NULL,
pt_dev_mode.dm_));
if (!dc.Get()) {
NOTREACHED();
return false;
}
hr = E_FAIL;
DOCINFO di = {0};
di.cbSize = sizeof(DOCINFO);
std::wstring doc_name = UTF8ToWide(job_title);
di.lpszDocName = doc_name.c_str();
int job_id = StartDoc(dc.Get(), &di);
if (SP_ERROR != job_id) {
if (print_data_mime_type == "application/pdf") {
hr = PrintPdf2DC(dc.Get(), print_data_file_path);
} else {
NOTREACHED();
}
EndDoc(dc.Get());
if (SUCCEEDED(hr) && job_id_ret) {
*job_id_ret = job_id;
}
}
return SUCCEEDED(hr);
}
bool PrintSystemWin::GetJobDetails(const std::string& printer_name,
PlatformJobId job_id,
PrintJobDetails *job_details) {
DCHECK(job_details);
HANDLE printer_handle = NULL;
std::wstring printer_name_wide = UTF8ToWide(printer_name);
OpenPrinter(const_cast<LPTSTR>(printer_name_wide.c_str()), &printer_handle,
NULL);
DCHECK(printer_handle);
bool ret = false;
if (printer_handle) {
DWORD bytes_needed = 0;
GetJob(printer_handle, job_id, 1, NULL, 0, &bytes_needed);
DWORD last_error = GetLastError();
if (ERROR_INVALID_PARAMETER != last_error) {
// ERROR_INVALID_PARAMETER normally means that the job id is not valid.
DCHECK(last_error == ERROR_INSUFFICIENT_BUFFER);
scoped_ptr<BYTE> job_info_buffer(new BYTE[bytes_needed]);
if (GetJob(printer_handle, job_id, 1, job_info_buffer.get(), bytes_needed,
&bytes_needed)) {
JOB_INFO_1 *job_info =
reinterpret_cast<JOB_INFO_1 *>(job_info_buffer.get());
if (job_info->pStatus) {
WideToUTF8(job_info->pStatus, wcslen(job_info->pStatus),
&job_details->status_message);
}
job_details->platform_status_flags = job_info->Status;
if ((job_info->Status & JOB_STATUS_COMPLETE) ||
(job_info->Status & JOB_STATUS_PRINTED)) {
job_details->status = PRINT_JOB_STATUS_COMPLETED;
} else if (job_info->Status & JOB_STATUS_ERROR) {
job_details->status = PRINT_JOB_STATUS_ERROR;
} else {
job_details->status = PRINT_JOB_STATUS_IN_PROGRESS;
}
job_details->total_pages = job_info->TotalPages;
job_details->pages_printed = job_info->PagesPrinted;
ret = true;
}
}
ClosePrinter(printer_handle);
}
return ret;
}
bool PrintSystemWin::IsValidPrinter(const std::string& printer_name) {
std::wstring printer_name_wide = UTF8ToWide(printer_name);
HANDLE printer_handle = NULL;
OpenPrinter(const_cast<LPTSTR>(printer_name_wide.c_str()), &printer_handle,
NULL);
bool ret = false;
if (printer_handle) {
ret = true;
ClosePrinter(printer_handle);
}
return ret;
}
PrintSystem::PrintServerWatcher*
PrintSystemWin::CreatePrintServerWatcher() {
return new PrintServerWatcherWin();
}
PrintSystem::PrinterWatcher* PrintSystemWin::CreatePrinterWatcher(
const std::string& printer_name) {
DCHECK(!printer_name.empty());
return new PrinterWatcherWin(printer_name);
}
std::string PrintSystem::GenerateProxyId() {
GUID proxy_id = {0};
HRESULT hr = UuidCreate(&proxy_id);
DCHECK(SUCCEEDED(hr));
wchar_t* proxy_id_as_string = NULL;
UuidToString(&proxy_id, reinterpret_cast<RPC_WSTR *>(&proxy_id_as_string));
DCHECK(proxy_id_as_string);
std::string ret;
WideToUTF8(proxy_id_as_string, wcslen(proxy_id_as_string), &ret);
RpcStringFree(reinterpret_cast<RPC_WSTR *>(&proxy_id_as_string));
return ret;
}
scoped_refptr<PrintSystem> PrintSystem::CreateInstance(
const DictionaryValue* print_system_settings) {
return new PrintSystemWin;
}
} // namespace cloud_print
|