mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-03 08:35:29 +02:00
256 lines
6.6 KiB
JavaScript
256 lines
6.6 KiB
JavaScript
const fs = require('fs-extra');
|
|
const { promiseChain } = require('lib/promise-utils.js');
|
|
const moment = require('moment');
|
|
const BaseItem = require('lib/models/BaseItem.js');
|
|
const { time } = require('lib/time-utils.js');
|
|
|
|
// NOTE: when synchronising with the file system the time resolution is the second (unlike milliseconds for OneDrive for instance).
|
|
// What it means is that if, for example, client 1 changes a note at time t, and client 2 changes the same note within the same second,
|
|
// both clients will not know about each others updates during the next sync. They will simply both sync their note and whoever
|
|
// comes last will overwrite (on the remote storage) the note of the other client. Both client will then have a different note at
|
|
// that point and that will only be resolved if one of them changes the note and sync (if they don't change it, it will never get resolved).
|
|
//
|
|
// This is compound with the fact that we can't have a reliable delta API on the file system so we need to check all the timestamps
|
|
// every time and rely on this exclusively to know about changes.
|
|
//
|
|
// This explains occasional failures of the fuzzing program (it finds that the clients end up with two different notes after sync). To
|
|
// check that it is indeed the problem, check log-database.txt of both clients, search for the note ID, and most likely both notes
|
|
// will have been modified at the same exact second at some point. If not, it's another bug that needs to be investigated.
|
|
|
|
class FileApiDriverLocal {
|
|
|
|
fsErrorToJsError_(error) {
|
|
let msg = error.toString();
|
|
let output = new Error(msg);
|
|
if (error.code) output.code = error.code;
|
|
return output;
|
|
}
|
|
|
|
fsDriver() {
|
|
if (!FileApiDriverLocal.fsDriver_) throw new Error('FileApiDriverLocal.fsDriver_ not set!');
|
|
return FileApiDriverLocal.fsDriver_;
|
|
}
|
|
|
|
async stat(path) {
|
|
try {
|
|
const s = await this.fsDriver().stat(path);
|
|
return this.metadataFromStat_(s);
|
|
} catch (error) {
|
|
if (error.code == 'ENOENT') return null;
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
}
|
|
|
|
metadataFromStat_(stat) {
|
|
return {
|
|
path: stat.path,
|
|
created_time: stat.birthtime.getTime(),
|
|
updated_time: stat.mtime.getTime(),
|
|
created_time_orig: stat.birthtime,
|
|
updated_time_orig: stat.mtime,
|
|
isDir: stat.isDirectory(),
|
|
};
|
|
}
|
|
|
|
metadataFromStats_(stats) {
|
|
let output = [];
|
|
for (let i = 0; i < stats.length; i++) {
|
|
const mdStat = this.metadataFromStat_(stats[i]);
|
|
output.push(mdStat);
|
|
}
|
|
return output;
|
|
}
|
|
|
|
async setTimestamp(path, timestampMs) {
|
|
try {
|
|
await this.fsDriver().setTimestamp(path, new Date(timestampMs));
|
|
} catch (error) {
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
}
|
|
|
|
async delta(path, options) {
|
|
const itemIds = await options.allItemIdsHandler();
|
|
|
|
try {
|
|
const stats = await this.fsDriver().readDirStats(path);
|
|
let output = this.metadataFromStats_(stats);
|
|
|
|
if (!Array.isArray(itemIds)) throw new Error('Delta API not supported - local IDs must be provided');
|
|
|
|
let deletedItems = [];
|
|
for (let i = 0; i < itemIds.length; i++) {
|
|
const itemId = itemIds[i];
|
|
let found = false;
|
|
for (let j = 0; j < output.length; j++) {
|
|
const item = output[j];
|
|
if (BaseItem.pathToId(item.path) == itemId) {
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found) {
|
|
deletedItems.push({
|
|
path: BaseItem.systemPath(itemId),
|
|
isDeleted: true,
|
|
});
|
|
}
|
|
}
|
|
|
|
output = output.concat(deletedItems);
|
|
|
|
return {
|
|
hasMore: false,
|
|
context: null,
|
|
items: output,
|
|
};
|
|
} catch(error) {
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
}
|
|
|
|
async list(path, options) {
|
|
try {
|
|
const stats = await this.fsDriver().readDirStats(path);
|
|
const output = this.metadataFromStats_(stats);
|
|
|
|
return {
|
|
items: output,
|
|
hasMore: false,
|
|
context: null,
|
|
};
|
|
} catch(error) {
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
}
|
|
|
|
async get(path, options) {
|
|
let output = null;
|
|
|
|
try {
|
|
if (options.target === 'file') {
|
|
//output = await fs.copy(path, options.path, { overwrite: true });
|
|
output = await this.fsDriver().copy(path, options.path);
|
|
} else {
|
|
//output = await fs.readFile(path, options.encoding);
|
|
output = await this.fsDriver().readFile(path, options.encoding);
|
|
}
|
|
} catch (error) {
|
|
if (error.code == 'ENOENT') return null;
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
|
|
return output;
|
|
}
|
|
|
|
async mkdir(path) {
|
|
if (await this.fsDriver().exists(path)) return;
|
|
|
|
try {
|
|
await this.fsDriver().mkdir(path);
|
|
} catch (error) {
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
|
|
// return new Promise((resolve, reject) => {
|
|
// fs.exists(path, (exists) => {
|
|
// if (exists) {
|
|
// resolve();
|
|
// return;
|
|
// }
|
|
|
|
// fs.mkdirp(path, (error) => {
|
|
// if (error) {
|
|
// reject(this.fsErrorToJsError_(error));
|
|
// } else {
|
|
// resolve();
|
|
// }
|
|
// });
|
|
// });
|
|
// });
|
|
}
|
|
|
|
async put(path, content, options = null) {
|
|
if (!options) options = {};
|
|
|
|
try {
|
|
if (options.source === 'file') {
|
|
await this.fsDriver().copy(options.path, path);
|
|
return;
|
|
}
|
|
|
|
await this.fsDriver().writeFile(path, content, 'utf8');
|
|
} catch (error) {
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
|
|
// if (!options) options = {};
|
|
|
|
// if (options.source === 'file') content = await fs.readFile(options.path);
|
|
|
|
// return new Promise((resolve, reject) => {
|
|
// fs.writeFile(path, content, function(error) {
|
|
// if (error) {
|
|
// reject(this.fsErrorToJsError_(error));
|
|
// } else {
|
|
// resolve();
|
|
// }
|
|
// });
|
|
// });
|
|
}
|
|
|
|
async delete(path) {
|
|
try {
|
|
await this.fsDriver().unlink(path);
|
|
} catch (error) {
|
|
throw this.fsErrorToJsError_(error);
|
|
}
|
|
|
|
// return new Promise((resolve, reject) => {
|
|
// fs.unlink(path, function(error) {
|
|
// if (error) {
|
|
// if (error && error.code == 'ENOENT') {
|
|
// // File doesn't exist - it's fine
|
|
// resolve();
|
|
// } else {
|
|
// reject(this.fsErrorToJsError_(error));
|
|
// }
|
|
// } else {
|
|
// resolve();
|
|
// }
|
|
// });
|
|
// });
|
|
}
|
|
|
|
async move(oldPath, newPath) {
|
|
return this.fsDriver().move(oldPath, newPath);
|
|
|
|
// let lastError = null;
|
|
|
|
// for (let i = 0; i < 5; i++) {
|
|
// try {
|
|
// let output = await fs.move(oldPath, newPath, { overwrite: true });
|
|
// return output;
|
|
// } catch (error) {
|
|
// lastError = error;
|
|
// // Normally cannot happen with the `overwrite` flag but sometime it still does.
|
|
// // In this case, retry.
|
|
// if (error.code == 'EEXIST') {
|
|
// await time.sleep(1);
|
|
// continue;
|
|
// }
|
|
// throw this.fsErrorToJsError_(error);
|
|
// }
|
|
// }
|
|
|
|
// throw lastError;
|
|
}
|
|
|
|
format() {
|
|
throw new Error('Not supported');
|
|
}
|
|
|
|
}
|
|
|
|
module.exports = { FileApiDriverLocal }; |