1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-07-15 00:14:22 +00:00
TiddlyWiki5/core/modules/savers/put.js
Arlen22 c069d48a2a Remove URI encoding from PUT saver (#2974)
Remove URI encoding from PUT saver and let the browser handle it as necessary. This seems to be the normal way of doing things. We have confirmed that several WebDAV servers do not expect the file names to be double-encoded.
2017-09-16 15:30:13 +01:00

111 lines
2.5 KiB
JavaScript

/*\
title: $:/core/modules/savers/put.js
type: application/javascript
module-type: saver
Saves wiki by performing a PUT request to the server
Works with any server which accepts a PUT request
to the current URL, such as a WebDAV server.
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
/*
Select the appropriate saver module and set it up
*/
var PutSaver = function(wiki) {
this.wiki = wiki;
var self = this;
var uri = this.uri();
// Async server probe. Until probe finishes, save will fail fast
// See also https://github.com/Jermolene/TiddlyWiki5/issues/2276
$tw.utils.httpRequest({
url: uri,
type: "OPTIONS",
callback: function(err, data, xhr) {
// Check DAV header http://www.webdav.org/specs/rfc2518.html#rfc.section.9.1
if(!err) {
self.serverAcceptsPuts = xhr.status === 200 && !!xhr.getResponseHeader("dav");
}
}
});
// Retrieve ETag if available
$tw.utils.httpRequest({
url: uri,
type: "HEAD",
callback: function(err, data, xhr) {
if(!err) {
self.etag = xhr.getResponseHeader("ETag");
}
}
});
};
PutSaver.prototype.uri = function() {
return document.location.toString().split("#")[0];
};
// TODO: in case of edit conflict
// Prompt: Do you want to save over this? Y/N
// Merging would be ideal, and may be possible using future generic merge flow
PutSaver.prototype.save = function(text, method, callback) {
if(!this.serverAcceptsPuts) {
return false;
}
var self = this;
var headers = { "Content-Type": "text/html;charset=UTF-8" };
if(this.etag) {
headers["If-Match"] = this.etag;
}
$tw.utils.httpRequest({
url: this.uri(),
type: "PUT",
headers: headers,
data: text,
callback: function(err, data, xhr) {
if(err) {
callback(err);
} if(xhr.status === 200 || xhr.status === 201) {
self.etag = xhr.getResponseHeader("ETag");
callback(null); // success
} else if(xhr.status === 412) { // edit conflict
var message = $tw.language.getString("Error/EditConflict");
callback(message);
} else {
callback(xhr.responseText); // fail
}
}
});
return true;
};
/*
Information about this saver
*/
PutSaver.prototype.info = {
name: "put",
priority: 2000,
capabilities: ["save", "autosave"]
};
/*
Static method that returns true if this saver is capable of working
*/
exports.canSave = function(wiki) {
return /^https?:/.test(location.protocol);
};
/*
Create an instance of this saver
*/
exports.create = function(wiki) {
return new PutSaver(wiki);
};
})();