strapi/packages/strapi-plugin-settings-manager/services/SettingsManager.js

'use strict';

const fs = require('fs');
const path = require('path');

module.exports = {
  menu: {
    sections: [
      {
        name: 'menu.section.global-settings',
        items: [
            {
            slug: 'general',
            name: 'menu.item.general',
            icon: 'globe'
          },
          {
            slug: 'languages',
            name: 'menu.item.languages',
            icon: 'language'
          },
          {
            slug: 'advanced',
            name: 'menu.item.advanced',
            icon: 'cogs'
          }
        ]
      },
      {
        name: 'menu.section.environments',
        items: [
          {
            slug: 'databases',
            name: 'menu.item.databases',
            icon: 'database'
          },
          {
            slug: 'security',
            name: 'menu.item.security',
            icon: 'shield'
          },
          {
            slug: 'server',
            name: 'menu.item.server',
            icon: 'server'
          }
        ]
      }
    ]
  },

  general: () => ({
    name: 'form.general.name',
    description: 'form.general.description',
    sections: [
      {
        name: '',
        items: [
          {
            name: 'form.general.item.name',
            target: 'package.name',
            type: 'string',
            value: _.get(strapi.config, 'name', null),
            validations : {
              maxLength: 255,
              required: true
            }
          },
          {
            name: 'form.general.item.description',
            target: 'package.description',
            type: 'string',
            value: _.get(strapi.config, 'description', null),
            validations : {
              maxLength: 255,
              required: true
            }
          },
          {
            name: 'form.general.item.version',
            target: 'package.version',
            type: 'string',
            value: _.get(strapi.config, 'version', null),
            validations : {
              regex: '^(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)$',
              required: true
            }
          }
        ]
      }
    ]
  }),

  advanced: () => ({
    name: 'form.advanced.name',
    description: 'form.advanced.description',
    sections: [
      {
        name: '',
        items: [
          {
            name: 'form.advanced.item.admin',
            target: 'general.admin',
            type: 'string',
            value: _.get(strapi.config, 'general.admin', null),
            validations : {
              maxLength: 255,
              required: true
            }
          },
          {
            name: 'form.advanced.item.prefix',
            target: 'general.prefix',
            type: 'string',
            value: _.get(strapi.config, 'general.prefix', null),
            validations : {
              maxLength: 255
            }
          }
        ]
      }
    ]
  }),

  security: env => ({
    name: 'form.security.name',
    description: 'form.security.description',
    sections: [
      {
        name: 'form.security.item.session',
        items: [
          {
            name: 'form.security.item.session.key',
            target: 'security.session.key',
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.security.session.key`, null),
            validations: {
              required: true
            }
          },
          {
            name: 'form.security.item.session.maxAge',
            target: 'security.session.maxAge',
            type: 'number',
            value: _.get(strapi.config, `environments.${env}.security.session.maxAge`, null),
            validations: {
              required: true
            }
          }
        ]
      },
      {
        name: '',
        items: [
          {
            name: 'form.security.item.xframe',
            target: 'security.xframe',
            type: 'enum',
            value: _.get(strapi.config, `environments.${env}.security.xframe`, null),
            items: [
              {
                name: 'form.security.item.xframe.deny',
                value: 'DENY',
              },
              {
                name: 'form.security.item.xframe.sameorigin',
                value: 'SAMEORIGIN',
              },
              {
                name: 'form.security.item.xframe.allow-from',
                value: 'ALLOW-FROM',
                items: [{
                  name: '',
                  type: 'string',
                  value: '',
                  validations: {
                    required: true
                  }
                }]
              }
            ],
            validations: {
              required: true
            }
          },
          {
            name: 'form.security.item.xssProtection',
            target: 'security.xssProtection',
            type: 'boolean',
            value: _.get(strapi.config, `environments.${env}.security.xssProtection`, null),
            validations: {
              required: true
            }
          }
        ]
      },
      {
        name: 'form.security.item.cors',
        items: [
          {
            name: 'form.security.item.cors.origin',
            target: 'security.cors.origin',
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.security.cors.origin`, null),
            validations: {
              required: true
            }
          }
        ]
      }
    ]
  }),

  server: env => ({
    name: 'form.server.name',
    description: 'form.server.description',
    sections: [
      {
        name: '',
        items: [
          {
            name: 'form.server.item.host',
            target: 'server.host',
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.server.host`, null),
            validations: {}
          },
          {
            name: 'form.server.item.port',
            target: 'server.port',
            type: 'number',
            value: _.get(strapi.config, `environments.${env}.server.port`, null),
            validations: {}
          }
        ]
      }
    ]
  }),

  i18n: env => ({
    name: 'form.i18n.name',
    description: 'form.i18n.description',
    sections: [
      {
        name: '',
        items: [
          {
            name: 'form.i18n.choose',
            target: 'i18n.i18n.defaultLocale',
            type: 'select',
            items: strapi.plugins['settings-manager'].services.languages
          }
        ]
      }
    ]
  }),

  database: (name, env) => ({
    name: 'form.databases.name',
    description: 'form.databases.description',
    sections: [
      {
        name: '',
        items: [
          {
            name: 'form.databases.item.name',
            target: `databases.connections.${name}.name`,
            type: 'string',
            value: name,
            validations: {
              required: true
            }
          },
          {
            name: 'form.databases.item.provider',
            target: `databases.connections.${name}.connector`,
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.databases.connections.${name}.connector`, null),
            validations: {
              required: true
            }
          },
          {
            name: 'form.databases.item.host',
            target: `databases.connections.${name}.settings.host`,
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.databases.connections.${name}.settings.host`, null),
            validations: {
              required: true
            }
          },
          {
            name: 'form.databases.item.username',
            target: `databases.connections.${name}.settings.username`,
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.databases.connections.${name}.settings.username`, null),
            validations: {
              required: true
            }
          },
          {
            name: 'form.databases.item.password',
            target: `databases.connections.${name}.settings.password`,
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.databases.connections.${name}.settings.password`, null),
            validations: {}
          },
          {
            name: 'form.databases.item.database',
            target: `databases.connections.${name}.settings.database`,
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.databases.connections.${name}.settings.database`, null),
            validations: {
              required: true
            }
          }
        ]
      },
      {
        name: '',
        items: [
          {
            name: 'form.databases.item.default',
            target: `databases.defaultConnection`,
            type: 'string',
            value: _.get(strapi.config, `environments.${env}.databases.defaultConnection`, null),
            validations: {
              required: true
            }
          }
        ]
      }
    ]
  }),

  getEnvironments: () => {
    return _.map(_.keys(strapi.config.environments), environment => {
      return {
        name: environment,
        active: (strapi.config.environment === environment)
      }
    });
  },

  getLanguages: () => {
    return _.map(strapi.config.i18n.locales, language => {
      return {
        name: language,
        active: (strapi.config.i18n.defaultLocale === language)
      }
    });
  },

  getDatabases: env => {
    const databases = [];

    _.forEach(strapi.config.environments[env].databases.connections, (connection, name) => {
      databases.push({
        provider: connection.connector,
        name,
        host: connection.settings.host,
        database: connection.settings.database,
        active: (strapi.config.environments[env].databases.defaultConnection = name)
      });
    });

    return databases;
  },

  getItems: model => _.flatten(_.map(model.sections, section => section.items)),

  cleanParams: (params, items) => {
    const cleanParams = {};

    _.forEach(items, ({ target }) => _.has(params, target) ? _.set(cleanParams, target, _.get(params, target)) : '');

    return cleanParams;
  },

  formatErrors: errors => _.map(_.groupBy(errors, 'target'), (errs, target) => {
    return {
      target,
      messages: _.map(errs, err => {
        return {
          id: err.message,
          params: _.get(err, 'params', undefined)
        };
      })
    };
  }),

  paramsValidation: (params, items) => {
    let errors = [];

    const reformat = (value, format) => {
      if (format === 'number') try { return parseFloat(number) } catch (e) { return null };
      if (format === 'boolean') return value === 'true';

      return value;
    };

    const checkType = (input, { type, target, items }) => {
      if ((type === 'string' || type === 'text') && !_.isString(input)) return errors.push({
        target: target,
        message: 'request.error.type.string'
      });

      if (type === 'number' && !_.isNumber(input)) return errors.push({
        target: target,
        message: 'request.error.type.number'
      });

      if (type === 'boolean' && !_.isBoolean(input)) return errors.push({
        target: target,
        message: 'request.error.type.boolean'
      });

      if (type === 'select' && !_.find(items, { value: input })) return errors.push({
        target: target,
        message: 'request.error.type.select'
      });

      if (type === 'enum') {
        if (!_.find(items, { value: input })) {
          const key = input.split('.')[0];
          input = _.drop(input.split('.')).join('.');

          const item = _.find(items, { value: key });

          if (!item) return errors.push({
            target: target,
            message: 'request.error.type.enum'
          });

          input = reformat(input, item.type);
          params[target] = input;

          _.forEach(item.items, subItem => {
            subItem.target = target;
            if (_.has(params, subItem.target)) {
              const input = _.get(params, subItem.target, null);

              checkType(input, subItem);
              checkValidations(input, subItem);
            }
          });
        }
      }
    };

    const checkValidations = (input, item) => {
      _.forEach(item.validations, (value, key) => {
        if (key === 'required' && (_.isNull(input) || (_.isString(input) && _.isEmpty(input)) || _.isUndefined(input))) errors.push({
          target: item.target,
          message: 'request.error.validation.required'
        });

        if (key === 'regex' && !new RegExp(value).test(input)) errors.push({
          target: item.target,
          message: 'request.error.validation.regex'
        });

        if (key === 'max' && parseInt(input) > value) errors.push({
          target: item.target,
          message: 'request.error.validation.max'
        });

        if (key === 'min' && parseInt(input) < value) errors.push({
          target: item.target,
          message: 'request.error.validation.min'
        });

        if (key === 'maxLength' && input.length > value) errors.push({
          target: item.target,
          message: 'request.error.validation.maxLength'
        });

        if (key === 'minLength' && input.length  < value) errors.push({
          target: item.target,
          message: 'request.error.validation.minLength'
        });
      });
    };

    _.forEach(items, item => {
      if (_.has(params, item.target)) {
        const input = _.get(params, item.target, null);

        checkType(input, item);
        checkValidations(input, item);
      }
    });

    return [params, errors];
  },

  updateSettings: (params, items, env = '') => {
    const appPath = strapi.config.appPath;
    const errors = [];

    _.forEach(items, ({ target }) => {
      if (_.has(params, target)) {
        const input = _.get(params, target, null);
        const [file, ...objPath] = target.split('.');

        const filePath = (file === 'package') ? path.join(appPath, 'package.json') : path.join(appPath, 'config', `${env ? `environments/${env}` : ''}`, `${_.replace(file, '.', '/')}.json`);

        try {
          const fileContent = require(filePath);

          _.set(fileContent, objPath, input);

          fs.writeFileSync(filePath, JSON.stringify(fileContent, null, 2), 'utf8');
        } catch (e) {
          errors.push({
            target,
            message: 'request.error.config',
            params: {
              filePath: filePath
            }
          });
        }
      }
    });

    return errors;
  }
};