var schema = require('../schema').tables, _ = require('lodash'), validator = require('validator'), assert = require('assert'), Promise = require('bluebird'), errors = require('../../errors'), config = require('../../config'), readThemes = require('../../utils/read-themes'), i18n = require('../../i18n'), validateSchema, validateSettings, validateActiveTheme, validate, availableThemes; function assertString(input) { assert(typeof input === 'string', 'Validator js validates strings only'); } // extends has been removed in validator >= 5.0.0, need to monkey-patch it back in validator.extend = function (name, fn) { validator[name] = function () { var args = Array.prototype.slice.call(arguments); assertString(args[0]); return fn.apply(validator, args); }; }; // Provide a few custom validators validator.extend('empty', function empty(str) { return _.isEmpty(str); }); validator.extend('notContains', function notContains(str, badString) { return !_.includes(str, badString); }); validator.extend('isEmptyOrURL', function isEmptyOrURL(str) { return (_.isEmpty(str) || validator.isURL(str, {require_protocol: false})); }); validator.extend('isSlug', function isSlug(str) { return validator.matches(str, /^[a-z0-9\-_]+$/); }); // Validation against schema attributes // values are checked against the validation objects from schema.js validateSchema = function validateSchema(tableName, model) { var columns = _.keys(schema[tableName]), validationErrors = []; _.each(columns, function each(columnKey) { var message = '', strVal = _.toString(model[columnKey]); // check nullable if (model.hasOwnProperty(columnKey) && schema[tableName][columnKey].hasOwnProperty('nullable') && schema[tableName][columnKey].nullable !== true) { if (validator.empty(strVal)) { message = i18n.t('notices.data.validation.index.valueCannotBeBlank', {tableName: tableName, columnKey: columnKey}); validationErrors.push(new errors.ValidationError(message, tableName + '.' + columnKey)); } } // validate boolean columns if (model.hasOwnProperty(columnKey) && schema[tableName][columnKey].hasOwnProperty('type') && schema[tableName][columnKey].type === 'bool') { if (!(validator.isBoolean(strVal) || validator.empty(strVal))) { message = i18n.t('notices.data.validation.index.valueMustBeBoolean', {tableName: tableName, columnKey: columnKey}); validationErrors.push(new errors.ValidationError(message, tableName + '.' + columnKey)); } } // TODO: check if mandatory values should be enforced if (model[columnKey] !== null && model[columnKey] !== undefined) { // check length if (schema[tableName][columnKey].hasOwnProperty('maxlength')) { if (!validator.isLength(strVal, 0, schema[tableName][columnKey].maxlength)) { message = i18n.t('notices.data.validation.index.valueExceedsMaxLength', {tableName: tableName, columnKey: columnKey, maxlength: schema[tableName][columnKey].maxlength}); validationErrors.push(new errors.ValidationError(message, tableName + '.' + columnKey)); } } // check validations objects if (schema[tableName][columnKey].hasOwnProperty('validations')) { validationErrors = validationErrors.concat(validate(strVal, columnKey, schema[tableName][columnKey].validations)); } // check type if (schema[tableName][columnKey].hasOwnProperty('type')) { if (schema[tableName][columnKey].type === 'integer' && !validator.isInt(strVal)) { message = i18n.t('notices.data.validation.index.valueIsNotInteger', {tableName: tableName, columnKey: columnKey}); validationErrors.push(new errors.ValidationError(message, tableName + '.' + columnKey)); } } } }); if (validationErrors.length !== 0) { return Promise.reject(validationErrors); } return Promise.resolve(); }; // Validation for settings // settings are checked against the validation objects // form default-settings.json validateSettings = function validateSettings(defaultSettings, model) { var values = model.toJSON(), validationErrors = [], matchingDefault = defaultSettings[values.key]; if (matchingDefault && matchingDefault.validations) { validationErrors = validationErrors.concat(validate(values.value, values.key, matchingDefault.validations)); } if (validationErrors.length !== 0) { return Promise.reject(validationErrors); } return Promise.resolve(); }; validateActiveTheme = function validateActiveTheme(themeName) { // If Ghost is running and its availableThemes collection exists // give it priority. if (config.paths.availableThemes && Object.keys(config.paths.availableThemes).length > 0) { availableThemes = Promise.resolve(config.paths.availableThemes); } if (!availableThemes) { // A Promise that will resolve to an object with a property for each installed theme. // This is necessary because certain configuration data is only available while Ghost // is running and at times the validations are used when it's not (e.g. tests) availableThemes = readThemes(config.paths.themePath); } return availableThemes.then(function then(themes) { if (!themes.hasOwnProperty(themeName)) { return Promise.reject(new errors.ValidationError(i18n.t('notices.data.validation.index.themeCannotBeActivated', {themeName: themeName}), 'activeTheme')); } }); }; // 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 validate(value, key, validations) { var validationErrors = []; value = _.toString(value); _.each(validations, function each(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) { validationErrors.push(new errors.ValidationError(i18n.t('notices.data.validation.index.validationFailed', {validationName: validationName, key: key}))); } validationOptions.shift(); }, this); return validationErrors; }; module.exports = { validate: validate, validator: validator, validateSchema: validateSchema, validateSettings: validateSettings, validateActiveTheme: validateActiveTheme };