Google Drive realtime sync

This commit is contained in:
benweet 2013-07-21 23:18:35 +01:00
parent d1be6b1566
commit 890a71ec13
8 changed files with 64 additions and 38 deletions

View File

@ -480,7 +480,7 @@ div.dropdown-menu textarea {
.icon-gdrive.realtime { .icon-gdrive.realtime {
width: 18px; width: 18px;
background-position: -180px 0; background-position: -162px 0;
} }
.icon-dropbox { .icon-dropbox {

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

View File

@ -127,6 +127,12 @@ define([
// Run the next task in the queue if any and no other running // Run the next task in the queue if any and no other running
function runTask() { function runTask() {
// Wait for user first interaction before running first task
if(core.isUserReal === false) {
return
}
// Use defer to avoid stack overflow // Use defer to avoid stack overflow
_.defer(function() { _.defer(function() {

View File

@ -26,12 +26,12 @@ define([
}; };
// Used to detect user activity // Used to detect user activity
var userReal = false; core.isUserReal = false;
var userActive = false; var userActive = false;
var windowUnique = true; var windowUnique = true;
var userLastActivity = 0; var userLastActivity = 0;
function setUserActive() { function setUserActive() {
userReal = true; core.isUserReal = true;
userActive = true; userActive = true;
userLastActivity = utils.currentTime; userLastActivity = utils.currentTime;
} }
@ -46,7 +46,7 @@ define([
// Used to only have 1 window of the application in the same browser // Used to only have 1 window of the application in the same browser
var windowId = undefined; var windowId = undefined;
function checkWindowUnique() { function checkWindowUnique() {
if(userReal === false || windowUnique === false) { if(core.isUserReal === false || windowUnique === false) {
return; return;
} }
if(windowId === undefined) { if(windowId === undefined) {

View File

@ -85,6 +85,13 @@ define([
task.chain(localAuthenticate); task.chain(localAuthenticate);
}); });
} }
googleHelper.forceAuthenticate = function() {
authenticated = false;
var task = new AsyncTask();
connect(task);
authenticate(task);
task.enqueue();
};
googleHelper.upload = function(fileId, parentId, title, content, etag, callback) { googleHelper.upload = function(fileId, parentId, title, content, etag, callback) {
var result = undefined; var result = undefined;
@ -458,7 +465,7 @@ define([
task.enqueue(); task.enqueue();
}; };
googleHelper.loadRealtime = function(fileId, content, callback) { googleHelper.loadRealtime = function(fileId, content, callback, errorCallback) {
var doc = undefined; var doc = undefined;
var task = new AsyncTask(); var task = new AsyncTask();
connect(task); connect(task);
@ -473,10 +480,8 @@ define([
var string = model.createString(content); var string = model.createString(content);
model.getRoot().set('content', string); model.getRoot().set('content', string);
}, function(err) { }, function(err) {
// handleErrors errorCallback(err);
handleError({ task.error(new Error(err.message));
code: err.type
}, task);
}); });
}); });
task.onSuccess(function() { task.onSuccess(function() {
@ -503,7 +508,7 @@ define([
task.retry(new Error(errorMsg)); task.retry(new Error(errorMsg));
return; return;
} }
else if(error.code === 401 || error.code === 403) { else if(error.code === 401 || error.code === 403 || error.code == "token_refresh_required") {
authenticated = false; authenticated = false;
errorMsg = "Access to Google account is not authorized."; errorMsg = "Access to Google account is not authorized.";
task.retry(new Error(errorMsg), 1); task.retry(new Error(errorMsg), 1);

View File

@ -89,7 +89,7 @@ define([
callback(undefined, syncAttributes); callback(undefined, syncAttributes);
}); });
}; };
gdriveProvider.exportRealtimeFile = function(event, title, content, callback) { gdriveProvider.exportRealtimeFile = function(event, title, content, callback) {
var parentId = utils.getInputTextValue("#input-sync-export-gdrive-parentid"); var parentId = utils.getInputTextValue("#input-sync-export-gdrive-parentid");
googleHelper.createRealtimeFile(parentId, title, function(error, result) { googleHelper.createRealtimeFile(parentId, title, function(error, result) {
@ -266,33 +266,38 @@ define([
extensionMgr.addHookCallback("onEditorConfigure", function(editorParam) { extensionMgr.addHookCallback("onEditorConfigure", function(editorParam) {
editor = editorParam; editor = editorParam;
}); });
// Start realtime synchronization // Start realtime synchronization
var realtimeDocument = undefined; var realtimeDocument = undefined;
var realtimeBinding = undefined; var realtimeBinding = undefined;
var undoExecute = undefined; var undoExecute = undefined;
var redoExecute = undefined; var redoExecute = undefined;
gdriveProvider.startRealtimeSync = function(localTitle, localContent, syncAttributes, callback) { gdriveProvider.startRealtimeSync = function(fileDesc, syncAttributes) {
logger.log("Starting Google Drive realtime synchronization"); googleHelper.loadRealtime(syncAttributes.id, fileDesc.content, function(err, doc) {
googleHelper.loadRealtime(syncAttributes.id, localContent, function(err, doc) {
if(err || !doc) { if(err || !doc) {
callback(err);
return; return;
} }
// If user just switched to another document
if(fileMgr.currentFile !== fileDesc) {
doc.close();
return;
}
logger.log("Starting Google Drive realtime synchronization");
realtimeDocument = doc; realtimeDocument = doc;
var model = realtimeDocument.getModel(); var model = realtimeDocument.getModel();
var string = model.getRoot().get('content'); var string = model.getRoot().get('content');
// Saves model content checksum // Saves model content checksum
function updateContentState() { function updateContentState() {
syncAttributes.contentCRC = utils.crc32(string.getText()); syncAttributes.contentCRC = utils.crc32(string.getText());
utils.storeAttributes(syncAttributes); utils.storeAttributes(syncAttributes);
} }
var debouncedRefreshPreview = _.debounce(editor.refreshPreview, 100); var debouncedRefreshPreview = _.debounce(editor.refreshPreview, 100);
// Called when a modification has been detected // Called when a modification has been detected
function contentChangeListener(e) { function contentChangeListener(e) {
console.log(e);
// If modification comes down from a collaborator // If modification comes down from a collaborator
if(e.isLocal === false) { if(e.isLocal === false) {
logger.log("Google Drive realtime document updated from server"); logger.log("Google Drive realtime document updated from server");
@ -304,15 +309,15 @@ define([
string.addEventListener(gapi.drive.realtime.EventType.TEXT_INSERTED, contentChangeListener); string.addEventListener(gapi.drive.realtime.EventType.TEXT_INSERTED, contentChangeListener);
string.addEventListener(gapi.drive.realtime.EventType.TEXT_DELETED, contentChangeListener); string.addEventListener(gapi.drive.realtime.EventType.TEXT_DELETED, contentChangeListener);
realtimeDocument.addEventListener(gapi.drive.realtime.EventType.DOCUMENT_SAVE_STATE_CHANGED, function(e) { realtimeDocument.addEventListener(gapi.drive.realtime.EventType.DOCUMENT_SAVE_STATE_CHANGED, function(e) {
console.log(e);
// Save success event // Save success event
if(e.isPending === false && e.isSaving === false) { if(e.isPending === false && e.isSaving === false) {
logger.log("Google Drive realtime document successfully saved on server"); logger.log("Google Drive realtime document successfully saved on server");
updateContentState(); updateContentState();
} }
}); });
// Try to merge offline modifications // Try to merge offline modifications
var localContent = fileDesc.content;
var localContentChanged = syncAttributes.contentCRC != utils.crc32(localContent); var localContentChanged = syncAttributes.contentCRC != utils.crc32(localContent);
var remoteContent = string.getText(); var remoteContent = string.getText();
var remoteContentCRC = utils.crc32(remoteContent); var remoteContentCRC = utils.crc32(remoteContent);
@ -321,25 +326,25 @@ define([
if(fileContentChanged === true && localContentChanged === true) { if(fileContentChanged === true && localContentChanged === true) {
if(remoteContentChanged === true) { if(remoteContentChanged === true) {
// Conflict detected // Conflict detected
fileMgr.createFile(localTitle + " (backup)", localContent); fileMgr.createFile(fileDesc.title + " (backup)", localContent);
extensionMgr.onMessage('Conflict detected on "' + localTitle + '". A backup has been created locally.'); extensionMgr.onMessage('Conflict detected on "' + fileDesc.title + '". A backup has been created locally.');
} }
else { else {
// Add local modifications if no collaborators change // Add local modifications if no collaborators change
string.setText(localContent); string.setText(localContent);
} }
} }
// Binds model with textarea // Binds model with textarea
realtimeBinding = gapi.drive.realtime.databinding.bindString(string, $("#wmd-input")[0]); realtimeBinding = gapi.drive.realtime.databinding.bindString(string, $("#wmd-input")[0]);
// Update content state according to collaborators changes // Update content state according to collaborators changes
if(remoteContentChanged === true) { if(remoteContentChanged === true) {
logger.log("Google Drive realtime document updated from server"); logger.log("Google Drive realtime document updated from server");
updateContentState(); updateContentState();
debouncedRefreshPreview(); debouncedRefreshPreview();
} }
// Save undo/redo buttons actions // Save undo/redo buttons actions
undoExecute = editor.uiManager.buttons.undo.execute; undoExecute = editor.uiManager.buttons.undo.execute;
redoExecute = editor.uiManager.buttons.redo.execute; redoExecute = editor.uiManager.buttons.redo.execute;
@ -351,18 +356,30 @@ define([
editor.uiManager.buttons.redo.execute = function() { editor.uiManager.buttons.redo.execute = function() {
model.canRedo && model.redo(); model.canRedo && model.redo();
}; };
// Add event handler for model's UndoRedoStateChanged events // Add event handler for model's UndoRedoStateChanged events
function setUndoRedoState() { function setUndoRedoState() {
editor.uiManager.setButtonState(editor.uiManager.buttons.undo, model.canUndo); editor.uiManager.setButtonState(editor.uiManager.buttons.undo, model.canUndo);
editor.uiManager.setButtonState(editor.uiManager.buttons.redo, model.canRedo); editor.uiManager.setButtonState(editor.uiManager.buttons.redo, model.canRedo);
} }
model.addEventListener( model.addEventListener(gapi.drive.realtime.EventType.UNDO_REDO_STATE_CHANGED, setUndoRedoState);
gapi.drive.realtime.EventType.UNDO_REDO_STATE_CHANGED,
setUndoRedoState);
setUndoRedoState(); setUndoRedoState();
callback(); }, function(err) {
console.error(err);
if(err.type == "token_refresh_required") {
googleHelper.forceAuthenticate();
}
else if(err.type == "not_found") {
extensionMgr.onError('"' + fileDesc.title + '" has been removed from Google Drive.');
fileDesc.removeSyncLocation(syncAttributes);
extensionMgr.onSyncRemoved(fileDesc, syncAttributes);
gdriveProvider.stopRealtimeSync();
}
else if(err.isFatal) {
extensionMgr.onError('An error has forced real time synchronization to stop.');
gdriveProvider.stopRealtimeSync();
}
}); });
}; };
@ -377,7 +394,7 @@ define([
realtimeDocument.close(); realtimeDocument.close();
realtimeDocument = undefined; realtimeDocument = undefined;
} }
// Set back original undo/redo actions // Set back original undo/redo actions
editor.uiManager.buttons.undo.execute = undoExecute; editor.uiManager.buttons.undo.execute = undoExecute;
editor.uiManager.buttons.redo.execute = redoExecute; editor.uiManager.buttons.redo.execute = redoExecute;

View File

@ -240,10 +240,7 @@ define([
// 2. we are online // 2. we are online
function tryStartRealtimeSync() { function tryStartRealtimeSync() {
if(realtimeFileDesc !== undefined && isOnline === true) { if(realtimeFileDesc !== undefined && isOnline === true) {
core.lockUI(true); realtimeSyncAttributes.provider.startRealtimeSync(realtimeFileDesc, realtimeSyncAttributes);
realtimeSyncAttributes.provider.startRealtimeSync(realtimeFileDesc.title, realtimeFileDesc.content, realtimeSyncAttributes, function() {
core.lockUI(false);
});
} }
} }
@ -319,7 +316,7 @@ define([
}); });
} }
else { else {
if(_.size(fileDesc.syncLocations) > 0 && _.first(_.values(obj)).isRealtime) { if(_.size(fileDesc.syncLocations) > 0 && _.first(_.values(fileDesc.syncLocations)).isRealtime) {
extensionMgr.onError("Realtime collaboration document can't be synchronized with multiple locations"); extensionMgr.onError("Realtime collaboration document can't be synchronized with multiple locations");
return; return;
} }
@ -344,7 +341,7 @@ define([
// Provider's manual export button // Provider's manual export button
$(".action-sync-manual-" + provider.providerId).click(function(event) { $(".action-sync-manual-" + provider.providerId).click(function(event) {
var fileDesc = fileMgr.currentFile; var fileDesc = fileMgr.currentFile;
if(_.size(fileDesc.syncLocations) > 0 && _.first(_.values(obj)).isRealtime) { if(_.size(fileDesc.syncLocations) > 0 && _.first(_.values(fileDesc.syncLocations)).isRealtime) {
extensionMgr.onError("Realtime collaboration document can't be synchronized with multiple locations"); extensionMgr.onError("Realtime collaboration document can't be synchronized with multiple locations");
return; return;
} }

View File

@ -137,6 +137,7 @@ define([
// Reset input control in all modals // Reset input control in all modals
utils.resetModalInputs = function() { utils.resetModalInputs = function() {
$(".modal input[type=text]:not([disabled]), .modal input[type=password], .modal textarea").val(""); $(".modal input[type=text]:not([disabled]), .modal input[type=password], .modal textarea").val("");
$(".modal input[type=checkbox]").prop("checked", false);
}; };
// Basic trim function // Basic trim function