/
qz-tray.js
1645 lines (1463 loc) · 74.1 KB
/
qz-tray.js
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
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
'use strict';
/**
* @version 2.0.12;
* @overview QZ Tray Connector
* <p/>
* Connects a web client to the QZ Tray software.
* Enables printing and device communication from javascript.
*
* @requires RSVP
* Provides Promises/A+ functionality for API calls.
* Can be overridden via <code>qz.api.setPromiseType</code> to remove dependency.
* @requires Sha256
* Provides hashing algorithm for signing messages.
* Can be overridden via <code>qz.api.setSha256Type</code> to remove dependency.
*/
var qz = (function() {
///// POLYFILLS /////
if (!Array.isArray) {
Array.isArray = function(arg) {
return Object.prototype.toString.call(arg) === '[object Array]';
};
}
///// PRIVATE METHODS /////
var _qz = {
VERSION: "2.0.12", //must match @version above
DEBUG: false,
log: {
/** Debugging messages */
trace: function() { if (_qz.DEBUG) { console.log.apply(console, arguments); } },
/** General messages */
info: function() { console.info.apply(console, arguments); },
/** Debugging errors */
warn: function() { if (_qz.DEBUG) { console.warn.apply(console, arguments); } },
/** General errors */
error: function() { console.error.apply(console, arguments); }
},
//stream types
streams: {
serial: 'SERIAL', usb: 'USB', hid: 'HID'
},
websocket: {
/** The actual websocket object managing the connection. */
connection: null,
/** Default parameters used on new connections. Override values using options parameter on {@link qz.websocket.connect}. */
connectConfig: {
host: ["localhost", "localhost.qz.io"], //hosts QZ Tray can be running on
hostIndex: 0, //internal var - index on host array
usingSecure: true, //boolean use of secure protocol
protocol: {
secure: "wss://", //secure websocket
insecure: "ws://" //insecure websocket
},
port: {
secure: [8181, 8282, 8383, 8484], //list of secure ports QZ Tray could be listening on
insecure: [8182, 8283, 8384, 8485], //list of insecure ports QZ Tray could be listening on
portIndex: 0 //internal var - index on active port array
},
keepAlive: 60, //time between pings to keep connection alive, in seconds
retries: 0, //number of times to reconnect before failing
delay: 0 //seconds before firing a connection
},
setup: {
/** Loop through possible ports to open connection, sets web socket calls that will settle the promise. */
findConnection: function(config, resolve, reject) {
//force flag if missing ports
if (!config.port.secure.length) {
if (!config.port.insecure.length) {
reject(new Error("No ports have been specified to connect over"));
return;
} else if (config.usingSecure) {
_qz.log.error("No secure ports specified - forcing insecure connection");
config.usingSecure = false;
}
} else if (!config.port.insecure.length && !config.usingSecure) {
_qz.log.trace("No insecure ports specified - forcing secure connection");
config.usingSecure = true;
}
var deeper = function() {
config.port.portIndex++;
if ((config.usingSecure && config.port.portIndex >= config.port.secure.length)
|| (!config.usingSecure && config.port.portIndex >= config.port.insecure.length)) {
if (config.hostIndex >= config.host.length - 1) {
//give up, all hope is lost
reject(new Error("Unable to establish connection with QZ"));
return;
} else {
config.hostIndex++;
config.port.portIndex = 0;
}
}
// recursive call until connection established or all ports are exhausted
_qz.websocket.setup.findConnection(config, resolve, reject);
};
var address;
if (config.usingSecure) {
address = config.protocol.secure + config.host[config.hostIndex] + ":" + config.port.secure[config.port.portIndex];
} else {
address = config.protocol.insecure + config.host[config.hostIndex] + ":" + config.port.insecure[config.port.portIndex];
}
try {
_qz.log.trace("Attempting connection", address);
_qz.websocket.connection = new _qz.tools.ws(address);
}
catch(err) {
_qz.log.error(err);
deeper();
return;
}
if (_qz.websocket.connection != null) {
_qz.websocket.connection.established = false;
//called on successful connection to qz, begins setup of websocket calls and resolves connect promise after certificate is sent
_qz.websocket.connection.onopen = function(evt) {
if (!_qz.websocket.connection.established) {
_qz.log.trace(evt);
_qz.log.info("Established connection with QZ Tray on " + address);
_qz.websocket.setup.openConnection({ resolve: resolve, reject: reject });
if (config.keepAlive > 0) {
var interval = setInterval(function() {
if (!qz.websocket.isActive()) {
clearInterval(interval);
return;
}
_qz.websocket.connection.send("ping");
}, config.keepAlive * 1000);
}
}
};
//called during websocket close during setup
_qz.websocket.connection.onclose = function() {
// Safari compatibility fix to raise error event
if (_qz.websocket.connection && typeof navigator !== 'undefined' && navigator.userAgent.indexOf('Safari') != -1 && navigator.userAgent.indexOf('Chrome') == -1) {
_qz.websocket.connection.onerror();
}
};
//called for errors during setup (such as invalid ports), reject connect promise only if all ports have been tried
_qz.websocket.connection.onerror = function(evt) {
_qz.log.trace(evt);
_qz.websocket.connection = null;
deeper();
};
} else {
reject(new Error("Unable to create a websocket connection"));
}
},
/** Finish setting calls on successful connection, sets web socket calls that won't settle the promise. */
openConnection: function(openPromise) {
_qz.websocket.connection.established = true;
//called when an open connection is closed
_qz.websocket.connection.onclose = function(evt) {
_qz.log.trace(evt);
_qz.log.info("Closed connection with QZ Tray");
//if this is set, then an explicit close call was made
if (_qz.websocket.connection.promise != undefined) {
_qz.websocket.connection.promise.resolve();
}
_qz.websocket.callClose(evt);
_qz.websocket.connection = null;
for(var uid in _qz.websocket.pendingCalls) {
if (_qz.websocket.pendingCalls.hasOwnProperty(uid)) {
_qz.websocket.pendingCalls[uid].reject(new Error("Connection closed before response received"));
}
}
};
//called for any errors with an open connection
_qz.websocket.connection.onerror = function(evt) {
_qz.websocket.callError(evt);
};
//send JSON objects to qz
_qz.websocket.connection.sendData = function(obj) {
_qz.log.trace("Preparing object for websocket", obj);
if (obj.timestamp == undefined) {
obj.timestamp = Date.now();
if (typeof obj.timestamp !== 'number') {
obj.timestamp = new Date().getTime();
}
}
if (obj.promise != undefined) {
obj.uid = _qz.websocket.setup.newUID();
_qz.websocket.pendingCalls[obj.uid] = obj.promise;
}
// track requesting monitor
obj.position = {
x: typeof screen !== 'undefined' ? ((screen.availWidth || screen.width) / 2) + (screen.left || screen.availLeft) : 0,
y: typeof screen !== 'undefined' ? ((screen.availHeight || screen.height) / 2) + (screen.top || screen.availTop) : 0
};
try {
if (obj.call != undefined && obj.signature == undefined) {
var signObj = {
call: obj.call,
params: obj.params,
timestamp: obj.timestamp
};
//make a hashing promise if not already one
var hashing = _qz.tools.hash(_qz.tools.stringify(signObj));
if (!hashing.then) {
hashing = _qz.tools.promise(function(resolve) {
resolve(hashing);
});
}
hashing.then(function(hashed) {
return _qz.security.callSign(hashed);
}).then(function(signature) {
_qz.log.trace("Signature for call", signature);
obj.signature = signature;
_qz.signContent = undefined;
_qz.websocket.connection.send(_qz.tools.stringify(obj));
});
} else {
_qz.log.trace("Signature for call", obj.signature);
//called for pre-signed content and (unsigned) setup calls
_qz.websocket.connection.send(_qz.tools.stringify(obj));
}
}
catch(err) {
_qz.log.error(err);
if (obj.promise != undefined) {
obj.promise.reject(err);
delete _qz.websocket.pendingCalls[obj.uid];
}
}
};
//receive message from qz
_qz.websocket.connection.onmessage = function(evt) {
var returned = JSON.parse(evt.data);
if (returned.uid == null) {
if (returned.type == null) {
//incorrect response format, likely connected to incompatible qz version
_qz.websocket.connection.close(4003, "Connected to incompatible QZ Tray version");
} else {
//streams (callbacks only, no promises)
switch(returned.type) {
case _qz.streams.serial:
if (!returned.event) {
returned.event = JSON.stringify({ portName: returned.key, output: returned.data });
}
_qz.serial.callSerial(JSON.parse(returned.event));
break;
case _qz.streams.usb:
if (!returned.event) {
returned.event = JSON.stringify({ vendorId: returned.key[0], productId: returned.key[1], output: returned.data });
}
_qz.usb.callUsb(JSON.parse(returned.event));
break;
case _qz.streams.hid:
_qz.hid.callHid(JSON.parse(returned.event));
break;
default:
_qz.log.warn("Cannot determine stream type for callback", returned);
break;
}
}
return;
}
_qz.log.trace("Received response from websocket", returned);
var promise = _qz.websocket.pendingCalls[returned.uid];
if (promise == undefined) {
_qz.log.warn('No promise found for returned response');
} else {
if (returned.error != undefined) {
promise.reject(new Error(returned.error));
} else {
promise.resolve(returned.result);
}
}
delete _qz.websocket.pendingCalls[returned.uid];
};
//send up the certificate before making any calls
//also gives the user a chance to deny the connection
function sendCert(cert) {
if (cert === undefined) { cert = null; }
_qz.websocket.connection.sendData({ certificate: cert, promise: openPromise });
}
_qz.security.callCert().then(sendCert).catch(sendCert);
},
/** Generate unique ID used to map a response to a call. */
newUID: function() {
var len = 6;
return (new Array(len + 1).join("0") + (Math.random() * Math.pow(36, len) << 0).toString(36)).slice(-len)
}
},
dataPromise: function(callName, params, signature, signingTimestamp) {
return _qz.tools.promise(function(resolve, reject) {
var msg = {
call: callName,
promise: { resolve: resolve, reject: reject },
params: params,
signature: signature,
timestamp: signingTimestamp
};
_qz.websocket.connection.sendData(msg);
});
},
/** Library of promises awaiting a response, uid -> promise */
pendingCalls: {},
/** List of functions to call on error from the websocket. */
errorCallbacks: [],
/** Calls all functions registered to listen for errors. */
callError: function(evt) {
if (Array.isArray(_qz.websocket.errorCallbacks)) {
for(var i = 0; i < _qz.websocket.errorCallbacks.length; i++) {
_qz.websocket.errorCallbacks[i](evt);
}
} else {
_qz.websocket.errorCallbacks(evt);
}
},
/** List of function to call on closing from the websocket. */
closedCallbacks: [],
/** Calls all functions registered to listen for closing. */
callClose: function(evt) {
if (Array.isArray(_qz.websocket.closedCallbacks)) {
for(var i = 0; i < _qz.websocket.closedCallbacks.length; i++) {
_qz.websocket.closedCallbacks[i](evt);
}
} else {
_qz.websocket.closedCallbacks(evt);
}
}
},
printing: {
/** Default options used for new printer configs. Can be overridden using {@link qz.configs.setDefaults}. */
defaultConfig: {
//value purposes are explained in the qz.configs.setDefaults docs
colorType: 'color',
copies: 1,
density: 0,
duplex: false,
fallbackDensity: null,
interpolation: 'bicubic',
jobName: null,
legacy: false,
margins: 0,
orientation: null,
paperThickness: null,
printerTray: null,
rasterize: true,
rotation: 0,
scaleContent: true,
size: null,
units: 'in',
altPrinting: false,
encoding: null,
endOfDoc: null,
perSpool: 1
}
},
serial: {
/** List of functions called when receiving data from serial connection. */
serialCallbacks: [],
/** Calls all functions registered to listen for serial events. */
callSerial: function(streamEvent) {
if (Array.isArray(_qz.serial.serialCallbacks)) {
for(var i = 0; i < _qz.serial.serialCallbacks.length; i++) {
_qz.serial.serialCallbacks[i](streamEvent);
}
} else {
_qz.serial.serialCallbacks(streamEvent);
}
}
},
usb: {
/** List of functions called when receiving data from usb connection. */
usbCallbacks: [],
/** Calls all functions registered to listen for usb events. */
callUsb: function(streamEvent) {
if (Array.isArray(_qz.usb.usbCallbacks)) {
for(var i = 0; i < _qz.usb.usbCallbacks.length; i++) {
_qz.usb.usbCallbacks[i](streamEvent);
}
} else {
_qz.usb.usbCallbacks(streamEvent);
}
}
},
hid: {
/** List of functions called when receiving data from hid connection. */
hidCallbacks: [],
/** Calls all functions registered to listen for hid events. */
callHid: function(streamEvent) {
if (Array.isArray(_qz.hid.hidCallbacks)) {
for(var i = 0; i < _qz.hid.hidCallbacks.length; i++) {
_qz.hid.hidCallbacks[i](streamEvent);
}
} else {
_qz.hid.hidCallbacks(streamEvent);
}
}
},
security: {
/** Function used to resolve promise when acquiring site's public certificate. */
certPromise: function(resolve, reject) { reject(); },
/** Called to create new promise (using {@link _qz.security.certPromise}) for certificate retrieval. */
callCert: function() {
return _qz.tools.promise(_qz.security.certPromise);
},
/** Function used to create promise resolver when requiring signed calls. */
signaturePromise: function() { return function(resolve) { resolve(); } },
/** Called to create new promise (using {@link _qz.security.signaturePromise}) for signed calls. */
callSign: function(toSign) {
return _qz.tools.promise(_qz.security.signaturePromise(toSign));
}
},
tools: {
/** Create a new promise */
promise: function(resolver) {
return new RSVP.Promise(resolver);
},
stringify: function(object) {
//old versions of prototype affect stringify
var pjson = Array.prototype.toJSON;
delete Array.prototype.toJSON;
var result = JSON.stringify(object);
if (pjson) {
Array.prototype.toJSON = pjson;
}
return result;
},
hash: function(data) {
return Sha256.hash(data);
},
ws: typeof WebSocket !== 'undefined' ? WebSocket : null,
absolute: function(loc) {
if (typeof window !== 'undefined' && typeof document.createElement === 'function') {
var a = document.createElement("a");
a.href = loc;
return a.href;
}
return loc;
},
/** Performs deep copy to target from remaining params */
extend: function(target) {
//special case when reassigning properties as objects in a deep copy
if (typeof target !== 'object') {
target = {};
}
for(var i = 1; i < arguments.length; i++) {
var source = arguments[i];
if (!source) { continue; }
for(var key in source) {
if (source.hasOwnProperty(key)) {
if (target === source[key]) { continue; }
if (source[key] && source[key].constructor && source[key].constructor === Object) {
var clone;
if (Array.isArray(source[key])) {
clone = target[key] || [];
} else {
clone = target[key] || {};
}
target[key] = _qz.tools.extend(clone, source[key]);
} else if (source[key] !== undefined) {
target[key] = source[key];
}
}
}
}
return target;
}
}
};
///// CONFIG CLASS ////
/** Object to handle configured printer options. */
function Config(printer, opts) {
/**
* Set the printer assigned to this config.
* @param {string|Object} newPrinter Name of printer. Use object type to specify printing to file or host.
* @param {string} [newPrinter.name] Name of printer to send printing.
* @param {string} [newPrinter.file] Name of file to send printing.
* @param {string} [newPrinter.host] IP address or host name to send printing.
* @param {string} [newPrinter.port] Port used by <printer.host>.
*/
this.setPrinter = function(newPrinter) {
if (typeof newPrinter === 'string') {
newPrinter = { name: newPrinter };
}
this.printer = newPrinter;
};
/**
* @returns {Object} The printer currently assigned to this config.
*/
this.getPrinter = function() {
return this.printer;
};
/**
* Alter any of the printer options currently applied to this config.
* @param newOpts {Object} The options to change. See <code>qz.config.setDefaults</code> docs for available values.
*
* @see qz.config.setDefaults
*/
this.reconfigure = function(newOpts) {
_qz.tools.extend(this.config, newOpts);
};
/**
* @returns {Object} The currently applied options on this config.
*/
this.getOptions = function() {
return this.config;
};
// init calls for new config object
this.setPrinter(printer);
this.config = opts;
}
/**
* Shortcut method for calling <code>qz.print</code> with a particular config.
* @param {Array<Object|string>} data Array of data being sent to the printer. See <code>qz.print</code> docs for available values.
* @param {boolean} [signature] Pre-signed signature of JSON string containing <code>call</code>, <code>params</code>, and <code>timestamp</code>.
* @param {number} [signingTimestamp] Required with <code>signature</code>. Timestamp used with pre-signed content.
*
* @example
* qz.print(myConfig, ...); // OR
* myConfig.print(...);
*
* @see qz.print
*/
Config.prototype.print = function(data, signature, signingTimestamp) {
qz.print(this, data, signature, signingTimestamp);
};
///// PUBLIC METHODS /////
/** @namespace qz */
return {
/**
* Calls related specifically to the web socket connection.
* @namespace qz.websocket
*/
websocket: {
/**
* Check connection status. Active connection is necessary for other calls to run.
*
* @returns {boolean} If there is an active connection with QZ Tray.
*
* @see connect
*
* @memberof qz.websocket
*/
isActive: function() {
return _qz.websocket.connection != null && _qz.websocket.connection.established;
},
/**
* Call to setup connection with QZ Tray on user's system.
*
* @param {Object} [options] Configuration options for the web socket connection.
* @param {string|Array<string>} [options.host=['localhost', 'localhost.qz.io']] Host running the QZ Tray software.
* @param {Object} [options.port] Config options for ports to cycle.
* @param {Array<number>} [options.port.secure=[8181, 8282, 8383, 8484]] Array of secure (WSS) ports to try
* @param {Array<number>} [options.port.insecure=[8182, 8283, 8384, 8485]] Array of insecure (WS) ports to try
* @param {boolean} [options.usingSecure=true] If the web socket should try to use secure ports for connecting.
* @param {number} [options.keepAlive=60] Seconds between keep-alive pings to keep connection open. Set to 0 to disable.
* @param {number} [options.retries=0] Number of times to reconnect before failing.
* @param {number} [options.delay=0] Seconds before firing a connection. Ignored if <code>options.retries</code> is 0.
*
* @returns {Promise<null|Error>}
*
* @memberof qz.websocket
*/
connect: function(options) {
return _qz.tools.promise(function(resolve, reject) {
if (qz.websocket.isActive()) {
reject(new Error("An open connection with QZ Tray already exists"));
return;
} else if (_qz.websocket.connection != null) {
reject(new Error("The current connection attempt has not returned yet"));
return;
}
if (!_qz.tools.ws) {
reject(new Error("WebSocket not supported by this browser"));
return;
} else if (!_qz.tools.ws.CLOSED || _qz.tools.ws.CLOSED == 2) {
reject(new Error("Unsupported WebSocket version detected: HyBi-00/Hixie-76"));
return;
}
//ensure some form of options exists for value checks
if (options == undefined) { options = {}; }
//disable secure ports if page is not secure
if (typeof location === 'undefined' || location.protocol !== 'https:') {
//respect forcing secure ports if it is defined, otherwise disable
if (typeof options.usingSecure === 'undefined') {
_qz.log.trace("Disabling secure ports due to insecure page");
options.usingSecure = false;
}
}
//ensure any hosts are passed to internals as an array
if (typeof options.host !== 'undefined' && !Array.isArray(options.host)) {
options.host = [options.host];
}
var attempt = function(count) {
var tried = false;
var nextAttempt = function() {
if (!tried) {
tried = true;
if (options && count < options.retries) {
attempt(count + 1);
} else {
reject.apply(null, arguments);
}
}
};
var delayed = function() {
var config = _qz.tools.extend({}, _qz.websocket.connectConfig, options);
_qz.websocket.setup.findConnection(config, resolve, nextAttempt)
};
if (count == 0) {
delayed(); // only retries will be called with a delay
} else {
setTimeout(delayed, options.delay * 1000);
}
};
attempt(0);
});
},
/**
* Stop any active connection with QZ Tray.
*
* @returns {Promise<null|Error>}
*
* @memberof qz.websocket
*/
disconnect: function() {
return _qz.tools.promise(function(resolve, reject) {
if (qz.websocket.isActive()) {
_qz.websocket.connection.close();
_qz.websocket.connection.promise = { resolve: resolve, reject: reject };
} else {
reject(new Error("No open connection with QZ Tray"))
}
});
},
/**
* List of functions called for any connections errors outside of an API call.<p/>
* Also called if {@link websocket#connect} fails to connect.
*
* @param {Function|Array<Function>} calls Single or array of <code>Function({Event} event)</code> calls.
*
* @memberof qz.websocket
*/
setErrorCallbacks: function(calls) {
_qz.websocket.errorCallbacks = calls;
},
/**
* List of functions called for any connection closing event outside of an API call.<p/>
* Also called when {@link websocket#disconnect} is called.
*
* @param {Function|Array<Function>} calls Single or array of <code>Function({Event} event)</code> calls.
*
* @memberof qz.websocket
*/
setClosedCallbacks: function(calls) {
_qz.websocket.closedCallbacks = calls;
},
/**
* @param {string} [hostname] Hostname to try to connect to when determining network interfaces, defaults to "google.com"
* @param {number} [port] Port to use with custom hostname, defaults to 443
* @param {string} [signature] Pre-signed signature of hashed JSON string containing <code>call='websocket.getNetworkInfo'</code>, <code>params</code> object, and <code>timestamp</code>.
* @param {number} [signingTimestamp] Required with <code>signature</code>. Timestamp used with pre-signed content.
*
* @returns {Promise<Object<{ipAddress: String, macAddress: String}>|Error>} Connected system's network information.
*
* @memberof qz.websocket
*/
getNetworkInfo: function(hostname, port, signature, signingTimestamp) {
return _qz.websocket.dataPromise('websocket.getNetworkInfo', {
hostname: hostname,
port: port
}, signature, signingTimestamp);
},
/**
* @returns {Object<{socket: String, host: String, port: Number}>} Details of active websocket connection
*
* @memberof qz.websocket
*/
getConnectionInfo: function() {
if (_qz.websocket.connection) {
var url = _qz.websocket.connection.url.split(/[:\/]+/g);
return { socket: url[0], host: url[1], port: +url[2] };
} else {
throw new Error("A connection to QZ has not been established yet");
}
}
},
/**
* Calls related to getting printer information from the connection.
* @namespace qz.printers
*/
printers: {
/**
* @param {string} [signature] Pre-signed signature of hashed JSON string containing <code>call='printers.getDefault</code>, <code>params</code>, and <code>timestamp</code>.
* @param {number} [signingTimestamp] Required with <code>signature</code>. Timestamp used with pre-signed content.
*
* @returns {Promise<string|Error>} Name of the connected system's default printer.
*
* @memberof qz.printers
*/
getDefault: function(signature, signingTimestamp) {
return _qz.websocket.dataPromise('printers.getDefault', null, signature, signingTimestamp);
},
/**
* @param {string} [query] Search for a specific printer. All printers are returned if not provided.
* @param {string} [signature] Pre-signed signature of hashed JSON string containing <code>call='printers.find'</code>, <code>params</code>, and <code>timestamp</code>.
* @param {number} [signingTimestamp] Required with <code>signature</code>. Timestamp used with pre-signed content.
*
* @returns {Promise<Array<string>|string|Error>} The matched printer name if <code>query</code> is provided.
* Otherwise an array of printer names found on the connected system.
*
* @memberof qz.printers
*/
find: function(query, signature, signingTimestamp) {
return _qz.websocket.dataPromise('printers.find', { query: query }, signature, signingTimestamp);
}
},
/**
* Calls related to setting up new printer configurations.
* @namespace qz.configs
*/
configs: {
/**
* Default options used by new configs if not overridden.
* Setting a value to NULL will use the printer's default options.
* Updating these will not update the options on any created config.
*
* @param {Object} options Default options used by printer configs if not overridden.
*
* @param {string} [options.colorType='color'] Valid values <code>[color | grayscale | blackwhite]</code>
* @param {number} [options.copies=1] Number of copies to be printed.
* @param {number|Array<number>} [options.density=0] Pixel density (DPI, DPMM, or DPCM depending on <code>[options.units]</code>).
* If provided as an array, uses the first supported density found (or the first entry if none found).
* @param {boolean} [options.duplex=false] Double sided printing
* @param {number} [options.fallbackDensity=null] Value used when default density value cannot be read, or in cases where reported as "Normal" by the driver, (in DPI, DPMM, or DPCM depending on <code>[options.units]</code>).
* @param {string} [options.interpolation='bicubic'] Valid values <code>[bicubic | bilinear | nearest-neighbor]</code>. Controls how images are handled when resized.
* @param {string} [options.jobName=null] Name to display in print queue.
* @param {boolean} [options.legacy=false] If legacy style printing should be used.
* @param {Object|number} [options.margins=0] If just a number is provided, it is used as the margin for all sides.
* @param {number} [options.margins.top=0]
* @param {number} [options.margins.right=0]
* @param {number} [options.margins.bottom=0]
* @param {number} [options.margins.left=0]
* @param {string} [options.orientation=null] Valid values <code>[portrait | landscape | reverse-landscape]</code>
* @param {number} [options.paperThickness=null]
* @param {string} [options.printerTray=null] //TODO - string?
* @param {boolean} [options.rasterize=true] Whether documents should be rasterized before printing. Forced TRUE if <code>[options.density]</code> is specified.
* @param {number} [options.rotation=0] Image rotation in degrees.
* @param {boolean} [options.scaleContent=true] Scales print content to page size, keeping ratio.
* @param {Object} [options.size=null] Paper size.
* @param {number} [options.size.width=null] Page width.
* @param {number} [options.size.height=null] Page height.
* @param {string} [options.units='in'] Page units, applies to paper size, margins, and density. Valid value <code>[in | cm | mm]</code>
*
* @param {boolean} [options.altPrinting=false] Print the specified file using CUPS command line arguments. Has no effect on Windows.
* @param {string} [options.encoding=null] Character set
* @param {string} [options.endOfDoc=null]
* @param {number} [options.perSpool=1] Number of pages per spool.
*
* @memberof qz.configs
*/
setDefaults: function(options) {
_qz.tools.extend(_qz.printing.defaultConfig, options);
},
/**
* Creates new printer config to be used in printing.
*
* @param {string|object} printer Name of printer. Use object type to specify printing to file or host.
* @param {string} [printer.name] Name of printer to send printing.
* @param {string} [printer.file] Name of file to send printing.
* @param {string} [printer.host] IP address or host name to send printing.
* @param {string} [printer.port] Port used by <printer.host>.
* @param {Object} [options] Override any of the default options for this config only.
*
* @returns {Config} The new config.
*
* @see config.setDefaults
*
* @memberof qz.configs
*/
create: function(printer, options) {
var myOpts = _qz.tools.extend({}, _qz.printing.defaultConfig, options);
return new Config(printer, myOpts);
}
},
/**
* Send data to selected config for printing.
* The promise for this method will resolve when the document has been sent to the printer. Actual printing may not be complete.
* <p/>
* Optionally, print requests can be pre-signed:
* Signed content consists of a JSON object string containing no spacing,
* following the format of the "call" and "params" keys in the API call, with the addition of a "timestamp" key in milliseconds
* ex. <code>'{"call":"<callName>","params":{...},"timestamp":1450000000}'</code>
*
* @param {Object<Config>} config Previously created config object.
* @param {Array<Object|string>} data Array of data being sent to the printer. String values are interpreted the same as the default <code>[raw]</code> object value.
* @param {string} data.data
* @param {string} data.type Valid values <code>[html | image | pdf | raw]</code>
* @param {string} [data.format] Format of data provided.<p/>
* For <code>[html]</code> types, valid formats include <code>[file(default) | plain]</code>.<p/>
* For <code>[image]</code> types, valid formats include <code>[base64 | file(default)]</code>.<p/>
* For <code>[pdf]</code> types, valid format include <code>[base64 | file(default)]</code>.<p/>
* For <code>[raw]</code> types, valid formats include <code>[base64 | file | hex | plain(default) | image | xml]</code>.
* @param {Object} [data.options]
* @param {string} [data.options.language] Required with <code>[raw]</code> type <code>[image]</code> format. Printer language.
* @param {number} [data.options.x] Optional with <code>[raw]</code> type <code>[image]</code> format. The X position of the image.
* @param {number} [data.options.y] Optional with <code>[raw]</code> type <code>[image]</code> format. The Y position of the image.
* @param {string|number} [data.options.dotDensity] Optional with <code>[raw]</code> type <code>[image]</code> format.
* @param {number} [data.precision=128] Optional with <code>[raw]</code> type <code>[image]</code> format. Bit precision of the ribbons.
* @param {boolean|string|Array<Array<number>>} [data.options.overlay=false] Optional with <code>[raw]</code> type <code>[image]</code> format.
* Boolean sets entire layer, string sets mask image, Array sets array of rectangles in format <code>[x1,y1,x2,y2]</code>.
* @param {string} [data.options.xmlTag] Required with <code>[xml]</code> format. Tag name containing base64 formatted data.
* @param {number} [data.options.pageWidth] Optional with <code>[html]</code> type printing. Width of the web page to render. Defaults to paper width.
* @param {number} [data.options.pageHeight] Optional with <code>[html]</code> type printing. Height of the web page to render. Defaults to adjusted web page height.
* @param {string} [signature] Pre-signed signature of hashed JSON string containing <code>call='print'</code>, <code>params</code>, and <code>timestamp</code>.
* @param {number} [signingTimestamp] Required with <code>signature</code>. Timestamp used with pre-signed content.
*
* @returns {Promise<null|Error>}
*
* @see qz.config.create
*
* @memberof qz
*/
print: function(config, data, signature, signingTimestamp) {
//change relative links to absolute
for(var i = 0; i < data.length; i++) {
if (data[i].constructor === Object) {
if ((!data[i].format && data[i].type && (data[i].type.toUpperCase() !== 'RAW' && data[i].type.toUpperCase() !== 'DIRECT')) //unspecified format and not raw -> assume file
|| (data[i].format && (data[i].format.toUpperCase() === 'FILE'
|| (data[i].format.toUpperCase() === 'IMAGE' && !(data[i].data.indexOf("data:image/") === 0 && data[i].data.indexOf(";base64,") !== 0))
|| data[i].format.toUpperCase() === 'XML'))) {
data[i].data = _qz.tools.absolute(data[i].data);
}
if (data[i].options && typeof data[i].options.overlay === 'string') {
data[i].options.overlay = _qz.tools.absolute(data[i].options.overlay);
}
}
}
var params = {
printer: config.getPrinter(),
options: config.getOptions(),
data: data
};
return _qz.websocket.dataPromise('print', params, signature, signingTimestamp);
},
/**
* Calls related to interaction with serial ports.
* @namespace qz.serial
*/
serial: {
/**
* @returns {Promise<Array<string>|Error>} Communication (RS232, COM, TTY) ports available on connected system.
*
* @memberof qz.serial
*/
findPorts: function() {
return _qz.websocket.dataPromise('serial.findPorts');
},
/**
* List of functions called for any response from open serial ports.
* Event data will contain <code>{string} portName</code> for all types.
* For RECEIVE types, <code>{string} output</code>.
* For ERROR types, <code>{string} exception</code>.
*
* @param {Function|Array<Function>} calls Single or array of <code>Function({string} portName, {string} output)</code> calls.
*
* @memberof qz.serial
*/
setSerialCallbacks: function(calls) {
_qz.serial.serialCallbacks = calls;
},
/**
* @param {string} port Name of port to open.
* @param {Object} [options] Boundaries of serial port output.
* @param {string} [options.start=0x0002] Character denoting start of serial response. Not used if <code>width</code is provided.
* @param {string} [options.end=0x000D] Character denoting end of serial response. Not used if <code>width</code> is provided.
* @param {number} [options.width] Used for fixed-width response serial communication.
* @param {string} [options.baudRate=9600]
* @param {string} [options.dataBits=8]
* @param {string} [options.stopBits=1]
* @param {string} [options.parity='NONE'] Valid values <code>[NONE| EVEN | ODD | MARK | SPACE]</code>
* @param {string} [options.flowControl='NONE'] Valid values <code>[NONE | XONXOFF | XONXOFF_OUT | XONXOFF_IN | RTSCTS | RTSCTS_OUT | RTSCTS_IN]</code>
*