archive-gh-me/offline-editor-js
1
0
Fork 0
mirror of https://github.com/Esri/offline-editor-js.git synced 2025-12-15 15:20:05 +00:00
Code Issues Projects Releases Wiki Activity
offline-editor-js/lib/edit/offlineFeaturesManager.js

1587 lines
79 KiB
JavaScript
Raw Blame History

define([
"dojo/Evented",
"dojo/_base/Deferred",
"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, 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
// Database properties
DB_NAME: "features_store", // Sets the database name.
DB_OBJECTSTORE_NAME: "features",// Represents an object store that allows access to a set of data in the IndexedDB database
DB_UID: "objectid", // Set this based on the unique identifier is set up in the feature service
// 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. Call this AFTER the FeatureLayer's 'update-end' event.
* IMPORTANT: If options are specified they will be saved to the database. Any complex
* objects such as [esri.Graphic] will need to be serialized or you will get an error.
* @param layer
* @param updateEndEvent The FeatureLayer's update-end event object
* @param callback {true, null} or {false, errorString} Traps whether or not the database initialized
* @param options Optional configuration Object. Added @ v2.5
* @returns deferred
*/
extend: function (layer, callback, options) {
var self = this;
// Initialize the database as well as set offline data.
this._initializeDB(options,callback);
// 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
* @event EDITS_ENQUEUED boolean if all edits successfully stored while offline
* @event EDITS_ENQUEUED_ERROR string message 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 deferred1 = new Deferred();
var results = {addResults: [], updateResults: [], deleteResults: []};
var updatesMap = {};
adds = adds || [];
adds.forEach(function (addEdit) {
var deferred = new Deferred();
var objectId = this._getNextTempId();
addEdit.attributes[this.objectIdField] = objectId;
var thisLayer = this;
// We need to run some validation tests against each feature being added.
// Adding the same feature multiple times results in the last edit wins. LIFO.
this._validateFeature(addEdit,this.url,self._editStore.ADD).then(function(result){
console.log("EDIT ADD IS BACK!!! " );
if(result.success){
thisLayer._pushValidatedAddFeatureToDB(thisLayer,addEdit,result.operation,results,objectId,deferred);
}
else{
// If we get here then we deleted an edit that was added offline.
// We also have deleted the phantom graphic.
deferred.resolve(true);
}
},function(error){
console.log("_validateFeature: Unable to validate!");
deferred.reject(error);
});
promises.push(deferred);
}, this);
updates = updates || [];
updates.forEach(function (updateEdit) {
var deferred = new Deferred();
var objectId = updateEdit.attributes[this.objectIdField];
updatesMap[objectId] = updateEdit;
var thisLayer = this;
// We need to run some validation tests against each feature being updated.
// If we have added a feature and we need to update it then we change it's operation type to "add"
// and the last edits wins. LIFO.
this._validateFeature(updateEdit,this.url,self._editStore.UPDATE).then(function(result){
console.log("EDIT UPDATE IS BACK!!! " );
if(result.success){
thisLayer._pushValidatedUpdateFeatureToDB(thisLayer,updateEdit,result.operation,results,objectId,deferred);
}
else{
// If we get here then we deleted an edit that was added offline.
// We also have deleted the phantom graphic.
deferred.resolve(true);
}
},function(error){
console.log("_validateFeature: Unable to validate!");
deferred.reject(error);
});
promises.push(deferred);
}, this);
deletes = deletes || [];
deletes.forEach(function (deleteEdit) {
var deferred = new Deferred();
var objectId = deleteEdit.attributes[this.objectIdField];
var thisLayer = this;
// We need to run some validation tests against each feature being deleted.
// If we have added a feature and then deleted it in the app then we go ahead
// and delete it and its phantom graphic from the database.
// NOTE: at this time we don't handle attachments automatically
this._validateFeature(deleteEdit,this.url,self._editStore.DELETE).then(function(result){
console.log("EDIT DELETE IS BACK!!! " );
if(result.success){
thisLayer._pushValidatedDeleteFeatureToDB(thisLayer,deleteEdit,result.operation,results,objectId,deferred);
}
else{
// If we get here then we deleted an edit that was added offline.
// We also have deleted the phantom graphic.
deferred.resolve(true);
}
},function(error){
console.log("_validateFeature: Unable to validate!");
deferred.reject(error);
});
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
// EDITS_ENQUEUED = callback(true, edit), and EDITS_ENQUEUED_ERROR = callback(false, /*String */ error)
this._editHandler(results, adds, updatesMap, callback, errback, deferred1);
success == true ? self.emit(self.events.EDITS_ENQUEUED, results) : self.emit(self.events.EDITS_ENQUEUED_ERROR, results);
}.bind(this));
return deferred1;
}; // layer.applyEdits()
/**
* Converts an array of graphics/features into JSON
* @param features
* @param updateEndEvent The layer's 'update-end' event
* @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;
}
}
};
/**
* Retrieves f=json from the feature layer
* @param url FeatureLayer's URL
* @param callback
* @private
*/
layer.getFeatureLayerJSON = function (url, callback) {
require(["esri/request"], function (esriRequest) {
var request = esriRequest({
url: url,
content: {f: "json"},
handleAs: "json",
callbackParamName: "callback"
});
request.then(function (response) {
console.log("Success: ", response);
callback(true, response);
}, function (error) {
console.log("Error: ", error.message);
callback(false, error.message);
});
})
};
/**
* Sets the optional feature layer storage object
* @param jsonObject
* @param callback
*/
layer.setFeatureLayerJSONOptions = function(jsonObject, callback){
self._editStore.pushFeatureLayerJSON(jsonObject,function(success,error){
callback(success,error);
});
};
/**
* Retrieves the optional feature layer storage object
* @param callback callback(true, object) || callback(false, error)
*/
layer.getFeatureLayerJSONOptions = function(callback){
self._editStore.getFeatureLayerJSON(function(success,message){
callback(success,message);
})
};
///**
//* Serialize the feature layer graphics
//* @param features Array of features
//* @param callback
//*/
//layer.convertFeatureGraphicsToJSON = function (features, callback) {
// 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);
// callback(featureJSON);
// 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;
}
}
};
/**
* Returns an array of phantom graphics from the database.
* @param callback callback (true, array) or (false, errorString)
*/
layer.getPhantomGraphicsArray = function(callback){
self._editStore.getPhantomGraphicsArray(function(array,message){
if(message == "end"){
callback(true,array);
}
else{
callback(false,message);
}
});
};
/**
* Returns the approximate size of the database in bytes
* @param callback callback({usage}, error) Whereas, the usage Object is {sizeBytes: number, editCount: number}
*/
layer.getUsage = function(callback){
self._editStore.getUsage(function(usage,error){
callback(usage,error);
});
};
/**
* Full database reset.
* CAUTION! If some edits weren't successfully sent, then their record
* will still exist in the database. If you use this function you
* will also delete those records.
* @param callback (boolean, error)
*/
layer.resetDatabase = function(callback){
self._editStore.resetEditsQueue(function(result,error){
callback(result,error);
});
};
/**
* Returns the number of edits pending in the database.
* @param callback callback( int )
*/
layer.pendingEditsCount = function(callback){
self._editStore.pendingEditsCount(function(count){
callback(count);
})
};
/**
* 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);
};
/**
* Returns an interable array of all edits stored in the database
* Each item in the array is an object and contains:
* {
* id: "internal ID",
* operation: "add, update or delete",
* layer: "layerURL",
* type: "esri Geometry Type",
* graphic: "esri.Graphic converted to JSON"
* }
* @param callback (true, array) or (false, errorString)
*/
layer.getAllEditsArray = function(callback){
self._editStore.getAllEditsArray(function(array,message){
if(message == "end"){
callback(true,array);
}
else{
callback(false,message);
}
})
};
/* internal methods */
/**
* Pushes an DELETE request to the database after it's been validated
* @param layer
* @param deleteEdit
* @param operation
* @param resultsArray
* @param objectId
* @param deferred
* @private
*/
layer._pushValidatedDeleteFeatureToDB = function(layer,deleteEdit,operation,resultsArray,objectId,deferred){
self._editStore.pushEdit(operation, layer.url, deleteEdit, function (result, error) {
if(result == true){
resultsArray.deleteResults.push({success: true, error: null, objectId: objectId});
// Use the correct key as set by self.DB_UID
var tempIdObject = {};
tempIdObject[self.DB_UID] = objectId;
var phantomDelete = new Graphic(
deleteEdit.geometry,
self._getPhantomSymbol(deleteEdit.geometry, self._editStore.DELETE),
tempIdObject
);
layer._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(layer.url, objectId, function (deletedCount) {
console.log("deleted", deletedCount, "attachments of feature", objectId);
});
}
deferred.resolve(result);
}
else{
// If we can't push edit to database then we don't create a phantom graphic
resultsArray.addResults.push({success: false, error: error, objectId: objectId});
deferred.reject(error);
}
});
};
/**
* Pushes an UPDATE request to the database after it's been validated
* @param layer
* @param updateEdit
* @param operation
* @param resultsArray
* @param objectId
* @param deferred
* @private
*/
layer._pushValidatedUpdateFeatureToDB = function(layer,updateEdit,operation,resultsArray,objectId,deferred){
self._editStore.pushEdit(operation, layer.url, updateEdit, function (result, error) {
if(result == true){
resultsArray.updateResults.push({success: true, error: null, objectId: objectId});
// Use the correct key as set by self.DB_UID
var tempIdObject = {};
tempIdObject[self.DB_UID] = objectId;
var phantomUpdate = new Graphic(
updateEdit.geometry,
self._getPhantomSymbol(updateEdit.geometry, self._editStore.UPDATE),
tempIdObject
);
layer._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");
deferred.resolve(result);
}
else{
// If we can't push edit to database then we don't create a phantom graphic
resultsArray.addResults.push({success: false, error: error, objectId: objectId});
deferred.reject(error);
}
});
};
/**
* Pushes an ADD request to the database after it's been validated
* @param layer
* @param addEdit
* @param operation
* @param resultsArray
* @param objectId
* @param deferred
* @private
*/
layer._pushValidatedAddFeatureToDB = function(layer,addEdit,operation,resultsArray,objectId,deferred){
self._editStore.pushEdit(operation, layer.url, addEdit, function (result, error) {
if(result == true){
resultsArray.addResults.push({success: true, error: null, objectId: objectId});
// Use the correct key as set by self.DB_UID
var tempIdObject = {};
tempIdObject[self.DB_UID] = objectId;
var phantomAdd = new Graphic(
addEdit.geometry,
self._getPhantomSymbol(addEdit.geometry, self._editStore.ADD),
tempIdObject
);
// Add phantom graphic to the layer
layer._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");
deferred.resolve(result);
}
else{
// If we can't push edit to database then we don't create a phantom graphic
resultsArray.addResults.push({success: false, error: error, objectId: objectId});
deferred.reject(error);
}
});
};
/**
* Validates duplicate entries. Last edit on same feature can overwite any previous values.
* Note: if an edit was already added offline and you delete it then we return success == false
* @param graphic esri.Graphic.
* @param layerUrl the URL of the feature service
* @param operation add, update or delete action on an edit
* @returns deferred {success:boolean,graphic:graphic,operation:add|update|delete}
* @private
*/
layer._validateFeature = function (graphic,layerUrl,operation) {
var deferred = new Deferred();
var id = layerUrl + "/" + graphic.attributes.objectid;
self._editStore.getEdit(id,function(success,result){
if (success) {
switch( operation )
{
case self._editStore.ADD:
// Not good - however we'll allow the new ADD to replace/overwrite existing edit
// and pass it through unmodified. Last ADD wins.
deferred.resolve({"success":true,"graphic":graphic,"operation":operation});
break;
case self._editStore.UPDATE:
// If we are doing an update on a feature that has not been added to
// the server yet, then we need to maintain its operation as an ADD
// and not an UPDATE. This avoids the potential for an error if we submit
// an update operation on a feature that has not been added to the
// database yet.
if(result.operation == self._editStore.ADD){
graphic.operation = self._editStore.ADD;
operation = self._editStore.ADD;
}
deferred.resolve({"success":true,"graphic":graphic,"operation":operation});
break;
case self._editStore.DELETE:
var resolved = true;
if(result.operation == self._editStore.ADD){
// If we are deleting a new feature that has not been added to the
// server yet we need to delete it and its phantom graphic.
self._deleteTemporaryFeature(graphic,function(success){
if(success == false){
resolved = false;
}
});
}
deferred.resolve({"success":resolved,"graphic":graphic,"operation":operation});
break;
}
}
else if(result == "Id not found"){
// Let's simply pass the graphic back as good-to-go.
// No modifications needed because the graphic does not
// already exist in the database.
deferred.resolve({"success":true,"graphic":graphic,"operation":operation});
}
else{
deferred.reject(graphic);
}
});
return deferred;
};
/**
* Delete a graphic and its associated phantom graphic that has been added while offline.
* @param graphic
* @param callback
* @private
*/
layer._deleteTemporaryFeature = function(graphic,callback){
var phantomGraphicId = self._editStore.PHANTOM_GRAPHIC_PREFIX + self._editStore._PHANTOM_PREFIX_TOKEN + graphic.attributes.objectid;
function _deleteGraphic(){
var deferred = new Deferred();
self._editStore.delete(layer.url,graphic,function(success,error){
if(success){
deferred.resolve(true);
}
else{
deferred.resolve(false);
}
});
return deferred.promise;
}
function _deletePhantomGraphic(){
var deferred = new Deferred();
self._editStore.deletePhantomGraphic(phantomGraphicId,function(success){
if(success){
deferred.resolve(true);
}
else{
deferred.resolve(false);
}
});
return deferred.promise;
}
all([_deleteGraphic(),_deletePhantomGraphic()]).then(function (results) {
callback(results);
});
};
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 < n; i++) {
self.attachmentsStore.replaceFeatureId(this.url, tempObjectIds[i], newObjectIds[i], function (success) {
--count;
successCount += (success ? 1 : 0);
if (count === 0) {
callback(successCount);
}
}.bind(this));
}
};
// we need to identify ADDs before sending them to the server
// we assign temporary ids (using negative numbers to distinguish them from real ids)
layer._nextTempId = -1;
layer._getNextTempId = function () {
return this._nextTempId--;
};
function _initPhantomLayer() {
try {
layer._phantomLayer = new GraphicsLayer({opacity: 0.8});
layer._map.addLayer(layer._phantomLayer);
}
catch (err) {
console.log("Unable to init PhantomLayer");
}
}
_initPhantomLayer();
}, // extend
/**
* Forces library into an offline state. Any edits applied during this condition will be stored locally
*/
goOffline: function () {
console.log("offlineFeatureManager going offline");
this._onlineStatus = this.OFFLINE;
},
/**
* Forces library to return to an online state. If there are pending edits,
* an attempt will be made to sync them with the remote feature server
* @param callback callback( boolean, errors )
*/
goOnline: function (callback) {
console.log("offlineFeaturesManager going online");
this._onlineStatus = this.RECONNECTING;
this._replayStoredEdits(function (success, responses) {
var result = {features: {success: success, responses: responses}};
if (this.attachmentsStore != null) {
console.log("sending attachments");
this._sendStoredAttachments(function (success, responses) {
this._onlineStatus = this.ONLINE;
result.attachments = {success: success, responses: responses};
callback && callback(result);
}.bind(this));
}
else {
this._onlineStatus = this.ONLINE;
callback && callback(result);
}
}.bind(this));
},
/**
* Determines if offline or online condition exists
* @returns {string} ONLINE or OFFLINE
*/
getOnlineStatus: function () {
return this._onlineStatus;
},
/**
* Serialize the feature layer graphics
* @param features Array of features
* @param callback Returns a JSON string
*/
serializeFeatureGraphicsArray: function (features, callback) {
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);
callback(featureJSON);
break;
}
}
},
/* internal methods */
/**
* Intialize the database and push featureLayer JSON to DB if required
* @param options
* @param callback
* @private
*/
_initializeDB: function(options,callback){
var editStore = this._editStore;
// Configure the database
editStore.dbName = this.DB_NAME;
editStore.objectStoreName = this.DB_OBJECTSTORE_NAME;
editStore.objectId = this.DB_UID;
// Attempt to initialize the database
editStore.init(function (result, error) {
////////////////////////////////////////////////////
// OFFLINE RESTART CONFIGURATION
// Added @ v2.5
//
// Configure database for offline restart
// Options object allows you to store data that you'll
// use after an offline browser restart.
//
// If options Object is not defined then do nothing.
//
////////////////////////////////////////////////////
if (typeof options == "object" && result == true) {
editStore.pushFeatureLayerJSON(options, function (success, err) {
if (success) {
callback(true, null);
}
else {
callback(false, err);
}
})
}
else if(result == false){
callback(false, error);
}
else if(result == true){
callback(true, null);
}
});
},
/**
* internal method that checks if this browser supports everything that is needed to handle offline attachments
* it also extends XMLHttpRequest with sendAsBinary() method, needed in Chrome
*/
_checkFileAPIs: function () {
if (window.File && window.FileReader && window.FileList && window.Blob) {
console.log("All APIs supported!");
if (!XMLHttpRequest.prototype.sendAsBinary) {
// https://code.google.com/p/chromium/issues/detail?id=35705#c40
XMLHttpRequest.prototype.sendAsBinary = function (datastr) {
function byteValue(x) {
return x.charCodeAt(0) & 0xff;
}
var ords = Array.prototype.map.call(datastr, byteValue);
var ui8a = new Uint8Array(ords);
this.send(ui8a.buffer);
};
console.log("extending XMLHttpRequest");
}
return true;
}
console.log("The File APIs are not fully supported in this browser.");
return false;
},
/**
* internal method that extends an object with sendAsBinary() method
* sometimes extending XMLHttpRequest.prototype is not enough, as ArcGIS JS lib seems to mess with this object too
* @param oAjaxReq object to extend
*/
_extendAjaxReq: function (oAjaxReq) {
oAjaxReq.sendAsBinary = XMLHttpRequest.prototype.sendAsBinary;
console.log("extending XMLHttpRequest");
},
//
// phantom symbols
//
_phantomSymbols: [],
_getPhantomSymbol: function (geometry, operation) {
if (this._phantomSymbols.length === 0) {
var color = [0, 255, 0, 255];
var width = 1.5;
this._phantomSymbols['point'] = [];
this._phantomSymbols['point'][this._editStore.ADD] = new SimpleMarkerSymbol({
"type": "esriSMS", "style": "esriSMSCross",
"xoffset": 10, "yoffset": 10,
"color": [255, 255, 255, 0], "size": 15,
"outline": {"color": color, "width": width, "type": "esriSLS", "style": "esriSLSSolid"}
});
this._phantomSymbols['point'][this._editStore.UPDATE] = new SimpleMarkerSymbol({
"type": "esriSMS", "style": "esriSMSCircle",
"xoffset": 0, "yoffset": 0,
"color": [255, 255, 255, 0], "size": 15,
"outline": {"color": color, "width": width, "type": "esriSLS", "style": "esriSLSSolid"}
});
this._phantomSymbols['point'][this._editStore.DELETE] = new SimpleMarkerSymbol({
"type": "esriSMS", "style": "esriSMSX",
"xoffset": 0, "yoffset": 0,
"color": [255, 255, 255, 0], "size": 15,
"outline": {"color": color, "width": width, "type": "esriSLS", "style": "esriSLSSolid"}
});
this._phantomSymbols['multipoint'] = null;
this._phantomSymbols['polyline'] = [];
this._phantomSymbols['polyline'][this._editStore.ADD] = new SimpleLineSymbol({
"type": "esriSLS", "style": "esriSLSSolid",
"color": color, "width": width
});
this._phantomSymbols['polyline'][this._editStore.UPDATE] = new SimpleLineSymbol({
"type": "esriSLS", "style": "esriSLSSolid",
"color": color, "width": width
});
this._phantomSymbols['polyline'][this._editStore.DELETE] = new SimpleLineSymbol({
"type": "esriSLS", "style": "esriSLSSolid",
"color": color, "width": width
});
this._phantomSymbols['polygon'] = [];
this._phantomSymbols['polygon'][this._editStore.ADD] = new SimpleFillSymbol({
"type": "esriSFS",
"style": "esriSFSSolid",
"color": [255, 255, 255, 0],
"outline": {"type": "esriSLS", "style": "esriSLSSolid", "color": color, "width": width}
});
this._phantomSymbols['polygon'][this._editStore.UPDATE] = new SimpleFillSymbol({
"type": "esriSFS",
"style": "esriSFSSolid",
"color": [255, 255, 255, 0],
"outline": {"type": "esriSLS", "style": "esriSLSDash", "color": color, "width": width}
});
this._phantomSymbols['polygon'][this._editStore.DELETE] = new SimpleFillSymbol({
"type": "esriSFS",
"style": "esriSFSSolid",
"color": [255, 255, 255, 0],
"outline": {"type": "esriSLS", "style": "esriSLSDot", "color": color, "width": width}
});
}
return this._phantomSymbols[geometry.type][operation];
},
//
// methods to handle attachment uploads
//
_fieldSegment: function (name, value) {
return "Content-Disposition: form-data; name=\"" + name + "\"\r\n\r\n" + value + "\r\n";
},
_fileSegment: function (fieldName, fileName, fileType, fileContent) {
return "Content-Disposition: form-data; name=\"" + fieldName +
"\"; filename=\"" + fileName +
"\"\r\nContent-Type: " + fileType + "\r\n\r\n" +
fileContent + "\r\n";
},
_uploadAttachment: function (attachment) {
var dfd = new Deferred();
var segments = [];
segments.push(this._fieldSegment("f", "json"));
segments.push(this._fileSegment("attachment", attachment.name, attachment.contentType, attachment.content));
var oAjaxReq = new XMLHttpRequest();
// surprisingly, sometimes the oAjaxReq object doesn't have the sendAsBinary() method, even if we added it to the XMLHttpRequest.prototype
if (!oAjaxReq.sendAsBinary) {
this._extendAjaxReq(oAjaxReq);
}
oAjaxReq.onload = function (result) {
dfd.resolve(JSON.parse(result.target.response));
};
oAjaxReq.onerror = function (err) {
dfd.reject(err);
};
// IMPORTANT!
// Proxy path can be set to null if feature service is CORS enabled
// Refer to "Using the Proxy Page" for more information: https://developers.arcgis.com/en/javascript/jshelp/ags_proxy.html
var proxy = this.proxyPath || esriConfig.defaults.io.proxyUrl || "";
if (proxy !== "") {
proxy += "?";
}
console.log("proxy:", proxy);
oAjaxReq.open("post", proxy + attachment.featureId + "/addAttachment", true);
var sBoundary = "---------------------------" + Date.now().toString(16);
oAjaxReq.setRequestHeader("Content-Type", "multipart\/form-data; boundary=" + sBoundary);
oAjaxReq.sendAsBinary("--" + sBoundary + "\r\n" + segments.join("--" + sBoundary + "\r\n") + "--" + sBoundary + "--\r\n");
return dfd;
},
_deleteAttachment: function (attachmentId, uploadResult) {
var dfd = new Deferred();
console.log("upload complete", uploadResult, attachmentId);
this.attachmentsStore.delete(attachmentId, function (success) {
console.assert(success === true, "can't delete attachment already uploaded");
console.log("delete complete", success);
dfd.resolve(uploadResult);
});
return dfd;
},
_sendStoredAttachments: function (callback) {
this.attachmentsStore.getAllAttachments(function (attachments) {
console.log("we have", attachments.length, "attachments to upload");
var promises = [];
attachments.forEach(function (attachment) {
console.log("sending attachment", attachment.id, "to feature", attachment.featureId);
var deleteCompleted =
this._uploadAttachment(attachment)
.then(function (uploadResult) {
if (uploadResult.addAttachmentResult && uploadResult.addAttachmentResult.success === true) {
console.log("upload success", uploadResult.addAttachmentResult.success);
return this._deleteAttachment(attachment.id, uploadResult);
}
else {
console.log("upload failed", uploadResult);
return null;
}
}.bind(this),
function (err) {
console.log("failed uploading attachment", attachment);
}
);
promises.push(deleteCompleted);
}, this);
console.log("promises", promises.length);
var allPromises = all(promises);
allPromises.then(function (results) {
console.log(results);
callback && callback(true, results);
},
function (err) {
console.log("error!", err);
callback && callback(false, err);
});
}.bind(this));
},
//
// methods to send features back to the server
//
/**
* Attempts to send any edits in the database. Monitor events for success or failure.
* @param callback
* @event ALL_EDITS_SENT when all edits have been successfully sent. Contains {[addResults],[updateResults],[deleteResults]}
* @event EDITS_SENT_ERROR some edits were not sent successfully. Contains {msg: error}
* @private
*/
_replayStoredEdits: function (callback) {
var promises = {};
var that = this;
//
// send edits for each of the layers
//
var layer;
var adds = [], updates = [], deletes = [];
var tempObjectIds = [];
var tempArray = [];
var featureLayers = this._featureLayers;
var attachmentsStore = this.attachmentsStore;
var editStore = this._editStore;
this._editStore.getAllEditsArray(function (result, err) {
if (result.length > 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("NOTICE: you may need to run OfflineFeaturesManager.initAttachments(). Check the Attachments doc for more info. Layer id: " + layer.id + " accepts attachments");
}
// 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");
};
// 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);
}
}
else{
// No edits were found
callback(true,[]);
}
// 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) {
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,responses);
}
callback && callback(true, responses);
}.bind(this))
}
else {
this.emit(this.events.EDITS_SENT_ERROR, {msg: responses}); // 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;
},
/**
* Retrieves f=json from the feature layer
* @param url FeatureLayer's URL
* @param callback
* @private
*/
getFeatureLayerJSON: function (url, callback) {
require(["esri/request"], function (esriRequest) {
var request = esriRequest({
url: url,
content: {f: "json"},
handleAs: "json",
callbackParamName: "callback"
});
request.then(function (response) {
console.log("Success: ", response);
callback(true, response);
}, function (error) {
console.log("Error: ", error.message);
callback(false, error.message);
});
})
},
/**
* 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();
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;
dfd.reject(error);
}
);
return dfd.promise;
},
/**
* Deprecated @ v2.5. Internal-use only
* @returns {string}
* @private
*/
_optimizeEditsQueue: function(){
return "DEPRECATED at v2.5!";
},
/**
* DEPRECATED @ v2.5. Use getAllEditsArray() and parse the results
* A string value representing human readable information on pending edits
* @param edit
* @returns {string}
*/
getReadableEdit: function (edit) {
return "DEPRECATED at v2.5!";
}
}); // declare
}); // define
Reference in New Issue View Git Blame Copy Permalink