/
LocalStorageBase.js
217 lines (183 loc) · 7.15 KB
/
LocalStorageBase.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// # Local File Base Storage module
// The (default) module for storing files using the local file system
const serveStatic = require('../../../shared/express').static;
const fs = require('fs-extra');
const path = require('path');
const tpl = require('@tryghost/tpl');
const errors = require('@tryghost/errors');
const constants = require('@tryghost/constants');
const urlUtils = require('../../../shared/url-utils');
const StorageBase = require('ghost-storage-base');
const messages = {
notFound: 'File not found',
notFoundWithRef: 'File not found: {file}',
cannotRead: 'Could not read file: {file}',
invalidUrlParameter: `The URL "{url}" is not a valid URL for this site.`
};
class LocalStorageBase extends StorageBase {
/**
*
* @param {Object} options
* @param {String} options.storagePath
* @param {String} options.siteUrl
* @param {String} [options.staticFileURLPrefix]
* @param {Object} [options.errorMessages]
* @param {String} [options.errorMessages.notFound]
* @param {String} [options.errorMessages.notFoundWithRef]
* @param {String} [options.errorMessages.cannotRead]
*/
constructor({storagePath, staticFileURLPrefix, siteUrl, errorMessages}) {
super();
this.storagePath = storagePath;
this.staticFileURLPrefix = staticFileURLPrefix;
this.siteUrl = siteUrl;
this.staticFileUrl = `${siteUrl}${staticFileURLPrefix}`;
this.errorMessages = errorMessages || messages;
}
/**
* Saves the file to storage (the file system)
* - returns a promise which ultimately returns the full url to the uploaded file
*
* @param {StorageBase.Image} file
* @param {String} targetDir
* @returns {Promise<String>}
*/
async save(file, targetDir) {
let targetFilename;
// NOTE: the base implementation of `getTargetDir` returns the format this.storagePath/YYYY/MM
targetDir = targetDir || this.getTargetDir(this.storagePath);
const filename = await this.getUniqueFileName(file, targetDir);
targetFilename = filename;
await fs.mkdirs(targetDir);
await fs.copy(file.path, targetFilename);
// The src for the image must be in URI format, not a file system path, which in Windows uses \
// For local file system storage can use relative path so add a slash
const fullUrl = (
urlUtils.urlJoin('/',
urlUtils.getSubdir(),
this.staticFileURLPrefix,
path.relative(this.storagePath, targetFilename))
).replace(new RegExp(`\\${path.sep}`, 'g'), '/');
return fullUrl;
}
/**
*
* @param {String} url full url under which the stored content is served, result of save method
* @returns {String} path under which the content is stored
*/
urlToPath(url) {
let filePath;
const prefix = urlUtils.urlJoin('/',
urlUtils.getSubdir(),
this.staticFileURLPrefix
);
if (url.startsWith(this.staticFileUrl)) {
// CASE: full path that includes the site url
filePath = url.replace(this.staticFileUrl, '');
filePath = path.join(this.storagePath, filePath);
} else if (url.startsWith(prefix)) {
// CASE: The result of the save method doesn't include the site url. So we need to handle this case.
filePath = url.replace(prefix, '');
filePath = path.join(this.storagePath, filePath);
} else {
throw new errors.IncorrectUsageError({
message: tpl(messages.invalidUrlParameter, {url})
});
}
return filePath;
}
exists(fileName, targetDir) {
const filePath = path.join(targetDir || this.storagePath, fileName);
return fs.stat(filePath)
.then(() => {
return true;
})
.catch(() => {
return false;
});
}
/**
* For some reason send divides the max age number by 1000
* Fallthrough: false ensures that if an image isn't found, it automatically 404s
* Wrap server static errors
*
* @returns {serveStaticContent}
*/
serve() {
const {storagePath, errorMessages} = this;
return function serveStaticContent(req, res, next) {
return serveStatic(
storagePath,
{
maxAge: constants.ONE_YEAR_MS,
fallthrough: false
}
)(req, res, (err) => {
if (err) {
if (err.statusCode === 404) {
return next(new errors.NotFoundError({
message: tpl(errorMessages.notFound),
code: 'STATIC_FILE_NOT_FOUND',
property: err.path
}));
}
if (err.statusCode === 400) {
return next(new errors.BadRequestError({err: err}));
}
if (err.statusCode === 403) {
return next(new errors.NoPermissionError({err: err}));
}
if (err.name === 'RangeNotSatisfiableError') {
return next(new errors.RangeNotSatisfiableError({err}));
}
return next(new errors.InternalServerError({err: err}));
}
next();
});
};
}
/**
* @param {String} filePath
* @returns {Promise.<*>}
*/
async delete(fileName, targetDir) {
const filePath = path.join(targetDir, fileName);
return await fs.remove(filePath);
}
/**
* Reads bytes from disk for a target file
* - path of target file (without content path!)
*
* @param options
*/
read(options) {
options = options || {};
// remove trailing slashes
options.path = (options.path || '').replace(/\/$|\\$/, '');
const targetPath = path.join(this.storagePath, options.path);
return new Promise((resolve, reject) => {
fs.readFile(targetPath, (err, bytes) => {
if (err) {
if (err.code === 'ENOENT' || err.code === 'ENOTDIR') {
return reject(new errors.NotFoundError({
err: err,
message: tpl(this.errorMessages.notFoundWithRef, {file: options.path})
}));
}
if (err.code === 'ENAMETOOLONG') {
return reject(new errors.BadRequestError({err: err}));
}
if (err.code === 'EACCES') {
return reject(new errors.NoPermissionError({err: err}));
}
return reject(new errors.InternalServerError({
err: err,
message: tpl(this.errorMessages.cannotRead, {file: options.path})
}));
}
resolve(bytes);
});
});
}
}
module.exports = LocalStorageBase;