mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-06-28 16:23:15 +00:00
326ae61929
* Fix encodebase64 and decodebase64 filters The documentation for encodebase64 says that the input is treated as binary data, but in fact the input is being treated as text data, with an extra UTF-8 encoding step being performed first. Likewise, the decodebase64 documentation says that it outputs binary data, but in fact it will do a UTF-8 decoding step before producing output, which will in fact garble binary data. This commit changes the behavior of encodebase64 and decodebase64 to match what the documentation says they do. It also adds an optional `text` suffix to both filters to keep the current behavior. Finally, an optional `urlsafe` suffix is added to both filters to allow them to use the "URL-safe" variant of base64 (using `-` instead of `+` and `_` instead of `/`). * Try to fix failing test Turns out a little more than this is going to be needed. * Fix binary base64 encoding, including unit tests * Update base64 filter documentation * Can't use replaceAll, too new Have to use String.replace with a global regex instead * Replace uses of window.btoa() in rest of code Since window.btoa() is not available under Node.js, we'll replace all uses of it with the $tw.utils.base64encode() function that now works correctly for binary data. * Add link to UTF-8 glossary definition at MDN
120 lines
3.0 KiB
JavaScript
120 lines
3.0 KiB
JavaScript
/*\
|
|
title: $:/core/modules/savers/github.js
|
|
type: application/javascript
|
|
module-type: saver
|
|
|
|
Saves wiki by pushing a commit to the GitHub v3 REST API
|
|
|
|
\*/
|
|
(function(){
|
|
|
|
/*jslint node: true, browser: true */
|
|
/*global $tw: false */
|
|
"use strict";
|
|
|
|
/*
|
|
Select the appropriate saver module and set it up
|
|
*/
|
|
var GitHubSaver = function(wiki) {
|
|
this.wiki = wiki;
|
|
};
|
|
|
|
GitHubSaver.prototype.save = function(text,method,callback) {
|
|
var self = this,
|
|
username = this.wiki.getTiddlerText("$:/GitHub/Username"),
|
|
password = $tw.utils.getPassword("github"),
|
|
repo = this.wiki.getTiddlerText("$:/GitHub/Repo"),
|
|
path = this.wiki.getTiddlerText("$:/GitHub/Path",""),
|
|
filename = this.wiki.getTiddlerText("$:/GitHub/Filename"),
|
|
branch = this.wiki.getTiddlerText("$:/GitHub/Branch") || "main",
|
|
endpoint = this.wiki.getTiddlerText("$:/GitHub/ServerURL") || "https://api.github.com",
|
|
headers = {
|
|
"Accept": "application/vnd.github.v3+json",
|
|
"Content-Type": "application/json;charset=UTF-8",
|
|
"Authorization": "Basic " + $tw.utils.base64Encode(username + ":" + password),
|
|
"If-None-Match": ""
|
|
};
|
|
// Bail if we don't have everything we need
|
|
if(!username || !password || !repo || !filename) {
|
|
return false;
|
|
}
|
|
// Make sure the path start and ends with a slash
|
|
if(path.substring(0,1) !== "/") {
|
|
path = "/" + path;
|
|
}
|
|
if(path.substring(path.length - 1) !== "/") {
|
|
path = path + "/";
|
|
}
|
|
// Compose the base URI
|
|
var uri = endpoint + "/repos/" + repo + "/contents" + path;
|
|
// Perform a get request to get the details (inc shas) of files in the same path as our file
|
|
$tw.utils.httpRequest({
|
|
url: uri,
|
|
type: "GET",
|
|
headers: headers,
|
|
data: {
|
|
ref: branch
|
|
},
|
|
callback: function(err,getResponseDataJson,xhr) {
|
|
var getResponseData,sha = "";
|
|
if(err && xhr.status !== 404) {
|
|
return callback(err);
|
|
}
|
|
if(xhr.status !== 404) {
|
|
getResponseData = $tw.utils.parseJSONSafe(getResponseDataJson);
|
|
$tw.utils.each(getResponseData,function(details) {
|
|
if(details.name === filename) {
|
|
sha = details.sha;
|
|
}
|
|
});
|
|
}
|
|
var data = {
|
|
message: $tw.language.getString("ControlPanel/Saving/GitService/CommitMessage"),
|
|
content: $tw.utils.base64Encode(text),
|
|
branch: branch,
|
|
sha: sha
|
|
};
|
|
// Perform a PUT request to save the file
|
|
$tw.utils.httpRequest({
|
|
url: uri + filename,
|
|
type: "PUT",
|
|
headers: headers,
|
|
data: JSON.stringify(data),
|
|
callback: function(err,putResponseDataJson,xhr) {
|
|
if(err) {
|
|
return callback(err);
|
|
}
|
|
var putResponseData = $tw.utils.parseJSONSafe(putResponseDataJson);
|
|
callback(null);
|
|
}
|
|
});
|
|
}
|
|
});
|
|
return true;
|
|
};
|
|
|
|
/*
|
|
Information about this saver
|
|
*/
|
|
GitHubSaver.prototype.info = {
|
|
name: "github",
|
|
priority: 2000,
|
|
capabilities: ["save", "autosave"]
|
|
};
|
|
|
|
/*
|
|
Static method that returns true if this saver is capable of working
|
|
*/
|
|
exports.canSave = function(wiki) {
|
|
return true;
|
|
};
|
|
|
|
/*
|
|
Create an instance of this saver
|
|
*/
|
|
exports.create = function(wiki) {
|
|
return new GitHubSaver(wiki);
|
|
};
|
|
|
|
})();
|