handle different locale

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## UNRELEASED
 
+### Adds
+
+* TODO:
+
 ### Changes
 
 * Hide "Duplicates Detected." notification.

i18n/en.json

@@ -16,6 +16,8 @@
   "exporting": "Exporting {{ type }}...",
   "import": "Import {{ type }}",
   "importCleanFailed": "The cleaning of the imported file on server failed: {{ exportPath }}",
+  "importWithCurrentLocaleHeading": "Different locale detected",
+  "importWithCurrentLocaleDescription": "This file was exported from the \"{{ docsLocale }}\" locale. Are you sure you want to import it into the \"{{ currentLocale }}\" locale?",
   "importDuplicateContinue": "Continue Import",
   "importDuplicateDetected": "Duplicates Detected.",
   "importDuplicateMessage": "Check the items you'd like to overwrite during import.",

lib/methods/import.js

@@ -6,13 +6,64 @@ const { EJSON } = require('bson');
 module.exports = self => {
   return {
     async import(req, moduleName) {
-      const {
-        docs, attachmentsInfo, exportPath, filePath
-      } = await self.readExportFile(req);
       if (!req.user) {
         throw self.apos.error('forbidden');
       }
 
+      const overrideLocale = self.apos.launder.boolean(req.body.overrideLocale);
+      let exportPath = self.apos.launder.string(req.body.exportPath);
+
+      let docs;
+      let attachmentsInfo;
+
+      if (exportPath) {
+        const filesData = await self.getFilesData(exportPath);
+
+        ({ docs, attachmentsInfo } = filesData);
+      } else {
+        const exportFile = await self.readExportFile(req);
+
+        ({ docs, attachmentsInfo } = exportFile);
+        exportPath = exportFile.exportPath;
+
+        await self.cleanFile(exportFile.filePath);
+      }
+
+      const siteHasMultipleLocales = Object.keys(self.apos.i18n.locales).length > 1;
+      const differentDocsLocale = self.getFirstDifferentLocale(req, docs);
+
+      if (siteHasMultipleLocales && differentDocsLocale) {
+        if (!overrideLocale) {
+          // Display confirmation modal to ask the user if he wants to
+          // continue the import with the current locale overriding the docs one:
+          await self.apos.notify(req, ' ', {
+            type: 'warning',
+            event: {
+              name: 'import-locale-differs',
+              data: {
+                moduleName,
+                exportPath,
+                content: {
+                  heading: req.t('aposImportExport:importWithCurrentLocaleHeading'),
+                  description: req.t('aposImportExport:importWithCurrentLocaleDescription', {
+                    docsLocale: differentDocsLocale,
+                    currentLocale: req.locale
+                  }),
+                  negativeLabel: 'apostrophe:no',
+                  affirmativeLabel: 'apostrophe:yes'
+                }
+              }
+            },
+            classes: [ 'apos-notification--hidden' ]
+          });
+
+          return;
+        }
+
+        // The user decided to continue the import (`overrideLocale` param sent)
+        self.rewriteDocsWithCurrentLocale(req, docs);
+      }
+
       const total = docs.length + attachmentsInfo.length;
       const {
         reporting, jobId, notificationId
@@ -21,6 +72,7 @@ module.exports = self => {
       const {
         duplicatedDocs, duplicatedIds, failedIds
       } = await self.insertDocs(req, docs, reporting);
+
       const importedAttachments = await self.insertAttachments(req, {
         attachmentsInfo,
         reporting,
@@ -52,7 +104,6 @@ module.exports = self => {
           });
 
         await self.cleanFile(exportPath);
-        await self.cleanFile(filePath);
         return;
       }
 
@@ -87,8 +138,6 @@ module.exports = self => {
         classes: [ 'apos-notification--hidden' ]
       });
 
-      self.cleanFile(filePath);
-
       return results;
     },
 
@@ -180,6 +229,36 @@ module.exports = self => {
       };
     },
 
+    getFirstDifferentLocale(req, docs) {
+      const doc = docs
+        .find(doc => self.isLocaleDifferent(req, doc));
+
+      return doc && self.stripOutMode(doc.aposLocale);
+    },
+
+    rewriteDocsWithCurrentLocale(req, docs) {
+      for (const doc of docs) {
+        if (self.isLocaleDifferent(req, doc)) {
+          self.replaceLocale(req, doc);
+        }
+      }
+    },
+
+    isLocaleDifferent(req, doc) {
+      return doc.aposLocale && self.stripOutMode(doc.aposLocale) !== req.locale;
+    },
+
+    replaceLocale(req, doc) {
+      const [ id, , mode ] = doc._id.split(':');
+
+      doc._id = [ id, req.locale, mode ].join(':');
+      doc.aposLocale = [ req.locale, mode ].join(':');
+    },
+
+    stripOutMode(aposLocale) {
+      return aposLocale.split(':').at(0);
+    },
+
     async insertDocs(req, docs, reporting) {
       const duplicatedDocs = [];
       const duplicatedIds = [];
@@ -342,20 +421,20 @@ module.exports = self => {
       }
     },
 
-    async cleanFile(exportPath) {
+    async cleanFile(path) {
       try {
-        const stat = await fsp.lstat(exportPath);
+        const stat = await fsp.lstat(path);
         if (stat.isDirectory()) {
-          await fsp.rm(exportPath, {
+          await fsp.rm(path, {
             recursive: true,
             force: true
           });
         } else {
-          await fsp.unlink(exportPath);
+          await fsp.unlink(path);
         }
       } catch (err) {
         self.apos.util.error(
-          `Error while trying to remove the file or folder: ${exportPath}. You might want to remove it yourself.`
+          `Error while trying to remove the file or folder: ${path}. You might want to remove it yourself.`
         );
       }
     },
@@ -428,15 +507,15 @@ module.exports = self => {
       const jobId = self.apos.launder.string(req.body.jobId);
       const notificationId = self.apos.launder.string(req.body.notificationId);
 
-      const jobManager = self.apos.modules['@apostrophecms/job'];
-      const job = await jobManager.db.findOne({ _id: jobId });
-
-      jobManager.end(job, true);
+      if (jobId) {
+        const jobManager = self.apos.modules['@apostrophecms/job'];
+        const job = await jobManager.db.findOne({ _id: jobId });
+        jobManager.end(job, true);
+      }
+      if (notificationId) {
+        self.apos.notification.dismiss(req, notificationId, 2000).catch(self.apos.util.error);
+      }
 
-      self.apos.notification.dismiss(req, notificationId, 2000)
-        .catch((error) => {
-          self.apos.util.error(error);
-        });
       await self.cleanFile(exportPath);
     }
   };

ui/apos/apps/index.js

@@ -7,6 +7,7 @@ export default () => {
       apos.bus.$on('export-download', openUrl);
       apos.bus.$on('import-started', addBeforeUnloadListener);
       apos.bus.$on('import-ended', removeBeforeUnloadListener);
+      apos.bus.$on('import-locale-differs', handleDifferentLocale);
       apos.bus.$on('import-duplicates', handleDuplicates);
     }
   });
@@ -25,6 +26,46 @@ export default () => {
     window.removeEventListener('beforeunload', warningImport);
   }
 
+  async function handleDifferentLocale(event) {
+    const continueImport = await apos.modal.execute('AposModalConfirm', event);
+
+    if (continueImport) {
+      try {
+        const moduleAction = apos.modules[event.moduleName].action;
+
+        await apos.http.post(`${moduleAction}/import`, {
+          body: {
+            overrideLocale: true,
+            exportPath: event.exportPath
+          }
+        });
+      } catch (error) {
+        apos.notify('aposImportExport:importFailed', {
+          type: 'danger',
+          dismiss: true
+        });
+      }
+
+      return;
+    }
+
+    // If not, we still need to clean the uploaded archive
+    try {
+      await apos.http.post('/api/v1/@apostrophecms/import-export/clean-export', {
+        body: {
+          exportPath: event.exportPath
+        }
+      });
+    } catch (error) {
+      apos.notify('aposImportExport:importCleanFailed', {
+        type: 'warning',
+        interpolate: {
+          exportPath: event.exportPath
+        }
+      });
+    }
+  }
+
   async function handleDuplicates(event) {
     if (event.duplicatedDocs.length) {
       await apos.modal.execute('AposDuplicateImportModal', event);

ui/apos/components/AposDuplicateImportModal.vue

@@ -194,7 +194,7 @@ export default {
           }
         });
       } catch (error) {
-        apos.notify(this.$t('aposImportExport:importCleanFailed'), {
+        apos.notify('aposImportExport:importCleanFailed', {
           type: 'warning',
           interpolate: {
             exportPath: this.exportPath
@@ -217,7 +217,7 @@ export default {
           jobId: this.jobId
         }
       }).catch(() => {
-        apos.notify(this.$t('aposImportExport:exportFailed'), {
+        apos.notify('aposImportExport:exportFailed', {
           type: 'danger',
           dismiss: true
         });

ui/apos/components/AposExportModal.vue

@@ -256,7 +256,7 @@ export default {
           }
         });
       } catch (error) {
-        apos.notify(this.$t('aposImportExport:exportFailed'), {
+        apos.notify('aposImportExport:exportFailed', {
           type: 'danger',
           dismiss: true
         });

ui/apos/components/AposImportModal.vue

@@ -130,7 +130,7 @@ export default {
       apos.http.post(`${this.moduleAction}/${this.action}`, {
         body: formData
       }).catch(() => {
-        apos.notify(this.$t('aposImportExport:importFailed'), {
+        apos.notify('aposImportExport:importFailed', {
           type: 'danger',
           dismiss: true
         });