Server side translation evershopcommerce#305

iamasrar011 · Aug 9, 2023 · de1c0c5 · de1c0c5
1 parent 514c07c
commit de1c0c5
Show file tree

Hide file tree

Showing 18 changed files with 123 additions and 49 deletions.
diff --git a/packages/evershop/bin/lib/addDefaultMiddlewareFuncs.js b/packages/evershop/bin/lib/addDefaultMiddlewareFuncs.js
@@ -17,6 +17,9 @@ const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
 const {
   setContextValue
 } = require('@evershop/evershop/src/modules/graphql/services/contextHelper');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 
 module.exports = exports = {};
 
@@ -277,8 +280,8 @@ exports.addDefaultMiddlewareFuncs = function addDefaultMiddlewareFuncs(
       response.status(404);
       request.currentRoute = routes.find((r) => r.id === 'notFound');
       setContextValue(request, 'pageInfo', {
-        title: 'Not found',
-        description: 'Not found'
+        title: translate('Not found'),
+        description: translate('Not found')
       });
       next();
     } else {

diff --git a/...ages/evershop/src/lib/locale/translate.js → ...vershop/src/lib/locale/translate/index.js b/...ages/evershop/src/lib/locale/translate.js → ...vershop/src/lib/locale/translate/index.js
diff --git a/packages/evershop/src/lib/locale/translate/translate.js b/packages/evershop/src/lib/locale/translate/translate.js
@@ -0,0 +1,31 @@
+const {
+  loadCsvTranslationFiles
+} = require('../../webpack/loaders/loadTranslationFromCsv');
+
+var csvData = undefined;
+
+/**
+ * This function is used to translate the text form server side, like from middleware. For templating use the _ function
+ */
+module.exports.translate = function translate(enText, values = {}) {
+  const translatedText =
+    csvData[enText] !== undefined ? csvData[enText] : enText;
+  // Check if the data is null, undefined or empty object
+  if (!values || Object.keys(values).length === 0) {
+    return translatedText;
+  } else {
+    const template = `${translatedText}`;
+    return template.replace(/\${(.*?)}/g, (match, key) =>
+      values[key.trim()] !== undefined ? values[key.trim()] : match
+    );
+  }
+};
+
+module.exports.loadCsv = async function loadCsv() {
+  // Only load the csv files once
+  if (csvData === undefined) {
+    csvData = await loadCsvTranslationFiles();
+  } else {
+    return;
+  }
+};
diff --git a/packages/evershop/src/lib/util/readCsvFile.js b/packages/evershop/src/lib/util/readCsvFile.js
@@ -0,0 +1,24 @@
+const fs = require('fs');
+const csv = require('csv-parser');
+
+async function readCsvFile(filePath) {
+  return new Promise((resolve, reject) => {
+    const results = {};
+    fs.createReadStream(filePath)
+      .pipe(csv({ headers: false }))
+      .on('data', (data) => {
+        // Skip the first row (headers)
+        if (!data[0].startsWith('#')) {
+          results[data[0]] = data[1];
+        }
+      })
+      .on('end', () => {
+        resolve(results);
+      })
+      .on('error', (err) => {
+        reject(err);
+      });
+  });
+}
+
+module.exports.readCsvFile = readCsvFile;
diff --git a/packages/evershop/src/lib/webpack/loaders/TranslationLoader.js b/packages/evershop/src/lib/webpack/loaders/TranslationLoader.js
@@ -2,23 +2,22 @@
 /* eslint-disable global-require */
 module.exports = exports = async function TranslationLoader(c) {
   const csvData = await this.getOptions().getTranslateData();
-  //console.log('csvData', csvData);
-  // Use regex to find all function call `t()` in the template string
+  // Use regex to find all function call `_()` in the template string
   const regex =
-    /_\s*\(\s*(?<arg1>["'][^"']*["']|\w+)\s*(?:,\s*(?<arg2>null|\{[\s\S]*?\}|[\w\.]+)\s*)?\)/g;
+    /_\s*\(\s*(?<arg1>"[^"\\]*(?:\\.[^"\\]*)*"|'[^'\\]*(?:\\.[^'\\]*)*'|\w+)\s*(?:,\s*(?<arg2>null|\{[\s\S]*?\}|"[^"\\]*(?:\\.[^"\\]*)*"|'[^'\\]*(?:\\.[^'\\]*)*'|\w+)\s*)?\)/g;
+
   let result = c;
   // Loop through each function call and get the template string
   let match;
   while ((match = regex.exec(c)) !== null) {
     let template = match.groups.arg1;
     // Remove the quote from the start and end of the template string
-    template = template.replace(/^['"]|['"]$/g, '');
+    template = template.replace(/^["']/, '').replace(/["']$/, '');
     const newValue = csvData[template];
     // Check if the template is exist in the csvData
     if (newValue) {
       result = result.replace(match[0], `_("${newValue}",${match[2] || null})`);
     }
   }
-
   return result;
 };
diff --git a/packages/evershop/src/lib/webpack/loaders/loadTranslationFromCsv.js b/packages/evershop/src/lib/webpack/loaders/loadTranslationFromCsv.js
@@ -1,28 +1,8 @@
 const fs = require('fs');
-const csv = require('csv-parser');
 const { getConfig } = require('../../util/getConfig');
 const path = require('path');
 const { CONSTANTS } = require('../../helpers');
-
-async function readCsvFile(filePath) {
-  return new Promise((resolve, reject) => {
-    const results = {};
-    fs.createReadStream(filePath)
-      .pipe(csv({ headers: false }))
-      .on('data', (data) => {
-        // Skip the first row (headers)
-        if (!data[0].startsWith('#')) {
-          results[data[0]] = data[1];
-        }
-      })
-      .on('end', () => {
-        resolve(results);
-      })
-      .on('error', (err) => {
-        reject(err);
-      });
-  });
-}
+const { readCsvFile } = require('../../util/readCsvFile');
 
 module.exports.loadCsvTranslationFiles =
   async function loadCsvTranslationFiles() {
@@ -36,7 +16,7 @@ module.exports.loadCsvTranslationFiles =
 
       // Check if path exists
       if (!fs.existsSync(folderPath)) {
-        return [];
+        return {};
       }
 
       const results = {};

diff --git a/packages/evershop/src/modules/base/bootstrap.js b/packages/evershop/src/modules/base/bootstrap.js
@@ -0,0 +1,7 @@
+const {
+  loadCsv
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
+
+module.exports = async () => {
+  await loadCsv();
+};
diff --git a/packages/evershop/src/modules/base/pages/global/[notification]notFound[response].js b/packages/evershop/src/modules/base/pages/global/[notification]notFound[response].js
@@ -1,12 +1,15 @@
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 const { setContextValue } = require('../../../graphql/services/contextHelper');
 
 module.exports = async (request, response, delegate, next) => {
   if (response.statusCode !== 404) {
     next();
   } else {
     setContextValue(request, 'pageInfo', {
-      title: 'Not found',
-      description: 'Page not found'
+      title: translate('Not found'),
+      description: translate('Page not found')
     });
     next();
   }

diff --git a/packages/evershop/src/modules/catalog/pages/frontStore/catalogSearch/[index]filters.js b/packages/evershop/src/modules/catalog/pages/frontStore/catalogSearch/[index]filters.js
@@ -1,3 +1,6 @@
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 const {
   setContextValue
 } = require('@evershop/evershop/src/modules/graphql/services/contextHelper');
@@ -47,8 +50,8 @@ module.exports = (request, response, delegate, next) => {
     // Remove html tags
     const keyword = query.keyword;
     setContextValue(request, 'pageInfo', {
-      title: `Search results for "${keyword}"`,
-      description: `Search results for "${keyword}"`
+      title: translate('Search results for "${keyword}"', { keyword }),
+      description: translate('Search results for "${keyword}"', { keyword })
     });
 
     filtersFromUrl.push({

diff --git a/packages/evershop/src/modules/checkout/pages/frontStore/checkout/index.js b/packages/evershop/src/modules/checkout/pages/frontStore/checkout/index.js
@@ -4,6 +4,9 @@ const {
   getContextValue
 } = require('../../../../graphql/services/contextHelper');
 const { getCustomerCart } = require('../../../services/getCustomerCart');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 
 module.exports = async (request, response, delegate, next) => {
   const cart = await getCustomerCart(
@@ -19,8 +22,8 @@ module.exports = async (request, response, delegate, next) => {
     response.redirect(302, buildUrl('cart'));
   } else {
     setContextValue(request, 'pageInfo', {
-      title: 'Checkout',
-      description: 'Checkout'
+      title: translate('Checkout'),
+      description: translate('Checkout')
     });
     setContextValue(request, 'cart_id', cart.getData('uuid'));
     next();

diff --git a/packages/evershop/src/modules/cms/graphql/types/PageInfo/PageInfo.resolvers.js b/packages/evershop/src/modules/cms/graphql/types/PageInfo/PageInfo.resolvers.js
@@ -1,3 +1,6 @@
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 const { get } = require('@evershop/evershop/src/lib/util/get');
 const { select } = require('@evershop/postgres-query-builder');
 
@@ -30,7 +33,7 @@ module.exports = {
       if (!rewriteRule) {
         return [
           {
-            title: 'Home',
+            title: translate('Home'),
             url: '/'
           },
           {
@@ -46,7 +49,7 @@ module.exports = {
         // Build the breadrumbs
         const breadcrumbs = [
           {
-            title: 'Home',
+            title: translate('Home'),
             url: '/'
           }
         ];

diff --git a/packages/evershop/src/modules/customer/pages/frontStore/account/index.js b/packages/evershop/src/modules/customer/pages/frontStore/account/index.js
@@ -3,6 +3,9 @@ const {
   getContextValue,
   setContextValue
 } = require('../../../../graphql/services/contextHelper');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 
 module.exports = (request, response, delegate, next) => {
   // Check if the user is logged in
@@ -12,8 +15,8 @@ module.exports = (request, response, delegate, next) => {
     response.redirect(buildUrl('homepage'));
   } else {
     setContextValue(request, 'pageInfo', {
-      title: 'Account details',
-      description: 'Account details'
+      title: translate('Account details'),
+      description: translate('Account details')
     });
     next();
   }

diff --git a/packages/evershop/src/modules/customer/pages/frontStore/login/index.js b/packages/evershop/src/modules/customer/pages/frontStore/login/index.js
@@ -3,6 +3,9 @@ const {
   getContextValue,
   setContextValue
 } = require('../../../../graphql/services/contextHelper');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 
 module.exports = (request, response, delegate, next) => {
   // Check if the user is logged in
@@ -12,8 +15,8 @@ module.exports = (request, response, delegate, next) => {
     response.redirect(buildUrl('homepage'));
   } else {
     setContextValue(request, 'pageInfo', {
-      title: 'Login',
-      description: 'Login'
+      title: translate('Login'),
+      description: translate('Login')
     });
     next();
   }

diff --git a/packages/evershop/src/modules/customer/pages/frontStore/register/index.js b/packages/evershop/src/modules/customer/pages/frontStore/register/index.js
@@ -3,6 +3,9 @@ const {
   getContextValue,
   setContextValue
 } = require('../../../../graphql/services/contextHelper');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 
 module.exports = (request, response, delegate, next) => {
   // Check if the user is logged in
@@ -12,8 +15,8 @@ module.exports = (request, response, delegate, next) => {
     response.redirect(buildUrl('homepage'));
   } else {
     setContextValue(request, 'pageInfo', {
-      title: 'Create an account',
-      description: 'Create an account'
+      title: translate('Create an account'),
+      description: translate('Create an account')
     });
     next();
   }

diff --git a/packages/evershop/src/modules/customer/pages/frontStore/resetPasswordPage/index.js b/packages/evershop/src/modules/customer/pages/frontStore/resetPasswordPage/index.js
@@ -3,6 +3,9 @@ const {
   getContextValue,
   setContextValue
 } = require('../../../../graphql/services/contextHelper');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 
 module.exports = (request, response, delegate, next) => {
   // Check if the user is logged in
@@ -12,8 +15,8 @@ module.exports = (request, response, delegate, next) => {
     response.redirect(buildUrl('homepage'));
   } else {
     setContextValue(request, 'pageInfo', {
-      title: 'Reset password',
-      description: 'Reset password'
+      title: translate('Reset password'),
+      description: translate('Reset password')
     });
     next();
   }

diff --git a/packages/evershop/src/modules/customer/pages/frontStore/updatePasswordPage/index.js b/packages/evershop/src/modules/customer/pages/frontStore/updatePasswordPage/index.js
@@ -3,6 +3,9 @@ const {
   getContextValue,
   setContextValue
 } = require('../../../../graphql/services/contextHelper');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
 
 module.exports = (request, response, delegate, next) => {
   // Check if the user is logged in
@@ -12,8 +15,8 @@ module.exports = (request, response, delegate, next) => {
     response.redirect(buildUrl('homepage'));
   } else {
     setContextValue(request, 'pageInfo', {
-      title: 'Update password',
-      description: 'Update password'
+      title: translate('Update password'),
+      description: translate('Update password')
     });
     next();
   }

diff --git a/translations/zh/catalog.csv b/translations/zh/catalog.csv
@@ -2,4 +2,5 @@ Featured collection, 精选合集
 SHOP BY, 按类别购买
 Sort By, 按类别排序
 There is no product to display, 没有产品可显示
-${count} products, ${count} 个产品
+${count} products, ${count} 个产品
+Search results for "${keyword}", 搜索结果为 “${keyword}”
diff --git a/translations/zh/general.csv b/translations/zh/general.csv
@@ -2,4 +2,6 @@ Discount ${discount} For All Orders Over ${price}, 所有超过 ${price} 的订
 Please select, 请选择
 The page you requested does not exist., 您请求的页面不存在。
 Continue shopping, 继续购物
-404 Page Not Found, 404 页面未找到
+404 Page Not Found, 404 页面未找到
+Home, 首页
+Not found, 未找到