define([ "dojo/Evented", "dojo/_base/Deferred", "dojo/DeferredList", "dojo/promise/all", "dojo/_base/declare", "dojo/_base/array", "dojo/dom-attr", "dojo/dom-style", "dojo/query", "esri/config", "esri/layers/GraphicsLayer", "esri/graphic", "esri/symbols/SimpleMarkerSymbol", "esri/symbols/SimpleLineSymbol", "esri/symbols/SimpleFillSymbol", "esri/urlUtils"], function( Evented,Deferred,DeferredList,all,declare,array,domAttr,domStyle,query, esriConfig,GraphicsLayer,Graphic,SimpleMarkerSymbol,SimpleLineSymbol,SimpleFillSymbol,urlUtils) { "use strict"; return declare("O.esri.Edit.OfflineFeaturesManager",[Evented], { _onlineStatus: "online", _featureLayers: {}, _editStore: new O.esri.Edit.EditStore(), ONLINE: "online", // all edits will directly go to the server OFFLINE: "offline", // edits will be enqueued RECONNECTING: "reconnecting", // sending stored edits to the server attachmentsStore: null, // indexedDB for storing attachments proxyPath: null, // by default we use CORS and therefore proxyPath is null // manager emits event when... events: { EDITS_SENT: "edits-sent", // ...whenever any edit is actually sent to the server EDITS_ENQUEUED: "edits-enqueued", // ...when an edit is enqueued (and not sent to the server) EDITS_ENQUEUED_ERROR: "edits-enqueued-error", // ...when there is an error during the queing process EDITS_SENT_ERROR: "edits-sent-error", // ...there was a problem with one or more edits! ALL_EDITS_SENT: "all-edits-sent", // ...after going online and there are no pending edits in the queue ATTACHMENT_ENQUEUED: "attachment-enqueued", ATTACHMENTS_SENT: "attachments-sent" }, /** * Need to call this method only if you want to support offline attachments * it is optional * @param callback(success) * @returns void */ initAttachments: function(callback) { callback = callback || function(success) { console.log("attachments inited ", success? "ok" : "failed"); }; if( !this._checkFileAPIs()) { return callback(false, "File APIs not supported"); } try { this.attachmentsStore = new O.esri.Edit.AttachmentsStore(); if( /*false &&*/ this.attachmentsStore.isSupported() ) { this.attachmentsStore.init(callback); } else { return callback(false, "indexedDB not supported"); } } catch(err) { console.log("problem! " + err.toString()); } }, /** * Overrides a feature layer. * @param layer * @param callback {boolean, String} Traps whether or not the database initialized * @returns deferred */ extend: function(layer,callback) { var self = this; // Attempt to initialize the database self._editStore.init(function(result){ callback(result); //return; }); // we keep track of the FeatureLayer object this._featureLayers[ layer.url ] = layer; // replace the applyEdits() method layer._applyEdits = layer.applyEdits; // attachments layer._addAttachment = layer.addAttachment; layer._queryAttachmentInfos = layer.queryAttachmentInfos; layer._deleteAttachments = layer.deleteAttachments; /* operations supported offline: 1. add a new attachment to an existing feature (DONE) 2. add a new attachment to a new feature (DONE) 3. remove an attachment that is already in the server... (NOT YET) 4. remove an attachment that is not in the server yet (DONE) 5. update an existing attachment to an existing feature (NOT YET) 6. update a new attachment (NOT YET) concerns: - manage the relationship between offline features and attachments: what if the user wants to add an attachment to a feature that is still offline? we need to keep track of objectids so that when the feature is sent to the server and receives a final objectid we replace the temporary negative id by its final objectid (DONE) - what if the user deletes an offline feature that had offline attachments? we need to discard the attachment (DONE) pending tasks: - check for hasAttachments attribute in the FeatureLayer (NOT YET) */ // // attachments // layer.queryAttachmentInfos = function(objectId,callback,errback) { if( self.getOnlineStatus() === self.ONLINE) { var def = this._queryAttachmentInfos(objectId, function() { console.log(arguments); self.emit(self.events.ATTACHMENTS_INFO,arguments); callback && callback.apply(this,arguments); }, errback); return def; } if( !self.attachmentsStore ) { console.log("in order to support attachments you need to call initAttachments() method of offlineFeaturesManager"); return; } // will only return LOCAL attachments var deferred = new Deferred(); self.attachmentsStore.getAttachmentsByFeatureId(this.url, objectId, function(attachments) { callback && callback(attachments); deferred.resolve(attachments); }); return deferred; }; layer.addAttachment = function(objectId,formNode,callback,errback) { if( self.getOnlineStatus() === self.ONLINE) { return this._addAttachment(objectId,formNode, function() { console.log(arguments); self.emit(self.events.ATTACHMENTS_SENT,arguments); callback && callback.apply(this,arguments); }, function(err) { console.log("addAttachment: " + err); errback && errback.apply(this,arguments); } ); } if( !self.attachmentsStore ) { console.log("in order to support attachments you need to call initAttachments() method of offlineFeaturesManager"); return; } var files = this._getFilesFromForm(formNode); var file = files[0]; // addAttachment can only add one file, so the rest -if any- are ignored var deferred = new Deferred(); var attachmentId = this._getNextTempId(); self.attachmentsStore.store(this.url, attachmentId, objectId, file, function(success, newAttachment) { var returnValue = { attachmentId: attachmentId, objectId:objectId, success:success }; if( success ) { self.emit(self.events.ATTACHMENT_ENQUEUED,returnValue); callback && callback(returnValue); deferred.resolve(returnValue); // replace the default URL that is set by attachmentEditor with the local file URL var attachmentUrl = this._url.path + "/" + objectId + "/attachments/" + attachmentId; var attachmentElement = query("[href=" + attachmentUrl + "]"); attachmentElement.attr("href", newAttachment.url); } else { returnValue.error = "can't store attachment"; errback && errback(returnValue); deferred.reject(returnValue); } }.bind(this)); return deferred; }; layer.deleteAttachments = function(objectId,attachmentsIds,callback,errback) { if( self.getOnlineStatus() === self.ONLINE) { var def = this._deleteAttachments(objectId,attachmentsIds, function() { callback && callback.apply(this,arguments); }, function(err) { console.log("deleteAttachments: " + err); errback && errback.apply(this,arguments); }); return def; } if( !self.attachmentsStore ) { console.log("in order to support attachments you need to call initAttachments() method of offlineFeaturesManager"); return; } // case 1.- it is a new attachment // case 2.- it is an already existing attachment // only case 1 is supported right now // asynchronously delete each of the attachments var promises = []; attachmentsIds.forEach(function(attachmentId) { attachmentId = parseInt(attachmentId,10); // to number console.assert( attachmentId<0 , "we only support deleting local attachments"); var deferred = new Deferred(); self.attachmentsStore.delete(attachmentId, function(success) { var result = { objectId: objectId, attachmentId: attachmentId, success: success }; deferred.resolve(result); }); promises.push(deferred); }, this); // call callback once all deletes have finished var allPromises = all(promises); allPromises.then( function(results) { callback && callback(results); }); return allPromises; }; // // other functions // /** * Overrides the ArcGIS API for JavaSccript applyEdits() method. * @param adds Creates a new edit entry. * @param updates Updates an existing entry. * @param deletes Deletes an existing entry. * @param callback Called when the operation is complete. * @param errback An error object is returned if an error occurs * @returns {*} deferred * @throws EDITS_ENQUEUED if all edits successfully stored while offline * @throws EDITS_ENQUEUED_ERROR if there was an error while storing an edit while offline */ layer.applyEdits = function(adds,updates,deletes,callback,errback) { // inside this method, 'this' will be the FeatureLayer // and 'self' will be the offlineFeatureLayer object var promises = []; if( self.getOnlineStatus() === self.ONLINE) { var def = this._applyEdits(adds,updates,deletes, function() { self.emit(self.events.EDITS_SENT,arguments); callback && callback.apply(this,arguments); }, errback); return def; } var deferred = new Deferred(); var results = { addResults:[],updateResults:[], deleteResults:[] }; var updatesMap = {}; this.onBeforeApplyEdits(adds, updates, deletes); adds = adds || []; adds.forEach(function(addEdit) { var deferred = new Deferred(); var objectId = this._getNextTempId(); addEdit.attributes[ this.objectIdField ] = objectId; self._editStore.pushEdit(self._editStore.ADD, this.url, addEdit,function(result,error){ result == true ? deferred.resolve(result) : deferred.reject(error); }); results.addResults.push({ success:true, error: null, objectId: objectId}); var phantomAdd = new Graphic( addEdit.geometry, self._getPhantomSymbol(addEdit.geometry, self._editStore.ADD), { objectId: objectId }); // Add phantom graphic to the layer this._phantomLayer.add(phantomAdd); // Add phantom graphic to the database self._editStore.pushPhantomGraphic(phantomAdd,function(result){ if(!result)console.log("There was a problem adding phantom graphic id: " + objectId); console.log("Phantom graphic " + objectId + " added to database as an add."); }); domAttr.set(phantomAdd.getNode(),"stroke-dasharray","10,4"); domStyle.set(phantomAdd.getNode(), "pointer-events","none"); promises.push(deferred); },this); updates = updates || []; updates.forEach(function(updateEdit) { var deferred = new Deferred(); var objectId = updateEdit.attributes[ this.objectIdField ]; updatesMap[ objectId ] = updateEdit; self._editStore.pushEdit(self._editStore.UPDATE, this.url, updateEdit,function(result,error){ result == true ? deferred.resolve(result) : deferred.reject(error); }); results.updateResults.push({success:true, error: null, objectId: objectId}); var phantomUpdate = new Graphic( updateEdit.geometry, self._getPhantomSymbol(updateEdit.geometry, self._editStore.UPDATE), { objectId: objectId }); this._phantomLayer.add(phantomUpdate); // Add phantom graphic to the database self._editStore.pushPhantomGraphic(phantomUpdate,function(result){ if(!result)console.log("There was a problem adding phantom graphic id: " + objectId); console.log("Phantom graphic " + objectId + " added to database as an update."); }); domAttr.set(phantomUpdate.getNode(),"stroke-dasharray","5,2"); domStyle.set(phantomUpdate.getNode(), "pointer-events","none"); promises.push(deferred); },this); deletes = deletes || []; deletes.forEach(function(deleteEdit) { var deferred = new Deferred(); var objectId = deleteEdit.attributes[ this.objectIdField ]; self._editStore.pushEdit(self._editStore.DELETE, this.url, deleteEdit,function(result,error){ result == true ? deferred.resolve(result) : deferred.reject(error); }); results.deleteResults.push({success:true, error: null, objectId: objectId}); var phantomDelete = new Graphic( deleteEdit.geometry, self._getPhantomSymbol(deleteEdit.geometry, self._editStore.DELETE), { objectId: objectId }); this._phantomLayer.add(phantomDelete); // Add phantom graphic to the database self._editStore.pushPhantomGraphic(phantomDelete,function(result){ if(!result)console.log("There was a problem adding phantom graphic id: " + objectId); console.log("Phantom graphic " + objectId + " added to database as a deletion."); }); domAttr.set(phantomDelete.getNode(),"stroke-dasharray","4,4"); domStyle.set(phantomDelete.getNode(), "pointer-events","none"); if( self.attachmentsStore ) { // delete local attachments of this feature, if any... we just launch the delete and don't wait for it to complete self.attachmentsStore.deleteAttachmentsByFeatureId(this.url, objectId, function(deletedCount) { console.log("deleted",deletedCount,"attachments of feature",objectId); }); } promises.push(deferred); },this); all(promises).then( function(r) { // Make sure all edits were successful. If not throw an error. var success = true; var length = r.length; for(var v = 0;v < length;v++){ if(r[v] == false) success = false; } /* we already pushed the edits into the database, now we let the FeatureLayer to do the local updating of the layer graphics */ setTimeout(function() { this._editHandler(results, adds, updatesMap, callback, errback, deferred); success == true ? self.emit(self.events.EDITS_ENQUEUED, results) : self.emit(self.events.EDITS_ENQUEUED_ERROR, results); }.bind(this),0); return deferred; }.bind(this)); }; // layer.applyEdits() /** * Converts an array of graphics/features into JSON * @param features * @param updateEndEvent * @param callback */ layer.convertGraphicLayerToJSON = function(features,updateEndEvent,callback){ var layerDefinition = {}; layerDefinition.objectIdFieldName = updateEndEvent.target.objectIdField; layerDefinition.globalIdFieldName = updateEndEvent.target.globalIdField; layerDefinition.geometryType = updateEndEvent.target.geometryType; layerDefinition.spatialReference = updateEndEvent.target.spatialReference; layerDefinition.fields = updateEndEvent.target.fields; var length = features.length; var jsonArray = []; for(var i=0; i < length; i++){ var jsonGraphic = features[i].toJson(); jsonArray.push(jsonGraphic); if(i == (length - 1)) { var featureJSON = JSON.stringify(jsonArray); var layerDefJSON = JSON.stringify(layerDefinition); callback(featureJSON,layerDefJSON); break; } } }; /** * Sets the phantom layer with new features. * Used to restore PhantomGraphicsLayer after offline restart * @param graphicsArray an array of Graphics */ layer.setPhantomLayerGraphics = function(graphicsArray){ var length = graphicsArray.length; if(length > 0){ for(var i=0; i < length; i++){ var graphic = new Graphic(graphicsArray[i]); this._phantomLayer.add(graphic); } } }; /** * Returns the array of graphics from the phantom graphics layer. * This layer identifies features that have been modified * while offline. * @returns {array} */ layer.getPhantomLayerGraphics = function(callback){ //return layer._phantomLayer.graphics; var graphics = layer._phantomLayer.graphics; var length = layer._phantomLayer.graphics.length; var jsonArray = []; for(var i=0; i < length; i++){ var jsonGraphic = graphics[i].toJson(); jsonArray.push(jsonGraphic); if(i == (length - 1)) { var graphicsJSON = JSON.stringify(jsonArray); callback(graphicsJSON); break; } } }; /** * Create a featureDefinition * @param featureLayer * @param featuresArr * @param geometryType * @param callback */ layer.getFeatureDefinition = function(/* Object */ featureLayer,/* Array */ featuresArr,/* String */ geometryType,callback){ var featureDefinition = { "layerDefinition":featureLayer, "featureSet":{ "features": featuresArr, "geometryType": geometryType } }; callback(featureDefinition); }; /* internal methods */ layer._getFilesFromForm = function(formNode) { var files = []; var inputNodes = array.filter(formNode.elements, function(node) { return node.type === "file"; }); inputNodes.forEach(function(inputNode) { files.push.apply(files,inputNode.files); },this); return files; }; layer._replaceFeatureIds = function(tempObjectIds,newObjectIds,callback) { console.log("replacing ids of attachments",tempObjectIds, newObjectIds); console.assert( tempObjectIds.length === newObjectIds.length, "arrays must be the same length"); if(!tempObjectIds.length) { console.log("no ids to replace!"); callback(0); } var i, n = tempObjectIds.length; var count = n; var successCount = 0; for(i=0; i 0) { tempArray = result; var length = tempArray.length; for(var n= 0;n < length;n++) { layer = featureLayers[tempArray[n].layer]; // If the layer has attachments then check to see if the attachmentsStore has been initialized if (attachmentsStore == null && layer.hasAttachments) { console.log("ERROR: you need to run OfflineFeaturesManager.initAttachments(). Check the Attachments doc for more info."); throw new Error("OfflineFeaturesManager: Attachments aren't initialized."); } // Assign the attachmentsStore to the layer as a private var so we can access it from // the promises applyEdits() method. layer._attachmentsStore = attachmentsStore; layer.__onEditsComplete = layer.onEditsComplete; layer.onEditsComplete = function () { console.log("intercepting events onEditsComplete"); }; layer.__onBeforeApplyEdits = layer.onBeforeApplyEdits; layer.onBeforeApplyEdits = function () { console.log("intercepting events onBeforeApplyEdits"); }; // Let's zero everything out adds = [], updates = [], deletes = [], tempObjectIds = []; // IMPORTANT: reconstitute the graphic JSON into an actual esri.Graphic object // NOTE: we are only sending one Graphic per loop! var graphic = new Graphic(tempArray[n].graphic); switch (tempArray[n].operation) { case editStore.ADD: for (var i = 0; i < layer.graphics.length; i++) { var g = layer.graphics[i]; if (g.attributes[layer.objectIdField] === graphic.attributes[layer.objectIdField]) { layer.remove(g); break; } } tempObjectIds.push(graphic.attributes[layer.objectIdField]); delete graphic.attributes[layer.objectIdField]; adds.push(graphic); break; case editStore.UPDATE: updates.push(graphic); break; case editStore.DELETE: deletes.push(graphic); break; } promises[n] = that._internalApplyEdits(layer, tempArray[n].id, tempObjectIds, adds, updates, deletes); } } // wait for all requests to finish // var allPromises = all(promises); allPromises.then( function(responses) { console.log("OfflineFeaturesManager - all responses are back"); this._cleanSuccessfulEditsDatabaseRecords(responses,function(success,error){ console.log("CLEANED EDITS DATABASE") if(success){ this._editStore.resetLimitedPhantomGraphicsQueue(responses,function(success){ console.log("CLEAR PHANTOM GRAPHICS " + JSON.stringify(responses)) }); this._editStore.resetPhantomGraphicsQueue(function(success){ this.emit(this.events.EDITS_SENT); if(success == false){ console.log("There was a problem deleting phantom graphics in the database."); this.emit(this.events.EDITS_SENT_ERROR,{msg:"Problem deleting phantom graphic(s)"}); } else{ this.emit(this.events.ALL_EDITS_SENT); } callback && callback(true,responses); }.bind(this)) } else{ this.emit(this.events.EDITS_SENT_ERROR,{msg:error}); // There was a problem, some edits were not successfully sent! callback && callback(false,responses); } }.bind(that)); }.bind(that), function(errors) { console.log("OfflineFeaturesManager - ERROR!!"); console.log(errors); callback && callback(false,errors); }.bind(that) ); }); }, /** * Only delete items from database that were verified as successfully updated on the server. * @param responses Object * @param callback callback(true, responses) or callback(false, responses) * @private */ _cleanSuccessfulEditsDatabaseRecords: function(responses,callback){ if( Object.keys(responses).length !== 0 ){ var editsArray = []; var editsFailedArray = []; for(var key in responses){ if (responses.hasOwnProperty(key)) { var edit = responses[key]; var tempResult = {}; if(edit.updateResults.length > 0){ if(edit.updateResults[0].success){ tempResult.layer = edit.layer; tempResult.id = edit.updateResults[0].objectId; editsArray.push(tempResult); } else{ editsFailedArray.push(edit); } } if(edit.deleteResults.length > 0){ if(edit.deleteResults[0].success){ tempResult.layer = edit.layer; tempResult.id = edit.deleteResults[0].objectId; editsArray.push(tempResult); } else{ editsFailedArray.push(edit); } } if(edit.addResults.length > 0){ if(edit.addResults[0].success){ tempResult.layer = edit.layer; tempResult.id = edit.tempId; editsArray.push(tempResult); } else{ editsFailedArray.push(edit); } } } } var promises = {}; var length = editsArray.length; for(var i = 0; i < length; i++){ promises[i] = this._updateDatabase(editsArray[i]); } //console.log("EDIT LIST " + JSON.stringify(editsArray)); // wait for all requests to finish // var allPromises = all(promises); allPromises.then( function(responses) { editsFailedArray.length > 0 ? callback(false,responses) : callback(true,responses); }, function(errors) { callback(false,errors); } ); } else{ callback(true,{}); } }, /** * Deletes items from database * @param edit * @returns {l.Deferred.promise|*|c.promise|q.promise|promise} * @private */ _updateDatabase: function(edit){ var dfd = new Deferred(); var fakeGraphic = {}; fakeGraphic.attributes = {}; fakeGraphic.attributes.objectid = edit.id; this._editStore.delete(edit.layer,fakeGraphic,function(success,error){ if(success){ var id = this._editStore.PHANTOM_GRAPHIC_PREFIX + this._editStore._PHANTOM_PREFIX_TOKEN + edit.id; console.log("PHANTOM DELETE ID " + id); //this.deletePhantomGraphic() dfd.resolve({success: true, error:null}); } else{ dfd.reject({success:false, error: error}); } }.bind(this)); return dfd.promise; }, /** * Executes the _applyEdits() method * @param layer * @param id the unique id that identifies the Graphic in the database * @param tempObjectIds * @param adds * @param updates * @param deletes * @returns {l.Deferred.promise} contains {id,layer,tempId,addResults,updateResults,deleteResults} * @private */ _internalApplyEdits: function(layer,id,tempObjectIds,adds,updates,deletes) { var dfd = new Deferred(); layer._applyEdits(adds,updates,deletes, function(addResults,updateResults,deleteResults) { layer._phantomLayer.clear(); layer.onBeforeApplyEdits = layer.__onBeforeApplyEdits; delete layer.__onBeforeApplyEdits; var newObjectIds = addResults.map(function (r) { return r.objectId; }); // We use a different pattern if the attachmentsStore is valid and the layer has attachments if (layer._attachmentsStore != null && layer.hasAttachments && tempObjectIds.length > 0) { layer._replaceFeatureIds(tempObjectIds, newObjectIds, function (success) { dfd.resolve({ id: id, layer: layer.url, tempId: tempObjectIds, // let's us internally match an ADD to it's new ObjectId addResults: addResults, updateResults: updateResults, deleteResults: deleteResults }); // wrap three arguments in a single object }); } else { dfd.resolve({ id: id, layer: layer.url, tempId: tempObjectIds, // let's us internally match an ADD to it's new ObjectId addResults: addResults, updateResults: updateResults, deleteResults: deleteResults }); // wrap three arguments in a single object } }, function(error) { layer.onEditsComplete = layer.__onEditsComplete; delete layer.__onEditsComplete; layer.onBeforeApplyEdits = layer.__onBeforeApplyEdits; delete layer.__onBeforeApplyEdits; dfd.reject(error); } ); return dfd.promise; }, /** * DEPRECATED @ v2.5 * @returns {{}} * @private */ _optimizeEditsQueue: function() { var optimizedEdits = {}, editCount = this._editStore.pendingEditsCount(), optimizedCount = 0; var edit, layer; var layerEdits, objectId; while( this._editStore.hasPendingEdits() ) { edit = this._editStore.popFirstEdit(); layer = this._featureLayers[ edit.layer ]; if( ! (edit.layer in optimizedEdits) ) { optimizedEdits[edit.layer] = {}; } layerEdits = optimizedEdits[edit.layer]; objectId = edit.graphic.attributes[ layer.objectIdField ]; if( !( objectId in layerEdits) ) { // first edit we see of this feature, no optimization to apply layerEdits[ objectId ] = edit; optimizedCount += 1; } else { // we already have seen one edit for this same feature... we can merge the two edits in a single operation switch( edit.operation ) { case this._editStore.ADD: /* impossible!! */ throw("can't add the same feature twice!"); case this._editStore.UPDATE: layerEdits[ objectId ].graphic = edit.graphic; break; case this._editStore.DELETE: if(objectId < 0) { delete layerEdits[ objectId ]; optimizedCount -= 1; } else { layerEdits[objectId].operation = this._editStore.DELETE; } break; } } if( Object.keys(layerEdits).length === 0 ) { delete optimizedEdits[edit.layer]; } } console.log("optimized", editCount, "edits into", optimizedCount,"edits of", Object.keys(optimizedEdits).length ,"layers"); return optimizedEdits; }, /** * DEPRECATED @ v2.5 * A string value representing human readable information on pending edits * @param edit * @returns {string} */ getReadableEdit: function(edit) { var layer = this._featureLayers[ edit.layer ]; var graphic = this._editStore._deserialize(edit.graphic); var readableGraphic = graphic.geometry.type; var layerId = edit.layer.substring(edit.layer.lastIndexOf("/")+1); if(layer) { readableGraphic += " [id=" + graphic.attributes[layer.objectIdField] + "]"; } return "o:" + edit.operation + ", l:" + layerId + ", g:" + readableGraphic; } }); // declare }); // define