Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00
Code Issues Activity

Burn dirty require of api utils

Browse source 
refs #9178

- `checkFileExists` and `checkFileIsValid` where dirty required from web/middleware
- these two functions are only used in the target middleware
- let's move them
This commit is contained in:
kirrg001 2017-12-14 21:25:51 +01:00
parent 849e97640f
commit 82597080be
5 changed files with 63 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
core/server/api/utils.js
View file

@ -2,7 +2,6 @@
// Shared helpers for working with the API
var Promise = require('bluebird'),
_ = require('lodash'),
path = require('path'),
permissions = require('../services/permissions'),
validation = require('../data/validation'),
common = require('../lib/common'),
@ -322,18 +321,6 @@ utils = {
}
return Promise.resolve(object);
},
checkFileExists: function checkFileExists(fileData) {
return !!(fileData.mimetype && fileData.path);
},
checkFileIsValid: function checkFileIsValid(fileData, types, extensions) {
var type = fileData.mimetype,
ext = path.extname(fileData.name).toLowerCase();
if (_.includes(types, type) && _.includes(extensions, ext)) {
return true;
}
return false;
}
};

12
core/server/web/middleware/validation/upload.js
View file

@ -1,6 +1,8 @@
var apiUtils = require('../../../api/utils'),
common = require('../../../lib/common'),
config = require('../../../config');
'use strict';
const common = require('../../../lib/common'),
config = require('../../../config'),
localUtils = require('../../utils');
module.exports = function upload(options) {
var type = options.type;
@ -15,14 +17,14 @@ module.exports = function upload(options) {
req.file.type = req.file.mimetype;
// Check if a file was provided
if (!apiUtils.checkFileExists(req.file)) {
if (!localUtils.checkFileExists(req.file)) {
return next(new common.errors.NoPermissionError({
message: common.i18n.t('errors.api.' + type + '.missingFile')
}));
}
// Check if the file is valid
if (!apiUtils.checkFileIsValid(req.file, contentTypes, extensions)) {
if (!localUtils.checkFileIsValid(req.file, contentTypes, extensions)) {
return next(new common.errors.UnsupportedMediaTypeError({
message: common.i18n.t('errors.api.' + type + '.invalidFile', {extensions: extensions})
}));

19
core/server/web/utils.js
View file

@ -1,6 +1,9 @@
'use strict';
const url = require('url');
const url = require('url'),
path = require('path'),
_ = require('lodash');
let _private = {};
_private.removeDoubleCharacters = function removeDoubleCharacters(character, string) {
@ -30,3 +33,17 @@ module.exports.removeOpenRedirectFromUrl = function removeOpenRedirectFromUrl(ur
(parsedUrl.hash || '')
);
};
module.exports.checkFileExists = function checkFileExists(fileData) {
return !!(fileData.mimetype && fileData.path);
};
module.exports.checkFileIsValid = function checkFileIsValid(fileData, types, extensions) {
var type = fileData.mimetype,
ext = path.extname(fileData.name).toLowerCase();
if (_.includes(types, type) && _.includes(extensions, ext)) {
return true;
}
return false;
};

37
core/test/unit/api/utils_spec.js
View file

@ -32,9 +32,7 @@ describe('API Utils', function () {
'prepareFields',
'prepareFormats',
'convertOptions',
'checkObject',
'checkFileExists',
'checkFileIsValid'
'checkObject'
]);
});
@ -427,39 +425,6 @@ describe('API Utils', function () {
});
});
describe('checkFileExists', function () {
it('should return true if file exists in input', function () {
apiUtils.checkFileExists({mimetype: 'file', path: 'path'}).should.be.true();
});
it('should return false if file does not exist in input', function () {
apiUtils.checkFileExists({}).should.be.false();
});
it('should return false if file is incorrectly structured', function () {
apiUtils.checkFileExists({type: 'file'}).should.be.false();
});
});
describe('checkFileIsValid', function () {
it('returns true if file has valid extension and type', function () {
apiUtils.checkFileIsValid({name: 'test.txt', mimetype: 'text'}, ['text'], ['.txt']).should.be.true();
apiUtils.checkFileIsValid({
name: 'test.jpg',
mimetype: 'jpeg'
}, ['text', 'jpeg'], ['.txt', '.jpg']).should.be.true();
});
it('returns false if file has invalid extension', function () {
apiUtils.checkFileIsValid({name: 'test.txt', mimetype: 'text'}, ['text'], ['.tar']).should.be.false();
apiUtils.checkFileIsValid({name: 'test', mimetype: 'text'}, ['text'], ['.txt']).should.be.false();
});
it('returns false if file has invalid type', function () {
apiUtils.checkFileIsValid({name: 'test.txt', mimetype: 'text'}, ['archive'], ['.txt']).should.be.false();
});
});
describe('isPublicContext', function () {
it('should call out to permissions', function () {
var permsStub = sandbox.stub(permissions, 'parseContext').returns({public: true});

37
core/test/unit/web/utils_spec.js Normal file
View file

@ -0,0 +1,37 @@
var should = require('should'),
webUtils = require('../../../server/web/utils');
describe('web utils', function () {
describe('checkFileExists', function () {
it('should return true if file exists in input', function () {
webUtils.checkFileExists({mimetype: 'file', path: 'path'}).should.be.true();
});
it('should return false if file does not exist in input', function () {
webUtils.checkFileExists({}).should.be.false();
});
it('should return false if file is incorrectly structured', function () {
webUtils.checkFileExists({type: 'file'}).should.be.false();
});
});
describe('checkFileIsValid', function () {
it('returns true if file has valid extension and type', function () {
webUtils.checkFileIsValid({name: 'test.txt', mimetype: 'text'}, ['text'], ['.txt']).should.be.true();
webUtils.checkFileIsValid({
name: 'test.jpg',
mimetype: 'jpeg'
}, ['text', 'jpeg'], ['.txt', '.jpg']).should.be.true();
});
it('returns false if file has invalid extension', function () {
webUtils.checkFileIsValid({name: 'test.txt', mimetype: 'text'}, ['text'], ['.tar']).should.be.false();
webUtils.checkFileIsValid({name: 'test', mimetype: 'text'}, ['text'], ['.txt']).should.be.false();
});
it('returns false if file has invalid type', function () {
webUtils.checkFileIsValid({name: 'test.txt', mimetype: 'text'}, ['archive'], ['.txt']).should.be.false();
});
});
});