Repository navigation
Expand file tree
/
Copy pathutils.mjs
More file actions
307 lines (287 loc) · 7.91 KB
/
Copy pathutils.mjs
File metadata and controls
307 lines (287 loc) · 7.91 KB
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
import fs from 'fs'
import path from 'path'
import util from 'util'
import $rdf from 'rdflib'
import from from 'from2'
import url, { fileURLToPath } from 'url'
import debugModule from './debug.mjs'
import getSize from 'get-folder-size'
import vocab from 'solid-namespace'
const nsObj = vocab($rdf)
const debug = debugModule.fs
/**
* Returns a fully qualified URL from an Express.js Request object.
* (It's insane that Express does not provide this natively.)
*
* Usage:
*
* ```
* console.log(util.fullUrlForReq(req))
* // -> https://example.com/path/to/resource?q1=v1
* ```
*
* @method fullUrlForReq
*
* @param req {IncomingRequest} Express.js request object
*
* @return {string} Fully qualified URL of the request
*/
export function fullUrlForReq (req) {
const fullUrl = url.format({
protocol: req.protocol,
host: req.get('host'),
pathname: url.resolve(req.baseUrl, req.path),
query: req.query
})
return fullUrl
}
/**
* Removes the `<` and `>` brackets around a string and returns it.
* Used by the `allow` handler in `verifyDelegator()` logic.
* @method debrack
*
* @param s {string}
*
* @return {string}
*/
export function debrack (s) {
if (!s || s.length < 2) {
return s
}
if (s[0] !== '<') {
return s
}
if (s[s.length - 1] !== '>') {
return s
}
return s.substring(1, s.length - 1)
}
/**
* Parse RDF content based on content type.
*
* @method parse
* @param graph {Graph} rdflib Graph object to parse into
* @param data {string} Data to parse
* @param base {string} Base URL
* @param contentType {string} Content type
* @return {Graph} The parsed graph
*/
export async function parse (data, baseUri, contentType) {
const graph = $rdf.graph()
return new Promise((resolve, reject) => {
try {
return $rdf.parse(data, graph, baseUri, contentType, (err, str) => {
if (err) {
return reject(err)
}
resolve(str)
})
} catch (err) {
return reject(err)
}
})
}
/**
* Returns the base filename (without directory) for a given path.
*
* @method pathBasename
*
* @param fullpath {string}
*
* @return {string}
*/
export function pathBasename (fullpath) {
let bname = ''
if (fullpath) {
bname = (fullpath.lastIndexOf('/') === fullpath.length - 1)
? ''
: path.basename(fullpath)
}
return bname
}
/**
* Checks to see whether a string has the given suffix.
*
* @method hasSuffix
*
* @param str {string}
* @param suffix {string}
*
* @return {boolean}
*/
export function hasSuffix (path, suffixes) {
for (const i in suffixes) {
if (path.indexOf(suffixes[i], path.length - suffixes[i].length) !== -1) {
return true
}
}
return false
}
/**
* Serializes an `rdflib` graph to a string.
*
* @method serialize
*
* @param graph {Graph} rdflib Graph object
* @param base {string} Base URL
* @param contentType {string}
*
* @return {string}
*/
export function serialize (graph, base, contentType) {
return new Promise((resolve, reject) => {
try {
// target, kb, base, contentType, callback
$rdf.serialize(null, graph, base, contentType, function (err, result) {
if (err) {
return reject(err)
}
if (result === undefined) {
return reject(new Error('Error serializing the graph to ' +
contentType))
}
resolve(result)
})
} catch (err) {
reject(err)
}
})
}
/**
* Translates common RDF content types to `rdflib` parser names.
*
* @method translate
*
* @param contentType {string}
*
* @return {string}
*/
export function translate (stream, baseUri, from, to) {
return new Promise((resolve, reject) => {
let data = ''
stream
.on('data', function (chunk) {
data += chunk
})
.on('end', function () {
const graph = $rdf.graph()
$rdf.parse(data, graph, baseUri, from, function (err) {
if (err) return reject(err)
resolve(serialize(graph, baseUri, to))
})
})
})
}
/**
* Converts a given string to a Node.js Readable Stream.
*
* @method stringToStream
*
* @param string {string}
*
* @return {ReadableStream}
*/
export function stringToStream (string) {
return from(function (size, next) {
// if there's no more content
// left in the string, close the stream.
if (!string || string.length <= 0) {
return next(null, null)
}
// Pull in a new chunk of text,
// removing it from the string.
const chunk = string.slice(0, size)
string = string.slice(size)
// Emit "chunk" from the stream.
next(null, chunk)
})
}
/**
* Removes line ending characters (\n and \r) from a string.
*
* @method stripLineEndings
* @param str {string}
* @return {string}
*/
export function stripLineEndings (obj) {
if (!obj) { return obj }
return obj.replace(/(\r\n|\n|\r)/gm, '')
}
/**
* Routes the resolved file. Serves static files with content negotiation.
*
* @method routeResolvedFile
* @param req {IncomingMessage} Express.js request object
* @param res {ServerResponse} Express.js response object
* @param file {string} resolved filename
* @param contentType {string} MIME type of the resolved file
* @param container {boolean} whether this is a container
* @param next {Function} Express.js next callback
*/
export function routeResolvedFile (router, path, file, appendFileName = true) {
const fullPath = appendFileName ? path + file.match(/[^/]+$/) : path
const fullFile = fileURLToPath(import.meta.resolve(file))
router.get(fullPath, (req, res) => res.sendFile(fullFile))
}
/**
* Returns the quota for a user in a root
* @param root
* @param serverUri
* @returns {Promise<Number>} The quota in bytes
*/
export async function getQuota (root, serverUri) {
const filename = path.join(root, 'settings/serverSide.ttl')
debug('Reading quota from ' + filename)
let prefs
try {
prefs = await _asyncReadfile(filename)
} catch (error) {
debug('Setting no quota. While reading serverSide.ttl, got ' + error)
return Infinity
}
const graph = $rdf.graph()
const storageUri = serverUri.endsWith('/') ? serverUri : serverUri + '/'
try {
$rdf.parse(prefs, graph, storageUri, 'text/turtle')
} catch (error) {
throw new Error('Failed to parse serverSide.ttl, got ' + error)
}
return Number(graph.anyValue($rdf.sym(storageUri), nsObj.solid('storageQuota'))) || Infinity
}
/**
* Returns true of the user has already exceeded their quota, i.e. it
* will check if new requests should be rejected, which means they
* could PUT a large file and get away with it.
*/
export async function overQuota (root, serverUri) {
const quota = await getQuota(root, serverUri)
if (quota === Infinity) {
return false
}
// TODO: cache this value?
const size = await actualSize(root)
return (size > quota)
}
/**
* Returns the number of bytes that is occupied by the actual files in
* the file system. IMPORTANT NOTE: Since it traverses the directory
* to find the actual file sizes, this does a costly operation, but
* neglible for the small quotas we currently allow. If the quotas
* grow bigger, this will significantly reduce write performance, and
* so it needs to be rewritten.
*/
function actualSize (root) {
return util.promisify(getSize)(root)
}
function _asyncReadfile (filename) {
return util.promisify(fs.readFile)(filename, 'utf-8')
}
/**
* Get the content type from a headers object
* @param headers An Express or Fetch API headers object
* @return {string} A content type string
*/
export function getContentType (headers) {
const value = headers.get ? headers.get('content-type') : headers['content-type']
return value ? value.replace(/;.*/, '') : ''
}