suzanne.soy/zotero
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix and change extraData for item change notifications

Browse Source 
- Some item changes were putting data in the wrong form into extraData,
  which was keeping it from being passed through in notifications.
- For item modifications, set a 'changed' object, keyed by itemID, with
  just the fields that changed as keys and their old values. For
  deletes, keep the 'old' object for now, since sync relies on it.
- Remove item.serialize() for all item changes except deletions, which
  should speed up writes (and which will leave extraData empty for some
  changes).
- Currently only item fields, creators, related items ('related'), and
  'parentItem' are added to 'changed'.

Closes #220
This commit is contained in:
Dan Stillman 2013-02-02 05:31:14 -05:00
parent b08e52363b
commit 1a0849e489
2 changed files with 118 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

171
chrome/content/zotero/xpcom/data/item.js
View File

@ -64,7 +64,7 @@ Zotero.Item.prototype._init = function () {
this._itemDataLoaded = false; this._itemDataLoaded = false;
this._relatedItemsLoaded = false; this._relatedItemsLoaded = false;
this._changed = false; this._changed = {};
this._changedPrimaryData = false; this._changedPrimaryData = false;
this._changedItemData = false; this._changedItemData = false;
this._changedCreators = false; this._changedCreators = false;
@ -74,7 +74,7 @@ Zotero.Item.prototype._init = function () {
this._changedAttachmentData = false; this._changedAttachmentData = false;
this._skipModTimeUpdate = false; this._skipModTimeUpdate = false;
this._previousData = null; this._previousData = {};
this._deleted = null; this._deleted = null;
this._noteTitle = null; this._noteTitle = null;
@ -412,7 +412,7 @@ Zotero.Item.prototype.loadFromRow = function(row, reload) {
* Check if any data fields have changed since last save * Check if any data fields have changed since last save
*/ */
Zotero.Item.prototype.hasChanged = function() { Zotero.Item.prototype.hasChanged = function() {
return !!(this._changed return !!(Object.keys(this._changed).length
|| this._changedPrimaryData || this._changedPrimaryData
|| this._changedItemData || this._changedItemData
|| this._changedCreators || this._changedCreators
@ -554,7 +554,7 @@ Zotero.Item.prototype.setType = function(itemTypeID, loadIn) {
if (copiedFields) { if (copiedFields) {
for each(var f in copiedFields) { for each(var f in copiedFields) {
this.setField(f[0], f[1]); this.setField(f[0], f[1], true);
} }
} }
@ -562,6 +562,7 @@ Zotero.Item.prototype.setType = function(itemTypeID, loadIn) {
this._itemDataLoaded = false; this._itemDataLoaded = false;
} }
else { else {
this._markFieldChange('itemType', Zotero.ItemTypes.getName(oldItemTypeID));
if (!this._changedPrimaryData) { if (!this._changedPrimaryData) {
this._changedPrimaryData = {}; this._changedPrimaryData = {};
} }
@ -720,10 +721,9 @@ Zotero.Item.prototype.setField = function(field, value, loadIn) {
if (this['_' + field] != value) { if (this['_' + field] != value) {
Zotero.debug("Field '" + field + "' has changed from '" + this['_' + field] + "' to '" + value + "'", 4); Zotero.debug("Field '" + field + "' has changed from '" + this['_' + field] + "' to '" + value + "'", 4);
// Save a copy of the object before modifying // Save a copy of the field before modifying
if (this.id && this.exists() && !this._previousData) { this._markFieldChange(field, this['_' + field]);
this._previousData = this.serialize();
}
if (field == 'itemTypeID') { if (field == 'itemTypeID') {
this.setType(value, loadIn); this.setType(value, loadIn);
} }
@ -808,10 +808,10 @@ Zotero.Item.prototype.setField = function(field, value, loadIn) {
return false; return false;
} }
// Save a copy of the object before modifying // Save a copy of the field before modifying
if (this.id && this.exists() && !this._previousData) { this._markFieldChange(
this._previousData = this.serialize(); Zotero.ItemFields.getName(field), this._itemData[fieldID]
} );
} }
this._itemData[fieldID] = value; this._itemData[fieldID] = value;
@ -1052,15 +1052,20 @@ Zotero.Item.prototype.setCreator = function(orderIndex, creator, creatorTypeIDOr
return false; return false;
} }
// Save copy of old creators for notifier
if (!this._changedCreators) {
this._changedCreators = {};
var oldCreators = this._getOldCreators()
this._markFieldChange('creators', oldCreators);
}
this._changedCreators[orderIndex] = true;
this._creators[orderIndex] = { this._creators[orderIndex] = {
ref: creator, ref: creator,
creatorTypeID: creatorTypeID creatorTypeID: creatorTypeID
}; };
if (!this._changedCreators) {
this._changedCreators = {};
}
this._changedCreators[orderIndex] = true;
return true; return true;
} }
@ -1083,6 +1088,14 @@ Zotero.Item.prototype.removeCreator = function(orderIndex) {
Zotero.Prefs.set('purge.creators', true); Zotero.Prefs.set('purge.creators', true);
} }
// Save copy of old creators for notifier
if (!this._changedCreators) {
this._changedCreators = {};
var oldCreators = this._getOldCreators();
this._markFieldChange('creators', oldCreators);
}
// Shift creator orderIndexes down, going to length+1 so we clear the last one // Shift creator orderIndexes down, going to length+1 so we clear the last one
for (var i=orderIndex, max=this._creators.length+1; i<max; i++) { for (var i=orderIndex, max=this._creators.length+1; i<max; i++) {
var next = this._creators[i+1] ? this._creators[i+1] : false; var next = this._creators[i+1] ? this._creators[i+1] : false;
@ -1093,9 +1106,6 @@ Zotero.Item.prototype.removeCreator = function(orderIndex) {
this._creators.splice(i, 1); this._creators.splice(i, 1);
} }
if (!this._changedCreators) {
this._changedCreators = {};
}
this._changedCreators[i] = true; this._changedCreators[i] = true;
} }
@ -1167,7 +1177,8 @@ Zotero.Item.prototype.addRelatedItem = function (itemID) {
} }
*/ */
this._prepFieldChange('relatedItems'); this._markFieldChange('related', current);
this._changed.relatedItems = true;
this._relatedItems.push(item); this._relatedItems.push(item);
return true; return true;
} }
@ -1189,7 +1200,8 @@ Zotero.Item.prototype.removeRelatedItem = function (itemID) {
return false; return false;
} }
this._prepFieldChange('relatedItems'); this._markFieldChange('related', current);
this._changed.relatedItems = true;
this._relatedItems.splice(index, 1); this._relatedItems.splice(index, 1);
return true; return true;
} }
@ -1506,9 +1518,7 @@ Zotero.Item.prototype.save = function() {
} }
var newSourceItemNotifierData = {}; var newSourceItemNotifierData = {};
newSourceItemNotifierData[newSourceItem.id] = { //newSourceItemNotifierData[newSourceItem.id] = {};
old: newSourceItem.serialize()
};
Zotero.Notifier.trigger('modify', 'item', newSourceItem.id, newSourceItemNotifierData); Zotero.Notifier.trigger('modify', 'item', newSourceItem.id, newSourceItemNotifierData);
switch (Zotero.ItemTypes.getName(this.itemTypeID)) { switch (Zotero.ItemTypes.getName(this.itemTypeID)) {
@ -1528,16 +1538,13 @@ Zotero.Item.prototype.save = function() {
var newids = []; var newids = [];
var currentIDs = this._getRelatedItems(true); var currentIDs = this._getRelatedItems(true);
if (this._previousData && this._previousData.related) {
for each(var id in this._previousData.related) { for each(var id in this._previousData.related) {
if (currentIDs.indexOf(id) == -1) { if (currentIDs.indexOf(id) == -1) {
removed.push(id); removed.push(id);
} }
} }
}
for each(var id in currentIDs) { for each(var id in currentIDs) {
if (this._previousData && this._previousData.related && if (this._previousData.related.indexOf(id) != -1) {
this._previousData.related.indexOf(id) != -1) {
continue; continue;
} }
newids.push(id); newids.push(id);
@ -1882,7 +1889,9 @@ Zotero.Item.prototype.save = function() {
Zotero.DB.query(sql, bindParams); Zotero.DB.query(sql, bindParams);
} }
Zotero.Notifier.trigger('modify', 'item', this.id, { old: this._previousData }); var notifierData = {};
notifierData[this.id] = { changed: this._previousData };
Zotero.Notifier.trigger('modify', 'item', this.id, notifierData);
// Parent // Parent
if (this._changedSource) { if (this._changedSource) {
@ -1905,22 +1914,16 @@ Zotero.Item.prototype.save = function() {
} }
var newSourceItemNotifierData = {}; var newSourceItemNotifierData = {};
newSourceItemNotifierData[newSourceItem.id] = { //newSourceItemNotifierData[newSourceItem.id] = {};
old: newSourceItem.serialize()
};
Zotero.Notifier.trigger('modify', 'item', newSourceItem.id, newSourceItemNotifierData); Zotero.Notifier.trigger('modify', 'item', newSourceItem.id, newSourceItemNotifierData);
} }
if (this._previousData) { var oldSourceItemKey = this._previousData.parent;
var oldSourceItemKey = this._previousData.sourceItemKey;
if (oldSourceItemKey) { if (oldSourceItemKey) {
var oldSourceItem = Zotero.Items.getByLibraryAndKey(this.libraryID, oldSourceItemKey); var oldSourceItem = Zotero.Items.getByLibraryAndKey(this.libraryID, oldSourceItemKey);
}
if (oldSourceItem) { if (oldSourceItem) {
var oldSourceItemNotifierData = {}; var oldSourceItemNotifierData = {};
oldSourceItemNotifierData[oldSourceItem.id] = { //oldSourceItemNotifierData[oldSourceItem.id] = {};
old: oldSourceItem.serialize()
};
Zotero.Notifier.trigger('modify', 'item', oldSourceItem.id, oldSourceItemNotifierData); Zotero.Notifier.trigger('modify', 'item', oldSourceItem.id, oldSourceItemNotifierData);
} }
else if (oldSourceItemKey) { else if (oldSourceItemKey) {
@ -1931,6 +1934,7 @@ Zotero.Item.prototype.save = function() {
} }
// If this was an independent item, remove from any collections // If this was an independent item, remove from any collections
// where it existed previously and add source instead if // where it existed previously and add source instead if
// there is one // there is one
@ -2003,16 +2007,13 @@ Zotero.Item.prototype.save = function() {
var newids = []; var newids = [];
var currentIDs = this._getRelatedItems(true); var currentIDs = this._getRelatedItems(true);
if (this._previousData && this._previousData.related) {
for each(var id in this._previousData.related) { for each(var id in this._previousData.related) {
if (currentIDs.indexOf(id) == -1) { if (currentIDs.indexOf(id) == -1) {
removed.push(id); removed.push(id);
} }
} }
}
for each(var id in currentIDs) { for each(var id in currentIDs) {
if (this._previousData && this._previousData.related && if (this._previousData.related.indexOf(id) != -1) {
this._previousData.related.indexOf(id) != -1) {
continue; continue;
} }
newids.push(id); newids.push(id);
@ -2243,12 +2244,9 @@ Zotero.Item.prototype.setSource = function(sourceItemID) {
return false; return false;
} }
if (this.id && this.exists() && !this._previousData) { this._markFieldChange('parentItem', this.getSourceKey());
this._previousData = this.serialize();
}
this._sourceItem = sourceItemID ? parseInt(sourceItemID) : false;
this._changedSource = true; this._changedSource = true;
this._sourceItem = sourceItemID ? parseInt(sourceItemID) : false;
return true; return true;
} }
@ -2280,12 +2278,9 @@ Zotero.Item.prototype.setSourceKey = function(sourceItemKey) {
return false; return false;
} }
if (this.id && this.exists() && !this._previousData) { this._markFieldChange('parentItem', oldSourceItemKey);
this._previousData = this.serialize();
}
this._sourceItem = sourceItemKey ? sourceItemKey : false;
this._changedSource = true; this._changedSource = true;
this._sourceItem = sourceItemKey ? sourceItemKey : false;
return true; return true;
} }
@ -2452,12 +2447,10 @@ Zotero.Item.prototype.setNote = function(text) {
return false; return false;
} }
if (this.id && this.exists() && !this._previousData) {
this._previousData = this.serialize();
}
this._noteText = text; this._noteText = text;
this._noteTitle = Zotero.Notes.noteToTitle(text); this._noteTitle = Zotero.Notes.noteToTitle(text);
this._markFieldChange('note', oldText);
this._changedNote = true; this._changedNote = true;
return true; return true;
@ -4096,7 +4089,7 @@ Zotero.Item.prototype.erase = function() {
var sourceItemID = Zotero.DB.valueQuery(sql); var sourceItemID = Zotero.DB.valueQuery(sql);
if (sourceItemID) { if (sourceItemID) {
var sourceItem = Zotero.Items.get(sourceItemID); var sourceItem = Zotero.Items.get(sourceItemID);
changedItemsNotifierData[sourceItem.id] = { old: sourceItem.serialize() }; //changedItemsNotifierData[sourceItem.id] = {};
if (!this.deleted) { if (!this.deleted) {
sourceItem.decrementNoteCount(); sourceItem.decrementNoteCount();
} }
@ -4110,7 +4103,7 @@ Zotero.Item.prototype.erase = function() {
var sourceItemID = Zotero.DB.valueQuery(sql); var sourceItemID = Zotero.DB.valueQuery(sql);
if (sourceItemID) { if (sourceItemID) {
var sourceItem = Zotero.Items.get(sourceItemID); var sourceItem = Zotero.Items.get(sourceItemID);
changedItemsNotifierData[sourceItem.id] = { old: sourceItem.serialize() }; //changedItemsNotifierData[sourceItem.id] = {};
if (!this.deleted) { if (!this.deleted) {
sourceItem.decrementAttachmentCount(); sourceItem.decrementAttachmentCount();
} }
@ -4157,7 +4150,7 @@ Zotero.Item.prototype.erase = function() {
for each(var id in relateds) { for each(var id in relateds) {
var relatedItem = Zotero.Items.get(id); var relatedItem = Zotero.Items.get(id);
if (changedItems.indexOf(id) != -1) { if (changedItems.indexOf(id) != -1) {
changedItemsNotifierData[id] = { old: relatedItem.serialize() }; //changedItemsNotifierData[id] = {};
changedItems.push(id); changedItems.push(id);
} }
} }
@ -4753,7 +4746,8 @@ Zotero.Item.prototype._setRelatedItems = function (itemIDs) {
// Mark as changed if new or removed ids // Mark as changed if new or removed ids
if (newIDs.length > 0 || oldIDs.length != currentIDs.length) { if (newIDs.length > 0 || oldIDs.length != currentIDs.length) {
this._prepFieldChange('relatedItems'); this._markFieldChange('related', currentIDs);
this._changed.relatedItems = true
} }
else { else {
Zotero.debug('Related items not changed in Zotero.Item._setRelatedItems()', 4); Zotero.debug('Related items not changed in Zotero.Item._setRelatedItems()', 4);
@ -4769,17 +4763,58 @@ Zotero.Item.prototype._setRelatedItems = function (itemIDs) {
} }
// TODO: use for stuff other than related items /**
Zotero.Item.prototype._prepFieldChange = function (field) { * The creator has already been changed in itembox.xml before being passed
if (!this._changed) { * to setCreator()/removeCreator(), so we have to reach in and get its
this._changed = {}; * previousData, and ideally try to detect when this private data structure
* has changed, which it almost certainly will. I am so sorry.
*/
Zotero.Item.prototype._getOldCreators = function () {
var oldCreators = [];
for (var i in this._creators) {
if (this._creators[i].ref._changed) {
if (!this._creators[i].ref._previousData
&& !this._creators[i].ref._previousData.fields) {
Components.utils.reportError("Previous creator data not available in expected form");
oldCreators.push(false);
continue;
}
var c = this._creators[i].ref._previousData.fields;
}
else {
var c = this._creators[i].ref;
} }
this._changed[field] = true;
// Save a copy of the data before changing var old = {
if (this.id && this.exists() && !this._previousData) { // Convert creatorTypeIDs to text
this._previousData = this.serialize(); creatorType: Zotero.CreatorTypes.getName(
this._creators[i].creatorTypeID
)
};
if (c.fieldMode) {
// In 'fields' there's just 'name' for single-field mode
old.name = typeof c.name == 'undefined' ? c.lastName : c.name;
} }
else {
old.firstName = c.firstName;
old.lastName = c.lastName;
}
oldCreators.push(old);
}
return oldCreators;
}
/**
* Save old version of data that's being changed, to pass to the notifier
*/
Zotero.Item.prototype._markFieldChange = function (field, oldValue) {
// Only save if item already exists and field not already changed
if (!this.id || !this.exists() || this._previousData[field]) {
return;
}
this._previousData[field] = oldValue;
} }

4
chrome/content/zotero/xpcom/notifier.js
View File

@ -136,9 +136,11 @@ Zotero.Notifier = new function(){
// Merge extraData keys // Merge extraData keys
if (extraData) { if (extraData) {
for (var dataID in extraData) { for (var dataID in extraData) {
if (extraData[dataID]) {
_queue[type][event].data[dataID] = extraData[dataID]; _queue[type][event].data[dataID] = extraData[dataID];
} }
} }
}
return true; return true;
} }
@ -271,9 +273,11 @@ Zotero.Notifier = new function(){
if (runQueue[type][event].ids.indexOf(id) == -1) { if (runQueue[type][event].ids.indexOf(id) == -1) {
runQueue[type][event].ids.push(id); runQueue[type][event].ids.push(id);
if (data) {
runQueue[type][event].data[id] = data; runQueue[type][event].data[id] = data;
} }
} }
}
if (runQueue[type][event].ids.length || event == 'refresh') { if (runQueue[type][event].ids.length || event == 'refresh') {
totals += ' [' + event + '-' + type + ': ' + runQueue[type][event].ids.length + ']'; totals += ' [' + event + '-' + type + ': ' + runQueue[type][event].ids.length + ']';