Merge branch 'feature/36-runner_certificates' of git.odit.services:lfk/document-server into feature/36-runner_certificates

ref #36

.drone.yml

@@ -113,6 +113,7 @@ steps:
       tags:
         - latest
       registry: registry.odit.services
+      mtu: 1000
   - name: push merge to repo
     depends_on: ["clone"]
     image: appleboy/drone-git-push
@@ -147,6 +148,7 @@ steps:
       tags:
         - '${DRONE_TAG}'
       registry: registry.odit.services
+      mtu: 1000
 trigger:
   event:
   - tag

CHANGELOG.md

@@ -2,8 +2,24 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
+#### [v0.4.3](https://git.odit.services/lfk/document-server/compare/v0.4.3...v0.4.3)
+
+#### [v0.4.3](https://git.odit.services/lfk/document-server/compare/v0.4.2...v0.4.3)
+
+> 30 March 2021
+
+- Merge pull request 'Release 0.4.3' (#40) from dev into main [`c8dc998`](https://git.odit.services/lfk/document-server/commit/c8dc998ecdccc7fc4348ecc0db552a3d7bc2eb52)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`289a0d8`](https://git.odit.services/lfk/document-server/commit/289a0d8671575dda911c64f79d24726d3bbee071)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`3df3d26`](https://git.odit.services/lfk/document-server/commit/3df3d26708aab12590cd9c1f697cfdea8017ace4)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`457ea26`](https://git.odit.services/lfk/document-server/commit/457ea26cf8124009084415d12c7a0e31912a3eb1)
+- 🚀Bumped version to v0.4.3 [`c3beb3e`](https://git.odit.services/lfk/document-server/commit/c3beb3e1032492f9a8304c4b099a700ad0d1d2cf)
+- Pipeline mtu fix [`c2d2b66`](https://git.odit.services/lfk/document-server/commit/c2d2b66f2f6fbd30c2027fd3dab393db5219eb44)
+
 #### [v0.4.2](https://git.odit.services/lfk/document-server/compare/v0.4.0...v0.4.2)
 
+> 29 March 2021
+
+- Merge pull request 'Release 0.4.2' (#39) from dev into main [`ce3053c`](https://git.odit.services/lfk/document-server/commit/ce3053c0ba5404ebd8d4cbd5386c454d8cd8c4d2)
 - 🚀Bumped version to v0.4.1 [`d17108f`](https://git.odit.services/lfk/document-server/commit/d17108f4b9f041727afcee5c171d5d8f9a3c677c)
 - 🧾New changelog file version [CI SKIP] [skip ci] [`0ade575`](https://git.odit.services/lfk/document-server/commit/0ade57536e372a62356fe2f329f6cfe04bcfc397)
 - Fixed faulty object mapping [`9584bfe`](https://git.odit.services/lfk/document-server/commit/9584bfed8ba5b8c856b55aa90969874d4d6751ff)
@@ -11,6 +27,7 @@ All notable changes to this project will be documented in this file. Dates are d
 - 🧾New changelog file version [CI SKIP] [skip ci] [`b8f0d1f`](https://git.odit.services/lfk/document-server/commit/b8f0d1fa60da4e3262623cecf4a78c8a9a322f8c)
 - 🧾New changelog file version [CI SKIP] [skip ci] [`073433f`](https://git.odit.services/lfk/document-server/commit/073433f308f2f8e7ada97dd0b3896fb541e85711)
 - 🧾New changelog file version [CI SKIP] [skip ci] [`a478081`](https://git.odit.services/lfk/document-server/commit/a47808172797e12800c46d17ccf4b458f4a506de)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`6608456`](https://git.odit.services/lfk/document-server/commit/6608456c686e51d3aa16e630ba72c7c29e428b2a)
 - 🧾New changelog file version [CI SKIP] [skip ci] [`0839ff6`](https://git.odit.services/lfk/document-server/commit/0839ff63593cfb9e8339b2b2a86dbe7e2afb5dcb)
 - Now using our own images to build stuff 🚀 [`96886c7`](https://git.odit.services/lfk/document-server/commit/96886c74bc397e1ee793e83e0d01a6bbaa953da3)
 - 🚀Bumped version to v0.4.2 [`1cbe5a1`](https://git.odit.services/lfk/document-server/commit/1cbe5a1614c40fbf23f032be60039ddb1472ca94)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odit/lfk-document-server",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "The document generation server for the LfK! runner system. This generates certificates, sponsoring aggreements and more",
   "main": "src/app.ts",
   "scripts": {

src/PdfCreator.ts

@@ -10,6 +10,7 @@ import { PDFDocument } from 'pdf-lib';
 import puppeteer from "puppeteer";
 import { awaitAsyncHandlebarHelpers, helpers } from './asyncHelpers';
 import { config } from './config';
+import { CertificateRunner } from './models/CertificateRunner';
 import { Runner } from './models/Runner';
 import { RunnerCard } from './models/RunnerCard';
 import { RunnerGroup } from './models/RunnerGroup';
@@ -153,13 +154,37 @@ export class PdfCreator {
         await i18next.changeLanguage(locale);
         const template_source = fs.readFileSync(`${this.templateDir}/runner_card.html`, 'utf8');
         const template = Handlebars.compile(template_source);
-        let result = template({ cards, cards_swapped, eventname: "LfK! 2069", codeformat: "qrcode" })
+        let result = template({ cards, cards_swapped, eventname: config.eventname, codeformat: codeformat })
         result = await awaitAsyncHandlebarHelpers(result);
-        fs.writeFileSync("lelelelele.tmp", result);
         const pdf = await this.renderPdf(result, { format: "A4", landscape: false });
         return pdf
     }
 
+    /**
+     * Generate sponsoring contract pdfs.
+     * @param runner The runner you want to generate the contracts for.
+     * @param locale The locale used for the contracts (default:en)
+     */
+    public async generateRunnerCertficates(runners: CertificateRunner[], locale: string = "en"): Promise<Buffer> {
+        if (runners.length > 50) {
+            let pdf_promises = new Array<Promise<Buffer>>();
+            let i, j;
+            for (i = 0, j = runners.length; i < j; i += 50) {
+                let chunk = runners.slice(i, i + 50);
+                pdf_promises.push(this.generateRunnerCertficates(chunk, locale));
+            }
+            const pdfs = await Promise.all(pdf_promises);
+            return await this.mergePdfs(pdfs);
+        }
+        await i18next.changeLanguage(locale);
+        const template_source = fs.readFileSync(`${this.templateDir}/runner_certificate.html`, 'utf8');
+        const template = Handlebars.compile(template_source);
+        let result = template({ runners, eventname: config.eventname });
+        result = await awaitAsyncHandlebarHelpers(result);
+        const pdf = await this.renderPdf(result, { format: "A4", landscape: false, printBackground: true });
+        return pdf;
+    }
+
     /**
      * Converts all images in html to base64.
      * Works with image files in the template directory or images from urls.
@@ -167,6 +192,7 @@ export class PdfCreator {
      */
     public async imgToBase64(html): Promise<string> {
         const $ = cheerio.load(html)
+
         $('img').each(async (index, element) => {
             let imgsrc = $(element).attr("src");
             if (imgsrc.startsWith("data:image")) {
@@ -192,7 +218,7 @@ export class PdfCreator {
 
             image = `data:${img_type};base64,${image}`
             $(element).attr("src", image)
-        })
+        });
 
         return $.html();
     }

src/controllers/PdfController.ts

@@ -1,5 +1,6 @@
 import { Authorized, Body, JsonController, Post, QueryParam, Res } from 'routing-controllers';
 import { OpenAPI } from 'routing-controllers-openapi';
+import { CertificateRunner } from '../models/CertificateRunner';
 import { Runner } from '../models/Runner';
 import { RunnerCard } from '../models/RunnerCard';
 import { PdfCreator } from '../PdfCreator';
@@ -54,6 +55,25 @@ export class PdfController {
         return contracts;
     }
 
+    @Post('/certificates')
+    @OpenAPI({ description: "Generate runner certificate pdfs from certificate runner objects.<br>You can choose your prefered locale by passing the 'locale' query-param.<br> If you provide more than 100 runenrs this could take a moment or two (we tested up to 1000 runners in about 70sec so far)." })
+    async generateCertificates(@Body({ validate: true, options: { limit: "500mb" } }) runners: CertificateRunner[], @Res() res: any, @QueryParam("locale") locale: string, @QueryParam("download") download: boolean) {
+        if (!this.initialized) {
+            await this.pdf.init();
+            this.initialized = true;
+        }
+        if (!Array.isArray(runners)) {
+            runners = [runners];
+        }
+        runners = this.mapCertificatRunnersGroupNames(runners)
+        const certificates = await this.pdf.generateRunnerCertficates(runners, locale);
+        res.setHeader('content-type', 'application/pdf');
+        if (download) {
+            res.setHeader('Content-Disposition', 'attachment; filename="certificates.pdf"')
+        }
+        return certificates;
+    }
+
     private mapRunnerGroupNames(runners: Runner[]): Runner[] {
         let response = new Array<Runner>();
         for (let runner of runners) {
@@ -68,6 +88,20 @@ export class PdfController {
         return response;
     }
 
+    private mapCertificatRunnersGroupNames(runners: CertificateRunner[]): CertificateRunner[] {
+        let response = new Array<CertificateRunner>();
+        for (let runner of runners) {
+            if (!runner.group.parentGroup) {
+                runner.group.fullName = runner.group.name;
+            }
+            else {
+                runner.group.fullName = `${runner.group.parentGroup.name}/${runner.group.name}`;
+            }
+            response.push(runner)
+        }
+        return response;
+    }
+
     private mapCardGroupNames(cards: RunnerCard[]): RunnerCard[] {
         let response = new Array<RunnerCard>();
         for (let card of cards) {

src/locales/de.json

@@ -1,20 +1,28 @@
 {
-    "address": "Adresse",
-    "city": "Stadt",
-    "date": "Datum",
-    "firstname": "Vorname",
-    "group": "Team/Klasse",
-    "house_number": "Hausnummer",
-    "id": "ID",
-    "lastname": "Nachname",
-    "location": "Ort",
-    "please_use_blockletters": "Bitte in DRUCKBUCHSTABEN schreiben",
-    "postalcode": "Postleitzahl",
-    "signature": "Unterschrift",
-    "sponsor": "Sponsor",
-    "sponsoring_address_condition": "Muss ausgefüllt werden, wenn Sie eine Spendenquittung benötigen - Spendenquittungen können erst ab einem Gesamtbetrag von {{sponsoring_receipt_minimum_amount}}{{currency_symbol}} ausgestellt werden",
-    "sponsoring_amount_per_distance": "mit einem Betrag von _____{{currency_symbol}} pro gelaufenem Kilometer zu unterstützen.",
-    "sponsoring_subtitle": "Ich/Wir sind bereit anlässlich des {{eventname}}",
-    "sponsoring_title": "Sponsoringerklärung",
-    "street": "Straße"
-}
+  "address": "Adresse",
+  "city": "Stadt",
+  "date": "Datum",
+  "firstname": "Vorname",
+  "group": "Team/Klasse",
+  "house_number": "Hausnummer",
+  "id": "ID",
+  "lastname": "Nachname",
+  "location": "Ort",
+  "please_use_blockletters": "Bitte in DRUCKBUCHSTABEN schreiben",
+  "postalcode": "Postleitzahl",
+  "signature": "Unterschrift",
+  "sponsor": "Sponsor",
+  "sponsoring_address_condition": "Muss ausgefüllt werden, wenn Sie eine Spendenquittung benötigen - Spendenquittungen können erst ab einem Gesamtbetrag von {{sponsoring_receipt_minimum_amount}}{{currency_symbol}} ausgestellt werden",
+  "sponsoring_amount_per_distance": "mit einem Betrag von _____{{currency_symbol}} pro gelaufenem Kilometer zu unterstützen.",
+  "sponsoring_subtitle": "Ich/Wir sind bereit anlässlich des {{eventname}}",
+  "sponsoring_title": "Sponsoringerklärung",
+  "street": "Straße",
+  "urkunde": "Urkunde",
+  "hat-beim-eventname": "Hat beim {{../eventname}}",
+  "fuer-den-guten-zweck-zurueckgelegt": "für den guten Zweck zurückgelegt",
+  "sponsorings": "Sponsorings",
+  "sponsor-in": "Sponsor:in",
+  "betrag-km": "Betrag/KM",
+  "gesamtbetrag": "Gesamtbetrag",
+  "gesamt": "Gesamt"
+}

src/locales/en.json

@@ -1,19 +1,28 @@
 {
-    "address": "Address",
-    "city": "City",
-    "date": "date",
-    "firstname": "First name",
-    "group": "Team/class",
-    "house_number": "House number",
-    "lastname": "Last name",
-    "location": "Location",
-    "please_use_blockletters": "Please write in BLOCK LETTERS.",
-    "postalcode": "Postal code",
-    "signature": "Signature",
-    "sponsor": "sponsor",
-    "sponsoring_address_condition": "You have to provide an address if you want a donation receipt - Donation receipts can't be issued for total donation amounts under {{sponsoring_receipt_minimum_amount}}{{currency_symbol}}",
-    "sponsoring_amount_per_distance": "with the amount of _____{{currency_symbol}} per kilometer run.",
-    "sponsoring_subtitle": "On the ocation of the {{eventname}} I/We want to support",
-    "sponsoring_title": "Sponsoring contract",
-    "street": "Street"
-}
+  "address": "Address",
+  "city": "City",
+  "date": "date",
+  "firstname": "First name",
+  "group": "Team/class",
+  "house_number": "House number",
+  "lastname": "Last name",
+  "location": "Location",
+  "please_use_blockletters": "Please write in BLOCK LETTERS.",
+  "postalcode": "Postal code",
+  "signature": "Signature",
+  "sponsor": "sponsor",
+  "sponsoring_address_condition": "You have to provide an address if you want a donation receipt - Donation receipts can't be issued for total donation amounts under {{sponsoring_receipt_minimum_amount}}{{currency_symbol}}",
+  "sponsoring_amount_per_distance": "with the amount of _____{{currency_symbol}} per kilometer run.",
+  "sponsoring_subtitle": "On the ocation of the {{eventname}} I/We want to support",
+  "sponsoring_title": "Sponsoring contract",
+  "street": "Street",
+  "urkunde": "Certifcate",
+  "fuer-den-guten-zweck-zurueckgelegt": "for our good cuse at the {eventname}",
+  "hat-beim-eventname": "Ran",
+  "id": "ID",
+  "sponsorings": "Donations",
+  "sponsor-in": "Donor",
+  "betrag-km": "Amount/KM",
+  "gesamtbetrag": "Total",
+  "gesamt": "Combined"
+}