"use strict"; describe("Zotero.Item", function () { describe("#getField()", function () { it("should return an empty string for valid unset fields on unsaved items", function () { var item = new Zotero.Item('book'); assert.strictEqual(item.getField('rights'), ""); }); it("should return an empty string for valid unset fields on unsaved items after setting on another field", function () { var item = new Zotero.Item('book'); item.setField('title', 'foo'); assert.strictEqual(item.getField('rights'), ""); }); it("should return an empty string for invalid unset fields on unsaved items after setting on another field", function () { var item = new Zotero.Item('book'); item.setField('title', 'foo'); assert.strictEqual(item.getField('invalid'), ""); }); it("should return a firstCreator for an unsaved item", function* () { var item = createUnsavedDataObject('item'); item.setCreators([ { firstName: "A", lastName: "B", creatorType: "author" }, { firstName: "C", lastName: "D", creatorType: "editor" } ]); assert.equal(item.getField('firstCreator'), "B"); }); }); describe("#setField", function () { it("should throw an error if item type isn't set", function () { var item = new Zotero.Item; assert.throws(() => item.setField('title', 'test'), "Item type must be set before setting field data"); }) it("should mark a field as changed", function () { var item = new Zotero.Item('book'); item.setField('title', 'Foo'); assert.isTrue(item._changed.itemData[Zotero.ItemFields.getID('title')]); assert.isTrue(item.hasChanged()); }) it("should save an integer as a string", function* () { var val = 1234; var item = new Zotero.Item('book'); item.setField('numPages', val); yield item.saveTx(); assert.strictEqual(item.getField('numPages'), "" + val); // Setting again as string shouldn't register a change assert.isFalse(item.setField('numPages', "" + val)); // Value should be TEXT in the DB var sql = "SELECT TYPEOF(value) FROM itemData JOIN itemDataValues USING (valueID) " + "WHERE itemID=? AND fieldID=?"; var type = yield Zotero.DB.valueQueryAsync(sql, [item.id, Zotero.ItemFields.getID('numPages')]); assert.equal(type, 'text'); }); it("should save integer 0 as a string", function* () { var val = 0; var item = new Zotero.Item('book'); item.setField('numPages', val); yield item.saveTx(); assert.strictEqual(item.getField('numPages'), "" + val); // Setting again as string shouldn't register a change assert.isFalse(item.setField('numPages', "" + val)); }); it('should clear an existing field when ""/null/false is passed', function* () { var field = 'title'; var val = 'foo'; var fieldID = Zotero.ItemFields.getID(field); var item = new Zotero.Item('book'); item.setField(field, val); yield item.saveTx(); item.setField(field, ""); assert.ok(item._changed.itemData[fieldID]); assert.isTrue(item.hasChanged()); // Reset to original value yield item.reload(); assert.isFalse(item.hasChanged()); assert.equal(item.getField(field), val); // false item.setField(field, false); assert.ok(item._changed.itemData[fieldID]); assert.isTrue(item.hasChanged()); // Reset to original value yield item.reload(); assert.isFalse(item.hasChanged()); assert.equal(item.getField(field), val); // null item.setField(field, null); assert.ok(item._changed.itemData[fieldID]); assert.isTrue(item.hasChanged()); yield item.saveTx(); assert.equal(item.getField(field), ""); }) it('should clear a field set to "0" when a ""/null/false is passed', function* () { var field = 'title'; var val = "0"; var fieldID = Zotero.ItemFields.getID(field); var item = new Zotero.Item('book'); item.setField(field, val); yield item.saveTx(); assert.strictEqual(item.getField(field), val); // "" item.setField(field, ""); assert.ok(item._changed.itemData[fieldID]); assert.isTrue(item.hasChanged()); // Reset to original value yield item.reload(); assert.isFalse(item.hasChanged()); assert.strictEqual(item.getField(field), val); // False item.setField(field, false); assert.ok(item._changed.itemData[fieldID]); assert.isTrue(item.hasChanged()); // Reset to original value yield item.reload(); assert.isFalse(item.hasChanged()); assert.strictEqual(item.getField(field), val); // null item.setField(field, null); assert.ok(item._changed.itemData[fieldID]); assert.isTrue(item.hasChanged()); yield item.saveTx(); assert.strictEqual(item.getField(field), ""); }) it("should throw if value is undefined", function () { var item = new Zotero.Item('book'); assert.throws(() => item.setField('title'), "'title' value cannot be undefined"); }) it("should not mark an empty field set to an empty string as changed", function () { var item = new Zotero.Item('book'); item.setField('url', ''); assert.isUndefined(item._changed.itemData); }) it("should save version as object version", function* () { var item = new Zotero.Item('book'); item.setField("version", 1); var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); assert.equal(item.getField("version"), 1); assert.equal(item.version, 1); }); it("should save versionNumber for computerProgram", function* () { var item = new Zotero.Item('computerProgram'); item.setField("versionNumber", "1.0"); var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); assert.equal(item.getField("versionNumber"), "1.0"); }); it("should accept ISO 8601 dates", function* () { var fields = { accessDate: "2015-06-07T20:56:00Z", dateAdded: "2015-06-07T20:57:00Z", dateModified: "2015-06-07T20:58:00Z", }; var item = createUnsavedDataObject('item'); for (let i in fields) { item.setField(i, fields[i]); } assert.equal(item.getField('accessDate'), '2015-06-07 20:56:00'); assert.equal(item.dateAdded, '2015-06-07 20:57:00'); assert.equal(item.dateModified, '2015-06-07 20:58:00'); }) it("should accept SQL dates", function* () { var fields = { accessDate: "2015-06-07 20:56:00", dateAdded: "2015-06-07 20:57:00", dateModified: "2015-06-07 20:58:00", }; var item = createUnsavedDataObject('item'); for (let i in fields) { item.setField(i, fields[i]); item.getField(i, fields[i]); } }) it("should accept SQL accessDate without time", function* () { var item = createUnsavedDataObject('item'); var date = "2017-04-05"; item.setField("accessDate", date); assert.strictEqual(item.getField('accessDate'), date); }); it("should ignore unknown accessDate values", function* () { var fields = { accessDate: "foo" }; var item = createUnsavedDataObject('item'); for (let i in fields) { item.setField(i, fields[i]); } assert.strictEqual(item.getField('accessDate'), ''); }) }) describe("#dateAdded", function () { it("should use current time if value was not given for a new item", function* () { var item = new Zotero.Item('book'); var id = yield item.saveTx(); item = Zotero.Items.get(id); assert.closeTo(Zotero.Date.sqlToDate(item.dateAdded, true).getTime(), Date.now(), 2000); }) it("should use given value for a new item", function* () { var dateAdded = "2015-05-05 17:18:12"; var item = new Zotero.Item('book'); item.dateAdded = dateAdded; var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); assert.equal(item.dateAdded, dateAdded); }) }) describe("#dateModified", function () { it("should use given value for a new item", function* () { var dateModified = "2015-05-05 17:18:12"; var item = new Zotero.Item('book'); item.dateModified = dateModified; var id = yield item.saveTx(); assert.equal(item.dateModified, dateModified); item = yield Zotero.Items.getAsync(id); assert.equal(item.dateModified, dateModified); }) it("should use given value when skipDateModifiedUpdate is set for a new item", function* () { var dateModified = "2015-05-05 17:18:12"; var item = new Zotero.Item('book'); item.dateModified = dateModified; var id = yield item.saveTx({ skipDateModifiedUpdate: true }); assert.equal(item.dateModified, dateModified); item = yield Zotero.Items.getAsync(id); assert.equal(item.dateModified, dateModified); }) it("should use current time if value was not given for an existing item", function* () { var dateModified = "2015-05-05 17:18:12"; var item = new Zotero.Item('book'); item.dateModified = dateModified; var id = yield item.saveTx(); item = Zotero.Items.get(id); // Save again without changing Date Modified item.setField('title', 'Test'); yield item.saveTx() assert.closeTo(Zotero.Date.sqlToDate(item.dateModified, true).getTime(), Date.now(), 2000); }) it("should use current time if the existing value was given for an existing item", function* () { var dateModified = "2015-05-05 17:18:12"; var item = new Zotero.Item('book'); item.dateModified = dateModified; var id = yield item.saveTx(); item = Zotero.Items.get(id); // Set Date Modified to existing value item.setField('title', 'Test'); item.dateModified = dateModified; yield item.saveTx() assert.closeTo(Zotero.Date.sqlToDate(item.dateModified, true).getTime(), Date.now(), 2000); }) it("should use current time if value is not given when skipDateModifiedUpdate is set for a new item", function* () { var item = new Zotero.Item('book'); var id = yield item.saveTx({ skipDateModifiedUpdate: true }); item = yield Zotero.Items.getAsync(id); assert.closeTo(Zotero.Date.sqlToDate(item.dateModified, true).getTime(), Date.now(), 2000); }) it("should keep original value when skipDateModifiedUpdate is set for an existing item", function* () { var dateModified = "2015-05-05 17:18:12"; var item = new Zotero.Item('book'); item.dateModified = dateModified; var id = yield item.saveTx(); item = Zotero.Items.get(id); // Resave with skipDateModifiedUpdate item.setField('title', 'Test'); yield item.saveTx({ skipDateModifiedUpdate: true }) assert.equal(item.dateModified, dateModified); }) }) describe("#deleted", function () { it("should be set to true after save", function* () { var item = yield createDataObject('item'); item.deleted = true; // Sanity check for itemsTest#trash() assert.isTrue(item._changed.deleted); yield item.saveTx(); assert.ok(item.deleted); }) it("should be set to false after save", function* () { var collection = yield createDataObject('collection'); var item = createUnsavedDataObject('item'); item.deleted = true; yield item.saveTx(); item.deleted = false; yield item.saveTx(); assert.isFalse(item.deleted); }) }) describe("#inPublications", function () { it("should add item to publications table", function* () { var item = yield createDataObject('item'); item.inPublications = true; yield item.saveTx(); assert.ok(item.inPublications); assert.equal( (yield Zotero.DB.valueQueryAsync( "SELECT COUNT(*) FROM publicationsItems WHERE itemID=?", item.id)), 1 ); }) it("should be set to false after save", function* () { var collection = yield createDataObject('collection'); var item = createUnsavedDataObject('item'); item.inPublications = false; yield item.saveTx(); item.inPublications = false; yield item.saveTx(); assert.isFalse(item.inPublications); assert.equal( (yield Zotero.DB.valueQueryAsync( "SELECT COUNT(*) FROM publicationsItems WHERE itemID=?", item.id)), 0 ); }); it("should be invalid for linked-file attachments", function* () { var item = yield createDataObject('item', { inPublications: true }); var attachment = yield Zotero.Attachments.linkFromFile({ file: OS.Path.join(getTestDataDirectory().path, 'test.png'), parentItemID: item.id }); attachment.inPublications = true; var e = yield getPromiseError(attachment.saveTx()); assert.ok(e); assert.include(e.message, "Linked-file attachments cannot be added to My Publications"); }); it("should be invalid for group library items", function* () { var group = yield getGroup(); var item = yield createDataObject('item', { libraryID: group.libraryID }); item.inPublications = true; var e = yield getPromiseError(item.saveTx()); assert.ok(e); assert.equal(e.message, "Only items in user libraries can be added to My Publications"); }); }); describe("#parentID", function () { it("should create a child note", function* () { var item = new Zotero.Item('book'); var parentItemID = yield item.saveTx(); item = new Zotero.Item('note'); item.parentID = parentItemID; var childItemID = yield item.saveTx(); item = yield Zotero.Items.getAsync(childItemID); assert.ok(item.parentID); assert.equal(item.parentID, parentItemID); }); }); describe("#parentKey", function () { it("should be false for an unsaved attachment", function () { var item = new Zotero.Item('attachment'); assert.isFalse(item.parentKey); }); it("should be false on an unsaved non-attachment item", function () { var item = new Zotero.Item('book'); assert.isFalse(item.parentKey); }); it("should not be marked as changed setting to false on an unsaved item", function () { var item = new Zotero.Item('attachment'); item.attachmentLinkMode = 'linked_url'; item.parentKey = false; assert.isUndefined(item._changed.parentKey); }); it("should not mark item as changed if false and no existing parent", function* () { var item = new Zotero.Item('attachment'); item.attachmentLinkMode = 'linked_url'; item.url = "https://www.zotero.org/"; var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); item.parentKey = false; assert.isFalse(item.hasChanged()); }); it("should move a top-level note under another item", function* () { var noteItem = new Zotero.Item('note'); var id = yield noteItem.saveTx() noteItem = yield Zotero.Items.getAsync(id); var item = new Zotero.Item('book'); id = yield item.saveTx(); var { libraryID, key } = Zotero.Items.getLibraryAndKeyFromID(id); noteItem.parentKey = key; yield noteItem.saveTx(); assert.isFalse(noteItem.isTopLevelItem()); }) it("should remove top-level item from collections when moving it under another item", function* () { // Create a collection var collection = new Zotero.Collection; collection.name = "Test"; var collectionID = yield collection.saveTx(); // Create a top-level note and add it to a collection var noteItem = new Zotero.Item('note'); noteItem.addToCollection(collectionID); var id = yield noteItem.saveTx() noteItem = yield Zotero.Items.getAsync(id); var item = new Zotero.Item('book'); id = yield item.saveTx(); var { libraryID, key } = Zotero.Items.getLibraryAndKeyFromID(id); noteItem.parentKey = key; yield noteItem.saveTx(); assert.isFalse(noteItem.isTopLevelItem()); }) }); describe("#getCreators()", function () { it("should update after creators are removed", function* () { var item = createUnsavedDataObject('item'); item.setCreators([ { creatorType: "author", name: "A" } ]); yield item.saveTx(); assert.lengthOf(item.getCreators(), 1); item.setCreators([]); yield item.saveTx(); assert.lengthOf(item.getCreators(), 0); }); }); describe("#setCreators", function () { it("should accept an array of creators in API JSON format", function* () { var creators = [ { firstName: "First", lastName: "Last", creatorType: "author" }, { name: "Test Name", creatorType: "editor" } ]; var item = new Zotero.Item("journalArticle"); item.setCreators(creators); var id = yield item.saveTx(); item = Zotero.Items.get(id); assert.sameDeepMembers(item.getCreatorsJSON(), creators); }) it("should accept an array of creators in internal format", function* () { var creators = [ { firstName: "First", lastName: "Last", fieldMode: 0, creatorTypeID: 1 }, { firstName: "", lastName: "Test Name", fieldMode: 1, creatorTypeID: 2 } ]; var item = new Zotero.Item("journalArticle"); item.setCreators(creators); var id = yield item.saveTx(); item = Zotero.Items.get(id); assert.sameDeepMembers(item.getCreators(), creators); }) it("should clear creators if empty array passed", function () { var item = createUnsavedDataObject('item'); item.setCreators([ { firstName: "First", lastName: "Last", fieldMode: 0, creatorTypeID: 1 } ]); assert.lengthOf(item.getCreators(), 1); item.setCreators([]); assert.lengthOf(item.getCreators(), 0); }); }) describe("#getAttachments()", function () { it("#should return child attachments", function* () { var item = yield createDataObject('item'); var attachment = new Zotero.Item("attachment"); attachment.parentID = item.id; attachment.attachmentLinkMode = Zotero.Attachments.LINK_MODE_IMPORTED_FILE; yield attachment.saveTx(); var attachments = item.getAttachments(); assert.lengthOf(attachments, 1); assert.equal(attachments[0], attachment.id); }) it("#should ignore trashed child attachments by default", function* () { var item = yield createDataObject('item'); var attachment = new Zotero.Item("attachment"); attachment.parentID = item.id; attachment.attachmentLinkMode = Zotero.Attachments.LINK_MODE_IMPORTED_FILE; attachment.deleted = true; yield attachment.saveTx(); var attachments = item.getAttachments(); assert.lengthOf(attachments, 0); }) it("#should include trashed child attachments if includeTrashed=true", function* () { var item = yield createDataObject('item'); var attachment = new Zotero.Item("attachment"); attachment.parentID = item.id; attachment.attachmentLinkMode = Zotero.Attachments.LINK_MODE_IMPORTED_FILE; attachment.deleted = true; yield attachment.saveTx(); var attachments = item.getAttachments(true); assert.lengthOf(attachments, 1); assert.equal(attachments[0], attachment.id); }) it("#should return an empty array for an item with no attachments", function* () { var item = yield createDataObject('item'); assert.lengthOf(item.getAttachments(), 0); }) it("should update after an attachment is moved to another item", function* () { var item1 = yield createDataObject('item'); var item2 = yield createDataObject('item'); var item3 = new Zotero.Item('attachment'); item3.parentID = item1.id; item3.attachmentLinkMode = 'linked_url'; item3.setField('url', 'http://example.com'); yield item3.saveTx(); assert.lengthOf(item1.getAttachments(), 1); assert.lengthOf(item2.getAttachments(), 0); item3.parentID = item2.id; yield item3.saveTx(); assert.lengthOf(item1.getAttachments(), 0); assert.lengthOf(item2.getAttachments(), 1); }); }) describe("#getNotes()", function () { it("#should return child notes", function* () { var item = yield createDataObject('item'); var note = new Zotero.Item("note"); note.parentID = item.id; yield note.saveTx(); var notes = item.getNotes(); assert.lengthOf(notes, 1); assert.equal(notes[0], note.id); }) it("#should ignore trashed child notes by default", function* () { var item = yield createDataObject('item'); var note = new Zotero.Item("note"); note.parentID = item.id; note.deleted = true; yield note.saveTx(); var notes = item.getNotes(); assert.lengthOf(notes, 0); }) it("#should include trashed child notes if includeTrashed=true", function* () { var item = yield createDataObject('item'); var note = new Zotero.Item("note"); note.parentID = item.id; note.deleted = true; yield note.saveTx(); var notes = item.getNotes(true); assert.lengthOf(notes, 1); assert.equal(notes[0], note.id); }) it("#should return an empty array for an item with no notes", function* () { var item = yield createDataObject('item'); assert.lengthOf(item.getNotes(), 0); }); it("should update after a note is moved to another item", function* () { var item1 = yield createDataObject('item'); var item2 = yield createDataObject('item'); var item3 = yield createDataObject('item', { itemType: 'note', parentID: item1.id }); assert.lengthOf(item1.getNotes(), 1); assert.lengthOf(item2.getNotes(), 0); item3.parentID = item2.id; yield item3.saveTx(); assert.lengthOf(item1.getNotes(), 0); assert.lengthOf(item2.getNotes(), 1); }); }) describe("#attachmentCharset", function () { it("should get and set a value", function* () { var charset = 'utf-8'; var item = new Zotero.Item("attachment"); item.attachmentLinkMode = Zotero.Attachments.LINK_MODE_IMPORTED_FILE; item.attachmentCharset = charset; var itemID = yield item.saveTx(); assert.equal(item.attachmentCharset, charset); item = yield Zotero.Items.getAsync(itemID); assert.equal(item.attachmentCharset, charset); }) it("should not allow a numerical value", function* () { var charset = 1; var item = new Zotero.Item("attachment"); try { item.attachmentCharset = charset; } catch (e) { assert.equal(e.message, "Character set must be a string") return; } assert.fail("Numerical charset was allowed"); }) it("should not be marked as changed if not changed", function* () { var charset = 'utf-8'; var item = new Zotero.Item("attachment"); item.attachmentLinkMode = Zotero.Attachments.LINK_MODE_IMPORTED_FILE; item.attachmentCharset = charset; var itemID = yield item.saveTx(); item = yield Zotero.Items.getAsync(itemID); // Set charset to same value item.attachmentCharset = charset assert.isFalse(item.hasChanged()); }) }) describe("#attachmentFilename", function () { it("should get and set a filename for a stored file", function* () { var filename = "test.txt"; // Create parent item var item = new Zotero.Item("book"); var parentItemID = yield item.saveTx(); // Create attachment item var item = new Zotero.Item("attachment"); item.attachmentLinkMode = Zotero.Attachments.LINK_MODE_IMPORTED_FILE; item.parentID = parentItemID; var itemID = yield item.saveTx(); // Should be empty when unset assert.equal(item.attachmentFilename, ''); // Set filename item.attachmentFilename = filename; yield item.saveTx(); item = yield Zotero.Items.getAsync(itemID); // Check filename assert.equal(item.attachmentFilename, filename); // Check full path var file = Zotero.Attachments.getStorageDirectory(item); file.append(filename); assert.equal(item.getFilePath(), file.path); }); it.skip("should get and set a filename for a base-dir-relative file", function* () { }) }) describe("#attachmentPath", function () { it("should return an absolute path for a linked attachment", function* () { var file = getTestDataDirectory(); file.append('test.png'); var item = yield Zotero.Attachments.linkFromFile({ file }); assert.equal(item.attachmentPath, file.path); }) it("should return a prefixed path for an imported file", function* () { var file = getTestDataDirectory(); file.append('test.png'); var item = yield Zotero.Attachments.importFromFile({ file }); assert.equal(item.attachmentPath, "storage:test.png"); }) it("should set a prefixed relative path for a path within the defined base directory", function* () { var dir = getTestDataDirectory().path; var dirname = OS.Path.basename(dir); var baseDir = OS.Path.dirname(dir); Zotero.Prefs.set('saveRelativeAttachmentPath', true) Zotero.Prefs.set('baseAttachmentPath', baseDir) var file = OS.Path.join(dir, 'test.png'); var item = new Zotero.Item('attachment'); item.attachmentLinkMode = 'linked_file'; item.attachmentPath = file; assert.equal(item.attachmentPath, "attachments:data/test.png"); Zotero.Prefs.set('saveRelativeAttachmentPath', false) Zotero.Prefs.clear('baseAttachmentPath') }) it("should return a prefixed path for a linked attachment within the defined base directory", function* () { var dir = getTestDataDirectory().path; var dirname = OS.Path.basename(dir); var baseDir = OS.Path.dirname(dir); Zotero.Prefs.set('saveRelativeAttachmentPath', true) Zotero.Prefs.set('baseAttachmentPath', baseDir) var file = OS.Path.join(dir, 'test.png'); var item = yield Zotero.Attachments.linkFromFile({ file: Zotero.File.pathToFile(file) }); assert.equal(item.attachmentPath, "attachments:data/test.png"); Zotero.Prefs.set('saveRelativeAttachmentPath', false) Zotero.Prefs.clear('baseAttachmentPath') }) }) describe("#renameAttachmentFile()", function () { it("should rename an attached file", function* () { var file = getTestDataDirectory(); file.append('test.png'); var item = yield Zotero.Attachments.importFromFile({ file: file }); var newName = 'test2.png'; yield item.renameAttachmentFile(newName); assert.equal(item.attachmentFilename, newName); var path = yield item.getFilePathAsync(); assert.equal(OS.Path.basename(path), newName) yield OS.File.exists(path); // File should be flagged for upload // DEBUG: Is this necessary? assert.equal(item.attachmentSyncState, Zotero.Sync.Storage.Local.SYNC_STATE_TO_UPLOAD); assert.isNull(item.attachmentSyncedHash); }) it("should rename a linked file", function* () { var filename = 'test.png'; var file = getTestDataDirectory(); file.append(filename); var tmpDir = yield getTempDirectory(); var tmpFile = OS.Path.join(tmpDir, filename); yield OS.File.copy(file.path, tmpFile); var item = yield Zotero.Attachments.linkFromFile({ file: tmpFile }); var newName = 'test2.png'; yield assert.eventually.isTrue(item.renameAttachmentFile(newName)); assert.equal(item.attachmentFilename, newName); var path = yield item.getFilePathAsync(); assert.equal(OS.Path.basename(path), newName) yield OS.File.exists(path); }) }) describe("#getBestAttachmentState()", function () { it("should cache state for an existing file", function* () { var parentItem = yield createDataObject('item'); var file = getTestDataDirectory(); file.append('test.png'); var childItem = yield Zotero.Attachments.importFromFile({ file, parentItemID: parentItem.id }); yield parentItem.getBestAttachmentState(); assert.equal(parentItem.getBestAttachmentStateCached(), 1); }) it("should cache state for a missing file", function* () { var parentItem = yield createDataObject('item'); var file = getTestDataDirectory(); file.append('test.png'); var childItem = yield Zotero.Attachments.importFromFile({ file, parentItemID: parentItem.id }); let path = yield childItem.getFilePathAsync(); yield OS.File.remove(path); yield parentItem.getBestAttachmentState(); assert.equal(parentItem.getBestAttachmentStateCached(), -1); }) }) describe("#fileExists()", function () { it("should cache state for an existing file", function* () { var file = getTestDataDirectory(); file.append('test.png'); var item = yield Zotero.Attachments.importFromFile({ file }); yield item.fileExists(); assert.equal(item.fileExistsCached(), true); }) it("should cache state for a missing file", function* () { var file = getTestDataDirectory(); file.append('test.png'); var item = yield Zotero.Attachments.importFromFile({ file }); let path = yield item.getFilePathAsync(); yield OS.File.remove(path); yield item.fileExists(); assert.equal(item.fileExistsCached(), false); }) }) describe("#relinkAttachmentFile", function () { it("should copy a file elsewhere into the storage directory", function* () { var filename = 'test.png'; var file = getTestDataDirectory(); file.append(filename); var tmpDir = yield getTempDirectory(); var tmpFile = OS.Path.join(tmpDir, filename); yield OS.File.copy(file.path, tmpFile); file = OS.Path.join(tmpDir, filename); var item = yield Zotero.Attachments.importFromFile({ file }); let path = yield item.getFilePathAsync(); yield OS.File.remove(path); yield OS.File.removeEmptyDir(OS.Path.dirname(path)); assert.isFalse(yield item.fileExists()); yield item.relinkAttachmentFile(file); assert.isTrue(yield item.fileExists()); assert.isTrue(yield OS.File.exists(tmpFile)); }); }); describe("#setTags", function () { it("should save an array of tags in API JSON format", function* () { var tags = [ { tag: "A" }, { tag: "B" } ]; var item = new Zotero.Item('journalArticle'); item.setTags(tags); var id = yield item.saveTx(); item = Zotero.Items.get(id); assert.sameDeepMembers(item.getTags(tags), tags); }) it("shouldn't mark item as changed if tags haven't changed", function* () { var tags = [ { tag: "A" }, { tag: "B" } ]; var item = new Zotero.Item('journalArticle'); item.setTags(tags); var id = yield item.saveTx(); item = Zotero.Items.get(id); item.setTags(tags); assert.isFalse(item.hasChanged()); }) it("should remove an existing tag", function* () { var tags = [ { tag: "A" }, { tag: "B" } ]; var item = new Zotero.Item('journalArticle'); item.setTags(tags); var id = yield item.saveTx(); item = Zotero.Items.get(id); item.setTags(tags.slice(0)); yield item.saveTx(); assert.sameDeepMembers(item.getTags(tags), tags.slice(0)); }) }) describe("#addTag", function () { it("should add a tag", function* () { var item = createUnsavedDataObject('item'); item.addTag('a'); yield item.saveTx(); var tags = item.getTags(); assert.deepEqual(tags, [{ tag: 'a' }]); }) it("should add two tags", function* () { var item = createUnsavedDataObject('item'); item.addTag('a'); item.addTag('b'); yield item.saveTx(); var tags = item.getTags(); assert.sameDeepMembers(tags, [{ tag: 'a' }, { tag: 'b' }]); }) it("should add two tags of different types", function* () { var item = createUnsavedDataObject('item'); item.addTag('a'); item.addTag('b', 1); yield item.saveTx(); var tags = item.getTags(); assert.sameDeepMembers(tags, [{ tag: 'a' }, { tag: 'b', type: 1 }]); }) it("should add a tag to an existing item", function* () { var item = yield createDataObject('item'); item.addTag('a'); yield item.saveTx(); var tags = item.getTags(); assert.deepEqual(tags, [{ tag: 'a' }]); }) it("should add two tags to an existing item", function* () { var item = yield createDataObject('item'); item.addTag('a'); item.addTag('b'); yield item.saveTx(); var tags = item.getTags(); assert.sameDeepMembers(tags, [{ tag: 'a' }, { tag: 'b' }]); }) }) // // Relations and related items // describe("#addRelatedItem", function () { it("should add a dc:relation relation to an item", function* () { var item1 = yield createDataObject('item'); var item2 = yield createDataObject('item'); item1.addRelatedItem(item2); yield item1.saveTx(); var rels = item1.getRelationsByPredicate(Zotero.Relations.relatedItemPredicate); assert.lengthOf(rels, 1); assert.equal(rels[0], Zotero.URI.getItemURI(item2)); }) it("should allow an unsaved item to be related to an item in the user library", function* () { var item1 = yield createDataObject('item'); var item2 = createUnsavedDataObject('item'); item2.addRelatedItem(item1); yield item2.saveTx(); var rels = item2.getRelationsByPredicate(Zotero.Relations.relatedItemPredicate); assert.lengthOf(rels, 1); assert.equal(rels[0], Zotero.URI.getItemURI(item1)); }) it("should throw an error for a relation in a different library", function* () { var group = yield getGroup(); var item1 = yield createDataObject('item'); var item2 = yield createDataObject('item', { libraryID: group.libraryID }); try { item1.addRelatedItem(item2) } catch (e) { assert.ok(e); assert.equal(e.message, "Cannot relate item to an item in a different library"); return; } assert.fail("addRelatedItem() allowed for an item in a different library"); }) }) describe("#save()", function () { it("should throw an error for an empty item without an item type", function* () { var item = new Zotero.Item; var e = yield getPromiseError(item.saveTx()); assert.ok(e); assert.equal(e.message, "Item type must be set before saving"); }) }) describe("#_eraseData()", function () { it("should remove relations pointing to this item", function* () { var item1 = yield createDataObject('item'); var item2 = yield createDataObject('item'); item1.addRelatedItem(item2); yield item1.saveTx(); item2.addRelatedItem(item1); yield item2.saveTx(); yield item1.eraseTx(); assert.lengthOf(item2.relatedItems, 0); yield assert.eventually.equal( Zotero.DB.valueQueryAsync("SELECT COUNT(*) FROM itemRelations WHERE itemID=?", item2.id), 0 ); }); }); describe("#multiDiff", function () { it("should return set of alternatives for differing fields in other items", function* () { var type = 'item'; var dates = ['2016-03-08 17:44:45']; var accessDates = ['2016-03-08T18:44:45Z']; var urls = ['http://www.example.com', 'http://example.net']; var obj1 = createUnsavedDataObject(type); obj1.setField('date', '2016-03-07 12:34:56'); // different in 1 and 3, not in 2 obj1.setField('url', 'http://example.com'); // different in all three obj1.setField('title', 'Test'); // only in 1 var obj2 = createUnsavedDataObject(type); obj2.setField('url', urls[0]); obj2.setField('accessDate', accessDates[0]); // only in 2 var obj3 = createUnsavedDataObject(type); obj3.setField('date', dates[0]); obj3.setField('url', urls[1]); var alternatives = obj1.multiDiff([obj2, obj3]); assert.sameMembers(Object.keys(alternatives), ['url', 'date', 'accessDate']); assert.sameMembers(alternatives.url, urls); assert.sameMembers(alternatives.date, dates); assert.sameMembers(alternatives.accessDate, accessDates); }); }); describe("#clone()", function () { // TODO: Expand to other data it("should copy creators", function* () { var item = new Zotero.Item('book'); item.setCreators([ { firstName: "A", lastName: "Test", creatorType: 'author' } ]); yield item.saveTx(); var newItem = item.clone(); assert.sameDeepMembers(item.getCreators(), newItem.getCreators()); }) }) describe("#toJSON()", function () { describe("default mode", function () { it("should output only fields with values", function* () { var itemType = "book"; var title = "Test"; var item = new Zotero.Item(itemType); item.setField("title", title); var id = yield item.saveTx(); item = Zotero.Items.get(id); var json = item.toJSON(); assert.equal(json.itemType, itemType); assert.equal(json.title, title); assert.isUndefined(json.date); assert.isUndefined(json.numPages); }) it("should output 'deleted' as 1", function* () { var itemType = "book"; var title = "Test"; var item = new Zotero.Item(itemType); item.setField("title", title); item.deleted = true; var id = yield item.saveTx(); item = Zotero.Items.get(id); var json = item.toJSON(); assert.strictEqual(json.deleted, 1); }) it.skip("should output attachment fields from file", function* () { var file = getTestDataDirectory(); file.append('test.png'); var item = yield Zotero.Attachments.importFromFile({ file }); yield Zotero.DB.executeTransaction(function* () { yield Zotero.Sync.Storage.Local.setSyncedModificationTime( item.id, new Date().getTime() ); yield Zotero.Sync.Storage.Local.setSyncedHash( item.id, 'b32e33f529942d73bea4ed112310f804' ); }); var json = item.toJSON(); assert.equal(json.linkMode, 'imported_file'); assert.equal(json.filename, 'test.png'); assert.isUndefined(json.path); assert.equal(json.mtime, (yield item.attachmentModificationTime)); assert.equal(json.md5, (yield item.attachmentHash)); }) it("should omit storage values with .skipStorageProperties", function* () { var file = getTestDataDirectory(); file.append('test.png'); var item = yield Zotero.Attachments.importFromFile({ file }); item.attachmentSyncedModificationTime = new Date().getTime(); item.attachmentSyncedHash = 'b32e33f529942d73bea4ed112310f804'; yield item.saveTx({ skipAll: true }); var json = item.toJSON({ skipStorageProperties: true }); assert.isUndefined(json.mtime); assert.isUndefined(json.md5); }); it("should output synced storage values with .syncedStorageProperties", function* () { var item = new Zotero.Item('attachment'); item.attachmentLinkMode = 'imported_file'; item.fileName = 'test.txt'; yield item.saveTx(); var mtime = new Date().getTime(); var md5 = 'b32e33f529942d73bea4ed112310f804'; item.attachmentSyncedModificationTime = mtime; item.attachmentSyncedHash = md5; yield item.saveTx({ skipAll: true }); var json = item.toJSON({ syncedStorageProperties: true }); assert.equal(json.mtime, mtime); assert.equal(json.md5, md5); }) it.skip("should output unset storage properties as null", function* () { var item = new Zotero.Item('attachment'); item.attachmentLinkMode = 'imported_file'; item.fileName = 'test.txt'; var id = yield item.saveTx(); var json = item.toJSON(); assert.isNull(json.mtime); assert.isNull(json.md5); }) it("shouldn't include filename or path for linked_url attachments", function* () { var item = new Zotero.Item('attachment'); item.attachmentLinkMode = 'linked_url'; item.url = "https://www.zotero.org/"; var json = item.toJSON(); assert.notProperty(json, "filename"); assert.notProperty(json, "path"); }); it("should include inPublications=true for items in My Publications", function* () { var item = createUnsavedDataObject('item'); item.inPublications = true; var json = item.toJSON(); assert.propertyVal(json, "inPublications", true); }); it("shouldn't include inPublications for items not in My Publications in patch mode", function* () { var item = createUnsavedDataObject('item'); var json = item.toJSON(); assert.notProperty(json, "inPublications"); }); it("should include inPublications=false for items not in My Publications in full mode", function* () { var item = createUnsavedDataObject('item'); var json = item.toJSON({ mode: 'full' }); assert.property(json, "inPublications", false); }); }) describe("'full' mode", function () { it("should output all fields", function* () { var itemType = "book"; var title = "Test"; var item = new Zotero.Item(itemType); item.setField("title", title); var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); var json = item.toJSON({ mode: 'full' }); assert.equal(json.title, title); assert.equal(json.date, ""); assert.equal(json.numPages, ""); }) }) describe("'patch' mode", function () { it("should output only fields that differ", function* () { var itemType = "book"; var title = "Test"; var date = "2015-05-12"; var item = new Zotero.Item(itemType); item.setField("title", title); var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); var patchBase = item.toJSON(); item.setField("date", date); yield item.saveTx(); var json = item.toJSON({ patchBase: patchBase }) assert.isUndefined(json.itemType); assert.isUndefined(json.title); assert.equal(json.date, date); assert.isUndefined(json.numPages); assert.isUndefined(json.deleted); assert.isUndefined(json.creators); assert.isUndefined(json.relations); assert.isUndefined(json.tags); }) it("should include changed 'deleted' field", function* () { // True to false var item = new Zotero.Item('book'); item.deleted = true; var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); var patchBase = item.toJSON(); item.deleted = false; var json = item.toJSON({ patchBase: patchBase }) assert.isUndefined(json.title); assert.isFalse(json.deleted); // False to true var item = new Zotero.Item('book'); item.deleted = false; var id = yield item.saveTx(); item = yield Zotero.Items.getAsync(id); var patchBase = item.toJSON(); item.deleted = true; var json = item.toJSON({ patchBase: patchBase }) assert.isUndefined(json.title); assert.strictEqual(json.deleted, 1); }) it("should set 'parentItem' to false when cleared", function* () { var item = yield createDataObject('item'); var note = new Zotero.Item('note'); note.parentID = item.id; // Create initial JSON with parentItem var patchBase = note.toJSON(); // Clear parent item and regenerate JSON note.parentID = false; var json = note.toJSON({ patchBase }); assert.isFalse(json.parentItem); }); it("should include relations if related item was removed", function* () { var item1 = yield createDataObject('item'); var item2 = yield createDataObject('item'); var item3 = yield createDataObject('item'); var item4 = yield createDataObject('item'); var relateItems = Zotero.Promise.coroutine(function* (i1, i2) { yield Zotero.DB.executeTransaction(function* () { i1.addRelatedItem(i2); yield i1.save({ skipDateModifiedUpdate: true }); i2.addRelatedItem(i1); yield i2.save({ skipDateModifiedUpdate: true }); }); }); yield relateItems(item1, item2); yield relateItems(item1, item3); yield relateItems(item1, item4); var patchBase = item1.toJSON(); item1.removeRelatedItem(item2); yield item1.saveTx(); item2.removeRelatedItem(item1); yield item2.saveTx(); var json = item1.toJSON({ patchBase }); assert.sameMembers(json.relations['dc:relation'], item1.getRelations()['dc:relation']); }); it("shouldn't clear storage properties from original in .skipStorageProperties mode", function* () { var item = new Zotero.Item('attachment'); item.attachmentLinkMode = 'imported_file'; item.attachmentFilename = 'test.txt'; item.attachmentContentType = 'text/plain'; item.attachmentCharset = 'utf-8'; item.attachmentSyncedModificationTime = 1234567890000; item.attachmentSyncedHash = '18d21750c8abd5e3afa8ea89e3dfa570'; var patchBase = item.toJSON({ syncedStorageProperties: true }); item.setNote("Test"); var json = item.toJSON({ patchBase, skipStorageProperties: true }); Zotero.debug(json); assert.equal(json.note, "Test"); assert.notProperty(json, "md5"); assert.notProperty(json, "mtime"); }); }) }) describe("#fromJSON()", function () { it("should clear missing fields", function* () { var item = new Zotero.Item('book'); item.setField('title', 'Test'); item.setField('date', '2016'); item.setField('accessDate', '2015-06-07T20:56:00Z'); yield item.saveTx(); var json = item.toJSON(); // Remove fields, which should cause them to be cleared in fromJSON() delete json.date; delete json.accessDate; item.fromJSON(json); assert.strictEqual(item.getField('title'), 'Test'); assert.strictEqual(item.getField('date'), ''); assert.strictEqual(item.getField('accessDate'), ''); }); it("should ignore unknown fields", function* () { var json = { itemType: "journalArticle", title: "Test", foo: "Invalid" }; var item = new Zotero.Item; item.fromJSON(json); assert.equal(item.getField('title'), 'Test'); }) it("should accept ISO 8601 dates", function* () { var json = { itemType: "journalArticle", accessDate: "2015-06-07T20:56:00Z", dateAdded: "2015-06-07T20:57:00Z", dateModified: "2015-06-07T20:58:00Z", }; var item = new Zotero.Item; item.fromJSON(json); assert.equal(item.getField('accessDate'), '2015-06-07 20:56:00'); assert.equal(item.dateAdded, '2015-06-07 20:57:00'); assert.equal(item.dateModified, '2015-06-07 20:58:00'); }) it("should accept ISO 8601 access date without time", function* () { var json = { itemType: "journalArticle", accessDate: "2015-06-07", dateAdded: "2015-06-07T20:57:00Z", dateModified: "2015-06-07T20:58:00Z", }; var item = new Zotero.Item; item.fromJSON(json); assert.equal(item.getField('accessDate'), '2015-06-07'); assert.equal(item.dateAdded, '2015-06-07 20:57:00'); assert.equal(item.dateModified, '2015-06-07 20:58:00'); }) it("should ignore non–ISO 8601 dates", function* () { var json = { itemType: "journalArticle", accessDate: "2015-06-07 20:56:00", dateAdded: "2015-06-07 20:57:00", dateModified: "2015-06-07 20:58:00", }; var item = new Zotero.Item; item.fromJSON(json); assert.strictEqual(item.getField('accessDate'), ''); // DEBUG: Should these be null, or empty string like other fields from getField()? assert.isNull(item.dateAdded); assert.isNull(item.dateModified); }) it("should set creators", function* () { var json = { itemType: "journalArticle", creators: [ { firstName: "First", lastName: "Last", creatorType: "author" }, { name: "Test Name", creatorType: "editor" } ] }; var item = new Zotero.Item; item.fromJSON(json); var id = yield item.saveTx(); assert.sameDeepMembers(item.getCreatorsJSON(), json.creators); }) it("should map a base field to an item-specific field", function* () { var item = new Zotero.Item("bookSection"); item.fromJSON({ "itemType":"bookSection", "publicationTitle":"Publication Title" }); assert.equal(item.getField("bookTitle"), "Publication Title"); }); }); });