Fix file sync error on Windows for old filenames containing colons
OS.Path.basename() stops at colons on Windows, so calling it on the full path produces unexpected results.
This commit is contained in:
Dan Stillman
parent
59fb9d0226
commit
9e59500619
2 changed files with 412 additions and 110 deletions
|
|
@ -632,33 +632,32 @@ Zotero.Sync.Storage.Local = {
|
|||
|
||||
yield Zotero.Attachments.createDirectoryForItem(item);
|
||||
|
||||
var path = item.getFilePath();
|
||||
if (!path) {
|
||||
var filename = item.attachmentFilename;
|
||||
if (!filename) {
|
||||
throw new Error("Empty path for item " + item.key);
|
||||
}
|
||||
// Don't save Windows aliases
|
||||
if (path.endsWith('.lnk')) {
|
||||
if (filename.endsWith('.lnk')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
var dir = OS.Path.dirname(path);
|
||||
var fileName = OS.Path.basename(path);
|
||||
var attachmentDir = Zotero.Attachments.getStorageDirectory(item).path;
|
||||
var renamed = false;
|
||||
|
||||
// Make sure the new filename is valid, in case an invalid character made it over
|
||||
// (e.g., from before we checked for them)
|
||||
var filteredName = Zotero.File.getValidFileName(fileName);
|
||||
if (filteredName != fileName) {
|
||||
Zotero.debug("Filtering filename '" + fileName + "' to '" + filteredName + "'");
|
||||
fileName = filteredName;
|
||||
path = OS.Path.join(dir, fileName);
|
||||
var filteredFilename = Zotero.File.getValidFileName(filename);
|
||||
if (filteredFilename != filename) {
|
||||
Zotero.debug("Filtering filename '" + filename + "' to '" + filteredFilename + "'");
|
||||
filename = filteredFilename;
|
||||
renamed = true;
|
||||
}
|
||||
var path = OS.Path.join(attachmentDir, filename);
|
||||
|
||||
Zotero.debug("Moving download file " + OS.Path.basename(tempFilePath)
|
||||
+ " into attachment directory as '" + fileName + "'");
|
||||
+ ` into attachment directory as '${filename}'`);
|
||||
try {
|
||||
var finalFileName = Zotero.File.createShortened(
|
||||
var finalFilename = Zotero.File.createShortened(
|
||||
path, Components.interfaces.nsIFile.NORMAL_FILE_TYPE, 0o644
|
||||
);
|
||||
}
|
||||
|
|
@ -666,14 +665,14 @@ Zotero.Sync.Storage.Local = {
|
|||
Zotero.File.checkFileAccessError(e, path, 'create');
|
||||
}
|
||||
|
||||
if (finalFileName != fileName) {
|
||||
Zotero.debug("Changed filename '" + fileName + "' to '" + finalFileName + "'");
|
||||
if (finalFilename != filename) {
|
||||
Zotero.debug("Changed filename '" + filename + "' to '" + finalFilename + "'");
|
||||
|
||||
fileName = finalFileName;
|
||||
path = OS.Path.join(dir, fileName);
|
||||
filename = finalFilename;
|
||||
path = OS.Path.join(attachmentDir, filename);
|
||||
|
||||
// Abort if Windows path limitation would cause filenames to be overly truncated
|
||||
if (Zotero.isWin && fileName.length < 40) {
|
||||
if (Zotero.isWin && filename.length < 40) {
|
||||
try {
|
||||
yield OS.File.remove(path);
|
||||
}
|
||||
|
|
@ -776,12 +775,11 @@ Zotero.Sync.Storage.Local = {
|
|||
Zotero.debug("Skipping directory " + filePath);
|
||||
continue;
|
||||
}
|
||||
|
||||
count++;
|
||||
|
||||
Zotero.debug("Extracting " + filePath);
|
||||
|
||||
var primaryFile = false;
|
||||
var primaryFile = itemFileName == filePath;
|
||||
var filtered = false;
|
||||
var renamed = false;
|
||||
|
||||
|
|
@ -808,10 +806,10 @@ Zotero.Sync.Storage.Local = {
|
|||
filePath = itemFileName;
|
||||
destPath = OS.Path.join(OS.Path.dirname(destPath), itemFileName);
|
||||
renamed = true;
|
||||
primaryFile = true;
|
||||
}
|
||||
}
|
||||
|
||||
var primaryFile = itemFileName == filePath;
|
||||
if (primaryFile && filtered) {
|
||||
renamed = true;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -119,6 +119,217 @@ describe("Zotero.Sync.Storage.Local", function () {
|
|||
});
|
||||
|
||||
describe("#processDownload()", function () {
|
||||
describe("single file", function () {
|
||||
it("should download a single file into the attachment directory", function* () {
|
||||
var libraryID = Zotero.Libraries.userLibraryID;
|
||||
var parentItem = yield createDataObject('item');
|
||||
var key = Zotero.DataObjectUtilities.generateKey();
|
||||
var fileContents = Zotero.Utilities.randomString();
|
||||
|
||||
var oldFilename = "Old File";
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var tmpFile = OS.Path.join(tmpDir, key + '.tmp');
|
||||
yield Zotero.File.putContentsAsync(tmpFile, fileContents);
|
||||
|
||||
// Create an existing attachment directory to replace
|
||||
var dir = Zotero.Attachments.getStorageDirectoryByLibraryAndKey(libraryID, key).path;
|
||||
yield OS.File.makeDir(
|
||||
dir,
|
||||
{
|
||||
unixMode: 0o755
|
||||
}
|
||||
);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(dir, oldFilename), '');
|
||||
|
||||
var md5 = Zotero.Utilities.Internal.md5(Zotero.File.pathToFile(tmpFile));
|
||||
var mtime = 1445667239000;
|
||||
|
||||
var json = {
|
||||
key,
|
||||
version: 10,
|
||||
itemType: 'attachment',
|
||||
linkMode: 'imported_url',
|
||||
url: 'https://example.com/foo.txt',
|
||||
filename: 'foo.txt',
|
||||
contentType: 'text/plain',
|
||||
charset: 'utf-8',
|
||||
md5,
|
||||
mtime
|
||||
};
|
||||
yield Zotero.Sync.Data.Local.processObjectsFromJSON('item', libraryID, [json]);
|
||||
|
||||
var item = yield Zotero.Items.getByLibraryAndKeyAsync(libraryID, key);
|
||||
yield Zotero.Sync.Storage.Local.processDownload({
|
||||
item,
|
||||
md5,
|
||||
mtime
|
||||
});
|
||||
yield OS.File.remove(tmpFile);
|
||||
|
||||
var storageDir = Zotero.Attachments.getStorageDirectory(item).path;
|
||||
|
||||
// Make sure previous files don't exist
|
||||
assert.isFalse(yield OS.File.exists(OS.Path.join(storageDir, oldFilename)));
|
||||
|
||||
// Make sure main file matches attachment hash and mtime
|
||||
yield assert.eventually.equal(
|
||||
item.attachmentHash, Zotero.Utilities.Internal.md5(fileContents)
|
||||
);
|
||||
yield assert.eventually.equal(item.attachmentModificationTime, mtime);
|
||||
});
|
||||
|
||||
|
||||
it("should download and rename a single file with invalid filename into the attachment directory", function* () {
|
||||
var libraryID = Zotero.Libraries.userLibraryID;
|
||||
var parentItem = yield createDataObject('item');
|
||||
var key = Zotero.DataObjectUtilities.generateKey();
|
||||
var fileContents = Zotero.Utilities.randomString();
|
||||
|
||||
var oldFilename = "Old File";
|
||||
var newFilename = " ab — c \\:.txt.";
|
||||
var filteredFilename = " ab — c .txt.";
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var tmpFile = OS.Path.join(tmpDir, key + '.tmp');
|
||||
yield Zotero.File.putContentsAsync(tmpFile, fileContents);
|
||||
|
||||
// Create an existing attachment directory to replace
|
||||
var dir = Zotero.Attachments.getStorageDirectoryByLibraryAndKey(libraryID, key).path;
|
||||
yield OS.File.makeDir(
|
||||
dir,
|
||||
{
|
||||
unixMode: 0o755
|
||||
}
|
||||
);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(dir, oldFilename), '');
|
||||
|
||||
var md5 = Zotero.Utilities.Internal.md5(Zotero.File.pathToFile(tmpFile));
|
||||
var mtime = 1445667239000;
|
||||
|
||||
var json = {
|
||||
key,
|
||||
version: 10,
|
||||
itemType: 'attachment',
|
||||
linkMode: 'imported_url',
|
||||
url: 'https://example.com/foo.txt',
|
||||
filename: newFilename,
|
||||
contentType: 'text/plain',
|
||||
charset: 'utf-8',
|
||||
md5,
|
||||
mtime
|
||||
};
|
||||
yield Zotero.Sync.Data.Local.processObjectsFromJSON('item', libraryID, [json]);
|
||||
|
||||
var item = yield Zotero.Items.getByLibraryAndKeyAsync(libraryID, key);
|
||||
yield Zotero.Sync.Storage.Local.processDownload({
|
||||
item,
|
||||
md5,
|
||||
mtime
|
||||
});
|
||||
yield OS.File.remove(tmpFile);
|
||||
|
||||
var storageDir = Zotero.Attachments.getStorageDirectory(item).path;
|
||||
|
||||
// Make sure previous file doesn't exist
|
||||
assert.isFalse(yield OS.File.exists(OS.Path.join(storageDir, oldFilename)));
|
||||
// And new one does
|
||||
assert.isTrue(yield OS.File.exists(OS.Path.join(storageDir, filteredFilename)));
|
||||
|
||||
// Make sure main file matches attachment hash and mtime
|
||||
yield assert.eventually.equal(
|
||||
item.attachmentHash, Zotero.Utilities.Internal.md5(fileContents)
|
||||
);
|
||||
yield assert.eventually.equal(item.attachmentModificationTime, mtime);
|
||||
});
|
||||
|
||||
|
||||
it("should download and rename a single file with invalid filename using Windows parsing rules into the attachment directory", function* () {
|
||||
var libraryID = Zotero.Libraries.userLibraryID;
|
||||
var parentItem = yield createDataObject('item');
|
||||
var key = Zotero.DataObjectUtilities.generateKey();
|
||||
var fileContents = Zotero.Utilities.randomString();
|
||||
|
||||
var oldFilename = "Old File";
|
||||
var newFilename = "a:b.txt";
|
||||
var filteredFilename = "ab.txt";
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var tmpFile = OS.Path.join(tmpDir, key + '.tmp');
|
||||
yield Zotero.File.putContentsAsync(tmpFile, fileContents);
|
||||
|
||||
// Create an existing attachment directory to replace
|
||||
var dir = Zotero.Attachments.getStorageDirectoryByLibraryAndKey(libraryID, key).path;
|
||||
yield OS.File.makeDir(
|
||||
dir,
|
||||
{
|
||||
unixMode: 0o755
|
||||
}
|
||||
);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(dir, oldFilename), '');
|
||||
|
||||
var md5 = Zotero.Utilities.Internal.md5(Zotero.File.pathToFile(tmpFile));
|
||||
var mtime = 1445667239000;
|
||||
|
||||
var json = {
|
||||
key,
|
||||
version: 10,
|
||||
itemType: 'attachment',
|
||||
linkMode: 'imported_url',
|
||||
url: 'https://example.com/foo.txt',
|
||||
filename: 'a:b.txt',
|
||||
contentType: 'text/plain',
|
||||
charset: 'utf-8',
|
||||
md5,
|
||||
mtime
|
||||
};
|
||||
yield Zotero.Sync.Data.Local.processObjectsFromJSON('item', libraryID, [json]);
|
||||
|
||||
var item = yield Zotero.Items.getByLibraryAndKeyAsync(libraryID, key);
|
||||
|
||||
// Stub functions to simulate OS.Path.basename() behavior on Windows
|
||||
var basenameOrigFunc = OS.Path.basename.bind(OS.Path);
|
||||
var basenameStub = sinon.stub(OS.Path, "basename", (path) => {
|
||||
// Split on colon
|
||||
if (path.endsWith("a:b.txt")) {
|
||||
return "b.txt";
|
||||
}
|
||||
return basenameOrigFunc(path);
|
||||
});
|
||||
var pathToFileOrigFunc = Zotero.File.pathToFile.bind(Zotero.File);
|
||||
var pathToFileStub = sinon.stub(Zotero.File, "pathToFile", (path) => {
|
||||
if (path.includes(":")) {
|
||||
throw new Error("Path contains colon");
|
||||
}
|
||||
return pathToFileOrigFunc(path);
|
||||
});
|
||||
|
||||
yield Zotero.Sync.Storage.Local.processDownload({
|
||||
item,
|
||||
md5,
|
||||
mtime
|
||||
});
|
||||
yield OS.File.remove(tmpFile);
|
||||
|
||||
var storageDir = Zotero.Attachments.getStorageDirectory(item).path;
|
||||
|
||||
basenameStub.restore();
|
||||
pathToFileStub.restore();
|
||||
|
||||
// Make sure path is set correctly
|
||||
assert.equal(item.getFilePath(), OS.Path.join(storageDir, filteredFilename));
|
||||
// Make sure previous files don't exist
|
||||
assert.isFalse(yield OS.File.exists(OS.Path.join(storageDir, oldFilename)));
|
||||
// And new one does
|
||||
assert.isTrue(yield OS.File.exists(OS.Path.join(storageDir, filteredFilename)));
|
||||
|
||||
// Make sure main file matches attachment hash and mtime
|
||||
yield assert.eventually.equal(
|
||||
item.attachmentHash, Zotero.Utilities.Internal.md5(fileContents)
|
||||
);
|
||||
yield assert.eventually.equal(item.attachmentModificationTime, mtime);
|
||||
});
|
||||
});
|
||||
|
||||
describe("ZIP", function () {
|
||||
it("should download and extract a ZIP file into the attachment directory", function* () {
|
||||
var file1Name = 'index.html';
|
||||
var file1Contents = '<html><body>Test</body></html>';
|
||||
var file2Name = 'aux1.txt';
|
||||
|
|
@ -127,30 +338,23 @@ describe("Zotero.Sync.Storage.Local", function () {
|
|||
var file3Name = 'aux2';
|
||||
var file3Contents = 'Test 2';
|
||||
|
||||
var createZIP = Zotero.Promise.coroutine(function* (zipFile) {
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var zipDir = OS.Path.join(tmpDir, Zotero.Utilities.randomString());
|
||||
yield OS.File.makeDir(zipDir);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(zipDir, file1Name), file1Contents);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(zipDir, file2Name), file2Contents);
|
||||
|
||||
// Subdirectory
|
||||
var subDir = OS.Path.join(zipDir, subDirName);
|
||||
yield OS.File.makeDir(subDir);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(subDir, file3Name), file3Contents);
|
||||
|
||||
yield Zotero.File.zipDirectory(zipDir, zipFile);
|
||||
yield removeDir(zipDir);
|
||||
});
|
||||
|
||||
it("should download and extract a ZIP file into the attachment directory", function* () {
|
||||
var libraryID = Zotero.Libraries.userLibraryID;
|
||||
var parentItem = yield createDataObject('item');
|
||||
var key = Zotero.DataObjectUtilities.generateKey();
|
||||
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var zipFile = OS.Path.join(tmpDir, key + '.tmp');
|
||||
yield createZIP(zipFile);
|
||||
|
||||
// Create ZIP file with subdirectory
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var zipDir = yield getTempDirectory();
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(zipDir, file1Name), file1Contents);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(zipDir, file2Name), file2Contents);
|
||||
var subDir = OS.Path.join(zipDir, subDirName);
|
||||
yield OS.File.makeDir(subDir);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(subDir, file3Name), file3Contents);
|
||||
yield Zotero.File.zipDirectory(zipDir, zipFile);
|
||||
yield removeDir(zipDir);
|
||||
|
||||
// Create an existing attachment directory (and subdirectory) to replace
|
||||
var dir = Zotero.Attachments.getStorageDirectoryByLibraryAndKey(libraryID, key).path;
|
||||
|
|
@ -215,7 +419,107 @@ describe("Zotero.Sync.Storage.Local", function () {
|
|||
Zotero.File.getContentsAsync(OS.Path.join(storageDir, subDirName, file3Name)),
|
||||
file3Contents
|
||||
);
|
||||
})
|
||||
});
|
||||
|
||||
|
||||
it("should download and rename a ZIP file with invalid filename using Windows parsing rules into the attachment directory", function* () {
|
||||
var libraryID = Zotero.Libraries.userLibraryID;
|
||||
var parentItem = yield createDataObject('item');
|
||||
var key = Zotero.DataObjectUtilities.generateKey();
|
||||
|
||||
var oldFilename = "Old File";
|
||||
var oldAuxFilename = "a.gif";
|
||||
var newFilename = "a:b.html";
|
||||
var fileContents = Zotero.Utilities.randomString();
|
||||
var newAuxFilename = "b.gif";
|
||||
var filteredFilename = "ab.html";
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var zipFile = OS.Path.join(tmpDir, key + '.tmp');
|
||||
|
||||
// Create ZIP file
|
||||
var tmpDir = Zotero.getTempDirectory().path;
|
||||
var zipDir = yield getTempDirectory();
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(zipDir, newFilename), fileContents);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(zipDir, newAuxFilename), '');
|
||||
yield Zotero.File.zipDirectory(zipDir, zipFile);
|
||||
yield removeDir(zipDir);
|
||||
|
||||
// Create an existing attachment directory to replace
|
||||
var dir = Zotero.Attachments.getStorageDirectoryByLibraryAndKey(libraryID, key).path;
|
||||
yield OS.File.makeDir(
|
||||
dir,
|
||||
{
|
||||
unixMode: 0o755
|
||||
}
|
||||
);
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(dir, oldFilename), '');
|
||||
yield Zotero.File.putContentsAsync(OS.Path.join(dir, oldAuxFilename), '');
|
||||
|
||||
var md5 = Zotero.Utilities.Internal.md5(Zotero.File.pathToFile(zipFile));
|
||||
var mtime = 1445667239000;
|
||||
|
||||
var json = {
|
||||
key,
|
||||
version: 10,
|
||||
itemType: 'attachment',
|
||||
linkMode: 'imported_url',
|
||||
url: 'https://example.com/foo.html',
|
||||
filename: 'a:b.html',
|
||||
contentType: 'text/plain',
|
||||
charset: 'utf-8',
|
||||
md5,
|
||||
mtime
|
||||
};
|
||||
yield Zotero.Sync.Data.Local.processObjectsFromJSON('item', libraryID, [json]);
|
||||
|
||||
var item = yield Zotero.Items.getByLibraryAndKeyAsync(libraryID, key);
|
||||
|
||||
// Stub functions to simulate OS.Path.basename() behavior on Windows
|
||||
var basenameOrigFunc = OS.Path.basename.bind(OS.Path);
|
||||
var basenameStub = sinon.stub(OS.Path, "basename", (path) => {
|
||||
// Split on colon
|
||||
if (path.endsWith("a:b.html")) {
|
||||
return "b.html";
|
||||
}
|
||||
return basenameOrigFunc(path);
|
||||
});
|
||||
var pathToFileOrigFunc = Zotero.File.pathToFile.bind(Zotero.File);
|
||||
var pathToFileStub = sinon.stub(Zotero.File, "pathToFile", (path) => {
|
||||
if (path.includes(":")) {
|
||||
throw new Error("Path contains colon");
|
||||
}
|
||||
return pathToFileOrigFunc(path);
|
||||
});
|
||||
|
||||
yield Zotero.Sync.Storage.Local.processDownload({
|
||||
item,
|
||||
md5,
|
||||
mtime,
|
||||
compressed: true
|
||||
});
|
||||
yield OS.File.remove(zipFile);
|
||||
|
||||
var storageDir = Zotero.Attachments.getStorageDirectory(item).path;
|
||||
|
||||
basenameStub.restore();
|
||||
pathToFileStub.restore();
|
||||
|
||||
// Make sure path is set correctly
|
||||
assert.equal(item.getFilePath(), OS.Path.join(storageDir, filteredFilename));
|
||||
// Make sure previous files don't exist
|
||||
assert.isFalse(yield OS.File.exists(OS.Path.join(storageDir, oldFilename)));
|
||||
assert.isFalse(yield OS.File.exists(OS.Path.join(storageDir, oldAuxFilename)));
|
||||
// And new ones do
|
||||
assert.isTrue(yield OS.File.exists(OS.Path.join(storageDir, filteredFilename)));
|
||||
assert.isTrue(yield OS.File.exists(OS.Path.join(storageDir, newAuxFilename)));
|
||||
|
||||
// Make sure main file matches attachment hash and mtime
|
||||
yield assert.eventually.equal(
|
||||
item.attachmentHash, Zotero.Utilities.Internal.md5(fileContents)
|
||||
);
|
||||
yield assert.eventually.equal(item.attachmentModificationTime, mtime);
|
||||
});
|
||||
});
|
||||
})
|
||||
|
||||
describe("#getConflicts()", function () {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue