@strapi/strapi 4.0.0-beta.0

package/lib/middlewares/helmet/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const helmet = require('koa-helmet');
+
+module.exports = strapi => ({
+  initialize() {
+    strapi.server.use(helmet(strapi.config.middleware.settings.helmet));
+  },
+});

package/lib/middlewares/index.js

@@ -0,0 +1,120 @@
+'use strict';
+
+const { uniq, difference, get, isUndefined, merge } = require('lodash');
+
+const requiredMiddlewares = [
+  'auth',
+  'responses',
+  'router',
+  'logger',
+  'error',
+  'cors',
+  'cron',
+  'xframe',
+  'xss',
+  'public',
+  'favicon',
+];
+
+module.exports = async function(strapi) {
+  /** Utils */
+  const middlewareConfig = strapi.config.middleware;
+
+  // check if a middleware exists
+  const middlewareExists = key => {
+    return !isUndefined(strapi.middleware[key]);
+  };
+
+  // check if a middleware is enabled
+  const middlewareEnabled = key => {
+    return (
+      requiredMiddlewares.includes(key) ||
+      get(middlewareConfig, ['settings', key, 'enabled'], false) === true
+    );
+  };
+
+  // list of enabled middlewares
+  const enabledMiddlewares = Object.keys(strapi.middleware).filter(middlewareEnabled);
+
+  // Method to initialize middlewares and emit an event.
+  const initialize = middlewareKey => {
+    if (strapi.middleware[middlewareKey].loaded === true) return;
+
+    const module = strapi.middleware[middlewareKey].load;
+
+    return new Promise((resolve, reject) => {
+      const timeout = setTimeout(
+        () => reject(`(middleware: ${middlewareKey}) is taking too long to load.`),
+        middlewareConfig.timeout || 1000
+      );
+      strapi.middleware[middlewareKey] = merge(strapi.middleware[middlewareKey], module);
+
+      Promise.resolve()
+        .then(() => module.initialize(strapi))
+        .then(() => {
+          clearTimeout(timeout);
+          strapi.middleware[middlewareKey].loaded = true;
+          resolve();
+        })
+        .catch(err => {
+          clearTimeout(timeout);
+
+          if (err) {
+            return reject(err);
+          }
+        });
+    });
+  };
+
+  /**
+   * Run init functions
+   */
+
+  // Run beforeInitialize of every middleware
+  await Promise.all(
+    enabledMiddlewares.map(key => {
+      const { beforeInitialize } = strapi.middleware[key].load;
+      if (typeof beforeInitialize === 'function') {
+        return beforeInitialize(strapi);
+      }
+    })
+  );
+
+  // run the initialization of an array of middlewares sequentially
+  const initMiddlewaresSeq = async middlewareArr => {
+    for (let key of uniq(middlewareArr)) {
+      await initialize(key);
+    }
+  };
+
+  const middlewaresBefore = get(middlewareConfig, 'load.before', [])
+    .filter(middlewareExists)
+    .filter(middlewareEnabled);
+
+  const middlewaresAfter = get(middlewareConfig, 'load.after', [])
+    .filter(middlewareExists)
+    .filter(middlewareEnabled);
+
+  const middlewaresOrder = get(middlewareConfig, 'load.order', [])
+    .filter(middlewareExists)
+    .filter(middlewareEnabled);
+
+  const unspecifiedMiddlewares = difference(
+    enabledMiddlewares,
+    middlewaresBefore,
+    middlewaresOrder,
+    middlewaresAfter
+  );
+
+  // before
+  await initMiddlewaresSeq(middlewaresBefore);
+
+  // ordered // rest of middlewares
+  await Promise.all([
+    initMiddlewaresSeq(middlewaresOrder),
+    Promise.all(unspecifiedMiddlewares.map(initialize)),
+  ]);
+
+  // after
+  await initMiddlewaresSeq(middlewaresAfter);
+};

package/lib/middlewares/ip/defaults.json

@@ -0,0 +1,7 @@
+{
+  "ip": {
+    "enabled": false,
+    "whiteList": [],
+    "blackList": []
+  }
+}

package/lib/middlewares/ip/index.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const ip = require('koa-ip');
+/**
+ * IP filter hook
+ */
+
+module.exports = strapi => {
+  return {
+    /**
+     * Initialize the hook
+     */
+
+    initialize() {
+      const { whiteList, blackList } = strapi.config.middleware.settings.ip;
+
+      strapi.server.use(
+        ip({
+          whitelist: whiteList,
+          blacklist: blackList,
+        })
+      );
+    },
+  };
+};

package/lib/middlewares/logger/defaults.json

@@ -0,0 +1,5 @@
+{
+  "logger": {
+    "enabled": true
+  }
+}

package/lib/middlewares/logger/index.js

@@ -0,0 +1,37 @@
+'use strict';
+const chalk = require('chalk');
+
+const codeToColor = code => {
+  return code >= 500
+    ? chalk.red(code)
+    : code >= 400
+    ? chalk.yellow(code)
+    : code >= 300
+    ? chalk.cyan(code)
+    : code >= 200
+    ? chalk.green(code)
+    : code;
+};
+
+/**
+ * Logger hook
+ */
+
+module.exports = strapi => {
+  return {
+    /**
+     * Initialize the hook
+     */
+    initialize() {
+      strapi.server.app.context.log = strapi.log;
+
+      strapi.server.use(async (ctx, next) => {
+        const start = Date.now();
+        await next();
+        const delta = Math.ceil(Date.now() - start);
+
+        strapi.log.http(`${ctx.method} ${ctx.url} (${delta} ms) ${codeToColor(ctx.status)}`);
+      });
+    },
+  };
+};

package/lib/middlewares/parser/defaults.json

@@ -0,0 +1,11 @@
+{
+  "parser": {
+    "enabled": true,
+    "multipart": true,
+    "queryStringParser": {
+      "strictNullHandling": true,
+      "arrayLimit": 100,
+      "depth": 20
+    }
+  }
+}

package/lib/middlewares/parser/index.js

@@ -0,0 +1,75 @@
+'use strict';
+
+const body = require('koa-body');
+const qs = require('qs');
+const { omit } = require('lodash');
+
+/**
+ * Body parser hook
+ */
+const addQsParser = (app, settings) => {
+  Object.defineProperty(app.request, 'query', {
+    configurable: false,
+    enumerable: true,
+    /*
+     * Get parsed query-string.
+     */
+    get() {
+      const qstr = this.querystring;
+      const cache = (this._querycache = this._querycache || {});
+      return cache[qstr] || (cache[qstr] = qs.parse(qstr, settings));
+    },
+
+    /*
+     * Set query-string as an object.
+     */
+    set(obj) {
+      this.querystring = qs.stringify(obj);
+    },
+  });
+
+  return app;
+};
+
+module.exports = strapi => {
+  return {
+    /**
+     * Initialize the hook
+     */
+    initialize() {
+      strapi.server.use(async (ctx, next) => {
+        // disable for graphql
+        // TODO: find a better way later
+        if (ctx.url === '/graphql') {
+          return next();
+        }
+
+        try {
+          const res = await body({
+            patchKoa: true,
+            ...omit(strapi.config.middleware.settings.parser, 'queryStringParser'),
+          })(ctx, next);
+          return res;
+        } catch (e) {
+          if ((e || {}).message && e.message.includes('maxFileSize exceeded')) {
+            throw strapi.errors.entityTooLarge('FileTooBig', {
+              errors: [
+                {
+                  id: 'Upload.status.sizeLimit',
+                  message: `file is bigger than the limit size!`,
+                },
+              ],
+            });
+          }
+
+          throw e;
+        }
+      });
+
+      addQsParser(
+        strapi.server.app,
+        strapi.config.get('middleware.settings.parser.queryStringParser')
+      );
+    },
+  };
+};

package/lib/middlewares/poweredBy/defaults.json

@@ -0,0 +1,5 @@
+{
+  "poweredBy": {
+    "enabled": true
+  }
+}

package/lib/middlewares/poweredBy/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+module.exports = strapi => {
+  return {
+    initialize() {
+      strapi.server.use(async (ctx, next) => {
+        await next();
+
+        ctx.set(
+          'X-Powered-By',
+          strapi.config.get('middleware.settings.poweredBy.value', 'Strapi <strapi.io>')
+        );
+      });
+    },
+  };
+};

package/lib/middlewares/public/defaults.json

@@ -0,0 +1,8 @@
+{
+  "public": {
+    "enabled": true,
+    "maxAge": 60000,
+    "path": "./public",
+    "defaultIndex": true
+  }
+}

package/lib/middlewares/public/index.html

@@ -0,0 +1,66 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <title>Welcome to your Strapi app</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="robots" content="noindex, nofollow">
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/meyer-reset/2.0/reset.min.css" rel="stylesheet" />
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/all.min.css" rel="stylesheet" />
+    <link href="https://fonts.googleapis.com/css?family=Lato:400,700&display=swap" rel="stylesheet" />
+    <style>
+      *{-webkit-box-sizing:border-box;text-decoration:none}body,html{margin:0;padding:0;font-size:62.5%;-webkit-font-smoothing:antialiased}body{font-size:1.3rem;font-family:Lato,Helvetica,Arial,Verdana,sans-serif;background:#fafafb;margin:0;padding:80px 0;color:#333740;line-height:1.8rem}strong{font-weight:700}.wrapper{width:684px;margin:auto}h1{text-align:center}h2{font-size:1.8rem;font-weight:700;margin-bottom:1px}.logo{height:40px;margin-bottom:74px}.informations{position:relative;overflow:hidden;display:flex;justify-content:space-between;width:100%;height:126px;margin-top:18px;padding:20px 30px;background:#fff;border-radius:2px;box-shadow:0 2px 4px 0 #e3e9f3}.informations:before{position:absolute;top:0;left:0;content:'';display:block;width:100%;height:2px;background:#007eff}.environment{display:inline-block;padding:0 10px;height:20px;margin-bottom:36px;background:#e6f0fb;border:1px solid #aed4fb;border-radius:2px;text-transform:uppercase;color:#007eff;font-size:1.2rem;font-weight:700;line-height:20px;letter-spacing:.05rem}.cta{display:inline-block;height:30px;padding:0 15px;margin-top:32px;border-radius:2px;color:#fff;font-weight:700;line-height:28px}.cta i{position:relative;display:inline-block;height:100%;vertical-align:middle;font-size:1rem;margin-right:20px}.cta i:before{position:absolute;top:8px}.cta-primary{background:#007eff}.cta-secondary{background:#6dbb1a}.text-align-right{text-align:right}.lets-started{position:relative;overflow:hidden;width:100%;height:144px;margin-top:18px;padding:20px 30px;background:#fff;border-radius:2px;box-shadow:0 2px 4px 0 #e3e9f3}.people-saying-hello{position:absolute;right:30px;bottom:-8px;width:113px;height:70px}.visible{opacity:1!important}.people-saying-hello img{position:absolute;max-width:100%;opacity:0;transition:opacity .2s ease-out}@media only screen and (max-width:768px){.wrapper{width:auto!important;margin:0 20px}.informations{flex-direction:column;height:auto}.environment{width:100%;text-align:center;margin-bottom:18px}.text-align-right{margin-top:18px;text-align:center}.cta{width:100%;text-align:center}.lets-started{height:auto}.people-saying-hello{display:none}}
+    </style>
+  </head>
+  <body lang="en">
+    <section class="wrapper">
+      <h1><img class="logo" src="<%= strapi.config.server.url %>/assets/images/logo_login.png" /></h1>
+      <% if (strapi.config.environment === 'development' && isInitialized) { %>
+        <div class="informations">
+          <div>
+            <span class="environment"><%= strapi.config.environment %></span>
+            <p>
+              The server is running successfully (<strong>v<%= strapi.config.info.version %>)</strong>
+            </p>
+          </div>
+          <div class="text-align-right">
+            <p><%= serverTime %></p>
+            <% if (strapi.config.serveAdminPanel) { %>
+            <a class="cta cta-primary" href="<%= strapi.config.admin.url %>" target="_blank" title="Click to open the administration" ><i class="fas fa-external-link-alt"></i>Open the administration</a>
+            <% } %>
+          </div>
+        </div>
+      <% } else if (strapi.config.environment === 'development' && !isInitialized) { %>
+        <div class="lets-started">
+          <h2>Let's get started!</h2>
+          <p>To discover the power provided by Strapi, you need to create an administrator.</p>
+          <a class="cta cta-secondary" href="<%= strapi.config.admin.url %>" target="_blank" title="Click to create the first administration" ><i class="fas fa-external-link-alt"></i>Create the first administrator</a>
+          <div class="people-saying-hello">
+            <img class="visible" src="<%= strapi.config.server.url %>/assets/images/group_people_1.png" alt="People saying hello" />
+            <img src="<%= strapi.config.server.url %>/assets/images/group_people_2.png" alt="People saying hello" />
+            <img src="<%= strapi.config.server.url %>/assets/images/group_people_3.png" alt="People saying hello" />
+          </div>
+        </div>
+      <% } else { %>
+        <div class="informations">
+          <div>
+            <span class="environment"><%= strapi.config.environment %></span>
+            <p>The server is running successfully.</p>
+          </div>
+          <div class="text-align-right">
+            <p><%= serverTime %></p>
+          </div>
+        </div>
+      <% } %>
+    </section>
+
+    <% if (strapi.config.environment === 'development' && !isInitialized) { %>
+      <script>
+        var images=document.querySelectorAll('.people-saying-hello img');var nextIndex=0;setInterval(function(){var currentIndex=0;images.forEach(function(image,index){if(image.className==='visible'){currentIndex=index}});nextIndex=currentIndex+1;if(nextIndex===images.length){nextIndex=0}
+        images.forEach(function(image){image.classList.remove('visible')})
+        images[nextIndex].classList.add('visible')},1500)
+      </script>
+    <% } %>
+  </body>
+</html>

package/lib/middlewares/public/index.js

@@ -0,0 +1,130 @@
+'use strict';
+
+/**
+ * Module dependencies
+ */
+
+// Node.js core.
+const fs = require('fs');
+const path = require('path');
+const stream = require('stream');
+const _ = require('lodash');
+const koaStatic = require('koa-static');
+const utils = require('../../utils');
+const serveStatic = require('./serve-static');
+
+/**
+ * Public assets hook
+ */
+
+module.exports = strapi => {
+  return {
+    /**
+     * Initialize the hook
+     */
+
+    async initialize() {
+      const { defaultIndex, maxAge, path: publicPath } = strapi.config.middleware.settings.public;
+      const staticDir = path.resolve(strapi.dirs.root, publicPath || strapi.config.paths.static);
+
+      if (defaultIndex === true) {
+        const index = fs.readFileSync(path.join(__dirname, 'index.html'), 'utf8');
+
+        const serveIndexPage = async (ctx, next) => {
+          // defer rendering of strapi index page
+          await next();
+
+          if (ctx.body != null || ctx.status !== 404) return;
+
+          ctx.url = 'index.html';
+          const isInitialized = await utils.isInitialized(strapi);
+          const data = {
+            serverTime: new Date().toUTCString(),
+            isInitialized,
+            ..._.pick(strapi, [
+              'config.info.version',
+              'config.info.name',
+              'config.admin.url',
+              'config.server.url',
+              'config.environment',
+              'config.serveAdminPanel',
+            ]),
+          };
+          const content = _.template(index)(data);
+          const body = stream.Readable({
+            read() {
+              this.push(Buffer.from(content));
+              this.push(null);
+            },
+          });
+          // Serve static.
+          ctx.type = 'html';
+          ctx.body = body;
+        };
+
+        strapi.server.routes([
+          {
+            method: 'GET',
+            path: '/',
+            handler: serveIndexPage,
+            config: { auth: false },
+          },
+          {
+            method: 'GET',
+            path: '/index.html',
+            handler: serveIndexPage,
+            config: { auth: false },
+          },
+          {
+            method: 'GET',
+            path: '/assets/images/(.*)',
+            handler: serveStatic(path.resolve(__dirname, 'assets/images'), {
+              maxage: maxAge,
+              defer: true,
+            }),
+            config: { auth: false },
+          },
+          {
+            method: 'GET',
+            path: '/(.*)',
+            handler: koaStatic(staticDir, {
+              maxage: maxAge,
+              defer: true,
+            }),
+            config: { auth: false },
+          },
+        ]);
+      }
+
+      if (!strapi.config.serveAdminPanel) return;
+
+      const buildDir = path.resolve(strapi.dirs.root, 'build');
+      const serveAdmin = async (ctx, next) => {
+        await next();
+
+        if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
+          return;
+        }
+
+        if (ctx.body != null || ctx.status !== 404) {
+          return;
+        }
+
+        ctx.type = 'html';
+        ctx.body = fs.createReadStream(path.join(buildDir + '/index.html'));
+      };
+
+      strapi.server.routes([
+        {
+          method: 'GET',
+          path: `${strapi.config.admin.path}/:path*`,
+          handler: [
+            serveAdmin,
+            serveStatic(buildDir, { maxage: maxAge, defer: false, index: 'index.html' }),
+          ],
+          config: { auth: false },
+        },
+      ]);
+    },
+  };
+};

package/lib/middlewares/public/serve-static.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const path = require('path');
+const koaStatic = require('koa-static');
+
+// serveStatic is not supposed to be used to serve a folder that have sub-folders
+const serveStatic = (filesDir, koaStaticOptions = {}) => {
+  const serve = koaStatic(filesDir, koaStaticOptions);
+
+  return async (ctx, next) => {
+    const prev = ctx.path;
+    const newPath = path.basename(ctx.path);
+    ctx.path = newPath;
+    await serve(ctx, async () => {
+      ctx.path = prev;
+      await next();
+      ctx.path = newPath;
+    });
+    ctx.path = prev;
+  };
+};
+
+module.exports = serveStatic;

package/lib/middlewares/responseTime/defaults.json

@@ -0,0 +1,5 @@
+{
+  "responseTime": {
+    "enabled": true
+  }
+}

package/lib/middlewares/responseTime/index.js

@@ -0,0 +1,25 @@
+'use strict';
+
+/**
+ * X-Response-Time hook
+ */
+
+module.exports = strapi => {
+  return {
+    /**
+     * Initialize the hook
+     */
+
+    initialize() {
+      strapi.server.use(async (ctx, next) => {
+        const start = Date.now();
+
+        await next();
+
+        const delta = Math.ceil(Date.now() - start);
+
+        ctx.set('X-Response-Time', delta + 'ms'); // eslint-disable-line prefer-template
+      });
+    },
+  };
+};

package/lib/middlewares/responses/defaults.json

@@ -0,0 +1,5 @@
+{
+  "responses": {
+    "enabled": true
+  }
+}

package/lib/middlewares/responses/index.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const _ = require('lodash');
+
+module.exports = strapi => {
+  return {
+    initialize() {
+      strapi.server.use(async (ctx, next) => {
+        await next();
+
+        const status = ctx.status;
+        const responseFn = strapi.config.get(`middleware.settings.responses.handlers.${status}`);
+        if (_.isFunction(responseFn)) {
+          await responseFn(ctx);
+        }
+      });
+    },
+  };
+};

package/lib/middlewares/router/defaults.json

@@ -0,0 +1,7 @@
+{
+  "router": {
+    "enabled": true,
+    "prefix": "",
+    "routes": {}
+  }
+}