Compare commits

..

No commits in common. "ff36b4871f2d696c0b86883d529365ee8f1c6132" and "03f63e3777381a4475910e6fa4a3986f87b73f39" have entirely different histories.

6 changed files with 239 additions and 298 deletions

View File

@ -40,9 +40,7 @@
"license": "CC-BY-NC-SA-4.0", "license": "CC-BY-NC-SA-4.0",
"dependencies": { "dependencies": {
"@odit/class-validator-jsonschema": "^2.1.1", "@odit/class-validator-jsonschema": "^2.1.1",
"async-helpers": "^0.3.17",
"axios": "^0.21.1", "axios": "^0.21.1",
"bwip-js": "^2.0.12",
"cheerio": "^1.0.0-rc.5", "cheerio": "^1.0.0-rc.5",
"class-transformer": "0.3.1", "class-transformer": "0.3.1",
"class-validator": "^0.13.1", "class-validator": "^0.13.1",

View File

@ -1,206 +1,199 @@
import axios from 'axios'; import axios from 'axios';
import cheerio from "cheerio"; import cheerio from "cheerio";
import fs from "fs"; import fs from "fs";
import Handlebars from 'handlebars'; import Handlebars from 'handlebars';
import i18next from "i18next"; import i18next from "i18next";
import Backend from 'i18next-fs-backend'; import Backend from 'i18next-fs-backend';
import mime from "mime-types"; import mime from "mime-types";
import path from 'path'; import path from 'path';
import { PDFDocument } from 'pdf-lib'; import { PDFDocument } from 'pdf-lib';
import puppeteer from "puppeteer"; import puppeteer from "puppeteer";
import { awaitAsyncHandlebarHelpers, helpers } from './asyncHelpers'; import { config } from './config';
import { config } from './config'; import { Runner } from './models/Runner';
import { Runner } from './models/Runner'; import { RunnerGroup } from './models/RunnerGroup';
import { RunnerGroup } from './models/RunnerGroup'; /**
* This class is responsible for all things pdf creation.
/** * This uses the html templates from src/templates.
* This class is responsible for all things pdf creation. */
* This uses the html templates from src/templates. export class PdfCreator {
*/ private templateDir = path.join(__dirname, '/templates');
export class PdfCreator { private browser;
private templateDir = path.join(__dirname, '/templates'); private static interpolations = { eventname: config.eventname, sponsoring_receipt_minimum_amount: config.sponsoring_receipt_minimum_amount, currency_symbol: config.currency_symbol }
private browser;
private static interpolations = { eventname: config.eventname, sponsoring_receipt_minimum_amount: config.sponsoring_receipt_minimum_amount, currency_symbol: config.currency_symbol } /**
* Main constructor.
/** * Initializes i18n(ext), Handlebars and puppeteer.
* Main constructor. */
* Initializes i18n(ext), Handlebars and puppeteer. constructor() {
*/ this.init();
constructor() { }
this.init();
} /**
* Main constructor.
/** * Initializes i18n(ext), Handlebars and puppeteer.
* Main constructor. */
* Initializes i18n(ext), Handlebars and puppeteer. public async init() {
*/ const minimal_args = [
public async init() { '--autoplay-policy=user-gesture-required',
const minimal_args = [ '--disable-background-networking',
'--autoplay-policy=user-gesture-required', '--disable-background-timer-throttling',
'--disable-background-networking', '--disable-backgrounding-occluded-windows',
'--disable-background-timer-throttling', '--disable-breakpad',
'--disable-backgrounding-occluded-windows', '--disable-client-side-phishing-detection',
'--disable-breakpad', '--disable-component-update',
'--disable-client-side-phishing-detection', '--disable-default-apps',
'--disable-component-update', '--disable-dev-shm-usage',
'--disable-default-apps', '--disable-domain-reliability',
'--disable-dev-shm-usage', '--disable-extensions',
'--disable-domain-reliability', '--disable-features=AudioServiceOutOfProcess',
'--disable-extensions', '--disable-hang-monitor',
'--disable-features=AudioServiceOutOfProcess', '--disable-ipc-flooding-protection',
'--disable-hang-monitor', '--disable-notifications',
'--disable-ipc-flooding-protection', '--disable-offer-store-unmasked-wallet-cards',
'--disable-notifications', '--disable-popup-blocking',
'--disable-offer-store-unmasked-wallet-cards', '--disable-print-preview',
'--disable-popup-blocking', '--disable-prompt-on-repost',
'--disable-print-preview', '--disable-renderer-backgrounding',
'--disable-prompt-on-repost', '--disable-speech-api',
'--disable-renderer-backgrounding', '--disable-sync',
'--disable-speech-api', '--hide-scrollbars',
'--disable-sync', '--ignore-gpu-blacklist',
'--hide-scrollbars', '--metrics-recording-only',
'--ignore-gpu-blacklist', '--mute-audio',
'--metrics-recording-only', '--no-default-browser-check',
'--mute-audio', '--no-first-run',
'--no-default-browser-check', '--no-pings',
'--no-first-run', '--no-zygote',
'--no-pings', '--password-store=basic',
'--no-zygote', '--use-gl=swiftshader',
'--password-store=basic', '--no-sandbox'
'--use-gl=swiftshader', ];
'--no-sandbox'
]; await i18next
await i18next .use(Backend)
.use(Backend) .init({
.init({ fallbackLng: 'en',
fallbackLng: 'en', lng: 'en',
lng: 'en', backend: {
backend: { loadPath: path.join(__dirname, '/locales/{{lng}}.json')
loadPath: path.join(__dirname, '/locales/{{lng}}.json') }
} });
}); await Handlebars.registerHelper('__',
function (str) {
await Handlebars.registerHelper(helpers); return i18next.t(str, PdfCreator.interpolations).toString();
await Handlebars.registerHelper('__', }
function (str) { );
return i18next.t(str, PdfCreator.interpolations).toString(); this.browser = await puppeteer.launch({ headless: true, args: minimal_args });
} }
);
this.browser = await puppeteer.launch({ headless: true, args: minimal_args }); /**
} * 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)
* Generate sponsoring contract pdfs. */
* @param runner The runner you want to generate the contracts for. public async generateSponsoringContract(runners: Runner[], locale: string = "en"): Promise<Buffer> {
* @param locale The locale used for the contracts (default:en) if (runners.length == 1 && Object.keys(runners[0]).length == 0) {
*/ runners[0] = this.generateEmptyRunner();
public async generateSponsoringContract(runners: Runner[], locale: string = "en", codeformat: string = config.codeformat): Promise<Buffer> { }
if (runners.length == 1 && Object.keys(runners[0]).length == 0) { if (runners.length > 50) {
runners[0] = this.generateEmptyRunner(); let pdf_promises = new Array<Promise<Buffer>>();
} let i, j;
if (runners.length > 50) { for (i = 0, j = runners.length; i < j; i += 50) {
let pdf_promises = new Array<Promise<Buffer>>(); let chunk = runners.slice(i, i + 50);
let i, j; pdf_promises.push(this.generateSponsoringContract(chunk, locale));
for (i = 0, j = runners.length; i < j; i += 50) { }
let chunk = runners.slice(i, i + 50); const pdfs = await Promise.all(pdf_promises);
pdf_promises.push(this.generateSponsoringContract(chunk, locale)); return await this.mergePdfs(pdfs);
} }
const pdfs = await Promise.all(pdf_promises); await i18next.changeLanguage(locale);
return await this.mergePdfs(pdfs); const template_source = fs.readFileSync(`${this.templateDir}/sponsoring_contract.html`, 'utf8');
} const template = Handlebars.compile(template_source);
await i18next.changeLanguage(locale); const result = template({ runners })
const template_source = fs.readFileSync(`${this.templateDir}/sponsoring_contract.html`, 'utf8'); const pdf = await this.renderPdf(result, { format: "A5", landscape: true });
const template = Handlebars.compile(template_source); return pdf
let result = template({ runners, codeformat }); }
result = await awaitAsyncHandlebarHelpers(result);
const pdf = await this.renderPdf(result, { format: "A5", landscape: true }); /**
return pdf * Converts all images in html to base64.
} * Works with image files in the template directory or images from urls.
* @param html The html string whoms images shall get replaced.
/** */
* Converts all images in html to base64. public async imgToBase64(html): Promise<string> {
* Works with image files in the template directory or images from urls. const $ = cheerio.load(html)
* @param html The html string whoms images shall get replaced. $('img').each(async (index, element) => {
*/ let imgsrc = $(element).attr("src");
public async imgToBase64(html): Promise<string> { const img_type = mime.lookup(imgsrc);
const $ = cheerio.load(html)
$('img').each(async (index, element) => { if (!(img_type.includes("image"))) {
let imgsrc = $(element).attr("src"); throw new Error("File is not image mime type");
if (imgsrc.startsWith("data:image")) { }
return;
} let image;
const img_type = mime.lookup(imgsrc); if (imgsrc.startsWith("http")) {
image = (await axios.get(imgsrc)).data;
if (!(img_type.includes("image"))) { image = Buffer.from(image).toString('base64');
throw new Error("File is not image mime type"); }
} else {
if (imgsrc.startsWith("./")) {
let image; imgsrc = imgsrc.replace("./", "");
if (imgsrc.startsWith("http")) { }
image = (await axios.get(imgsrc)).data; image = fs.readFileSync(`${this.templateDir}/${imgsrc}`, { encoding: "base64" });
image = Buffer.from(image).toString('base64'); }
}
else { image = `data:${img_type};base64,${image}`
if (imgsrc.startsWith("./")) { $(element).attr("src", image)
imgsrc = imgsrc.replace("./", ""); })
}
image = fs.readFileSync(`${this.templateDir}/${imgsrc}`, { encoding: "base64" }); return $.html();
} }
image = `data:${img_type};base64,${image}` /**
$(element).attr("src", image) * This method manages the creation of pdfs via puppeteer.
}) * @param html The HTML that should get rendered.
* @param options Puppeteer PDF option (eg: {format: "A4"})
return $.html(); */
} public async renderPdf(html: string, options): Promise<any> {
html = await this.imgToBase64(html);
/** let page = await this.browser.newPage();
* This method manages the creation of pdfs via puppeteer. await page.setContent(html);
* @param html The HTML that should get rendered. const pdf = await page.pdf(options);
* @param options Puppeteer PDF option (eg: {format: "A4"}) await page.close();
*/ return pdf;
public async renderPdf(html: string, options): Promise<any> { }
html = await this.imgToBase64(html);
let page = await this.browser.newPage(); /**
await page.setContent(html); * Merges multiple pdfs into one.
const pdf = await page.pdf(options); * @param pdfs The pdfs you want to merge as an buffer array.
await page.close(); * @returns The merged pdf as a buffer.
return pdf; */
} private async mergePdfs(pdfs: Buffer[]): Promise<Buffer> {
const mergedPdf = await PDFDocument.create();
/**
* Merges multiple pdfs into one. for (const pdfBuffer of pdfs) {
* @param pdfs The pdfs you want to merge as an buffer array. const pdf = await PDFDocument.load(pdfBuffer);
* @returns The merged pdf as a buffer. const copiedPages = await mergedPdf.copyPages(pdf, pdf.getPageIndices());
*/ copiedPages.forEach((page) => {
private async mergePdfs(pdfs: Buffer[]): Promise<Buffer> { mergedPdf.addPage(page);
const mergedPdf = await PDFDocument.create(); });
}
for (const pdfBuffer of pdfs) {
const pdf = await PDFDocument.load(pdfBuffer); return <Buffer>(await mergedPdf.save());
const copiedPages = await mergedPdf.copyPages(pdf, pdf.getPageIndices()); }
copiedPages.forEach((page) => {
mergedPdf.addPage(page); /**
}); * Generates a new dummy runner with halfspaces for all strings.
} * Can be used to generate empty sponsoring contracts.
* @returns A new runner object that apears to be empty.
return <Buffer>(await mergedPdf.save()); */
} private generateEmptyRunner(): Runner {
let group = new RunnerGroup();
/** group.id = 0;
* Generates a new dummy runner with halfspaces for all strings. group.name = "";
* Can be used to generate empty sponsoring contracts. let runner = new Runner();
* @returns A new runner object that apears to be empty. runner.id = 0;
*/ runner.firstname = "";
private generateEmptyRunner(): Runner { runner.lastname = "";
let group = new RunnerGroup(); runner.group = group;
group.id = 0; return runner;
group.name = ""; }
let runner = new Runner();
runner.id = 0;
runner.firstname = "";
runner.lastname = "";
runner.group = group;
return runner;
}
} }

File diff suppressed because one or more lines are too long

View File

@ -1,20 +1,19 @@
import { config as configDotenv } from 'dotenv'; import { config as configDotenv } from 'dotenv';
configDotenv(); configDotenv();
export const config = { export const config = {
internal_port: parseInt(process.env.APP_PORT) || 4010, internal_port: parseInt(process.env.APP_PORT) || 4010,
development: process.env.NODE_ENV === "production", development: process.env.NODE_ENV === "production",
version: process.env.VERSION || require('../package.json').version, version: process.env.VERSION || require('../package.json').version,
eventname: process.env.EVENT_NAME || "Please set the event name", eventname: process.env.EVENT_NAME || "Please set the event name",
currency_symbol: process.env.CURRENCY_SYMBOL || "€", currency_symbol: process.env.CURRENCY_SYMBOL || "€",
sponsoring_receipt_minimum_amount: process.env.SPONSORING_RECEIPT_MINIMUM_AMOUNT || "10", sponsoring_receipt_minimum_amount: process.env.SPONSORING_RECEIPT_MINIMUM_AMOUNT || "10"
codeformat: process.env.CODEFORMAT || "qrcode" }
} let errors = 0
let errors = 0 if (typeof config.internal_port !== "number") {
if (typeof config.internal_port !== "number") { errors++
errors++ }
} if (typeof config.development !== "boolean") {
if (typeof config.development !== "boolean") { errors++
errors++ }
}
export let e = errors export let e = errors

View File

@ -15,7 +15,7 @@ export class PdfController {
@Post('/contracts') @Post('/contracts')
@OpenAPI({ description: "Generate Sponsoring contract pdfs from 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)." }) @OpenAPI({ description: "Generate Sponsoring contract pdfs from 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 generateContracts(@Body({ validate: true, options: { limit: "500mb" } }) runners: Runner | Runner[], @Res() res: any, @QueryParam("locale") locale: string, @QueryParam("codeformat") codeformat: string) { async generateContracts(@Body({ validate: true, options: { limit: "500mb" } }) runners: Runner | Runner[], @Res() res: any, @QueryParam("locale") locale: string) {
if (!this.initialized) { if (!this.initialized) {
await this.pdf.init(); await this.pdf.init();
this.initialized = true; this.initialized = true;
@ -23,7 +23,7 @@ export class PdfController {
if (!Array.isArray(runners)) { if (!Array.isArray(runners)) {
runners = [runners]; runners = [runners];
} }
const contracts = await this.pdf.generateSponsoringContract(runners, locale, codeformat); const contracts = await this.pdf.generateSponsoringContract(runners, locale);
res.setHeader('content-type', 'application/pdf'); res.setHeader('content-type', 'application/pdf');
return contracts; return contracts;
} }

View File

@ -29,36 +29,31 @@
<div class="sheet"> <div class="sheet">
<img id="header_img" width="100%" src="sponsoringheader.png" /> <img id="header_img" width="100%" src="sponsoringheader.png" />
<div style=" padding: 0 1rem 0 1rem;"> <div style=" padding: 0 1rem 0 1rem;">
<div class="columns"> <div class="columns" style="padding-bottom: 0;">
<div class="column is-10"> <div class="column is-two-fifths">
<div class="columns" style="padding-bottom: 0;"> <p style="font-size: large; font-weight: bold;">{{__ "sponsoring_title"}}</p>
<div class="column is-two-fifths">
<p style="font-size: large; font-weight: bold;">{{__ "sponsoring_title"}}</p>
</div>
<div class="column">
<p style="font-size: x-small; vertical-align: revert; margin-top: auto;">{{__ "please_use_blockletters"}}
</p>
</div>
</div>
<p> {{__ "sponsoring_subtitle"}} </p>
<div class="columns">
<div class="column is-9">
<span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.firstname}}
{{this.middlename}}</span>
<p style="font-size: x-small; display: block;">{{__ "firstname"}}</p>
</div>
<div class="column is-3">
<span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.id}}</span>
<p style="font-size: x-small; display: block;">ID</p>
</div>
</div>
</div> </div>
<div class="column"> <div class="column">
<img style="vertical-align: revert; margin-top: auto; object-fit: cover; max-height: 2cm;" <p style="font-size: x-small; vertical-align: revert; margin-top: auto;">{{__ "please_use_blockletters"}}
src="{{--bc this.id ../codeformat}}" /> </p>
</div> </div>
</div> </div>
<div class="columns" style="padding-top: 1rem;"> <p> {{__ "sponsoring_subtitle"}} </p>
<div class="columns" style="padding-top: 0;">
<div class="column is-8">
<span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.firstname}}
{{this.middlename}}</span>
<p style="font-size: x-small; display: block;">{{__ "firstname"}}</p>
</div>
<div class="column is-2">
<span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.id}}</span>
<p style="font-size: x-small; display: block;">ID</p>
</div>
<div class="column">
<!-- CODE Here -->
</div>
</div>
<div class="columns">
<div class="column is-6"> <div class="column is-6">
<span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.lastname}}</span> <span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.lastname}}</span>
<p style="font-size: x-small; display: block;">{{__ "lastname"}}</p> <p style="font-size: x-small; display: block;">{{__ "lastname"}}</p>