printing_web.dart
12.4 KB
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
/*
* Copyright (C) 2017, David PHAM-VAN <dev.nfet.net@gmail.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import 'dart:async';
import 'dart:js_interop' as js;
import 'dart:js_interop_unsafe' as js;
import 'dart:typed_data';
import 'dart:ui';
import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';
import 'package:flutter_web_plugins/flutter_web_plugins.dart';
import 'package:pdf/pdf.dart';
import 'package:web/web.dart' as web;
import 'src/callback.dart';
import 'src/interface.dart';
import 'src/mutex.dart';
import 'src/output_type.dart';
import 'src/pdfjs.dart';
import 'src/printer.dart';
import 'src/printing_info.dart';
import 'src/raster.dart';
const _dartPdfJsVersion = 'dartPdfJsVersion';
const _dartPdfJsBaseUrl = 'dartPdfJsBaseUrl';
/// Print plugin targeting Flutter on the Web
class PrintingPlugin extends PrintingPlatform {
/// Registers this class as the default instance of [PrintingPlugin].
static void registerWith(Registrar registrar) {
PrintingPlatform.instance = PrintingPlugin();
}
static const String _scriptId = '__net_nfet_printing_s__';
static const String _frameId = '__net_nfet_printing__';
static const _pdfJsCdnPath = 'https://unpkg.com/pdfjs-dist';
static const _pdfJsVersion = '3.2.146';
final _loading = Mutex();
bool get _hasPdfJsLib => web.window
.callMethod<js.JSBoolean>(
'eval'.toJS,
'typeof pdfjsLib !== "undefined" && pdfjsLib.GlobalWorkerOptions.workerSrc != "";'
.toJS,
)
.toDart;
/// The base URL for loading pdf.js library
late String _pdfJsUrlBase;
Future<void> _initPlugin() async {
await _loading.acquire();
if (!_hasPdfJsLib) {
js.JSObject? amd;
js.JSObject? define;
js.JSObject? module;
js.JSObject? exports;
if (web.window.hasProperty('define'.toJS).toDart) {
// In dev, requireJs is loaded in. Disable it here.
define = web.window.getProperty('define'.toJS);
amd = define!.getProperty('amd'.toJS);
define.setProperty('amd'.toJS, false.toJS);
}
// Save Webpack values and make typeof module != object
if (web.window.hasProperty('exports'.toJS).toDart) {
exports = web.window.getProperty('exports'.toJS);
}
web.window.setProperty('exports'.toJS, 0.toJS);
if (web.window.hasProperty('module'.toJS).toDart) {
module = web.window.getProperty('module'.toJS);
}
web.window.setProperty('module'.toJS, 0.toJS);
// Check if the source of PDF.js library is overridden via
// [dartPdfJsBaseUrl] JavaScript variable.
if (web.window.hasProperty(_dartPdfJsBaseUrl.toJS).toDart) {
_pdfJsUrlBase = web.window.getProperty(_dartPdfJsBaseUrl.toJS);
} else {
final pdfJsVersion =
web.window.hasProperty(_dartPdfJsVersion.toJS).toDart
? web.window
.getProperty<js.JSString?>(_dartPdfJsVersion.toJS)!
.toDart
: _pdfJsVersion;
_pdfJsUrlBase = '$_pdfJsCdnPath@$pdfJsVersion/build/';
}
final script = web.HTMLScriptElement()
..type = 'text/javascript'
..async = true
..src = '${_pdfJsUrlBase}pdf.min.js';
assert(web.document.head != null);
web.document.head!.append(script);
await script.onLoad.first;
if (amd != null) {
// Re-enable requireJs
define!.setProperty('amd'.toJS, amd);
}
web.window
.getProperty<js.JSObject>('pdfjsLib'.toJS)
.getProperty<js.JSObject>('GlobalWorkerOptions'.toJS)
.setProperty(
'workerSrc'.toJS,
'${_pdfJsUrlBase}pdf.worker.min.js'.toJS,
);
// Restore module and exports
if (module != null) {
web.window.module = module;
}
if (exports != null) {
web.window.exports = exports;
}
}
_loading.release();
}
@override
Future<PrintingInfo> info() async {
await _initPlugin();
return PrintingInfo(
canPrint: true,
canShare: true,
canRaster: _hasPdfJsLib,
);
}
@override
Future<bool> layoutPdf(
Printer? printer,
LayoutCallback onLayout,
String name,
PdfPageFormat format,
bool dynamicLayout,
bool usePrinterSettings,
OutputType outputType,
bool forceCustomPrintPaper,
) async {
late Uint8List result;
try {
result = await onLayout(format);
} catch (e, s) {
InformationCollector? collector;
assert(() {
collector = () sync* {
yield StringProperty('PageFormat', format.toString());
};
return true;
}());
FlutterError.reportError(
FlutterErrorDetails(
exception: e,
stack: s,
stackFilter: (input) => input,
library: 'printing',
context: ErrorDescription('while generating a PDF'),
informationCollector: collector,
),
);
rethrow;
}
if (result.isEmpty) {
return false;
}
// UserAgent can contain both Chrome and Safari for Chrome browser.
// UserAgent contains only Safari for Safari browser.
final userAgent = web.window.navigator.userAgent;
final isChrome = userAgent.contains('Chrome');
final isSafari = userAgent.contains('Safari') && !isChrome;
final isFirefox = userAgent.contains('Firefox');
final isMobile = userAgent.contains('Mobile');
// Chrome, Safari, and Firefox on a desktop computer
if ((isChrome || isSafari || isFirefox) && !isMobile) {
final completer = Completer<bool>();
final pdfFile = web.Blob(
[result.toJS].toJS,
web.BlobPropertyBag(type: 'application/pdf'),
);
final pdfUrl = web.URL.createObjectURL(pdfFile);
final doc = web.window.document;
final script =
doc.getElementById(_scriptId) ?? doc.createElement('script');
script.setAttribute('id', _scriptId);
script.setAttribute('type', 'text/javascript');
script.innerHTML =
'''function ${_frameId}_print(){var f=document.getElementById('$_frameId');f.focus();f.contentWindow.print();}'''
.toJS;
doc.body!.append(script);
final frame = doc.getElementById(_frameId) ?? doc.createElement('iframe');
if (isFirefox) {
// Set the iframe to be is visible on the page (guaranteed by fixed position) but hidden using opacity 0, because
// this works in Firefox. The height needs to be sufficient for some part of the document other than the PDF
// viewer's toolbar to be visible in the page
frame.setAttribute(
'style',
'width: 1px; height: 100px; position: fixed; left: 0; top: 0; opacity: 0; border-width: 0; margin: 0; padding: 0',
);
} else {
// Hide the iframe in other browsers
frame.setAttribute(
'style',
'visibility: hidden; height: 0; width: 0; position: absolute;',
// 'height: 400px; width: 600px; position: absolute; z-index: 1000',
);
}
frame.setAttribute('id', _frameId);
frame.setAttribute('src', pdfUrl);
final stopWatch = Stopwatch();
web.EventListener? load;
load = (web.Event event) {
frame.removeEventListener('load', load);
Timer(Duration(milliseconds: isSafari ? 500 : 0), () {
try {
stopWatch.start();
web.window.callMethod('${_frameId}_print'.toJS);
stopWatch.stop();
completer.complete(true);
} catch (e) {
assert(() {
// ignore: avoid_print
print('Error: $e');
return true;
}());
completer.complete(_getPdf(result));
}
});
}.toJS;
frame.addEventListener('load', load);
doc.body!.append(frame);
final res = await completer.future;
// If print() is synchronous
if (stopWatch.elapsedMilliseconds > 1000) {
frame.remove();
script.remove();
}
return res;
}
return _getPdf(result);
}
@override
Future<bool> sharePdf(
Uint8List bytes,
String filename,
Rect bounds,
String? subject,
String? body,
List<String>? emails,
) async {
return _getPdf(bytes, filename: filename);
}
Future<bool> _getPdf(Uint8List bytes, {String? filename}) async {
final pdfFile = web.Blob(
[bytes.toJS].toJS,
web.BlobPropertyBag(type: 'application/pdf'),
);
final pdfUrl = web.URL.createObjectURL(pdfFile);
final doc = web.window.document;
final link = web.HTMLAnchorElement()..href = pdfUrl;
if (filename != null) {
link.download = filename;
} else {
link.target = '_blank';
}
doc.body?.append(link);
link.click();
link.remove();
return true;
}
@override
Future<Uint8List> convertHtml(
String html,
String? baseUrl,
PdfPageFormat format,
) {
throw UnimplementedError();
}
@override
Future<List<Printer>> listPrinters() {
throw UnimplementedError();
}
@override
Future<Printer> pickPrinter(
Rect bounds,
) {
throw UnimplementedError();
}
@override
Stream<PdfRaster> raster(
Uint8List document,
List<int>? pages,
double dpi,
) async* {
await _initPlugin();
final settings = Settings()..data = document.toJS;
if (!_hasPdfJsLib) {
settings
..cMapUrl = '$_pdfJsUrlBase/cmaps/'
..cMapPacked = true;
}
final jsDoc = getDocument(settings);
try {
final doc = await jsDoc.promise.toDart;
final numPages = doc.numPages;
final canvas =
web.window.document.createElement('canvas') as web.HTMLCanvasElement;
final context = canvas.getContext('2d')! as web.CanvasRenderingContext2D;
final computedPages =
pages ?? Iterable<int>.generate(numPages, (index) => index);
for (final pageIndex in computedPages) {
final page = await doc.getPage(pageIndex + 1).toDart;
try {
final viewport =
page.getViewport(Settings()..scale = dpi / PdfPageFormat.inch);
canvas.height = viewport.height.toInt();
canvas.width = viewport.width.toInt();
final renderContext = Settings()
..canvasContext = context
..viewport = viewport;
await page.render(renderContext).promise.toDart;
// Convert the image to PNG
final completer = Completer<void>();
final blobCompleter = Completer<web.Blob?>();
canvas.toBlob(
// ignore: unnecessary_lambdas
(web.Blob? blob) {
blobCompleter.complete(blob);
}.toJS,
);
final blob = await blobCompleter.future;
if (blob == null) {
continue;
}
final data = BytesBuilder();
final r = web.FileReader();
r.readAsArrayBuffer(blob);
r.onLoadEnd.listen(
(web.ProgressEvent e) {
data.add((r.result! as js.JSArrayBuffer).toDart.asInt8List());
completer.complete();
},
);
await completer.future;
yield _WebPdfRaster(
canvas.width,
canvas.height,
data.toBytes(),
);
} finally {
page.cleanup();
}
}
} finally {
jsDoc.destroy();
}
}
}
class _WebPdfRaster extends PdfRaster {
_WebPdfRaster(
int width,
int height,
this.png,
) : super(width, height, Uint8List(0));
final Uint8List png;
Uint8List? _pixels;
@override
Uint8List get pixels {
_pixels ??= PdfRasterBase.fromPng(png).pixels;
return _pixels!;
}
@override
Future<Image> toImage() async {
final codec = await instantiateImageCodec(png);
final frameInfo = await codec.getNextFrame();
return frameInfo.image;
}
@override
Future<Uint8List> toPng() async {
return png;
}
}
extension _WindowModule on web.Window {
external set module(js.JSObject? value);
external set exports(js.JSObject? value);
}