@strapi/admin 4.1.9 → 4.1.10-beta.0

package/server/controllers/admin.js

@@ -8,6 +8,11 @@ const { ValidationError } = require('@strapi/utils').errors;
 // eslint-disable-next-line node/no-extraneous-require
 const ee = require('@strapi/strapi/lib/utils/ee');
 
+const {
+  validateUpdateProjectSettings,
+  validateUpdateProjectSettingsFiles,
+  validateUpdateProjectSettingsImagesDimensions,
+} = require('../validation/project-settings');
 const { getService } = require('../utils');
 
 const PLUGIN_NAME_REGEX = /^[A-Za-z][A-Za-z0-9-_]+$/;
@@ -39,6 +44,7 @@ module.exports = {
   async init() {
     let uuid = strapi.config.get('uuid', false);
     const hasAdmin = await getService('user').exists();
+    const { menuLogo } = await getService('project-settings').getProjectSettings();
     // set to null if telemetryDisabled flag not avaialble in package.json
     const telemetryDisabled = strapi.config.get('packageJsonStrapi.telemetryDisabled', null);
 
@@ -46,7 +52,33 @@ module.exports = {
       uuid = false;
     }
 
-    return { data: { uuid, hasAdmin } };
+    return {
+      data: {
+        uuid,
+        hasAdmin,
+        menuLogo: menuLogo ? menuLogo.url : null,
+      },
+    };
+  },
+
+  async getProjectSettings() {
+    return getService('project-settings').getProjectSettings();
+  },
+
+  async updateProjectSettings(ctx) {
+    const projectSettingsService = getService('project-settings');
+
+    const {
+      request: { files, body },
+    } = ctx;
+
+    await validateUpdateProjectSettings(body);
+    await validateUpdateProjectSettingsFiles(files);
+
+    const formatedFiles = await projectSettingsService.parseFilesData(files);
+    await validateUpdateProjectSettingsImagesDimensions(formatedFiles);
+
+    return projectSettingsService.updateProjectSettings({ ...body, ...formatedFiles });
   },
 
   async information() {

package/server/routes/admin.js

@@ -7,6 +7,34 @@ module.exports = [
     handler: 'admin.init',
     config: { auth: false },
   },
+  {
+    method: 'GET',
+    path: '/project-settings',
+    handler: 'admin.getProjectSettings',
+    config: {
+      policies: [
+        'admin::isAuthenticatedAdmin',
+        {
+          name: 'admin::hasPermissions',
+          config: { actions: ['admin::project-settings.read'] },
+        },
+      ],
+    },
+  },
+  {
+    method: 'POST',
+    path: '/project-settings',
+    handler: 'admin.updateProjectSettings',
+    config: {
+      policies: [
+        'admin::isAuthenticatedAdmin',
+        {
+          name: 'admin::hasPermissions',
+          config: { actions: ['admin::project-settings.update'] },
+        },
+      ],
+    },
+  },
   {
     method: 'GET',
     path: '/project-type',

package/server/services/index.js

@@ -13,4 +13,5 @@ module.exports = {
   auth: require('./auth'),
   action: require('./action'),
   'api-token': require('./api-token'),
+  'project-settings': require('./project-settings'),
 };

package/server/services/project-settings.js

@@ -0,0 +1,173 @@
+'use strict';
+
+const fs = require('fs');
+const { pick } = require('lodash');
+
+const PROJECT_SETTINGS_FILE_INPUTS = ['menuLogo'];
+const DEFAULT_PROJECT_SETTINGS = {
+  menuLogo: null,
+};
+
+const parseFilesData = async files => {
+  const formatedFilesData = {};
+
+  await Promise.all(
+    PROJECT_SETTINGS_FILE_INPUTS.map(async inputName => {
+      const file = files[inputName];
+
+      // Skip empty file inputs
+      if (!file) {
+        return;
+      }
+
+      const getStream = () => fs.createReadStream(file.path);
+
+      // Add formated data for the upload provider
+      formatedFilesData[inputName] = strapi
+        .plugin('upload')
+        .service('upload')
+        .formatFileInfo({
+          filename: file.name,
+          type: file.type,
+          size: file.size,
+        });
+
+      // Add image dimensions
+      Object.assign(
+        formatedFilesData[inputName],
+        await strapi
+          .plugin('upload')
+          .service('image-manipulation')
+          .getDimensions({ getStream })
+      );
+
+      // Add file path, and stream
+      Object.assign(formatedFilesData[inputName], {
+        stream: getStream(),
+        tmpPath: file.path,
+        provider: strapi.config.get('plugin.upload').provider,
+      });
+    })
+  );
+
+  return formatedFilesData;
+};
+
+const getProjectSettings = async () => {
+  const store = strapi.store({ type: 'core', name: 'admin' });
+  const projectSettings = {
+    ...DEFAULT_PROJECT_SETTINGS,
+    ...(await store.get({ key: 'project-settings' })),
+  };
+
+  // Filter file input fields
+  PROJECT_SETTINGS_FILE_INPUTS.forEach(inputName => {
+    if (!projectSettings[inputName]) {
+      return;
+    }
+
+    projectSettings[inputName] = pick(projectSettings[inputName], [
+      'name',
+      'url',
+      'width',
+      'height',
+      'ext',
+      'size',
+    ]);
+  });
+
+  return projectSettings;
+};
+
+const uploadFiles = async (files = {}) => {
+  // Call the provider upload function for each file
+  return Promise.all(
+    Object.values(files)
+      .filter(file => file.stream instanceof fs.ReadStream)
+      .map(file => strapi.plugin('upload').provider.uploadStream(file))
+  );
+};
+
+const deleteOldFiles = async ({ previousSettings, newSettings }) => {
+  return Promise.all(
+    PROJECT_SETTINGS_FILE_INPUTS.map(async inputName => {
+      // Skip if the store doesn't contain project settings
+      if (!previousSettings) {
+        return;
+      }
+
+      // Skip if there was no previous file
+      if (!previousSettings[inputName]) {
+        return;
+      }
+
+      // Skip if the file was not changed
+      if (
+        newSettings[inputName] &&
+        previousSettings[inputName].hash === newSettings[inputName].hash
+      ) {
+        return;
+      }
+
+      // Skip if the file was not uploaded with the current provider
+      if (strapi.config.get('plugin.upload').provider !== previousSettings[inputName].provider) {
+        return;
+      }
+
+      // There was a previous file and an new file was uploaded
+      // Remove the previous file
+      strapi.plugin('upload').provider.delete(previousSettings[inputName]);
+    })
+  );
+};
+
+const updateProjectSettings = async newSettings => {
+  const store = strapi.store({ type: 'core', name: 'admin' });
+  const previousSettings = await store.get({ key: 'project-settings' });
+  const files = pick(newSettings, PROJECT_SETTINGS_FILE_INPUTS);
+
+  await uploadFiles(files);
+
+  PROJECT_SETTINGS_FILE_INPUTS.forEach(inputName => {
+    // If the user input exists but is not a formdata "file" remove it
+    if (newSettings[inputName] !== undefined && !(typeof newSettings[inputName] === 'object')) {
+      newSettings[inputName] = null;
+      return;
+    }
+
+    // If the user input is undefined reuse previous setting (do not update field)
+    if (!newSettings[inputName]) {
+      newSettings[inputName] = previousSettings[inputName];
+      return;
+    }
+
+    // Update the file
+    newSettings[inputName] = pick(newSettings[inputName], [
+      'name',
+      'hash',
+      'url',
+      'width',
+      'height',
+      'ext',
+      'size',
+      'provider',
+    ]);
+  });
+
+  // No await to proceed asynchronously
+  deleteOldFiles({ previousSettings, newSettings });
+
+  await store.set({
+    key: 'project-settings',
+    value: { ...previousSettings, ...newSettings },
+  });
+
+  return getProjectSettings();
+};
+
+module.exports = {
+  deleteOldFiles,
+  parseFilesData,
+  getProjectSettings,
+  updateProjectSettings,
+};

package/server/utils/index.d.ts

@@ -6,6 +6,7 @@ import * as metrics from '../services/metrics';
 import * as token from '../services/token';
 import * as auth from '../services/auth';
 import * as apiToken from '../services/api-token';
+import * as projectSettings from '../services/project-settings';
 
 type S = {
   role: typeof role;
@@ -16,6 +17,7 @@ type S = {
   auth: typeof auth;
   metrics: typeof metrics;
   'api-token': typeof apiToken;
+  'project-settings': typeof projectSettings;
 };
 
 export function getService<T extends keyof S>(name: T): S[T];

package/server/validation/project-settings.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const { yup, validateYupSchemaSync } = require('@strapi/utils');
+
+const MAX_IMAGE_WIDTH = 750;
+const MAX_IMAGE_HEIGHT = MAX_IMAGE_WIDTH;
+const MAX_IMAGE_FILE_SIZE = 1024 * 1024; // 1Mo
+const ALLOWED_IMAGE_FILE_TYPES = ['image/jpeg', 'image/png', 'image/svg+xml'];
+
+const updateProjectSettings = yup
+  .object({
+    menuLogo: yup.string(),
+  })
+  .noUnknown();
+
+const updateProjectSettingsFiles = yup
+  .object({
+    menuLogo: yup.object({
+      name: yup.string(),
+      type: yup.string().oneOf(ALLOWED_IMAGE_FILE_TYPES),
+      size: yup.number().max(MAX_IMAGE_FILE_SIZE),
+    }),
+  })
+  .noUnknown();
+
+const updateProjectSettingsImagesDimensions = yup.object({
+  menuLogo: yup.object({
+    width: yup.number().max(MAX_IMAGE_WIDTH),
+    height: yup.number().max(MAX_IMAGE_HEIGHT),
+  }),
+});
+
+module.exports = {
+  validateUpdateProjectSettings: validateYupSchemaSync(updateProjectSettings),
+  validateUpdateProjectSettingsFiles: validateYupSchemaSync(updateProjectSettingsFiles),
+  validateUpdateProjectSettingsImagesDimensions: validateYupSchemaSync(
+    updateProjectSettingsImagesDimensions
+  ),
+};