Merge pull request #46 from glenndehaan/feature/i18n

Feature/i18n
glenndehaan · Oct 14, 2024 · 2036f60 · 2036f60
2 parents 8ae97ce + eafd7aa
commit 2036f60
Show file tree

Hide file tree

Showing 16 changed files with 308 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ UniFi Voucher Site is a web-based platform for generating and managing UniFi net
 - **Home Assistant Add-on**: Seamlessly integrate with Home Assistant for centralized management.
 - **Receipt Printing**: Supports printing vouchers with 80mm thermal printers.
 - **Email Functionality**: Automatically send vouchers via SMTP.
+- **Localized Email/Print Templates** Fully localized templates, with support for multiple languages.
 
 ## Structure
 
@@ -123,6 +124,8 @@ services:
       SMTP_PASSWORD: ''
       # Sets the application Log Level (Valid Options: error|warn|info|debug|trace)
       LOG_LEVEL: 'info'
+      # Enables/disables translation debugging, when enabled only translation keys are shown
+      TRANSLATION_DEBUG: 'false'
 ```
 
 ### Home Assistant Add-on
@@ -454,6 +457,29 @@ Once the SMTP environment variables are configured, the email feature will be av
 
 ![Example Email](.docs/images/email_example.png)
 
+## Translations
+
+The UniFi Voucher Site supports multiple languages, and we're actively working to expand the list of available translations. To facilitate this, we use **Crowdin**, a platform that allows people from around the world to help translate and improve the localization of the project.
+
+### How to help
+
+If you'd like to contribute by translating the UniFi Voucher Site into your language or improve existing translations, you're welcome to join our project on Crowdin. Even small contributions can make a big difference!
+
+Simply visit our Crowdin project page by clicking the badge below:
+
+[![Crowdin](https://badges.crowdin.net/unifi-voucher-site/localized.svg)](https://crowdin.com/project/unifi-voucher-site)
+
+Once you're there, you can choose your language and start contributing immediately. Crowdin provides an intuitive interface to help you suggest translations, review them, or vote on others' contributions.
+
+### Getting Started
+
+1. **Create a Crowdin account** (if you don't have one already).
+2. **Join the UniFi Voucher Site project** by visiting our [Crowdin page](https://crowdin.com/project/unifi-voucher-site).
+3. Choose the language you want to contribute to or suggest improvements for.
+4. Start translating or reviewing!
+
+Your contributions will be automatically included in the next release after review.
+
 ## Screenshots
 
 ### Login (Desktop)

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -34,3 +34,4 @@ services:
       SMTP_USERNAME: ''
       SMTP_PASSWORD: ''
       LOG_LEVEL: 'info'
+      TRANSLATION_DEBUG: 'false'
diff --git a/locales/en/email.json b/locales/en/email.json
@@ -0,0 +1,19 @@
+{
+  "title": "WiFi Voucher Code",
+  "preHeader": "Your WiFi Voucher Code",
+  "greeting": "Hi there",
+  "intro": "Someone generated a WiFi Voucher, please use this code when connecting",
+  "connect": "Connect to",
+  "password": "Password",
+  "or": "or",
+  "scan": "Scan to connect",
+  "details": "Voucher Details",
+  "type": "Type",
+  "multiUse": "Multi-use",
+  "singleUse": "Single-use",
+  "duration": "Duration",
+  "dataLimit": "Data Limit",
+  "downloadLimit": "Download Limit",
+  "uploadLimit": "Upload Limit",
+  "poweredBy": "Powered by"
+}
diff --git a/locales/en/print.json b/locales/en/print.json
@@ -0,0 +1,15 @@
+{
+  "title": "WiFi Voucher Code",
+  "connect": "Connect to",
+  "password": "Password",
+  "or": "or",
+  "scan": "Scan to connect",
+  "details": "Voucher Details",
+  "type": "Type",
+  "multiUse": "Multi-use",
+  "singleUse": "Single-use",
+  "duration": "Duration",
+  "dataLimit": "Data Limit",
+  "downloadLimit": "Download Limit",
+  "uploadLimit": "Upload Limit"
+}
diff --git a/modules/mail.js b/modules/mail.js
@@ -10,6 +10,7 @@ const nodemailer = require('nodemailer');
  */
 const variables = require('./variables');
 const log = require('./log');
+const translation = require('./translation');
 const qr = require('./qr');
 
 /**
@@ -43,16 +44,22 @@ module.exports = {
      *
      * @param to
      * @param voucher
+     * @param language
      * @return {Promise<unknown>}
      */
-    send: (to, voucher) => {
+    send: (to, voucher, language) => {
         return new Promise(async (resolve, reject) => {
+            // Create new translator
+            const t = translation('email', language);
+
+            // Attempt to send mail via SMTP transport
             const result = await transport.sendMail({
                 from: variables.smtpFrom,
                 to: to,
-                subject: 'WiFi Voucher Code',
-                text: `Hi there,\n\nSomeone generated a WiFi Voucher, please use this code when connecting:\n\n${voucher.code.slice(0, 5)}-${voucher.code.slice(5)}`,
+                subject: t('title'),
+                text: `${t('greeting')},\n\n${t('intro')}:\n\n${voucher.code.slice(0, 5)}-${voucher.code.slice(5)}`,
                 html: ejs.render(fs.readFileSync(`${__dirname}/../template/email/voucher.ejs`, 'utf-8'), {
+                    t,
                     voucher,
                     unifiSsid: variables.unifiSsid,
                     unifiSsidPassword: variables.unifiSsidPassword,
@@ -66,6 +73,7 @@ module.exports = {
                 reject(`[Mail] ${e.message}`);
             });
 
+            // Check if the email was sent successfully
             if(result) {
                 log.info(`[Mail] Sent to: ${to}`);
                 resolve(true);

diff --git a/modules/print.js b/modules/print.js
@@ -11,6 +11,7 @@ const PrinterTypes = require('node-thermal-printer').types;
 const variables = require('./variables');
 const log = require('./log');
 const qr = require('./qr');
+const translation = require('./translation');
 
 /**
  * Import own utils
@@ -27,10 +28,14 @@ module.exports = {
      * Generates a voucher as a PDF
      *
      * @param voucher
+     * @param language
      * @return {Promise<unknown>}
      */
-    pdf: (voucher) => {
+    pdf: (voucher, language) => {
         return new Promise(async (resolve) => {
+            // Create new translator
+            const t = translation('print', language);
+
             const doc = new PDFDocument({
                 bufferPages: true,
                 size: [226.77165354330398, size(voucher)],
@@ -54,7 +59,7 @@ module.exports = {
 
             doc.font('Helvetica-Bold')
                 .fontSize(20)
-                .text(`WiFi Voucher Code`, {
+                .text(`${t('title')}`, {
                     align: 'center'
                 });
             doc.font('Helvetica-Bold')
@@ -68,7 +73,7 @@ module.exports = {
             if(variables.unifiSsid !== '') {
                 doc.font('Helvetica')
                     .fontSize(10)
-                    .text(`Connect to: `, {
+                    .text(`${t('connect')}: `, {
                         continued: true
                     });
                 doc.font('Helvetica-Bold')
@@ -83,7 +88,7 @@ module.exports = {
                         .text(`,`);
                     doc.font('Helvetica')
                         .fontSize(10)
-                        .text(`Password: `, {
+                        .text(`${t('password')}: `, {
                             continued: true
                         });
                     doc.font('Helvetica-Bold')
@@ -93,16 +98,16 @@ module.exports = {
                         });
                     doc.font('Helvetica')
                         .fontSize(10)
-                        .text(` or,`);
+                        .text(` ${t('or')},`);
                 } else {
                     doc.font('Helvetica')
                         .fontSize(10)
-                        .text(` or,`);
+                        .text(` ${t('or')},`);
                 }
 
                 doc.font('Helvetica')
                     .fontSize(10)
-                    .text(`Scan to connect:`);
+                    .text(`${t('scan')}:`);
 
                 doc.image(await qr(), 75, variables.unifiSsidPassword !== '' ? 215 : 205, {fit: [75, 75], align: 'center', valign: 'center'});
                 doc.moveDown(6);
@@ -112,24 +117,24 @@ module.exports = {
 
             doc.font('Helvetica-Bold')
                 .fontSize(12)
-                .text(`Voucher Details`);
+                .text(`${t('details')}`);
 
             doc.font('Helvetica-Bold')
                 .fontSize(10)
                 .text(`--------------------------------------------------------`);
 
             doc.font('Helvetica-Bold')
                 .fontSize(10)
-                .text(`Type: `, {
+                .text(`${t('type')}: `, {
                     continued: true
                 });
             doc.font('Helvetica')
                 .fontSize(10)
-                .text(voucher.quota === 0 ? 'Multi-use' : 'Single-use');
+                .text(voucher.quota === 0 ? t('multiUse') : t('singleUse'));
 
             doc.font('Helvetica-Bold')
                 .fontSize(10)
-                .text(`Duration: `, {
+                .text(`${t('duration')}: `, {
                     continued: true
                 });
             doc.font('Helvetica')
@@ -139,7 +144,7 @@ module.exports = {
             if(voucher.qos_usage_quota) {
                 doc.font('Helvetica-Bold')
                     .fontSize(10)
-                    .text(`Data Limit: `, {
+                    .text(`${t('dataLimit')}: `, {
                         continued: true
                     });
                 doc.font('Helvetica')
@@ -150,7 +155,7 @@ module.exports = {
             if(voucher.qos_rate_max_down) {
                 doc.font('Helvetica-Bold')
                     .fontSize(10)
-                    .text(`Download Limit: `, {
+                    .text(`${t('downloadLimit')}: `, {
                         continued: true
                     });
                 doc.font('Helvetica')
@@ -161,7 +166,7 @@ module.exports = {
             if(voucher.qos_rate_max_up) {
                 doc.font('Helvetica-Bold')
                     .fontSize(10)
-                    .text(`Upload Limit: `, {
+                    .text(`${t('uploadLimit')}: `, {
                         continued: true
                     });
                 doc.font('Helvetica')
@@ -177,10 +182,14 @@ module.exports = {
      * Sends a print job to an ESC/POS compatible network printer
      *
      * @param voucher
+     * @param language
      * @return {Promise<unknown>}
      */
-    escpos: (voucher) => {
+    escpos: (voucher, language) => {
         return new Promise(async (resolve, reject) => {
+            // Create new translator
+            const t = translation('print', language);
+
             const printer = new ThermalPrinter({
                 type: PrinterTypes.EPSON,
                 interface: `tcp://${variables.printerIp}`
@@ -202,7 +211,7 @@ module.exports = {
             printer.alignCenter();
             printer.newLine();
             printer.setTextSize(2, 2);
-            printer.println('WiFi Voucher Code');
+            printer.println(`${t('title')}`);
             printer.setTextSize(1, 1);
             printer.println(`${voucher.code.slice(0, 5)}-${voucher.code.slice(5)}`);
             printer.setTextNormal();
@@ -213,26 +222,26 @@ module.exports = {
                 printer.newLine();
 
                 printer.alignLeft();
-                printer.print('Connect to: ');
+                printer.print(`${t('connect')}: `);
                 printer.setTypeFontB();
                 printer.setTextSize(1, 1);
                 printer.print(variables.unifiSsid);
                 printer.setTextNormal();
                 if(variables.unifiSsidPassword) {
                     printer.print(',');
                     printer.newLine();
-                    printer.print('Password: ');
+                    printer.print(`${t('password')}: `);
                     printer.setTypeFontB();
                     printer.setTextSize(1, 1);
                     printer.print(variables.unifiSsidPassword);
                     printer.setTextNormal();
-                    printer.print(' or,');
+                    printer.print(` ${t('or')},`);
                     printer.newLine();
                 } else {
-                    printer.print(' or,');
+                    printer.print(` ${t('or')},`);
                     printer.newLine();
                 }
-                printer.println('Scan to connect:');
+                printer.println(`${t('scan')}:`);
                 printer.alignCenter();
                 await printer.printImageBuffer(await qr(true));
             }
@@ -243,28 +252,28 @@ module.exports = {
             printer.alignLeft();
             printer.setTypeFontB();
             printer.setTextSize(1, 1);
-            printer.println('Voucher Details');
+            printer.println(`${t('details')}`);
             printer.setTextNormal();
             printer.drawLine();
 
             printer.setTextDoubleHeight();
             printer.invert(true);
-            printer.print('Type:');
+            printer.print(`${t('type')}:`);
             printer.invert(false);
-            printer.print(voucher.quota === 0 ? ' Multi-use' : ' Single-use');
+            printer.print(voucher.quota === 0 ? ` ${t('multiUse')}` : ` ${t('singleUse')}`);
             printer.newLine();
 
             printer.setTextDoubleHeight();
             printer.invert(true);
-            printer.print('Duration:');
+            printer.print(`${t('duration')}:`);
             printer.invert(false);
             printer.print(` ${time(voucher.duration)}`);
             printer.newLine();
 
             if(voucher.qos_usage_quota) {
                 printer.setTextDoubleHeight();
                 printer.invert(true);
-                printer.print('Data Limit:');
+                printer.print(`${t('dataLimit')}:`);
                 printer.invert(false);
                 printer.print(` ${bytes(voucher.qos_usage_quota, 2)}`);
                 printer.newLine();
@@ -273,7 +282,7 @@ module.exports = {
             if(voucher.qos_rate_max_down) {
                 printer.setTextDoubleHeight();
                 printer.invert(true);
-                printer.print('Download Limit:');
+                printer.print(`${t('downloadLimit')}:`);
                 printer.invert(false);
                 printer.print(` ${bytes(voucher.qos_rate_max_down, 1, true)}`);
                 printer.newLine();
@@ -282,7 +291,7 @@ module.exports = {
             if(voucher.qos_rate_max_up) {
                 printer.setTextDoubleHeight();
                 printer.invert(true);
-                printer.print('Upload Limit:');
+                printer.print(`${t('uploadLimit')}:`);
                 printer.invert(false);
                 printer.print(` ${bytes(voucher.qos_rate_max_up, 1, true)}`);
                 printer.newLine();