mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-09 08:45:55 +02:00
422 lines
16 KiB
TypeScript
422 lines
16 KiB
TypeScript
import BaseModel from '../BaseModel';
|
|
import BaseItem from './BaseItem';
|
|
import ItemChange from './ItemChange';
|
|
import NoteResource from './NoteResource';
|
|
import Setting from './Setting';
|
|
import markdownUtils from '../markdownUtils';
|
|
import { _ } from '../locale';
|
|
import { ResourceEntity, ResourceLocalStateEntity } from '../services/database/types';
|
|
import ResourceLocalState from './ResourceLocalState';
|
|
const pathUtils = require('../path-utils');
|
|
const { mime } = require('../mime-utils.js');
|
|
const { filename, safeFilename } = require('../path-utils');
|
|
const { FsDriverDummy } = require('../fs-driver-dummy.js');
|
|
import JoplinError from '../JoplinError';
|
|
import itemCanBeEncrypted from './utils/itemCanBeEncrypted';
|
|
import { getEncryptionEnabled } from '../services/synchronizer/syncInfoUtils';
|
|
|
|
export default class Resource extends BaseItem {
|
|
|
|
public static IMAGE_MAX_DIMENSION = 1920;
|
|
|
|
public static FETCH_STATUS_IDLE = 0;
|
|
public static FETCH_STATUS_STARTED = 1;
|
|
public static FETCH_STATUS_DONE = 2;
|
|
public static FETCH_STATUS_ERROR = 3;
|
|
|
|
public static fsDriver_: any;
|
|
|
|
static tableName() {
|
|
return 'resources';
|
|
}
|
|
|
|
static modelType() {
|
|
return BaseModel.TYPE_RESOURCE;
|
|
}
|
|
|
|
static encryptionService() {
|
|
if (!this.encryptionService_) throw new Error('Resource.encryptionService_ is not set!!');
|
|
return this.encryptionService_;
|
|
}
|
|
|
|
static isSupportedImageMimeType(type: string) {
|
|
const imageMimeTypes = ['image/jpg', 'image/jpeg', 'image/png', 'image/gif', 'image/svg+xml', 'image/webp'];
|
|
return imageMimeTypes.indexOf(type.toLowerCase()) >= 0;
|
|
}
|
|
|
|
static fetchStatuses(resourceIds: string[]): Promise<any[]> {
|
|
if (!resourceIds.length) return Promise.resolve([]);
|
|
return this.db().selectAll(`SELECT resource_id, fetch_status FROM resource_local_states WHERE resource_id IN ("${resourceIds.join('","')}")`);
|
|
}
|
|
|
|
public static sharedResourceIds(): Promise<string[]> {
|
|
return this.db().selectAllFields('SELECT id FROM resources WHERE is_shared = 1', [], 'id');
|
|
}
|
|
|
|
static errorFetchStatuses() {
|
|
return this.db().selectAll(`
|
|
SELECT title AS resource_title, resource_id, fetch_error
|
|
FROM resource_local_states
|
|
LEFT JOIN resources ON resources.id = resource_local_states.resource_id
|
|
WHERE fetch_status = ?
|
|
`, [Resource.FETCH_STATUS_ERROR]);
|
|
}
|
|
|
|
static needToBeFetched(resourceDownloadMode: string = null, limit: number = null) {
|
|
const sql = ['SELECT * FROM resources WHERE encryption_applied = 0 AND id IN (SELECT resource_id FROM resource_local_states WHERE fetch_status = ?)'];
|
|
if (resourceDownloadMode !== 'always') {
|
|
sql.push('AND resources.id IN (SELECT resource_id FROM resources_to_download)');
|
|
}
|
|
sql.push('ORDER BY updated_time DESC');
|
|
if (limit !== null) sql.push(`LIMIT ${limit}`);
|
|
return this.modelSelectAll(sql.join(' '), [Resource.FETCH_STATUS_IDLE]);
|
|
}
|
|
|
|
static async resetStartedFetchStatus() {
|
|
return await this.db().exec('UPDATE resource_local_states SET fetch_status = ? WHERE fetch_status = ?', [Resource.FETCH_STATUS_IDLE, Resource.FETCH_STATUS_STARTED]);
|
|
}
|
|
|
|
static resetErrorStatus(resourceId: string) {
|
|
return this.db().exec('UPDATE resource_local_states SET fetch_status = ?, fetch_error = "" WHERE resource_id = ?', [Resource.FETCH_STATUS_IDLE, resourceId]);
|
|
}
|
|
|
|
static fsDriver() {
|
|
if (!Resource.fsDriver_) Resource.fsDriver_ = new FsDriverDummy();
|
|
return Resource.fsDriver_;
|
|
}
|
|
|
|
// DEPRECATED IN FAVOUR OF friendlySafeFilename()
|
|
static friendlyFilename(resource: ResourceEntity) {
|
|
let output = safeFilename(resource.title); // Make sure not to allow spaces or any special characters as it's not supported in HTTP headers
|
|
if (!output) output = resource.id;
|
|
let extension = resource.file_extension;
|
|
if (!extension) extension = resource.mime ? mime.toFileExtension(resource.mime) : '';
|
|
extension = extension ? `.${extension}` : '';
|
|
return output + extension;
|
|
}
|
|
|
|
static baseDirectoryPath() {
|
|
return Setting.value('resourceDir');
|
|
}
|
|
|
|
static baseRelativeDirectoryPath() {
|
|
return Setting.value('resourceDirName');
|
|
}
|
|
|
|
static filename(resource: ResourceEntity, encryptedBlob = false) {
|
|
let extension = encryptedBlob ? 'crypted' : resource.file_extension;
|
|
if (!extension) extension = resource.mime ? mime.toFileExtension(resource.mime) : '';
|
|
extension = extension ? `.${extension}` : '';
|
|
return resource.id + extension;
|
|
}
|
|
|
|
static friendlySafeFilename(resource: ResourceEntity) {
|
|
let ext = resource.file_extension;
|
|
if (!ext) ext = resource.mime ? mime.toFileExtension(resource.mime) : '';
|
|
const safeExt = ext ? pathUtils.safeFileExtension(ext).toLowerCase() : '';
|
|
let title = resource.title ? resource.title : resource.id;
|
|
if (safeExt && pathUtils.fileExtension(title).toLowerCase() === safeExt) title = pathUtils.filename(title);
|
|
return pathUtils.friendlySafeFilename(title) + (safeExt ? `.${safeExt}` : '');
|
|
}
|
|
|
|
static relativePath(resource: ResourceEntity, encryptedBlob = false) {
|
|
return `${Setting.value('resourceDirName')}/${this.filename(resource, encryptedBlob)}`;
|
|
}
|
|
|
|
static fullPath(resource: ResourceEntity, encryptedBlob = false) {
|
|
return `${Setting.value('resourceDir')}/${this.filename(resource, encryptedBlob)}`;
|
|
}
|
|
|
|
static async isReady(resource: ResourceEntity) {
|
|
const r = await this.readyStatus(resource);
|
|
return r === 'ok';
|
|
}
|
|
|
|
static async readyStatus(resource: ResourceEntity) {
|
|
const ls = await this.localState(resource);
|
|
if (!resource) return 'notFound';
|
|
if (ls.fetch_status !== Resource.FETCH_STATUS_DONE) return 'notDownloaded';
|
|
if (resource.encryption_blob_encrypted) return 'encrypted';
|
|
return 'ok';
|
|
}
|
|
|
|
static async requireIsReady(resource: ResourceEntity) {
|
|
const readyStatus = await Resource.readyStatus(resource);
|
|
if (readyStatus !== 'ok') throw new Error(`Resource is not ready. Status: ${readyStatus}`);
|
|
}
|
|
|
|
// For resources, we need to decrypt the item (metadata) and the resource binary blob.
|
|
static async decrypt(item: ResourceEntity) {
|
|
// The item might already be decrypted but not the blob (for instance if it crashes while
|
|
// decrypting the blob or was otherwise interrupted).
|
|
const decryptedItem = item.encryption_cipher_text ? await super.decrypt(item) : Object.assign({}, item);
|
|
if (!decryptedItem.encryption_blob_encrypted) return decryptedItem;
|
|
|
|
const localState = await this.localState(item);
|
|
if (localState.fetch_status !== Resource.FETCH_STATUS_DONE) {
|
|
// Not an error - it means the blob has not been downloaded yet.
|
|
// It will be decrypted later on, once downloaded.
|
|
return decryptedItem;
|
|
}
|
|
|
|
const plainTextPath = this.fullPath(decryptedItem);
|
|
const encryptedPath = this.fullPath(decryptedItem, true);
|
|
const noExtPath = `${pathUtils.dirname(encryptedPath)}/${pathUtils.filename(encryptedPath)}`;
|
|
|
|
// When the resource blob is downloaded by the synchroniser, it's initially a file with no
|
|
// extension (since it's encrypted, so we don't know its extension). So here rename it
|
|
// to a file with a ".crypted" extension so that it's better identified, and then decrypt it.
|
|
// Potentially plainTextPath is also a path with no extension if it's an unknown mime type.
|
|
if (await this.fsDriver().exists(noExtPath)) {
|
|
await this.fsDriver().move(noExtPath, encryptedPath);
|
|
}
|
|
|
|
try {
|
|
await this.encryptionService().decryptFile(encryptedPath, plainTextPath);
|
|
} catch (error) {
|
|
if (error.code === 'invalidIdentifier') {
|
|
// As the identifier is invalid it most likely means that this is not encrypted data
|
|
// at all. It can happen for example when there's a crash between the moment the data
|
|
// is decrypted and the resource item is updated.
|
|
this.logger().warn(`Found a resource that was most likely already decrypted but was marked as encrypted. Marked it as decrypted: ${item.id}`);
|
|
this.fsDriver().move(encryptedPath, plainTextPath);
|
|
} else {
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
decryptedItem.encryption_blob_encrypted = 0;
|
|
return super.save(decryptedItem, { autoTimestamp: false });
|
|
}
|
|
|
|
// Prepare the resource by encrypting it if needed.
|
|
// The call returns the path to the physical file AND a representation of the resource object
|
|
// as it should be uploaded to the sync target. Note that this may be different from what is stored
|
|
// in the database. In particular, the flag encryption_blob_encrypted might be 1 on the sync target
|
|
// if the resource is encrypted, but will be 0 locally because the device has the decrypted resource.
|
|
public static async fullPathForSyncUpload(resource: ResourceEntity) {
|
|
const plainTextPath = this.fullPath(resource);
|
|
|
|
if (!getEncryptionEnabled() || !itemCanBeEncrypted(resource as any)) {
|
|
// Normally not possible since itemsThatNeedSync should only return decrypted items
|
|
if (resource.encryption_blob_encrypted) throw new Error('Trying to access encrypted resource but encryption is currently disabled');
|
|
return { path: plainTextPath, resource: resource };
|
|
}
|
|
|
|
const encryptedPath = this.fullPath(resource, true);
|
|
if (resource.encryption_blob_encrypted) return { path: encryptedPath, resource: resource };
|
|
|
|
try {
|
|
await this.encryptionService().encryptFile(plainTextPath, encryptedPath);
|
|
} catch (error) {
|
|
if (error.code === 'ENOENT') throw new JoplinError(`File not found:${error.toString()}`, 'fileNotFound');
|
|
throw error;
|
|
}
|
|
|
|
const resourceCopy = Object.assign({}, resource);
|
|
resourceCopy.encryption_blob_encrypted = 1;
|
|
return { path: encryptedPath, resource: resourceCopy };
|
|
}
|
|
|
|
static markdownTag(resource: any) {
|
|
let tagAlt = resource.alt ? resource.alt : resource.title;
|
|
if (!tagAlt) tagAlt = '';
|
|
const lines = [];
|
|
if (Resource.isSupportedImageMimeType(resource.mime)) {
|
|
lines.push('![');
|
|
lines.push(markdownUtils.escapeTitleText(tagAlt));
|
|
lines.push(`](:/${resource.id})`);
|
|
} else {
|
|
lines.push('[');
|
|
lines.push(markdownUtils.escapeTitleText(tagAlt));
|
|
lines.push(`](:/${resource.id})`);
|
|
}
|
|
return lines.join('');
|
|
}
|
|
|
|
static internalUrl(resource: ResourceEntity) {
|
|
return `:/${resource.id}`;
|
|
}
|
|
|
|
static pathToId(path: string) {
|
|
return filename(path);
|
|
}
|
|
|
|
static async content(resource: ResourceEntity) {
|
|
return this.fsDriver().readFile(this.fullPath(resource), 'Buffer');
|
|
}
|
|
|
|
static setContent(resource: ResourceEntity, content: any) {
|
|
return this.fsDriver().writeBinaryFile(this.fullPath(resource), content);
|
|
}
|
|
|
|
static isResourceUrl(url: string) {
|
|
return url && url.length === 34 && url[0] === ':' && url[1] === '/';
|
|
}
|
|
|
|
static urlToId(url: string) {
|
|
if (!this.isResourceUrl(url)) throw new Error(`Not a valid resource URL: ${url}`);
|
|
return url.substr(2);
|
|
}
|
|
|
|
static async localState(resourceOrId: any) {
|
|
return ResourceLocalState.byResourceId(typeof resourceOrId === 'object' ? resourceOrId.id : resourceOrId);
|
|
}
|
|
|
|
static async setLocalState(resourceOrId: any, state: ResourceLocalStateEntity) {
|
|
const id = typeof resourceOrId === 'object' ? resourceOrId.id : resourceOrId;
|
|
await ResourceLocalState.save(Object.assign({}, state, { resource_id: id }));
|
|
}
|
|
|
|
static async needFileSizeSet() {
|
|
return this.modelSelectAll('SELECT * FROM resources WHERE `size` < 0 AND encryption_blob_encrypted = 0');
|
|
}
|
|
|
|
// Only set the `size` field and nothing else, not even the update_time
|
|
// This is because it's only necessary to do it once after migration 20
|
|
// and each client does it so there's no need to sync the resource.
|
|
static async setFileSizeOnly(resourceId: string, fileSize: number) {
|
|
return this.db().exec('UPDATE resources set `size` = ? WHERE id = ?', [fileSize, resourceId]);
|
|
}
|
|
|
|
static async batchDelete(ids: string[], options: any = null) {
|
|
// For resources, there's not really batch deleting since there's the file data to delete
|
|
// too, so each is processed one by one with the item being deleted last (since the db
|
|
// call is the less likely to fail).
|
|
for (let i = 0; i < ids.length; i++) {
|
|
const id = ids[i];
|
|
const resource = await Resource.load(id);
|
|
if (!resource) continue;
|
|
|
|
const path = Resource.fullPath(resource);
|
|
await this.fsDriver().remove(path);
|
|
await super.batchDelete([id], options);
|
|
await NoteResource.deleteByResource(id); // Clean up note/resource relationships
|
|
}
|
|
|
|
await ResourceLocalState.batchDelete(ids);
|
|
}
|
|
|
|
static async markForDownload(resourceId: string) {
|
|
// Insert the row only if it's not already there
|
|
const t = Date.now();
|
|
await this.db().exec('INSERT INTO resources_to_download (resource_id, updated_time, created_time) SELECT ?, ?, ? WHERE NOT EXISTS (SELECT 1 FROM resources_to_download WHERE resource_id = ?)', [resourceId, t, t, resourceId]);
|
|
}
|
|
|
|
static async downloadedButEncryptedBlobCount(excludedIds: string[] = null) {
|
|
let excludedSql = '';
|
|
if (excludedIds && excludedIds.length) {
|
|
excludedSql = `AND resource_id NOT IN ("${excludedIds.join('","')}")`;
|
|
}
|
|
|
|
const r = await this.db().selectOne(`
|
|
SELECT count(*) as total
|
|
FROM resource_local_states
|
|
WHERE fetch_status = ?
|
|
AND resource_id IN (SELECT id FROM resources WHERE encryption_blob_encrypted = 1)
|
|
${excludedSql}
|
|
`, [Resource.FETCH_STATUS_DONE]);
|
|
|
|
return r ? r.total : 0;
|
|
}
|
|
|
|
static async downloadStatusCounts(status: number) {
|
|
const r = await this.db().selectOne(`
|
|
SELECT count(*) as total
|
|
FROM resource_local_states
|
|
WHERE fetch_status = ?
|
|
`, [status]);
|
|
|
|
return r ? r.total : 0;
|
|
}
|
|
|
|
static async createdLocallyCount() {
|
|
const r = await this.db().selectOne(`
|
|
SELECT count(*) as total
|
|
FROM resources
|
|
WHERE id NOT IN
|
|
(SELECT resource_id FROM resource_local_states)
|
|
`);
|
|
|
|
return r ? r.total : 0;
|
|
}
|
|
|
|
static fetchStatusToLabel(status: number) {
|
|
if (status === Resource.FETCH_STATUS_IDLE) return _('Not downloaded');
|
|
if (status === Resource.FETCH_STATUS_STARTED) return _('Downloading');
|
|
if (status === Resource.FETCH_STATUS_DONE) return _('Downloaded');
|
|
if (status === Resource.FETCH_STATUS_ERROR) return _('Error');
|
|
throw new Error(`Invalid status: ${status}`);
|
|
}
|
|
|
|
static async updateResourceBlobContent(resourceId: string, newBlobFilePath: string) {
|
|
const resource = await Resource.load(resourceId);
|
|
await this.requireIsReady(resource);
|
|
|
|
const fileStat = await this.fsDriver().stat(newBlobFilePath);
|
|
await this.fsDriver().copy(newBlobFilePath, Resource.fullPath(resource));
|
|
|
|
return await Resource.save({
|
|
id: resource.id,
|
|
size: fileStat.size,
|
|
});
|
|
}
|
|
|
|
static async resourceBlobContent(resourceId: string, encoding = 'Buffer') {
|
|
const resource = await Resource.load(resourceId);
|
|
await this.requireIsReady(resource);
|
|
return await this.fsDriver().readFile(Resource.fullPath(resource), encoding);
|
|
}
|
|
|
|
static async duplicateResource(resourceId: string) {
|
|
const resource = await Resource.load(resourceId);
|
|
const localState = await Resource.localState(resource);
|
|
|
|
let newResource = { ...resource };
|
|
delete newResource.id;
|
|
newResource = await Resource.save(newResource);
|
|
|
|
const newLocalState = { ...localState };
|
|
newLocalState.resource_id = newResource.id;
|
|
delete newLocalState.id;
|
|
|
|
await Resource.setLocalState(newResource, newLocalState);
|
|
|
|
const sourcePath = Resource.fullPath(resource);
|
|
if (await this.fsDriver().exists(sourcePath)) {
|
|
await this.fsDriver().copy(sourcePath, Resource.fullPath(newResource));
|
|
}
|
|
|
|
return newResource;
|
|
}
|
|
|
|
public static async resourceConflictFolderId(): Promise<string> {
|
|
const folder = await this.resourceConflictFolder();
|
|
return folder.id;
|
|
}
|
|
|
|
private static async resourceConflictFolder(): Promise<any> {
|
|
const conflictFolderTitle = _('Conflicts (attachments)');
|
|
const Folder = this.getClass('Folder');
|
|
|
|
const folder = await Folder.loadByTitle(conflictFolderTitle);
|
|
if (!folder || folder.parent_id) {
|
|
return Folder.save({ title: conflictFolderTitle });
|
|
}
|
|
|
|
return folder;
|
|
}
|
|
|
|
public static async createConflictResourceNote(resource: ResourceEntity) {
|
|
const Note = this.getClass('Note');
|
|
const conflictResource = await Resource.duplicateResource(resource.id);
|
|
|
|
await Note.save({
|
|
title: _('Attachment conflict: "%s"', resource.title),
|
|
body: _('There was a [conflict](%s) on the attachment below.\n\n%s', 'https://joplinapp.org/conflict/', Resource.markdownTag(conflictResource)),
|
|
parent_id: await this.resourceConflictFolderId(),
|
|
}, { changeSource: ItemChange.SOURCE_SYNC });
|
|
}
|
|
|
|
}
|