/
scaffold.js
1187 lines (1032 loc) · 36 KB
/
scaffold.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
/*
***** BEGIN LICENSE BLOCK *****
Copyright © 2011 Center for History and New Media
George Mason University, Fairfax, Virginia, USA
http://zotero.org
This file is part of Zotero.
Zotero is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Zotero is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with Zotero. If not, see <http://www.gnu.org/licenses/>.
***** END LICENSE BLOCK *****
*/
var Zotero = Components.classes["@zotero.org/Zotero;1"]
// Currently uses only nsISupports
//.getService(Components.interfaces.chnmIZoteroService).
.getService(Components.interfaces.nsISupports)
.wrappedJSObject;
// Fix JSON stringify 2028/2029 "bug"
// Borrowed from http://stackoverflow.com/questions/16686687/json-stringify-and-u2028-u2029-check
if (JSON.stringify(["\u2028\u2029"]) !== '["\\u2028\\u2029"]') {
JSON.stringify = function (stringify) {
return function () {
var str = stringify.apply(this, arguments);
if (str && str.indexOf('\u2028') != -1) str = str.replace(/\u2028/g, '\\u2028');
if (str && str.indexOf('\u2029') != -1) str = str.replace(/\u2029/g, '\\u2029');
return str;
};
}(JSON.stringify);
}
// To be used elsewhere (e.g. varDump)
function fix2028(str) {
if (str.indexOf('\u2028') != -1) str = str.replace(/\u2028/g, '\\u2028');
if (str.indexOf('\u2029') != -1) str = str.replace(/\u2029/g, '\\u2029');
return str;
}
var Scaffold = new function() {
this.onLoad = onLoad;
this.load = load;
this.save = save;
this.run = run;
this.generateTranslatorID = generateTranslatorID;
this.testTargetRegex = testTargetRegex;
this.onResize = onResize;
this.populateTests = populateTests;
this.saveTests = saveTests;
this.runSelectedTests = runSelectedTests;
this.updateSelectedTests = updateSelectedTests;
this.deleteSelectedTests = deleteSelectedTests;
this.newTestFromCurrent = newTestFromCurrent;
this.editImportFromTest = editImportFromTest;
var _browser, _frames, _document;
var _editors = {};
var _propertyMap = {
'textbox-translatorID':'translatorID',
'textbox-label':'label',
'textbox-creator':'creator',
'textbox-target':'target',
'textbox-minVersion':'minVersion',
'textbox-maxVersion':'maxVersion',
'textbox-priority':'priority'
};
var modules;
function onLoad(e) {
// Load modules
try {
modules = JSON.parse(Zotero.File.getContentsFromURL('resource://scaffold/modules.json'));
} catch(e) {
Zotero.debug(e);
modules = {};
}
// Add module name and comment
for (let name in modules) {
let module = modules[name];
module.wrappedCode = '/* ' + name + ' LINE '
+ module.version + ':' + module.commit + ' */ ' + module.code;
}
if(e.target !== document) return;
_document = document;
_browser = Components.classes["@mozilla.org/appshell/window-mediator;1"]
.getService(Components.interfaces.nsIWindowMediator)
.getMostRecentWindow("navigator:browser");
_browser.document.getElementById("content").tabContainer.addEventListener("TabSelect",
_updateFrames, true);
_browser.document.getElementById("appcontent").addEventListener("pageshow",
_updateFrames, true);
_updateFrames();
var importWin = document.getElementById("editor-import").contentWindow;
var codeWin = document.getElementById("editor-code").contentWindow;
var testsWin = document.getElementById("editor-tests").contentWindow;
_editors["import"] = importWin.editor;
_editors["code"] = codeWin.editor;
_editors["tests"] = testsWin.editor;
_editors["code"].getSession().setUseWorker(false);
_editors["code"].getSession().setMode(new codeWin.JavaScriptMode);
_editors["code"].getSession().setUseSoftTabs(false);
_editors["tests"].getSession().setUseWorker(false);
_editors["tests"].getSession().setMode(new testsWin.JavaScriptMode);
_editors["tests"].getSession().setUseSoftTabs(false);
_editors["import"].getSession().setMode(new importWin.TextMode);
// Set resize handler
_document.addEventListener("resize", this.onResize, false);
// Boilerplate for framework translators
document.getElementById('checkbox-framework').addEventListener("command",
function() {
var usesFW = document.getElementById('checkbox-framework').checked;
/* Code to set compat for framework translators
if (!usesFW) {
for each(var browser in ["gecko", "chrome", "safari"]) {
document.getElementById('checkbox-'+browser).checked = true;
}
*/
// If code hasn't been added, put the boilerplate in
// We could be fancy here and see if detectWeb / doWeb are set
if (usesFW && _editors["code"].getSession().getValue().trim() == "")
_editors["code"].getSession().setValue("function detectWeb(doc, url) { return FW.detectWeb(doc, url); }\nfunction doWeb(doc, url) { return FW.doWeb(doc, url); }");
}, true);
// Disable editing if external editor is enabled, enable when it is disabled
document.getElementById('checkbox-editor-external').addEventListener("command",
function() {
var external = document.getElementById('checkbox-editor-external').checked;
_editors["code"].setReadOnly(external);
_editors["tests"].setReadOnly(external);
}, true);
generateTranslatorID();
}
function onResize() {
// We try to let ACE resize itself
_editors["import"].resize();
_editors["code"].resize();
_editors["tests"].resize();
return true;
}
/*
* load translator from database
*/
function load(translatorID) {
var translator = false;
if (translatorID === undefined) {
var io = new Object();
io.dataIn = _getDocument().location.href;
window.openDialog("chrome://scaffold/content/load.xul",
"_blank","chrome,modal", io);
translator = io.dataOut;
} else {
translator = Zotero.Translators.get(translatorID);
}
// No translator was selected in the dialog.
if (!translator) return false;
for(var id in _propertyMap) {
document.getElementById(id).value = translator[_propertyMap[id]];
}
//Strip JSON metadata
var lastUpdatedIndex = translator.code.indexOf('"lastUpdated"');
var header = translator.code.substr(0, lastUpdatedIndex + 50);
var m = /^\s*{[\S\s]*?}\s*?[\r\n]+/.exec(header);
// Detect the minified framework and strip it
var usesFW = (translator.code.substr(m[0].length).indexOf("/* FW LINE ") !== -1);
if(usesFW) var fixedCode = translator.code
.substr(m[0].length)
.replace(/\/\* FW LINE [^\n]*\n/,'');
else var fixedCode = translator.code.substr(m[0].length);
// load tests into test editing pane, but clear it first
_editors["tests"].getSession().setValue('');
_loadTests(fixedCode);
// and remove them from the translator code
var testStart = fixedCode.indexOf("/** BEGIN TEST CASES **/");
var testEnd = fixedCode.indexOf("/** END TEST CASES **/");
if (testStart !== -1 && testEnd !== -1)
fixedCode = fixedCode.substr(0,testStart) + fixedCode.substr(testEnd+23);
// Set up the test running pane
populateTests();
// Convert whitespace to tabs
_editors["code"].getSession().setValue(normalizeWhitespace(fixedCode));
// Then go to line 1
_editors["code"].gotoLine(1);
document.getElementById('checkbox-framework').checked = usesFW;
// Reset configOptions and displayOptions before loading
document.getElementById('textbox-configOptions').value = '';
document.getElementById('textbox-displayOptions').value = '';
var configOptions, displayOptions;
if(translator.configOptions) {
configOptions = JSON.stringify(translator.configOptions);
}
if(configOptions != '{}') {
document.getElementById('textbox-configOptions').value = configOptions;
}
if(translator.displayOptions) {
displayOptions = JSON.stringify(translator.displayOptions);
}
if(displayOptions != '{}') {
document.getElementById('textbox-displayOptions').value = displayOptions;
}
// get translator type; might as well have some fun here
var type = translator.translatorType;
var types = ["import", "export", "web", "search"];
for(var i=2; i<=16; i*=2) {
var mod = type % i;
document.getElementById('checkbox-'+types.shift()).checked = !!mod;
if(mod) type -= mod;
}
// get browser support
var browserSupport = translator.browserSupport;
if(!browserSupport) browserSupport = "g";
const browsers = {gecko:"g", chrome:"c", safari:"s", ie:"i", bookmarklet:"b", server:"v"};
for (var browser in browsers) {
document.getElementById('checkbox-'+browser).checked = browserSupport.indexOf(browsers[browser]) !== -1;
}
}
function _getMetadataObject() {
var metadata = {
translatorID: document.getElementById('textbox-translatorID').value,
label: document.getElementById('textbox-label').value,
creator: document.getElementById('textbox-creator').value,
target: document.getElementById('textbox-target').value,
minVersion: document.getElementById('textbox-minVersion').value,
maxVersion: document.getElementById('textbox-maxVersion').value,
priority: parseInt(document.getElementById('textbox-priority').value)
};
if(document.getElementById('textbox-configOptions').value != '') {
metadata.configOptions = JSON.parse(document.getElementById('textbox-configOptions').value);
}
if(document.getElementById('textbox-displayOptions').value != '') {
metadata.displayOptions = JSON.parse(document.getElementById('textbox-displayOptions').value);
}
// no option for this
metadata.inRepository = true;
metadata.translatorType = 0;
if(document.getElementById('checkbox-import').checked) {
metadata.translatorType += 1;
}
if(document.getElementById('checkbox-export').checked) {
metadata.translatorType += 2;
}
if(document.getElementById('checkbox-web').checked) {
metadata.translatorType += 4;
}
if(document.getElementById('checkbox-search').checked) {
metadata.translatorType += 8;
}
metadata.browserSupport = "";
if(document.getElementById('checkbox-gecko').checked) {
metadata.browserSupport += "g";
}
if(document.getElementById('checkbox-chrome').checked) {
metadata.browserSupport += "c";
}
if(document.getElementById('checkbox-safari').checked) {
metadata.browserSupport += "s";
}
if(document.getElementById('checkbox-ie').checked) {
metadata.browserSupport += "i";
}
if(document.getElementById('checkbox-bookmarklet').checked) {
metadata.browserSupport += "b";
}
if(document.getElementById('checkbox-server').checked) {
metadata.browserSupport += "v";
}
var date = new Date();
metadata.lastUpdated = date.getUTCFullYear()
+"-"+Zotero.Utilities.lpad(date.getUTCMonth()+1, '0', 2)
+"-"+Zotero.Utilities.lpad(date.getUTCDate(), '0', 2)
+" "+Zotero.Utilities.lpad(date.getUTCHours(), '0', 2)
+":"+Zotero.Utilities.lpad(date.getUTCMinutes(), '0', 2)
+":"+Zotero.Utilities.lpad(date.getUTCSeconds(), '0', 2);
return metadata;
}
/*
* save translator to database
*/
function save() {
var code = _editors["code"].getSession().getValue();
var tests = _editors["tests"].getSession().getValue();
code += tests;
if(document.getElementById('checkbox-framework').checked) {
code = modules.FW.wrappedCode + '\n' + code;
}
var metadata = _getMetadataObject();
if (metadata.label === "Untitled") {
_logOutput("Can't save an untitled translator.");
return;
}
Zotero.Translators.save(metadata,code);
Zotero.Translators.init();
}
/*
* run translator
*/
function run(functionToRun) {
if (document.getElementById('textbox-label').value == 'Untitled') {
alert("Translator title not set");
return;
}
_clearOutput();
if(document.getElementById('checkbox-editor-external').checked) {
// We don't save the translator-- we reload it instead
var translatorID = document.getElementById('textbox-translatorID').value;
load(translatorID);
} else {
save();
}
if (functionToRun == "detectWeb" || functionToRun == "doWeb") {
_run(functionToRun, _getDocument(), _selectItems, _myItemDone, _translators, function(){});
} else if (functionToRun == "detectImport" || functionToRun == "doImport") {
_run(functionToRun, _getImport(), _selectItems, _myItemDone, _translatorsImport, function(){});
}
}
/*
* run translator in given mode with given input
*/
function _run(functionToRun, input, selectItems, itemDone, detectHandler, done) {
if (functionToRun == "detectWeb" || functionToRun == "doWeb") {
var translate = new Zotero.Translate.Web();
var utilities = new Zotero.Utilities.Translate(translate);
// If this is a string, assume it's a URL
if (typeof input == 'string') {
try {
var doc = utilities.retrieveDocument(input);
} catch (e) {
// Time's up!
_logOutput("retrieveDocument timed out");
return false;
}
translate.setDocument(doc);
} else {
translate.setDocument(input);
}
} else if (functionToRun == "detectImport" || functionToRun == "doImport") {
var translate = new Zotero.Translate.Import();
translate.setString(input);
}
translate.setHandler("error", _error);
translate.setHandler("debug", _debug);
translate.setHandler("done", done);
if (functionToRun == "detectWeb") {
// get translator
var translator = _getTranslator();
// don't let target prevent translator from operating
translator.target = null;
// generate sandbox
translate.setHandler("translators", detectHandler);
// internal hack to call detect on this translator
translate._potentialTranslators = [translator];
translate._foundTranslators = [];
translate._currentState = "detect";
translate._detect();
} else if (functionToRun == "doWeb") {
// get translator
var translator = _getTranslator();
// don't let the detectCode prevent the translator from operating
translator.detectCode = null;
translate.setTranslator(translator);
translate.setHandler("select", selectItems);
translate.clearHandlers("itemDone");
translate.setHandler("itemDone", itemDone);
// disable output to database
translate.translate(false);
} else if (functionToRun == "detectImport") {
// get translator
var translator = _getTranslator();
// don't let target prevent translator from operating
translator.target = null;
// generate sandbox
translate.setHandler("translators", detectHandler);
// internal hack to call detect on this translator
translate._potentialTranslators = [translator];
translate._foundTranslators = [];
translate._currentState = "detect";
translate._detect();
} else if (functionToRun == "doImport") {
// get translator
var translator = _getTranslator();
// don't let the detectCode prevent the translator from operating
translator.detectCode = null;
translate.setTranslator(translator);
translate.clearHandlers("itemDone");
translate.clearHandlers("collectionDone");
translate.setHandler("itemDone", itemDone);
translate.setHandler("collectionDone", function(obj, collection) {
_logOutput("Collection: "+ collection.name + ", "+collection.children.length+" items");
});
// disable output to database
translate.translate(false);
}
}
/*
* generate translator GUID
*/
function generateTranslatorID() {
document.getElementById("textbox-translatorID").value = _generateGUID();
}
/*
* test target regular expression against document URL
*/
function testTargetRegex() {
var testDoc = _getDocument();
var url = Zotero.Proxies.proxyToProper(testDoc.location.href);
try {
var targetRe = new RegExp(document.getElementById('textbox-target').value, "i");
} catch(e) {
_logOutput("Regex parse error:\n"+JSON.stringify(e, null, "\t"));
}
_logOutput(targetRe.test(url));
}
/*
* called to select items
*/
function _selectItems(obj, itemList) {
var io = { dataIn:itemList, dataOut:null }
var newDialog = window.openDialog("chrome://zotero/content/ingester/selectitems.xul",
"_blank","chrome,modal,centerscreen,resizable=yes", io);
return io.dataOut;
}
/*
* called if an error occurs
*/
function _error(obj, error) {
if(error && error.lineNumber &&
error.fileName == obj.translator[0].label ) {
_editors["code"].gotoLine(error.lineNumber-2); // subtract two lines for metadata and FW
}
}
/*
* logs translator output (instead of logging in the console)
*/
function _debug(obj, string) {
_logOutput(string);
}
/*
* logs item output
*/
function _myItemDone(obj, item) {
Zotero.debug("Item returned");
item = _sanitizeItem(item);
_logOutput("Returned item:\n"+Zotero_TranslatorTester._generateDiff(item, Zotero_TranslatorTester._sanitizeItem(item, true)));
}
/*
* prints information from detectCode to window
*/
function _translators(obj, translators) {
if(translators && translators.length != 0) {
_logOutput('detectWeb returned type "'+translators[0].itemType+'"');
} else {
_logOutput('detectWeb did not match');
}
}
/*
* prints information from detectCode to window, for import
*/
function _translatorsImport(obj, translators) {
if(translators && translators.length != 0 && translators[0].itemType) {
_logOutput('detectImport matched');
} else {
_logOutput('detectImport did not match');
}
}
/*
* logs debug info (instead of console)
*/
function _logOutput(string) {
var date = new Date();
var output = document.getElementById('output');
if(typeof string != "string") {
string = fix2028(Zotero.Utilities.varDump(string));
}
if(output.value) output.value += "\n";
output.value += Zotero.Utilities.lpad(date.getHours(), '0', 2)
+":"+Zotero.Utilities.lpad(date.getMinutes(), '0', 2)
+":"+Zotero.Utilities.lpad(date.getSeconds(), '0', 2)
+" "+string.replace(/\n/g, "\n ");
// move to end
output.inputField.scrollTop = output.inputField.scrollHeight;
}
/*
* gets import text for import translator
*/
function _getImport() {
var text = _editors["import"].getSession().getValue();
return text;
}
/*
* transfers metadata to the translator object
* Replicated from translator.js
*/
function _metaToTranslator(translator, metadata) {
for each(var p in ["translatorID", "translatorType", "label", "creator", "target",
"minVersion", "maxVersion", "priority", "lastUpdated", "inRepository", "configOptions",
"displayOptions", "browserSupport"]) {
translator[p] = metadata[p];
}
if(!translator.configOptions) translator.configOptions = {};
if(!translator.displayOptions) translator.displayOptions = {};
if(!translator.browserSupport) translator.browserSupport = "g";
}
/*
* gets translator data from the metadata pane
*/
function _getTranslator() {
//create a barebones translator
var translator = new Object();
var metadata = _getMetadataObject();
//copy metadata into the translator object
_metaToTranslator(translator, metadata);
var locFW = document.getElementById('checkbox-framework').checked ? modules.FW.wrappedCode + "\n" : "\n";
metadata = JSON.stringify(metadata) + ";\n";
translator.code = metadata + locFW + _editors["code"].getSession().getValue();
// make sure translator gets run in browser in Zotero >2.1
if(Zotero.Translator.RUN_MODE_IN_BROWSER) {
translator.runMode = Zotero.Translator.RUN_MODE_IN_BROWSER;
}
return translator;
}
/*
* loads the translator's tests from the pane
*/
function _loadTests(code) {
var testStart = code.indexOf("/** BEGIN TEST CASES **/");
var testEnd = code.indexOf("/** END TEST CASES **/");
if (testStart !== -1 && testEnd !== -1) {
test = code.substring(testStart + 24, testEnd);
test = test.replace(/var testCases = /,'');
// The JSON parser doesn't like final semicolons
if (test.lastIndexOf(';') == (test.length-1))
test = test.slice(0,-1);
try {
var testObject = JSON.parse(test);
_writeTests(JSON.stringify(testObject, null, "\t")); // Don't modify current tests
return testObject;
} catch (e) {
_logOutput("Exception parsing JSON");
return false;
}
} else {
return false;
}
}
/*
* writes tests back into the translator
*/
function _writeTests(testString) {
var code = "/** BEGIN TEST CASES **/\nvar testCases = "
+ testString + "\n/** END TEST CASES **/";
_editors["tests"].getSession().setValue(code);
}
/* clear tests pane */
function _clearTests() {
var listbox = document.getElementById("testing-listbox");
var count = listbox.itemCount;
while(count-- > 0){
listbox.removeItemAt(0);
}
}
/* turns an item into a test-safe item
* does not check if all fields are valid
*/
function _sanitizeItem(item) {
// Clear attachment document objects
if (item && item.attachments && item.attachments.length) {
for (var i=0; i<item.attachments.length; i++) {
if (item.attachments[i].document)
item.attachments[i].document = "[object]";
}
}
if (item && item.tags) {
item.tags = Zotero.Utilities.arrayUnique(item.tags).sort();
}
return item;
}
/* sanitizes all items in a test
*/
function _sanitizeItemsInTest(test) {
if(test.items && typeof test.items != 'string' && test.items.length) {
for(var i=0, n=test.items.length; i<n; i++) {
test.items[i] = Zotero_TranslatorTester._sanitizeItem(test.items[i]);
}
}
return test;
}
/* stringifies an array of tests
* Output is the same as JSON.stringify (with pretty print), except that
* Zotero.Item objects are stringified in a deterministic manner (mostly):
* * Certain important fields are placed at the top of the object
* * Certain less-frequently used fields are placed at the bottom
* * Remaining fields are sorted alphabetically
* * tags are always sorted alphabetically
* * Some fields, like those inside creator objects, notes, etc. are not sorted
*/
function _stringifyTests(value, level) {
if(!level) level = 0;
if(typeof(value) == 'function' || typeof(value) == 'undefined' || value === null) {
return level ? undefined : '';
}
if(typeof(value) !== 'object') return JSON.stringify(value, null, "\t");
if(value instanceof Array) {
let str = '[';
for(let i=0; i<value.length; i++) {
let val = _stringifyTests(value[i], level+1);
if(val === undefined) val = 'undefined';
else val = val.replace(/\n/g, "\n\t"); // Indent
str += (i?',':'') + "\n\t" + val;
}
return str + (str.length > 1 ? "\n]" : ']');
}
if(!value.itemType) {
// Not a Zotero.Item object
let str = '{';
function processRow(key, value) {
let val = _stringifyTests(value, level+1);
if(val === undefined) return;
val = val.replace(/\n/g, "\n\t");
return JSON.stringify(''+key) + ': ' + val;
}
if (level < 2 && value.items) {
// Test object. Arrange properties in set order
let order = ['type', 'url', 'input', 'defer', 'items'];
for (let i=0; i<order.length; i++) {
let val = processRow(order[i], value[order[i]]);
if (val === undefined) continue;
str += (str.length > 1 ? ',' : '') + '\n\t' + val;
}
} else {
for (let i in value) {
let val = processRow(i, value[i]);
if (val === undefined) continue;
str += (str.length > 1 ? ',' : '') + '\n\t' + val;
}
}
return str + (str.length > 1 ? "\n}" : '}');
}
// Zotero.Item object
const topFields = ['itemType', 'title', 'caseName', 'nameOfAct', 'subject',
'creators', 'date', 'dateDecided', 'issueDate', 'dateEnacted'];
const bottomFields = ['attachments', 'tags', 'notes', 'seeAlso'];
let otherFields = Object.keys(value);
let presetFields = topFields.concat(bottomFields);
for(let i=0; i<presetFields.length; i++) {
let j = otherFields.indexOf(presetFields[i]);
if(j == -1) continue;
otherFields.splice(j, 1);
}
let fields = topFields.concat(otherFields.sort()).concat(bottomFields);
let str = '{';
for(let i=0; i<fields.length; i++) {
let rawVal = value[fields[i]];
if(!rawVal) continue;
let val;
if(fields[i] == 'tags') {
val = _stringifyTests(rawVal.sort(), level+1);
} else {
val = _stringifyTests(rawVal, level+1);
}
if(val === undefined) continue;
val = val.replace(/\n/g, "\n\t");
str += (str.length > 1 ? ',':'') + "\n\t" + JSON.stringify(fields[i]) + ': ' + val;
}
return str + "\n}";
}
/*
* adds a new test from the current input/translator
* web or import only for now
*/
function newTestFromCurrent(type) {
_clearOutput();
var input, label;
if (type == "web" && !document.getElementById('checkbox-web').checked) {
_logOutput("Current translator isn't a web translator");
return false;
} else if (type == "import" && !document.getElementById('checkbox-import').checked) {
_logOutput("Current translator isn't an import translator");
return false;
}
if (type == "web") {
input = _getDocument();
label = Zotero.Proxies.proxyToProper(input.location.href);
} else if (type == "import") {
input = _getImport();
label = input;
} else {
return false;
}
var listbox = document.getElementById("testing-listbox");
var listitem = document.createElement("listitem");
var listcell = document.createElement("listcell");
listcell.setAttribute("label", label);
listitem.appendChild(listcell);
listcell = document.createElement("listcell");
listcell.setAttribute("label", "Creating...");
listitem.appendChild(listcell);
listbox.appendChild(listitem);
if (type == "web") {
// Creates the test. The test isn't saved yet!
var tester = new Zotero_TranslatorTester(_getTranslator(), type, _debug);
tester.newTest(input, function (obj, newTest) { // "done" handler for do
if(newTest) {
listcell.setAttribute("label", "New unsaved test");
listitem.setUserData("test-string", JSON.stringify(_sanitizeItemsInTest(newTest)), null);
} else {
listcell.setAttribute("label", "Creation failed");
}
});
}
if (type == "import") {
var test = {"type" : "import", "input" : input, "items" : []};
// Creates the test. The test isn't saved yet!
// TranslatorTester doesn't handle these correctly, so we do it manually
_run("doImport", input, null, function(obj, item) {
if(item) {
test.items.push(Zotero_TranslatorTester._sanitizeItem(item));
}
}, null, function(){
listcell.setAttribute("label", "New unsaved test");
listitem.setUserData("test-string", JSON.stringify(test), null);
});
}
}
/*
* populate tests pane
*/
function populateTests() {
_clearTests();
var tests = _loadTests(_editors["tests"].getSession().getValue());
// We've got tests, let's display them
var listbox = document.getElementById("testing-listbox");
for each (var test in tests) {
var listitem = document.createElement("listitem");
var listcell = document.createElement("listcell");
if (test.type == "web")
listcell.setAttribute("label", test.url);
else if (test.type == "import")
// trim label to improve performance
listcell.setAttribute("label", test.input.substr(0,80));
else continue; // unknown test type
listitem.appendChild(listcell);
listcell = document.createElement("listcell");
listcell.setAttribute("label", "Not run");
listitem.appendChild(listcell);
// Put the serialized JSON in user data
listitem.setUserData("test-string", JSON.stringify(test), null);
listbox.appendChild(listitem);
}
}
/*
* Save tests back to translator, and save the translator
*/
function saveTests() {
var tests = [];
var item;
var i = 0;
var listbox = document.getElementById("testing-listbox");
var count = listbox.itemCount;
while(i < count){
item = listbox.getItemAtIndex(i);
if(item.getElementsByTagName("listcell")[1].getAttribute("label") === "New unsaved test") {
item.getElementsByTagName("listcell")[1].setAttribute("label", "New test");
}
var test = item.getUserData("test-string");
if(test) tests.push(JSON.parse(test));
i++;
}
_writeTests(_stringifyTests(tests));
save();
}
/*
* Delete selected test(s), from UI
*/
function deleteSelectedTests() {
var listbox = document.getElementById("testing-listbox");
var count = listbox.selectedCount;
while (count--) {
var item = listbox.selectedItems[0];
listbox.removeItemAt(listbox.getIndexOfItem(item));
}
}
/*
* Load the import input for the first selected test in the import pane,
* from the UI.
*/
function editImportFromTest() {
var listbox = document.getElementById("testing-listbox");
var item = listbox.selectedItems[0];
var test = JSON.parse(item.getUserData("test-string"));
if (test.input === undefined) {
_logOutput("Can't edit import data for a non-import test.");
}
_editors["import"].getSession().setValue(test.input);
}
/*
* Run selected test(s)
*/
function runSelectedTests() {
_clearOutput();
var listbox = document.getElementById("testing-listbox");
var items = listbox.selectedItems;
if(!items || items.length == 0) return false; // No action if nothing selected
var i;
var webtests = [];
var importtests = [];
for (i in items) {
items[i].getElementsByTagName("listcell")[1].setAttribute("label", "Running");
var test = JSON.parse(items[i].getUserData("test-string"));
test["ui-item"] = items[i];
if (test.type == "web") webtests.push(test);
if (test.type == "import") importtests.push(test);
}
if (webtests.length > 0) {
var webtester = new Zotero_TranslatorTester(_getTranslator(), "web", _debug);
webtester.setTests(webtests);
webtester.runTests(function(obj, test, status, message) {
test["ui-item"].getElementsByTagName("listcell")[1].setAttribute("label", message);
});
}
if (importtests.length > 0 ) {
var importtester = new Zotero_TranslatorTester(_getTranslator(), "import", _debug);
importtester.setTests(importtests);
importtester.runTests(function(obj, test, status, message) {
test["ui-item"].getElementsByTagName("listcell")[1].setAttribute("label", message);
});
}
}
/*
* Update selected test(s)
*/
function updateSelectedTests() {
_clearOutput();
var listbox = document.getElementById("testing-listbox");
var items = listbox.selectedItems.slice();
if(!items || items.length == 0) return false; // No action if nothing selected
var i;
var tests = [];
for (i in items) {
items[i].getElementsByTagName("listcell")[1].setAttribute("label", "Updating");
var test = JSON.parse(items[i].getUserData("test-string"));
tests.push(test);
}
var updater = new TestUpdater(tests);
var testsDone = 0;
updater.updateTests(
function(newTest) {
// Assume sequential. TODO: handle this properly via test ID of some sort
if(newTest) {
message = "Test updated";
//Zotero.debug(newTest[testsDone]);
items[testsDone].setUserData("test-string", JSON.stringify(newTest), null);
} else {
message = "Update failed"
}
items[testsDone].getElementsByTagName("listcell")[1].setAttribute("label", message);
testsDone++;
},
function() {
_logOutput("Tests updated.");
// Save tests
_logOutput("Saving tests and translator.");
saveTests();
}
);
}
var TestUpdater = function(tests) {
this.testsToUpdate = tests.slice();
this.numTestsTotal = this.testsToUpdate.length;
this.newTests = [];
this.tester = new Zotero_TranslatorTester(_getTranslator(), "web", _debug);
}
TestUpdater.prototype.updateTests = function(testDoneCallback, doneCallback) {
this.testDoneCallback = testDoneCallback || function() { /* no-op */};