mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-01-13 22:41:32 -05:00
e4bb6d08cc
Closes #1379 - Convert to new api usage for both server-side and client-side - Provide way require a negative response for boolean methods in default-settings.json - Add field validation functional tests - Settings (General) - Title length validation - Description length validation - postsPerPage, numeric, min, max - Settings (User) - Bio Length validation - Location length validation - Url validation - Login - Email validation - Editor - Title required validation
112 lines
4 KiB
JavaScript
112 lines
4 KiB
JavaScript
var schema = require('../schema').tables,
|
||
_ = require('lodash'),
|
||
validator = require('validator'),
|
||
|
||
validateSchema,
|
||
validateSettings,
|
||
validate;
|
||
|
||
// Provide a few custom validators
|
||
//
|
||
validator.extend('empty', function (str) {
|
||
return _.isEmpty(str);
|
||
});
|
||
|
||
validator.extend('notContains', function (str, badString) {
|
||
return !_.contains(str, badString);
|
||
});
|
||
|
||
// Validation validation against schema attributes
|
||
// values are checked against the validation objects
|
||
// form schema.js
|
||
validateSchema = function (tableName, model) {
|
||
var columns = _.keys(schema[tableName]);
|
||
|
||
_.each(columns, function (columnKey) {
|
||
// check nullable
|
||
if (model.hasOwnProperty(columnKey) && schema[tableName][columnKey].hasOwnProperty('nullable')
|
||
&& schema[tableName][columnKey].nullable !== true) {
|
||
if (validator.isNull(model[columnKey]) || validator.empty(model[columnKey])) {
|
||
throw new Error('Value in [' + tableName + '.' + columnKey + '] cannot be blank.');
|
||
}
|
||
}
|
||
// TODO: check if mandatory values should be enforced
|
||
if (model[columnKey]) {
|
||
// check length
|
||
if (schema[tableName][columnKey].hasOwnProperty('maxlength')) {
|
||
if (!validator.isLength(model[columnKey], 0, schema[tableName][columnKey].maxlength)) {
|
||
throw new Error('Value in [' + tableName + '.' + columnKey +
|
||
'] exceeds maximum length of ' + schema[tableName][columnKey].maxlength + ' characters.');
|
||
}
|
||
}
|
||
|
||
//check validations objects
|
||
if (schema[tableName][columnKey].hasOwnProperty('validations')) {
|
||
validate(model[columnKey], columnKey, schema[tableName][columnKey].validations);
|
||
}
|
||
|
||
//check type
|
||
if (schema[tableName][columnKey].hasOwnProperty('type')) {
|
||
if (schema[tableName][columnKey].type === 'integer' && !validator.isInt(model[columnKey])) {
|
||
throw new Error('Value in [' + tableName + '.' + columnKey + '] is no valid integer.');
|
||
}
|
||
}
|
||
}
|
||
});
|
||
};
|
||
|
||
// Validation for settings
|
||
// settings are checked against the validation objects
|
||
// form default-settings.json
|
||
validateSettings = function (defaultSettings, model) {
|
||
var values = model.toJSON(),
|
||
matchingDefault = defaultSettings[values.key];
|
||
|
||
if (matchingDefault && matchingDefault.validations) {
|
||
validate(values.value, values.key, matchingDefault.validations);
|
||
}
|
||
};
|
||
|
||
// Validate default settings using the validator module.
|
||
// Each validation's key is a method name and its value is an array of options
|
||
//
|
||
// eg:
|
||
// validations: { isUrl: true, isLength: [20, 40] }
|
||
//
|
||
// will validate that a setting's length is a URL between 20 and 40 chars.
|
||
//
|
||
// If you pass a boolean as the value, it will specify the "good" result. By default
|
||
// the "good" result is assumed to be true.
|
||
//
|
||
// eg:
|
||
// validations: { isNull: false } // means the "good" result would
|
||
// // fail the `isNull` check, so
|
||
// // not null.
|
||
//
|
||
// available validators: https://github.com/chriso/validator.js#validators
|
||
validate = function (value, key, validations) {
|
||
_.each(validations, function (validationOptions, validationName) {
|
||
var goodResult = true;
|
||
|
||
if (_.isBoolean(validationOptions)) {
|
||
goodResult = validationOptions;
|
||
validationOptions = [];
|
||
} else if (!_.isArray(validationOptions)) {
|
||
validationOptions = [validationOptions];
|
||
}
|
||
|
||
validationOptions.unshift(value);
|
||
|
||
// equivalent of validator.isSomething(option1, option2)
|
||
if (validator[validationName].apply(validator, validationOptions) !== goodResult) {
|
||
throw new Error('Settings validation (' + validationName + ') failed for ' + key);
|
||
}
|
||
|
||
validationOptions.shift();
|
||
}, this);
|
||
};
|
||
|
||
module.exports = {
|
||
validateSchema: validateSchema,
|
||
validateSettings: validateSettings
|
||
};
|