Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check eTag in Edit Mode #166

Closed
wants to merge 8 commits into from
Closed

Check eTag in Edit Mode #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b43ffc1
check webdav etag with jQuery
githubkoma Oct 17, 2021
7c5e63d
check webdav etag with jQuery 2
githubkoma Oct 17, 2021
939999b
check webdav etag with jQuery 3
githubkoma Oct 17, 2021
7d43729
check webdav etag with jQuery 4
githubkoma Oct 17, 2021
e9797f8
present Draft Modal, on how to proceed on Conflict
githubkoma Oct 18, 2021
6e1840f
rename draft modal buttons
githubkoma Oct 19, 2021
198be63
show correct editor on public update permissions
githubkoma Oct 20, 2021
0a0fccb
use permission constants
githubkoma Oct 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions drawio/controller/settingscontroller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public function index() {
"drawioOfflineMode" => $this->config->GetOfflineMode(),
"drawioTheme" => $this->config->GetTheme(),
"drawioLang" => $this->config->GetLang(),
"drawioAutosave" => $this->config->GetAutosave()
"drawioAutosave" => $this->config->GetAutosave(),
"drawioLibraries" => $this->config->GetLibraries()
];
return new TemplateResponse($this->appName, "settings", $data, "blank");
Expand Down Expand Up @@ -105,7 +105,7 @@ public function settings()
"offlineMode" => $this->config->GetOfflineMode(),
"theme" => $this->config->GetTheme(),
"lang" => $this->config->GetLang(),
"drawioAutosave" =>$this->config->GetAutosave()
"drawioAutosave" =>$this->config->GetAutosave(),
"drawioLibraries" =>$this->config->GetLibraries()
];
}
Expand Down
9 changes: 8 additions & 1 deletion drawio/controller/viewercontroller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,19 @@ public function index($fileId, $shareToken = NULL, $filePath = NULL) {

$share_type = $share->getShareType();

if (($share->getPermissions() & Constants::PERMISSION_UPDATE) !== 0) {
$permissions = $share->getPermissions();
if (($permissions & Constants::PERMISSION_UPDATE) !== 0) {
$params ['drawioReadOnly'] = false;
}

if ($share_type === \OCP\Share::SHARE_TYPE_LINK) { // public links / anonymous editing should not be possible (?)
$params ['drawioReadOnly'] = true;

if ($permissions == CONSTANTS::PERMISSION_READ + CONSTANTS::PERMISSION_UPDATE // 3 = 1 + 2
or $permissions == CONSTANTS::PERMISSION_SHARE + CONSTANTS::PERMISSION_READ + CONSTANTS::PERMISSION_UPDATE) { // 19 = 16 + 1 + 2
$params ['drawioReadOnly'] = false;
}

}

}
Expand Down
219 changes: 170 additions & 49 deletions drawio/js/editor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*
**/

(function (OCA) {
(function (OCA) {

// ADD SUPPORT TO IE
if (!String.prototype.includes) {
Expand Down Expand Up @@ -59,6 +59,11 @@
var autosaveEnabled = autosave === "yes";
var fileId = $("#iframeEditor").data("id");
var shareToken = $("#iframeEditor").data("sharetoken");
var etag = null;
var draftEtag = null; // cache the remote Draft's ETag
var saveInProgress = false;
var draftShown = false; // was the draftModal used recently?
var tempDiagramXml = null; // used if chosen to overwrite the remote Draft
if (!fileId && !shareToken) {
displayError(t(OCA.DrawIO.AppName, "FileId is empty"));
return;
Expand All @@ -71,6 +76,9 @@
}
if (shareToken) {
params.push("shareToken=" + encodeURIComponent(shareToken));
// For Public WebDav, shareToken is the Username, and Password is attached automatically to the upcoming ajax requests,
// as it was already entered on the "Enter Password Page" that Nextcloud's Core provides:
webdavUrl = OC.getProtocol() + '://' + encodeURIComponent(shareToken) + '@' + OC.getHost() + OC.webroot + '/public.php/webdav';
}
if (params.length) {
fileUrl += "?" + params.join("&");
Expand All @@ -83,13 +91,15 @@
var loadMsg = OC.Notification.show(t(OCA.DrawIO.AppName, "Loading, please wait."));
if(!fileId) {
$.ajax({
url: fileUrl,
success: function onSuccess(data) {
url: webdavUrl,
success: function onSuccess(data, result, response) {
editWindow.postMessage(JSON.stringify({
action: "load",
xml: data
xml: data,
autosave: Number(autosaveEnabled)
}), "*");
OC.Notification.hide(loadMsg);
etag = response.getResponseHeader('etag');
},
fail: function (status) {

Expand All @@ -102,8 +112,11 @@
}
});
} else {
ncClient.getFileContents(filePath)
.then(function (status, contents) {
webdavUrl = OC.getProtocol() + '://' + OC.getHost() + OC.webroot + '/remote.php/dav/files/' + OC.currentUser + filePath;

$.get(webdavUrl)
.then(function (contents, result, response) {
etag = response.getResponseHeader('etag');
if (contents === " ") {
OCA.DrawIO.NewFileMode = true; //[workaround] "loading" file without content, to display "template" later in "load" callback event without another filename prompt
editWindow.postMessage(JSON.stringify({
Expand Down Expand Up @@ -142,52 +155,160 @@
} else if (payload.event === "export") {
// TODO: handle export event
} else if (payload.event === "autosave") {
var time = new Date();
ncClient.putFileContents(
filePath,
payload.xml, {
contentType: "application/x-drawio",
overwrite: false
}
)
.then(function (status) {
editWindow.postMessage(JSON.stringify({
action: 'status',
message: "Autosave successful at " + time.toLocaleTimeString(),
modified: false
}), '*');
})
.fail(function (status) {
editWindow.postMessage(JSON.stringify({
action: 'status',
message: "Autosave failed at " + time.toLocaleTimeString(),
modified: false
}), '*');
});
} else if (payload.event === "save") {
var saveMsg = OC.Notification.show(t(OCA.DrawIO.AppName, "Saving..."));
ncClient.putFileContents(
filePath,
payload.xml, {
contentType: "application/x-drawio",
overwrite: false
}
)
.then(function (status) {
OC.Notification.showTemporary(t(OCA.DrawIO.AppName, "File saved!"));
})
.fail(function (status) {
// TODO: handle on failed write
OC.Notification.showTemporary(t(OCA.DrawIO.AppName, "File not saved!"));
})
.done(function () {
OC.Notification.hide(saveMsg);
});

if (!saveInProgress) {
var time = new Date();
saveInProgress = true;

$.ajax({
url: webdavUrl,
type: 'PUT',
data: payload.xml,
contentType: 'application/x-drawio',
beforeSend: function(request){
request.setRequestHeader('If-Match', etag); // Server will check if Remote-ETag matches this local etag
},
})
.then(function (status, content, result) {
etag = result.getResponseHeader('etag');

editWindow.postMessage(JSON.stringify({
action: 'status',
message: "Autosave successful at " + time.toLocaleTimeString(),
modified: false
}), '*');
saveInProgress = false;
})
.fail(function (result) {
saveInProgress = false;

if (result.status == 412) { // Wrong ETag -> 412="Precondition Failed"
OC.Notification.showUpdate(t(OCA.DrawIO.AppName, "Error: Conflict, please try saving manually."));
editWindow.postMessage(JSON.stringify({
action: 'status',
message: "Error: Conflict, please try saving manually.",
modified: false
}), '*');
} else {
editWindow.postMessage(JSON.stringify({
action: 'status',
message: "Autosave failed at " + time.toLocaleTimeString(),
modified: false
}), '*');
}
});

}

} else if (payload.event === "save") {

if (!saveInProgress) {
var saveMsg = OC.Notification.show(t(OCA.DrawIO.AppName, "Saving..."));

saveInProgress = true;
$.ajax({
url: webdavUrl,
type: 'PUT',
data: payload.xml,
contentType: 'application/x-drawio',
beforeSend: function(request){
request.setRequestHeader('If-Match', etag); // Server will check if Remote-ETag matches this local etag
},
})
.then(function (status, content, result) {
etag = result.getResponseHeader('etag');
OC.Notification.showTemporary(t(OCA.DrawIO.AppName, "File saved!"));
})
.fail(function (result) {
// TODO: handle on failed write
saveInProgress = false;
OC.Notification.hide(saveMsg);

if (result.status == 412) { // Wrong ETag -> 412="Precondition Failed"

// Let the User decide whether to Overwrite the Remote file, or import the remote Draft
OC.Notification.showTemporary(t(OCA.DrawIO.AppName, "Loading Remote Draft..."));
$.get(webdavUrl)
.then(function (contents, result, response) {
draftEtag = response.getResponseHeader('etag'); // Cache etag, if user will decide to use the draft

tempDiagramXml = payload.xml; // Cache the current version, to perhaps save it in draft Modal
draftShown = true; // Draft Modal was opened
editWindow.postMessage(JSON.stringify({
action: 'draft',
name: 'REMOTE FILE',
editKey: 'import',
discardKey: 'replace',
xml: contents
}), '*');

})
.fail(function (status) {
console.log("Status Error: " + status);
// TODO: show error on failed read
OCA.DrawIO.Cleanup(receiver, filePath);
});

};
OC.Notification.showTemporary(t(OCA.DrawIO.AppName, "File not saved!"));
})
.done(function () {
OC.Notification.hide(saveMsg);
saveInProgress = false;
});
}
} else if (payload.event === "exit") {
OCA.DrawIO.Cleanup(receiver, filePath);
// Only Exit the Drawio Editor, if the usual "Exit" Button was used
// dont exit, when the Draft Modal's Cancel/Exit Button was used
if (!draftShown) {
OCA.DrawIO.Cleanup(receiver, filePath);
}
draftShown = false;
} else if (payload.event === "draft") {
draftShown = false;
switch (payload.result) {
case "edit": // Load and use the Remote Draft Version
etag = draftEtag;
editWindow.postMessage(JSON.stringify({
action: 'load',
xml: payload.message.xml,
}), '*');
break;

case "discard": // Overwrite the Remote Version
saveInProgress = true;
var time = new Date();
$.ajax({
url: webdavUrl,
type: 'PUT',
data: tempDiagramXml,
contentType: 'application/x-drawio',
})
.then(function (status, content, result) {
editWindow.postMessage(JSON.stringify({
action: 'status',
message: "Save successful at " + time.toLocaleTimeString(),
modified: false
}), '*');
OC.Notification.showTemporary(t(OCA.DrawIO.AppName, "File saved!"));
etag = result.getResponseHeader('etag');
saveInProgress = false;
})
.fail(function (result) {
saveInProgress = false;
OC.Notification.showTemporary(t(OCA.DrawIO.AppName, "Error while saving."));
})
.done(function () {
saveInProgress = false;
tempDiagramXml = null;
});
break;

}

} else {
console.log("DrawIO Integration: unknown event " + payload.event);
console.dir(payload);
draftShown = false;
}
} else {
console.log("DrawIO Integration: bad origin " + evt.origin);
Expand Down
2 changes: 1 addition & 1 deletion drawio/js/settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
$("#theme").val(response.theme);
$("#lang").val(response.lang);
$("#drawioAutosave").val(response.drawioAutosave);
$("#drawioLibraries").val(response.libraries);
$("#drawioLibraries").val(response.drawioLibraries);

var message =
response.error
Expand Down
1 change: 1 addition & 0 deletions drawio/templates/settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<option value="min"<?php if ($_["drawioTheme"] === "min") echo ' selected'; ?>><?php p($l->t("Minimal")) ?></option>
<option value="atlas"<?php if ($_["drawioTheme"] === "atlas") echo ' selected'; ?>><?php p($l->t("Atlas")) ?></option>
<option value="dark"<?php if ($_["drawioTheme"] === "dark") echo ' selected'; ?>><?php p($l->t("Dark")) ?></option>
<option value="sketch"<?php if ($_["drawioTheme"] === "sketch") echo ' selected'; ?>><?php p($l->t("Sketch")) ?></option>
</select>
</p>

Expand Down