1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00

Handle binary files better when saving on Node.JS (#2420)

* Save binary tiddlers with meta file

The filesystemadaptor plugin was a little simplistic in its
understanding of a binary file. It was using the typeInfo dictionary to
choose what tiddler types were binary (and hence needed a meta file when
saving).

I looked as if it was trying to be smart by looking for the hasMetaFile
*OR* had the encoding of base64. Unfortunately the typeInfo only defined
image/jpeg and so any other base64 encoded tiddler was assumed to be of
type text/vnd.tiddlywiki.

The net effect was only JPG images got a meta file and everything else
were saved as .tid files with base64 encoding. It all still worked but
made working with binary data in a Git repo a bit daunting.

There is enough information in the $tw.config.contentTypeInfo to
determine if a tiddler type is encoded with base64 or not. A better list
is available from boot/boot.js who registers all the types thorough the
registerFileType and marks then with base64 were appropriate.

This commit uses the typeInfo dictionary first for any filesystem
specific overrides, then the contentTypeInfo, and finally defaults to
the typeInfo["text/vnd.tiddlywiki"]. It also eliminates the now
unnecessary override for image/jpeg.

I think this might have been the original intent from commit 10b192e7.
From my limited testing all files described in boot/boot.js (lines
1832-1856) with an encoding of base64 now save as the original binary
and a meta file. Meaning that when you start the node server and then
drag-n-drop a binary file (i.e. image/png) it will PUT to the server
and then save it on the filesystem as-is allowing the file to be managed
as a binary file and not a text file. (Binary diffs are better and
GitHub supports them as well).

* Prevent duplicate file extensions

A side effects of using the $tw.config.contentFileInfo in the previous
commit is that it will always append a file extension to the tiddler
title when saving. In most cases this is the correct course of action.
However, sometimes that title is already a proper filename with an
extension (for example importing 'foobar.png' would save a file named
'foobar.png.png') which seemed silly.

This commit simply checks to make sure the title does not already end
with the file extension before appending it to the filename. A little
convenience really.

Since IE apparently doesn't have the String endsWith method I took the
liberty to add a helper method to $tw.utils trying to follow the other
polyfill patterns. I figured this was more generic and readable then
attempting to use a one-off solution inline. I got the polyfill code
from MDN.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith#Polyfill

Is strEndsWith the best method name?
This commit is contained in:
Devin Weaver 2016-07-11 06:18:19 -04:00 committed by Jeremy Ruston
parent 19e699d330
commit bf74d13df5
2 changed files with 24 additions and 8 deletions

View File

@ -699,4 +699,20 @@ exports.sign = Math.sign || function(x) {
return x > 0 ? 1 : -1; return x > 0 ? 1 : -1;
}; };
/*
IE does not have an endsWith function
*/
exports.strEndsWith = function(str,ending,position) {
if(str.endsWith) {
return str.endsWith(ending,position);
} else {
if (typeof position !== 'number' || !isFinite(position) || Math.floor(position) !== position || position > str.length) {
position = str.length;
}
position -= str.length;
var lastIndex = str.indexOf(ending, position);
return lastIndex !== -1 && lastIndex === position;
}
};
})(); })();

View File

@ -37,9 +37,6 @@ $tw.config.typeInfo = {
"text/vnd.tiddlywiki": { "text/vnd.tiddlywiki": {
fileType: "application/x-tiddler", fileType: "application/x-tiddler",
extension: ".tid" extension: ".tid"
},
"image/jpeg" : {
hasMetaFile: true
} }
}; };
@ -53,11 +50,10 @@ FileSystemAdaptor.prototype.getTiddlerFileInfo = function(tiddler,callback) {
title = tiddler.fields.title, title = tiddler.fields.title,
fileInfo = $tw.boot.files[title]; fileInfo = $tw.boot.files[title];
// Get information about how to save tiddlers of this type // Get information about how to save tiddlers of this type
var type = tiddler.fields.type || "text/vnd.tiddlywiki", var type = tiddler.fields.type || "text/vnd.tiddlywiki";
typeInfo = $tw.config.typeInfo[type]; var typeInfo = $tw.config.typeInfo[type] ||
if(!typeInfo) { $tw.config.contentTypeInfo[type] ||
typeInfo = $tw.config.typeInfo["text/vnd.tiddlywiki"]; $tw.config.typeInfo["text/vnd.tiddlywiki"];
}
var extension = typeInfo.extension || ""; var extension = typeInfo.extension || "";
if(!fileInfo) { if(!fileInfo) {
// If not, we'll need to generate it // If not, we'll need to generate it
@ -132,6 +128,10 @@ FileSystemAdaptor.prototype.generateTiddlerFilename = function(title,extension,e
if(baseFilename.length > 200) { if(baseFilename.length > 200) {
baseFilename = baseFilename.substr(0,200); baseFilename = baseFilename.substr(0,200);
} }
// Prevent redundent file extensions
if($tw.utils.strEndsWith(baseFilename,extension)) {
extension = "";
}
// Start with the base filename plus the extension // Start with the base filename plus the extension
var filename = baseFilename + extension, var filename = baseFilename + extension,
count = 1; count = 1;