| 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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362 |
1×
1×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
6×
1×
1×
1×
1×
1×
1×
3×
3×
3×
3×
3×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
| 'use strict';
var log = require('./Log.js').Logger('libZotero:Library');
/**
* A user or group Zotero library. This is generally the top level object
* through which interactions should happen. It houses containers for
* Zotero API objects (collections, items, etc) and handles making requests
* with particular API credentials, as well as storing data locally.
* @param {string} type type of library, 'user' or 'group'
* @param {int} libraryID ID of the library
* @param {string} libraryUrlIdentifier identifier used in urls, could be library id or user/group slug
* @param {string} apiKey key to use for API requests
*/
var Library = function(type, libraryID, libraryUrlIdentifier, apiKey){
log.debug('Zotero.Library constructor', 3);
log.debug('Library Constructor: ' + type + ' ' + libraryID + ' ', 3);
var library = this;
log.debug(libraryUrlIdentifier, 4);
library.instance = 'Zotero.Library';
library.libraryVersion = 0;
library.syncState = {
earliestVersion: null,
latestVersion: null
};
library._apiKey = apiKey || '';
library.libraryUrlIdentifier = libraryUrlIdentifier;
Eif(Zotero.config.librarySettings){
library.libraryBaseWebsiteUrl = Zotero.config.librarySettings.libraryPathString;
}
else{
library.libraryBaseWebsiteUrl = Zotero.config.baseWebsiteUrl;
if(type == 'group'){
library.libraryBaseWebsiteUrl += 'groups/';
}
if(libraryUrlIdentifier){
this.libraryBaseWebsiteUrl += libraryUrlIdentifier + '/items';
} else {
log.warn('no libraryUrlIdentifier specified');
}
}
//object holders within this library, whether tied to a specific library or not
library.items = new Zotero.Items();
library.items.owningLibrary = library;
library.itemKeys = [];
library.collections = new Zotero.Collections();
library.collections.libraryUrlIdentifier = library.libraryUrlIdentifier;
library.collections.owningLibrary = library;
library.tags = new Zotero.Tags();
library.searches = new Zotero.Searches();
library.searches.owningLibrary = library;
library.groups = new Zotero.Groups();
library.groups.owningLibrary = library;
library.deleted = new Zotero.Deleted();
library.deleted.owningLibrary = library;
Iif(!type){
//return early if library not specified
log.warn('No type specified for library');
return;
}
//attributes tying instance to a specific Zotero library
library.type = type;
library.libraryType = type;
library.libraryID = libraryID;
library.libraryString = Zotero.utils.libraryString(library.libraryType, library.libraryID);
library.libraryUrlIdentifier = libraryUrlIdentifier;
//initialize preferences object
library.preferences = new Zotero.Preferences(Zotero.store, library.libraryString);
Eif(typeof window === 'undefined') {
Zotero.config.useIndexedDB = false;
log.warn('Node detected; disabling indexedDB');
} else {
//initialize indexedDB if we're supposed to use it
//detect safari until they fix their shit
var is_chrome = navigator.userAgent.indexOf('Chrome') > -1;
var is_explorer = navigator.userAgent.indexOf('MSIE') > -1;
var is_firefox = navigator.userAgent.indexOf('Firefox') > -1;
var is_safari = navigator.userAgent.indexOf('Safari') > -1;
var is_opera = navigator.userAgent.toLowerCase().indexOf('op') > -1;
if ((is_chrome)&&(is_safari)) {is_safari=false;}
if ((is_chrome)&&(is_opera)) {is_chrome=false;}
if(is_safari) {
Zotero.config.useIndexedDB = false;
log.warn('Safari detected; disabling indexedDB');
}
}
Iif(Zotero.config.useIndexedDB === true) {
log.debug('Library Constructor: indexedDB init', 3);
var idbLibrary = new Zotero.Idb.Library(library.libraryString);
idbLibrary.owningLibrary = this;
library.idbLibrary = idbLibrary;
library.cachedDataPromise = idbLibrary.init()
.then(function(){
log.debug('Library Constructor: idbInitD Done', 3);
if(Zotero.config.preloadCachedLibrary === true){
log.debug('Library Constructor: preloading cached library', 3);
var cacheLoadD = library.loadIndexedDBCache();
cacheLoadD.then(function(){
//TODO: any stuff that needs to execute only after cache is loaded
//possibly fire new events to cause display to refresh after load
log.debug('Library Constructor: Library.items.itemsVersion: ' + library.items.itemsVersion, 3);
log.debug('Library Constructor: Library.collections.collectionsVersion: ' + library.collections.collectionsVersion, 3);
log.debug('Library Constructor: Library.tags.tagsVersion: ' + library.tags.tagsVersion, 3);
log.debug('Library Constructor: Triggering cachedDataLoaded', 3);
library.trigger('cachedDataLoaded');
},
function(err){
log.error('Error loading cached library');
log.error(err);
throw new Error('Error loading cached library');
});
return cacheLoadD;
}
else {
//trigger cachedDataLoaded since we are done with that step
library.trigger('cachedDataLoaded');
}
},
function(){
//can't use indexedDB. Set to false in config and trigger error to notify user
Zotero.config.useIndexedDB = false;
library.trigger('indexedDBError');
library.trigger('cachedDataLoaded');
log.error('Error initializing indexedDB. Promise rejected.');
//don't re-throw error, since we can still load data from the API
});
} else {
library.cachedDataPromise = Promise.resolve();
}
library.dirty = false;
//set noop data-change callbacks
library.tagsChanged = function(){};
library.collectionsChanged = function(){};
library.itemsChanged = function(){};
};
/**
* Items columns for which sorting is supported
* @type {Array}
*/
Library.prototype.sortableColumns = ['title',
'creator',
'itemType',
'date',
'year',
'publisher',
'publicationTitle',
'journalAbbreviation',
'language',
'accessDate',
'libraryCatalog',
'callNumber',
'rights',
'dateAdded',
'dateModified',
/*'numChildren',*/
'addedBy'
/*'modifiedBy'*/];
/**
* Columns that can be displayed in an items table UI
* @type {Array}
*/
Library.prototype.displayableColumns = ['title',
'creator',
'itemType',
'date',
'year',
'publisher',
'publicationTitle',
'journalAbbreviation',
'language',
'accessDate',
'libraryCatalog',
'callNumber',
'rights',
'dateAdded',
'dateModified',
'numChildren',
'addedBy'
/*'modifiedBy'*/];
/**
* Items columns that only apply to group libraries
* @type {Array}
*/
Library.prototype.groupOnlyColumns = ['addedBy'
/*'modifiedBy'*/];
/**
* Sort function that converts strings to locale lower case before comparing,
* however this is still not particularly effective at getting correct localized
* sorting in modern browsers due to browser implementations being poor. What we
* really want here is to strip diacritics first.
* @param {string} a [description]
* @param {string} b [description]
* @return {int} [description]
*/
Library.prototype.comparer = function(){
if(Intl){
return new Intl.Collator().compare;
} else {
return function(a, b){
if(a.toLocaleLowerCase() == b.toLocaleLowerCase()){
return 0;
}
if(a.toLocaleLowerCase() < b.toLocaleLowerCase()){
return -1;
}
return 1;
};
}
};
//Zotero library wrapper around jQuery ajax that returns a jQuery promise
//@url String url to request or object for input to apiRequestUrl and query string
//@type request method
//@options jquery options that are not the default for Zotero requests
Library.prototype.ajaxRequest = function(url, type, options){
log.debug('Library.ajaxRequest', 3);
if(!type){
type = 'GET';
}
if(!options){
options = {};
}
var requestObject = {
url: url,
type: type
};
requestObject = Z.extend({}, requestObject, options);
if(!requestObject.key && (this._apiKey != '')){
requestObject.key = this._apiKey;
}
log.debug(requestObject, 3);
return Zotero.net.queueRequest(requestObject);
};
//Take an array of objects that specify Zotero API requests and perform them
//in sequence.
//return deferred that gets resolved when all requests have gone through.
//Update versions after each request, otherwise subsequent writes won't go through.
//or do we depend on specified callbacks to update versions if necessary?
//fail on error?
//request object must specify: url, method, body, headers, success callback, fail callback(?)
/**
* Take an array of objects that specify Zotero API requests and perform them
* in sequence. Return a promise that gets resolved when all requests have
* gone through.
* @param {[] Objects} requests Array of objects specifying requests to be made
* @return {Promise} Promise that resolves/rejects along with requests
*/
Library.prototype.sequentialRequests = function(requests){
log.debug('Zotero.Library.sequentialRequests', 3);
let modRequests = requests.map((request)=>{
Iif(!request.key && (this._apiKey != '')){
request.key = this._apiKey;
}
return request;
});
return Zotero.net.queueRequest(modRequests);
};
/**
* Generate a website url based on a dictionary of variables and the configured
* libraryBaseWebsiteUrl
* @param {Object} urlvars Dictionary of key/value variables
* @return {string} website url
*/
Library.prototype.websiteUrl = function(urlvars){
log.debug('Zotero.library.websiteUrl', 3);
log.debug(urlvars, 4);
var library = this;
var urlVarsArray = [];
Object.keys(urlvars).forEach(function(key){
var value = urlvars[key];
if(value === '') return;
urlVarsArray.push(key + '/' + value);
});
urlVarsArray.sort();
log.debug(urlVarsArray, 4);
var pathVarsString = urlVarsArray.join('/');
return library.libraryBaseWebsiteUrl + '/' + pathVarsString;
};
Library.prototype.synchronize = function(){
//get updated group metadata if applicable
// (this is an individual library method, so only necessary if this is
// a group library and we want to keep info about it)
//sync library data
// get updated collections versions newer than current library version
// get updated searches versions newer than current library version
// get updated item versions newer than current library version
//
};
/**
* Make and process API requests to update the local library items based on the
* versions we have locally. When the promise is resolved, we should have up to
* date items in this library's items container, as well as saved to indexedDB
* if configured to use it.
* @return {Promise} Promise
*/
Library.prototype.loadUpdatedItems = function(){
log.debug('Zotero.Library.loadUpdatedItems', 3);
var library = this;
//sync from the libraryVersion if it exists, otherwise use the itemsVersion, which is likely
//derived from the most recent version of any individual item we have.
var syncFromVersion = library.libraryVersion ? library.libraryVersion : library.items.itemsVersion;
return Promise.resolve(library.updatedVersions('items', syncFromVersion))
.then(function(response){
log.debug('itemVersions resolved', 3);
log.debug('items Last-Modified-Version: ' + response.lastModifiedVersion, 3);
library.items.updateSyncState(response.lastModifiedVersion);
var itemVersions = response.data;
library.itemVersions = itemVersions;
var itemKeys = [];
Object.keys(itemVersions).forEach(function(key){
var val = itemVersions[key];
var item = library.items.getItem(key);
if((!item) || (item.apiObj.key != val)){
itemKeys.push(key);
}
});
return library.loadItemsFromKeys(itemKeys);
}).then(function(responses){
log.debug('loadItemsFromKeys resolved', 3);
library.items.updateSyncedVersion();
//TODO: library needs its own state
if(Zotero.state) {
var displayParams = Zotero.state.getUrlVars();
library.buildItemDisplayView(displayParams);
}
//save updated items to IDB
if(Zotero.config.useIndexedDB){
var saveItemsD = library.idbLibrary.updateItems(library.items.objectArray);
}
});
};
Library.prototype.loadUpdatedCollections = function(){
log.debug('Zotero.Library.loadUpdatedCollections', 3);
var library = this;
//sync from the libraryVersion if it exists, otherwise use the collectionsVersion, which is likely
//derived from the most recent version of any individual collection we have.
log.debug('library.collections.collectionsVersion:' + library.collections.collectionsVersion, 4);
//var syncFromVersion = library.libraryVersion ? library.libraryVersion : library.collections.collectionsVersion;
var syncFromVersion = library.collections.collectionsVersion;
log.debug(`loadUpdatedCollections syncFromVersion: ${syncFromVersion}`, 3);
//we need modified collectionKeys regardless, so load them
return library.updatedVersions('collections', syncFromVersion)
.then(function(response){
log.debug('collectionVersions finished', 3);
log.debug('Collections Last-Modified-Version: ' + response.lastModifiedVersion, 3);
//start the syncState version tracking. This should be the earliest version throughout
library.collections.updateSyncState(response.lastModifiedVersion);
var collectionVersions = response.data;
library.collectionVersions = collectionVersions;
var collectionKeys = [];
Object.keys(collectionVersions).forEach(function(key){
var val = collectionVersions[key];
var c = library.collections.getCollection(key);
if((!c) || (c.apiObj.version != val)){
collectionKeys.push(key);
}
});
if(collectionKeys.length === 0){
log.debug('No collectionKeys need updating. resolving', 3);
return response;
}
else {
log.debug('fetching collections by key', 3);
return library.loadCollectionsFromKeys(collectionKeys)
.then(function(){
var collections = library.collections;
collections.initSecondaryData();
log.debug('All updated collections loaded', 3);
library.collections.updateSyncedVersion();
//TODO: library needs its own state
//save updated collections to cache
log.debug('loadUpdatedCollections complete - saving collections to cache before resolving', 3);
log.debug('collectionsVersion: ' + library.collections.collectionsVersion, 3);
//library.saveCachedCollections();
//save updated collections to IDB
if(Zotero.config.useIndexedDB){
return library.idbLibrary.updateCollections(collections.collectionsArray);
}
});
}
})
.then(function(){
log.debug('done getting collection data. requesting deleted data', 3);
return library.getDeleted(library.libraryVersion);
})
.then(function(response){
log.debug('got deleted collections data: removing local copies', 3);
log.debug(library.deleted, 3);
if(library.deleted.deletedData.collections && library.deleted.deletedData.collections.length > 0 ){
library.collections.removeLocalCollections(library.deleted.deletedData.collections);
}
});
};
Library.prototype.loadUpdatedTags = function(){
log.debug('Zotero.Library.loadUpdatedTags', 3);
var library = this;
log.debug('tagsVersion: ' + library.tags.tagsVersion, 3);
return Promise.resolve(library.loadAllTags({since:library.tags.tagsVersion}))
.then(function(){
log.debug('done getting tags, request deleted tags data', 3);
return library.getDeleted(library.libraryVersion);
})
.then(function(response){
log.debug('got deleted tags data', 3);
if(library.deleted.deletedData.tags && library.deleted.deletedData.tags.length > 0 ){
library.tags.removeTags(library.deleted.deletedData.tags);
}
//save updated tags to IDB
if(Zotero.config.useIndexedDB){
log.debug('saving updated tags to IDB', 3);
var saveTagsD = library.idbLibrary.updateTags(library.tags.tagsArray);
}
});
};
Library.prototype.getDeleted = function(version) {
log.debug('Zotero.Library.getDeleted', 3);
var library = this;
var urlconf = {
target:'deleted',
libraryType:library.libraryType,
libraryID:library.libraryID,
since:version
};
//if there is already a request working, create a new promise to resolve
//when the actual request finishes
if(library.deleted.pending){
log.debug('getDeleted resolving with previously pending promise', 3);
return Promise.resolve(library.deleted.pendingPromise);
}
//don't fetch again if version we'd be requesting is between
//deleted.newer and delete.deleted versions, just use that one
log.debug('version:' + version, 3);
log.debug('sinceVersion:' + library.deleted.sinceVersion, 3);
log.debug('untilVersion:' + library.deleted.untilVersion, 3);
if(library.deleted.untilVersion &&
version >= library.deleted.sinceVersion /*&&
version < library.deleted.untilVersion*/){
log.debug('deletedVersion matches requested: immediately resolving', 3);
return Promise.resolve(library.deleted.deletedData);
}
library.deleted.pending = true;
library.deleted.pendingPromise = library.ajaxRequest(urlconf)
.then(function(response){
log.debug('got deleted response', 3);
library.deleted.deletedData = response.data;
log.debug('Deleted Last-Modified-Version:' + response.lastModifiedVersion, 3);
library.deleted.untilVersion = response.lastModifiedVersion;
library.deleted.sinceVersion = version;
}).then(function(response){
log.debug('cleaning up deleted pending', 3);
library.deleted.pending = false;
library.deleted.pendingPromise = false;
});
return library.deleted.pendingPromise;
};
Library.prototype.processDeletions = function(deletions){
var library = this;
//process deleted collections
library.collections.processDeletions(deletions.collections);
//process deleted items
library.items.processDeletions(deletions.items);
};
//Get a full bibliography from the API for web based citating
Library.prototype.loadFullBib = function(itemKeys, style){
var library = this;
var itemKeyString = itemKeys.join(',');
var urlconfig = {
'target':'items',
'libraryType':library.libraryType,
'libraryID':library.libraryID,
'itemKey':itemKeyString,
'format':'bib',
'linkwrap':'1'
};
if(itemKeys.length == 1){
urlconfig.target = 'item';
}
if(style){
urlconfig['style'] = style;
}
var loadBibPromise = library.ajaxRequest(urlconfig)
.then(function(response){
return response.data;
});
return loadBibPromise;
};
//load bib for a single item from the API
Library.prototype.loadItemBib = function(itemKey, style) {
log.debug('Zotero.Library.loadItemBib', 3);
var library = this;
var urlconfig = {
'target':'item',
'libraryType':library.libraryType,
'libraryID':library.libraryID,
'itemKey':itemKey,
'content':'bib'
};
if(style){
urlconfig['style'] = style;
}
var itemBibPromise = library.ajaxRequest(urlconfig)
.then(function(response){
var item = new Zotero.Item(response.data);
var bibContent = item.apiObj.bib;
return bibContent;
});
return itemBibPromise;
};
//load library settings from Zotero API and return a promise that gets resolved with
//the Zotero.Preferences object for this library
Library.prototype.loadSettings = function() {
log.debug('Zotero.Library.loadSettings', 3);
var library = this;
var urlconfig = {
'target':'settings',
'libraryType':library.libraryType,
'libraryID':library.libraryID
};
return library.ajaxRequest(urlconfig)
.then(function(response){
var resultObject;
if(typeof response.data == 'string'){
resultObject = JSON.parse(response.data);
}
else {
resultObject = response.data;
}
//save the full settings object so we have it available if we need to write,
//even if it has settings we don't use or know about
library.preferences.setPref('settings', resultObject);
library.trigger('settingsLoaded');
return library.preferences;
});
};
//take an array of tags and return subset of tags that should be colored, along with
//the colors they should be
Library.prototype.matchColoredTags = function(tags) {
var library = this;
if(!library.tagColors){
//pull out the settings we know we care about so we can query them directly
let tagColors = [];
let settings = library.preferences.getPref('settings');
if(settings && settings.hasOwnProperty('tagColors')){
tagColors = settings.tagColors.value;
}
library.tagColors = new Zotero.TagColors(tagColors);
}
return library.tagColors.match(tags);
};
/**
* Duplicate existing Items from this library and save to foreignLibrary
* with relationships indicating the ties. At time of writing, Zotero client
* saves the relationship with either the destination group of two group
* libraries or the personal library.
* @param {Zotero.Item[]} items
* @param {Zotero.Library} foreignLibrary
* @return {Promise.Zotero.Item[]} - newly created items
*/
Library.prototype.sendToLibrary = function(items, foreignLibrary){
var foreignItems = [];
for(var i = 0; i < items.length; i++){
var item = items[i];
var transferData = item.emptyJsonItem();
transferData.data = Z.extend({}, items[i].apiObj.data);
//clear data that shouldn't be transferred:itemKey, collections
transferData.data.key = '';
transferData.data.version = 0;
transferData.data.collections = [];
delete transferData.data.dateModified;
delete transferData.data.dateAdded;
var newForeignItem = new Zotero.Item(transferData);
newForeignItem.pristine = Z.extend({}, newForeignItem.apiObj);
newForeignItem.initSecondaryData();
//set relationship to tie to old item
if(!newForeignItem.apiObj.data.relations){
newForeignItem.apiObj.data.relations = {};
}
newForeignItem.apiObj.data.relations['owl:sameAs'] = Zotero.url.relationUrl(item.owningLibrary.libraryType, item.owningLibrary.libraryID, item.key);
foreignItems.push(newForeignItem);
}
return foreignLibrary.items.writeItems(foreignItems);
};
/*METHODS FOR WORKING WITH THE ENTIRE LIBRARY -- NOT FOR GENERAL USE */
//sync pull:
//upload changed data
// get updatedVersions for collections
// get updatedVersions for searches
// get upatedVersions for items
// (sanity check versions we have for individual objects?)
// loadCollectionsFromKeys
// loadSearchesFromKeys
// loadItemsFromKeys
// process updated objects:
// ...
// getDeletedData
// process deleted
// checkConcurrentUpdates (compare Last-Modified-Version from collections?newer request to one from /deleted request)
Library.prototype.updatedVersions = function(target='items', version=this.libraryVersion){
log.debug('Library.updatedVersions', 3);
var library = this;
var urlconf = {
target: target,
format: 'versions',
libraryType: library.libraryType,
libraryID: library.libraryID,
since: version
};
return library.ajaxRequest(urlconf);
};
//Download and save information about every item in the library
//keys is an array of itemKeys from this library that we need to download
Library.prototype.loadItemsFromKeys = function(keys){
log.debug('Zotero.Library.loadItemsFromKeys', 3);
var library = this;
return library.loadFromKeys(keys, 'items');
};
//keys is an array of collectionKeys from this library that we need to download
Library.prototype.loadCollectionsFromKeys = function(keys){
log.debug('Zotero.Library.loadCollectionsFromKeys', 3);
var library = this;
return library.loadFromKeys(keys, 'collections');
};
//keys is an array of searchKeys from this library that we need to download
Library.prototype.loadSeachesFromKeys = function(keys){
log.debug('Zotero.Library.loadSearchesFromKeys', 3);
var library = this;
return library.loadFromKeys(keys, 'searches');
};
Library.prototype.loadFromKeys = function(keys, objectType){
log.debug('Zotero.Library.loadFromKeys', 3);
if(!objectType) objectType = 'items';
var library = this;
var keyslices = [];
while(keys.length > 0){
keyslices.push(keys.splice(0, 50));
}
var requestObjects = [];
keyslices.forEach(function(keyslice){
var keystring = keyslice.join(',');
switch (objectType) {
case 'items':
requestObjects.push({
url: {
'target':'items',
'targetModifier':null,
'itemKey':keystring,
'limit':50,
'libraryType':library.libraryType,
'libraryID':library.libraryID
},
type: 'GET',
success: library.processLoadedItems.bind(library)
});
break;
case 'collections':
requestObjects.push({
url: {
'target':'collections',
'targetModifier':null,
'collectionKey':keystring,
'limit':50,
'libraryType':library.libraryType,
'libraryID':library.libraryID
},
type: 'GET',
success: library.processLoadedCollections.bind(library)
});
break;
case 'searches':
requestObjects.push({
url: {
'target':'searches',
'targetModifier':null,
'searchKey':keystring,
'limit':50,
'libraryType':library.libraryType,
'libraryID':library.libraryID
},
type: 'GET'
//success: library.processLoadedSearches.bind(library)
});
break;
}
});
var promises = [];
for(var i = 0; i < requestObjects.length; i++){
let url = requestObjects[i].url;
let type = requestObjects[i].type;
let options = {
success: requestObjects[i].success
};
promises.push(library.ajaxRequest(url, type, options));
}
return Promise.all(promises);
};
//publishes: displayedItemsUpdated
//assume we have up to date information about items in indexeddb.
//build a list of indexedDB filter requests to then intersect to get final result
Library.prototype.buildItemDisplayView = function(params) {
log.debug('Zotero.Library.buildItemDisplayView', 3);
log.debug(params, 4);
//start with list of all items if we don't have collectionKey
//otherwise get the list of items in that collection
var library = this;
//short-circuit if we don't have an initialized IDB yet
if(!library.idbLibrary.db){
return Promise.resolve([]);
}
var filterPromises = [];
if(params.collectionKey){
if(params.collectionKey == 'trash'){
filterPromises.push(library.idbLibrary.filterItems('deleted', 1));
}
else{
filterPromises.push(library.idbLibrary.filterItems('collectionKeys', params.collectionKey));
}
}
else {
filterPromises.push(library.idbLibrary.getOrderedItemKeys('title'));
}
//filter by selected tags
var selectedTags = params.tag || [];
if(typeof selectedTags == 'string') selectedTags = [selectedTags];
for(var i = 0; i < selectedTags.length; i++){
log.debug('adding selected tag filter', 3);
filterPromises.push(library.idbLibrary.filterItems('itemTagStrings', selectedTags[i]));
}
//TODO: filter by search term.
//(need full text array or to decide what we're actually searching on to implement this locally)
//when all the filters have been applied, combine and sort
return Promise.all(filterPromises)
.then(function(results){
var i;
for(i = 0; i < results.length; i++){
log.debug('result from filterPromise: ' + results[i].length, 3);
log.debug(results[i], 3);
}
var finalItemKeys = library.idbLibrary.intersectAll(results);
var itemsArray = library.items.getItems(finalItemKeys);
log.debug('All filters applied - Down to ' + itemsArray.length + ' items displayed', 3);
log.debug('remove child items and, if not viewing trash, deleted items', 3);
var displayItemsArray = [];
for(i = 0; i < itemsArray.length; i++){
if(itemsArray[i].apiObj.data.parentItem){
continue;
}
if(params.collectionKey != 'trash' && itemsArray[i].apiObj.deleted){
continue;
}
displayItemsArray.push(itemsArray[i]);
}
//sort displayedItemsArray by given or configured column
var orderCol = params['order'] || 'title';
var sort = params['sort'] || 'asc';
log.debug('Sorting by ' + orderCol + ' - ' + sort, 3);
var comparer = Zotero.Library.prototype.comparer();
displayItemsArray.sort(function(a, b){
var aval = a.get(orderCol);
var bval = b.get(orderCol);
return comparer(aval, bval);
});
if(sort == 'desc'){
log.debug('sort is desc - reversing array', 4);
displayItemsArray.reverse();
}
//publish event signalling we're done
log.debug('triggering publishing displayedItemsUpdated', 3);
library.trigger('displayedItemsUpdated');
return displayItemsArray;
});
};
Library.prototype.trigger = function(eventType, data){
var library = this;
Zotero.trigger(eventType, data, library.libraryString);
};
Library.prototype.listen = function(events, handler, data){
var library = this;
var filter = library.libraryString;
Zotero.listen(events, handler, data, filter);
};
//CollectionFunctions
Library.prototype.processLoadedCollections = function(response){
log.debug('processLoadedCollections', 3);
var library = this;
//clear out display items
log.debug('adding collections to library.collections', 3);
var collectionsAdded = library.collections.addCollectionsFromJson(response.data);
for (var i = 0; i < collectionsAdded.length; i++) {
collectionsAdded[i].associateWithLibrary(library);
}
//update sync state
library.collections.updateSyncState(response.lastModifiedVersion);
Zotero.trigger('loadedCollectionsProcessed', {library:library, collectionsAdded:collectionsAdded});
return response;
};
//create+write a collection given a name and optional parentCollectionKey
Library.prototype.addCollection = function(name, parentCollection){
log.debug('Zotero.Library.addCollection', 3);
var library = this;
var collection = new Zotero.Collection();
collection.associateWithLibrary(library);
collection.set('name', name);
collection.set('parentCollection', parentCollection);
return library.collections.writeCollections([collection]);
};
//ItemFunctions
//make request for item keys and return jquery ajax promise
Library.prototype.fetchItemKeys = function(config={}){
log.debug('Zotero.Library.fetchItemKeys', 3);
var library = this;
var urlconfig = Z.extend(true, {
'target':'items',
'libraryType':this.libraryType,
'libraryID':this.libraryID,
'format':'keys'
}, config);
return library.ajaxRequest(urlconfig);
};
//get keys of all items marked for deletion
Library.prototype.getTrashKeys = function(){
log.debug('Zotero.Library.getTrashKeys', 3);
var library = this;
var urlconfig = {
'target': 'items',
'libraryType': library.libraryType,
'libraryID': library.libraryID,
'format': 'keys',
'collectionKey': 'trash'
};
return library.ajaxRequest(urlconfig);
};
Library.prototype.emptyTrash = function(){
log.debug('Zotero.Library.emptyTrash', 3);
var library = this;
return library.getTrashKeys()
.then(function(response){
var trashedItemKeys = response.data.split('\n');
return library.items.deleteItems(trashedItemKeys, response.lastModifiedVersion);
});
};
//gets the full set of item keys that satisfy `config`
Library.prototype.loadItemKeys = function(config){
log.debug('Zotero.Library.loadItemKeys', 3);
var library = this;
return this.fetchItemKeys(config)
.then(function(response){
log.debug('loadItemKeys proxied callback', 3);
var keys = response.data.split(/[\s]+/);
library.itemKeys = keys;
});
};
//loads a set of items specified by `config`
//The items are added to this Library's items container, as well included as an array of Zotero.Item
//on the returned promise as `response.loadedItems`
Library.prototype.loadItems = function(config){
log.debug('Zotero.Library.loadItems', 3);
var library = this;
if(!config){
config = {};
}
var defaultConfig = {
target:'items',
targetModifier: 'top',
start: 0,
limit: 25,
order: Zotero.config.defaultSortColumn,
sort: Zotero.config.defaultSortOrder
};
//Build config object that should be displayed next and compare to currently displayed
var newConfig = Z.extend({}, defaultConfig, config);
//newConfig.start = parseInt(newConfig.limit, 10) * (parseInt(newConfig.itemPage, 10) - 1);
var urlconfig = Z.extend({
'target':'items',
'libraryType':library.libraryType,
'libraryID':library.libraryID
}, newConfig);
return library.ajaxRequest(urlconfig)
.then(function(response){
log.debug('loadItems proxied callback', 3);
//var library = this;
var items = library.items;
//clear out display items
var loadedItemsArray = items.addItemsFromJson(response.data);
for (let i = 0; i < loadedItemsArray.length; i++) {
loadedItemsArray[i].associateWithLibrary(library);
}
response.loadedItems = loadedItemsArray;
Zotero.trigger('itemsChanged', {library:library});
return response;
});
};
Library.prototype.loadPublications = function(config){
log.debug('Zotero.Library.loadPublications', 3);
var library = this;
if(!config){
config = {};
}
var defaultConfig = {
target:'publications',
start: 0,
limit: 50,
order: Zotero.config.defaultSortColumn,
sort: Zotero.config.defaultSortOrder,
include: 'bib'
};
//Build config object that should be displayed next and compare to currently displayed
var newConfig = Z.extend({}, defaultConfig, config);
var urlconfig = Z.extend({
'target':'publications',
'libraryType':library.libraryType,
'libraryID':library.libraryID
}, newConfig);
return library.ajaxRequest(urlconfig)
.then(function(response){
log.debug('loadPublications proxied callback', 3);
var publicationItems = [];
var parsedItemJson = response.data;
parsedItemJson.forEach(function(itemObj){
var item = new Zotero.Item(itemObj);
publicationItems.push(item);
});
response.publicationItems = publicationItems;
return response;
});
};
Library.prototype.processLoadedItems = function(response){
log.debug('processLoadedItems', 3);
var library = this;
var items = library.items;
//clear out display items
var loadedItemsArray = items.addItemsFromJson(response.data);
for (var i = 0; i < loadedItemsArray.length; i++) {
loadedItemsArray[i].associateWithLibrary(library);
}
//update sync state
library.items.updateSyncState(response.lastModifiedVersion);
Zotero.trigger('itemsChanged', {library:library, loadedItems:loadedItemsArray});
return response;
};
Library.prototype.loadItem = function(itemKey) {
log.debug('Zotero.Library.loadItem', 3);
var library = this;
if(!config){
var config = {};
}
var urlconfig = {
'target':'item',
'libraryType':library.libraryType,
'libraryID':library.libraryID,
'itemKey':itemKey
};
return library.ajaxRequest(urlconfig)
.then(function(response){
log.debug('Got loadItem response', 3);
var item = new Zotero.Item(response.data);
item.owningLibrary = library;
library.items.itemObjects[item.key] = item;
Zotero.trigger('itemsChanged', {library:library});
return(item);
},
function(response){
log.warn('Error loading Item');
});
};
Library.prototype.trashItem = function(itemKey){
var library = this;
return library.items.trashItems([library.items.getItem(itemKey)]);
};
Library.prototype.untrashItem = function(itemKey){
log.debug('Zotero.Library.untrashItem', 3);
if(!itemKey) return false;
var item = this.items.getItem(itemKey);
item.apiObj.deleted = 0;
return item.writeItem();
};
Library.prototype.deleteItem = function(itemKey){
log.debug('Zotero.Library.deleteItem', 3);
var library = this;
return library.items.deleteItem(itemKey);
};
Library.prototype.deleteItems = function(itemKeys){
log.debug('Zotero.Library.deleteItems', 3);
var library = this;
return library.items.deleteItems(itemKeys);
};
Library.prototype.addNote = function(itemKey, note){
log.debug('Zotero.Library.prototype.addNote', 3);
var library = this;
var config = {
'target':'children',
'libraryType':library.libraryType,
'libraryID':library.libraryID,
'itemKey':itemKey
};
var item = this.items.getItem(itemKey);
return library.ajaxRequest(config, 'POST', {processData: false});
};
Library.prototype.fetchGlobalItems = function(config){
log.debug('Zotero.Library.fetchGlobalItems', 3);
var library = this;
if(!config){
config = {};
}
var defaultConfig = {
target:'items',
start: 0,
limit: 25
};
//Build config object that should be displayed next and compare to currently displayed
var newConfig = Z.extend({}, defaultConfig, config);
var urlconfig = Z.extend({'target':'items', 'libraryType': ''}, newConfig);
return library.ajaxRequest(urlconfig, 'GET', {dataType:'json'})
.then(function(response){
log.debug('globalItems callback', 3);
return(response.data);
});
};
Library.prototype.fetchGlobalItem = function(globalKey){
log.debug('Zotero.Library.fetchGlobalItem', 3);
log.debug(globalKey, 3);
var library = this;
var defaultConfig = {target:'item'};
//Build config object that should be displayed next and compare to currently displayed
var newConfig = Z.extend({}, defaultConfig);
var urlconfig = Z.extend({
'target':'item',
'libraryType': '',
'itemKey': globalKey
}, newConfig);
return library.ajaxRequest(urlconfig, 'GET', {dataType:'json'})
.then(function(response){
log.debug('globalItem callback', 3);
return(response.data);
});
};
//TagFunctions
Library.prototype.fetchTags = function(config){
log.debug('Zotero.Library.fetchTags', 3);
var library = this;
var defaultConfig = {
target:'tags',
order:'title',
sort:'asc',
limit: 100
};
var newConfig = Z.extend({}, defaultConfig, config);
var urlconfig = Z.extend({
'target':'tags',
'libraryType':this.libraryType,
'libraryID':this.libraryID
}, newConfig);
return Zotero.ajaxRequest(urlconfig);
};
Library.prototype.loadTags = function(config={}){
log.debug('Zotero.Library.loadTags', 3);
var library = this;
if(config.showAutomaticTags && config.collectionKey){
delete config.collectionKey;
}
library.tags.displayTagsArray = [];
return library.fetchTags(config)
.then(function(response){
log.debug('loadTags proxied callback', 3);
var updatedVersion = response.lastModifiedVersion;
library.tags.updateSyncState(updatedVersion);
var addedTags = library.tags.addTagsFromJson(response.data);
library.tags.updateTagsVersion(updatedVersion);
library.tags.rebuildTagsArray();
if(response.parsedLinks.hasOwnProperty('next')){
library.tags.hasNextLink = true;
library.tags.nextLink = response.parsedLinks['next'];
}
else{
library.tags.hasNextLink = false;
library.tags.nextLink = null;
}
library.trigger('tagsChanged', {library:library});
return library.tags;
});
};
Library.prototype.loadAllTags = function(config={}){
log.debug('Zotero.Library.loadAllTags', 3);
var library = this;
var defaultConfig = {
target:'tags',
order:'title',
sort:'asc',
limit: 100,
libraryType:library.libraryType,
libraryID:library.libraryID
};
//Build config object that should be displayed next and compare to currently displayed
var newConfig = Z.extend({}, defaultConfig, config);
var urlconfig = Z.extend({}, newConfig);
//check if already loaded tags are okay to use
return new Promise(function(resolve, reject){
var continueLoadingCallback = function(tags){
log.debug('loadAllTags continueLoadingCallback', 3);
var plainList = Zotero.Tags.prototype.plainTagsList(tags.tagsArray);
plainList.sort(Library.prototype.comparer());
tags.plainList = plainList;
if(tags.hasNextLink){
log.debug('still has next link.', 3);
tags.tagsArray.sort(Zotero.Tag.prototype.tagComparer());
plainList = Zotero.Tags.prototype.plainTagsList(tags.tagsArray);
plainList.sort(Library.prototype.comparer());
tags.plainList = plainList;
var nextLink = tags.nextLink;
var nextLinkConfig = Zotero.utils.parseQuery(Zotero.utils.querystring(nextLink));
var newConfig = Z.extend({}, config);
newConfig.start = nextLinkConfig.start;
newConfig.limit = nextLinkConfig.limit;
return library.loadTags(newConfig).then(continueLoadingCallback);
}
else{
log.debug('no next in tags link', 3);
tags.updateSyncedVersion();
tags.tagsArray.sort(Zotero.Tag.prototype.tagComparer());
plainList = Zotero.Tags.prototype.plainTagsList(tags.tagsArray);
plainList.sort(Library.prototype.comparer());
tags.plainList = plainList;
log.debug('resolving loadTags deferred', 3);
library.tagsLoaded = true;
library.tags.loaded = true;
tags.loadedConfig = config;
//update all tags with tagsVersion
for (var i = 0; i < library.tags.tagsArray.length; i++) {
tags.tagsArray[i].apiObj.version = tags.tagsVersion;
}
library.trigger('tagsChanged', {library:library});
return tags;
}
};
resolve( library.loadTags(urlconfig)
.then(continueLoadingCallback));
});
};
//LibraryCache
//load objects from indexedDB
Library.prototype.loadIndexedDBCache = function(){
log.debug('Zotero.Library.loadIndexedDBCache', 3);
var library = this;
var itemsPromise = library.idbLibrary.getAllItems();
var collectionsPromise = library.idbLibrary.getAllCollections();
var tagsPromise = library.idbLibrary.getAllTags();
itemsPromise.then(function(itemsArray){
log.debug('loadIndexedDBCache itemsD done', 3);
//create itemsDump from array of item objects
var latestItemVersion = 0;
for(var i = 0; i < itemsArray.length; i++){
var item = new Zotero.Item(itemsArray[i]);
library.items.addItem(item);
if(item.version > latestItemVersion){
latestItemVersion = item.version;
}
}
library.items.itemsVersion = latestItemVersion;
//TODO: add itemsVersion as last version in any of these items?
//or store it somewhere else for indexedDB cache purposes
library.items.loaded = true;
log.debug('Done loading indexedDB items promise into library', 3);
});
collectionsPromise.then(function(collectionsArray){
log.debug('loadIndexedDBCache collectionsD done', 3);
//create collectionsDump from array of collection objects
var latestCollectionVersion = 0;
for(var i = 0; i < collectionsArray.length; i++){
var collection = new Zotero.Collection(collectionsArray[i]);
library.collections.addCollection(collection);
if(collection.version > latestCollectionVersion){
latestCollectionVersion = collection.version;
}
}
library.collections.collectionsVersion = latestCollectionVersion;
//TODO: add collectionsVersion as last version in any of these items?
//or store it somewhere else for indexedDB cache purposes
library.collections.initSecondaryData();
library.collections.loaded = true;
});
tagsPromise.then(function(tagsArray){
log.debug('loadIndexedDBCache tagsD done', 3);
log.debug(tagsArray, 4);
//create tagsDump from array of tag objects
var latestVersion = 0;
var tagsVersion = 0;
for(var i = 0; i < tagsArray.length; i++){
var tag = new Zotero.Tag(tagsArray[i]);
library.tags.addTag(tag);
if(tagsArray[i].version > latestVersion){
latestVersion = tagsArray[i].version;
}
}
tagsVersion = latestVersion;
library.tags.tagsVersion = tagsVersion;
//TODO: add tagsVersion as last version in any of these items?
//or store it somewhere else for indexedDB cache purposes
library.tags.loaded = true;
});
//resolve the overall deferred when all the child deferreds are finished
return Promise.all([itemsPromise, collectionsPromise, tagsPromise]);
};
Library.prototype.saveIndexedDB = function(){
var library = this;
var saveItemsPromise = library.idbLibrary.updateItems(library.items.itemsArray);
var saveCollectionsPromise = library.idbLibrary.updateCollections(library.collections.collectionsArray);
var saveTagsPromise = library.idbLibrary.updateTags(library.tags.tagsArray);
//resolve the overall deferred when all the child deferreds are finished
return Promise.all([saveItemsPromise, saveCollectionsPromise, saveTagsPromise]);
};
module.exports = Library;
|