forked from maclovin/thumbor-1
-
Notifications
You must be signed in to change notification settings - Fork 6
/
index.js
379 lines (311 loc) · 8.85 KB
/
index.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
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
// core deps
const crypto = require('crypto');
// locals
const keys = {};
const consts = {
TOP : 'top',
MIDDLE : 'middle',
BOTTOM : 'bottom',
RIGHT : 'right',
CENTER : 'center',
LEFT : 'left',
};
/**
* returns whether given input a non-empty string
*
* @param {String} s
* @return {Boolean}
*/
function validString(s)
{
return (typeof s === 'string') && s.length;
}
function initSeckey(seckey)
{
if (!validString(seckey))
return null;
const existing_key = Object.getOwnPropertySymbols(keys).reduce((pv, sym) => pv || (keys[sym] === seckey ? sym : null), null);
if (existing_key)
return existing_key;
const new_key = Symbol();
keys[ new_key ] = seckey;
return new_key;
}
function getSeckey(prop)
{
return prop && keys[ prop ];
}
/**
* Build operation path, must be bound to instance of Thumbor
*
* @return {Array}
*/
function getOperationPath(reset)
{
if (!this.imagePath)
throw new Error('The image url can\'t be null or empty (call `imgpath()` first).');
const parts = [];
if (this.meta)
parts.push('meta');
if (this.cropValues)
parts.push(
this.cropValues.left +
'x' + this.cropValues.top +
':' + this.cropValues.right +
'x' + this.cropValues.bottom
);
if (this.fitInFlag)
parts.push('fit-in');
if (
this.width ||
this.height ||
this.withFlipHorizontally ||
this.withFlipVertically
) {
let sizeString = '';
if (this.withFlipHorizontally)
sizeString += '-';
sizeString += this.width;
sizeString += 'x';
if (this.withFlipVertically)
sizeString += '-';
sizeString += this.height;
parts.push(sizeString);
}
if (this.halignValue)
parts.push(this.halignValue);
if (this.valignValue)
parts.push(this.valignValue);
if (this.smart)
parts.push('smart');
if (this.filtersCalls.length)
parts.push('filters:' + this.filtersCalls.join(':'));
parts.push(this.imagePath);
if (reset)
this.reset();
return parts.join('/');
}
class ThumborJS
{
/**
* ctor
*
* @param {String} thumborServerUrl
* @param {String|null} securityKey
*/
constructor(thumborServerUrl, securityKey)
{
if (!validString(thumborServerUrl))
throw new Error('`thumborServerUrl` parameter must be a non-empty string');
this.seckeyProp = initSeckey(securityKey);
this.serverUrl = thumborServerUrl;
this.reset();
}
/**
* reset the internal properties (that map to thumbor url-parts)
*/
reset()
{
this.imagePath = '';
this.width = 0;
this.height = 0;
this.smart = false;
this.fitInFlag = false;
this.withFlipHorizontally = false;
this.withFlipVertically = false;
this.halignValue = null;
this.valignValue = null;
this.cropValues = null;
this.meta = false;
this.filtersCalls = [];
}
/**
* Set path of image
*
* @param {String} imagePath
*/
imgpath(imagePath, reset)
{
if (reset)
this.reset();
this.imagePath = (imagePath.charAt(0) === '/') ? imagePath.substring(1, imagePath.length) : imagePath;
return this;
}
/**
* Resize the image to the specified dimensions. Overrides any previous call
* to `fitIn` or `resize`.
*
* Use a value of 0 for proportional resizing. E.g. for a 640 x 480 image,
* `.resize(320, 0)` yields a 320 x 240 thumbnail.
*
* Use a value of 'orig' to use an original image dimension. E.g. for a 640
* x 480 image, `.resize(320, 'orig')` yields a 320 x 480 thumbnail.
* @param {String} width
* @param {String} height
*/
resize(width, height)
{
this.width = width || '';
this.height = height || '';
return this;
}
/**
* turn on smart-crop
*/
smartcrop(smartCrop)
{
this.smart = smartCrop;
return this;
}
/**
* Resize the image to fit in a box of the specified dimensions. Overrides
* any previous call to `fitIn` or `resize`.
*
* @param {String} width
* @param {String} height
*/
fitin(width, height)
{
this.fitInFlag = true;
return this.resize(width, height);
}
/**
* Flip image horizontally
*/
hflip()
{
this.withFlipHorizontally = true;
return this;
}
/**
* Flip image vertically
*/
vflip()
{
this.withFlipVertically = true;
return this;
}
/**
* Specify horizontal alignment used if width is altered due to cropping
*
* @param {String} halign 'left', 'center', 'right'
*/
halign(halign)
{
if (
halign !== consts.LEFT &&
halign !== consts.RIGHT &&
halign !== consts.CENTER
) throw new Error(`Horizontal align must be ${consts.LEFT}, ${consts.RIGHT} or ${consts.CENTER}.`);
this.halignValue = halign;
return this;
}
/**
* Specify vertical alignment used if height is altered due to cropping
*
* @param {String} valign 'top', 'middle', 'bottom'
*/
valign(valign)
{
if (
valign !== consts.TOP &&
valign !== consts.BOTTOM &&
valign !== consts.MIDDLE
) throw new Error(`Vertical align must be ${consts.TOP}, ${consts.BOTTOM} or ${consts.MIDDLE}.`);
this.valignValue = valign;
return this;
}
/**
* Specify that JSON metadata should be returned instead of the thumbnailed image.
*
* @param {Boolean} metaData
*/
metadata(metaData)
{
this.meta = !!metaData;
return this;
}
/**
* Append a filter, e.g. quality(80)
* @param {String} filterCall
*/
filter(filterCall)
{
if (this.filtersCalls.indexOf(filterCall) == -1)
this.filtersCalls.push(filterCall);
return this;
}
/**
* Manually specify crop window.
*
* @param {Integer} left
* @param {Integer} top
* @param {Integer} right
* @param {Integer} bottom
* @return {[type]}
*/
crop(left, top, right, bottom)
{
this.cropValues = {
left : left,
top : top,
right : right,
bottom : bottom
};
return this;
}
/**
* generate and return the "operation path" based on the "operation" settings currently defined in this ThumborJS instance
*
* N.B. this function is primarily for testing purposes - it allows for taking the "operation path" and
* performing the encryption with Thumbor's own python module ... thereby allowing for verfication of
* the generated security hash
*
* @return {String}
* @throws {Error} - thrown if an "image path" is not currently set
*/
getpath()
{
return getOperationPath.call(this);
}
/**
* generate and return the encryption hash part of a thumbor URL,
* based on the "operation" settings currently defined in this ThumborJS instance,
* or the explicit `operation` string (if given)
*
* @param {String} operation - optional, will auto-generate it if not supplied
* @return {String}
*/
gethash(operation)
{
if (!this.seckeyProp)
return 'unsafe'; // no security key set
return crypto.createHmac('sha1', getSeckey(this.seckeyProp))
.update(operation || this.getpath())
.digest('base64')
.replace(/\+/g, '-')
.replace(/\//g, '_')
;
}
/**
* generate a thumbor image url
*
* @param {Boolean} skip_reset - optional, pass TRUE to skip resetting of objects internal state (after generation of "operation path")
* @param {Boolean} skip_serverurl - optional, pass TRUE to skip prefixing of generated URL with "server url"
* @return {String}
* @throws {Error} - thrown if an "image path" is not currently set
*/
genurl(skip_reset, skip_serverurl)
{
const operation = getOperationPath.call(this, !skip_reset);
return (skip_serverurl ? '' : this.serverUrl) + '/' + this.gethash(operation) + '/' + operation;
}
};
// expose "class constants"
Object.keys(consts).forEach(k => Object.defineProperty(ThumborJS, k, {
configurable : false,
writable : false,
value : consts[k],
}));
// export class
module.exports = ThumborJS;