zotero/chrome/content/zotero/duplicatesMerge.js

/*
    ***** BEGIN LICENSE BLOCK *****
    
    Copyright © 2009 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 *****
*/

"use strict";

var Zotero_Duplicates_Pane = new function () {
	var _masterItem;
	var _items = [];
	var _otherItems = [];
	var _ignoreFields = ['dateAdded', 'dateModified', 'accessDate'];
	
	this.setItems = function (items, displayNumItemsOnTypeError) {
		var itemTypeID, oldestItem, otherItems = [];
		for (let item of items) {
			// Find the oldest item
			if (!oldestItem) {
				oldestItem = item;
			}
			else if (item.dateAdded < oldestItem.dateAdded) {
				otherItems.push(oldestItem);
				oldestItem = item;
			}
			else {
				otherItems.push(item);
			}
			
			if (!item.isRegularItem() || ['annotation', 'attachment', 'note'].includes(item.itemType)) {
				var msg = Zotero.getString('pane.item.duplicates.onlyTopLevel');
				ZoteroPane_Local.setItemPaneMessage(msg);
				return false;
			}
			
			// Make sure all items are of the same type
			if (itemTypeID) {
				if (itemTypeID != item.itemTypeID) {
					if (displayNumItemsOnTypeError) {
						var msg = Zotero.getString('pane.item.selected.multiple', items.length);
					}
					else {
						var msg = Zotero.getString('pane.item.duplicates.onlySameItemType');
					}
					ZoteroPane_Local.setItemPaneMessage(msg);
					return false;
				}
			}
			else {
				itemTypeID = item.itemTypeID;
			}
		}
		
		_items = items;
		
		_items.sort(function (a, b) {
			return a.dateAdded > b.dateAdded ? 1 : a.dateAdded == b.dateAdded ? 0 : -1;
		});
		
		//
		// Update the UI
		//
		
		var button = document.getElementById('zotero-duplicates-merge-button');
		var versionSelect = document.getElementById('zotero-duplicates-merge-version-select');
		var itembox = document.getElementById('zotero-duplicates-merge-item-box');
		var fieldSelect = document.getElementById('zotero-duplicates-merge-field-select');
		
		var alternatives = oldestItem.multiDiff(otherItems, _ignoreFields);
		if (alternatives) {
			// Populate menulist with Date Added values from all items
			var dateList = document.getElementById('zotero-duplicates-merge-original-date');
			dateList.innerHTML = '';
			
			var numRows = 0;
			for (let item of items) {
				var date = Zotero.Date.sqlToDate(item.dateAdded, true);
				dateList.appendItem(date.toLocaleString());
				numRows++;
			}
			
			dateList.setAttribute('rows', numRows);
			
			// If we set this inline, the selection doesn't take on the first
			// selection after unhiding versionSelect (when clicking
			// from a set with no differences) -- tested in Fx5.0.1
			setTimeout(function () {
				dateList.selectedIndex = 0;
			}, 0);
		}
		
		button.label = Zotero.getString('pane.item.duplicates.mergeItems', (otherItems.length + 1));
		versionSelect.hidden = fieldSelect.hidden = !alternatives;
		itembox.hiddenFields = alternatives ? [] : ['dateAdded', 'dateModified'];
		
		this.setMaster(0);
		
		return true;
	}
	
	
	this.setMaster = function (pos) {
		var itembox = document.getElementById('zotero-duplicates-merge-item-box');
		itembox.mode = 'fieldmerge';
		
		_otherItems = _items.concat();
		var item = _otherItems.splice(pos, 1)[0];
		
		// Add master item's values to the beginning of each set of
		// alternative values so that they're still available if the item box
		// modifies the item
		var alternatives = item.multiDiff(_otherItems, _ignoreFields);
		if (alternatives) {
			let itemValues = item.toJSON();
			for (let i in alternatives) {
				alternatives[i].unshift(itemValues[i] !== undefined ? itemValues[i] : '');
			}
			itembox.fieldAlternatives = alternatives;
		}
		
		_masterItem = item;
		itembox.item = item.clone();
	}
	
	
	this.merge = Zotero.Promise.coroutine(function* () {
		var itembox = document.getElementById('zotero-duplicates-merge-item-box');
		Zotero.CollectionTreeCache.clear();
		// Update master item with any field alternatives from the item box
		var json = _masterItem.toJSON();
		// Exclude certain properties that are empty in the cloned object, so we don't clobber them
		const { relations, collections, tags, ...keep } = itembox.item.toJSON();
		Object.assign(json, keep);
		
		_masterItem.fromJSON(json);
		Zotero.Items.merge(_masterItem, _otherItems);
	});
}