Merge pull request 'feature/#35-list-printing' (#76) from feature/#35-list-printing into develop

Reviewed-on: #76

src/controller/admin/club/listprintController.ts

@@ -0,0 +1,60 @@
+import { Request, Response } from "express";
+import { PdfExport } from "../../../helpers/pdfExport";
+import DynamicQueryBuilder from "../../../helpers/dynamicQueryBuilder";
+import QueryStoreService from "../../../service/configuration/queryStoreService";
+import InternalException from "../../../exceptions/internalException";
+
+/**
+ * @description print list by query and template
+ * @param req {Request} Express req object
+ * @param res {Response} Express res object
+ * @returns {Promise<*>}
+ */
+export async function printListByQueryAndTemplate(req: Request, res: Response): Promise<any> {
+  const title = req.body.title;
+  const queryStore = req.body.queryStore;
+  const headerId = req.body.headerId ?? null;
+  const bodyId = req.body.bodyId ?? null;
+  const footerId = req.body.footerId ?? null;
+  const headerHeight = req.body.headerHeight ?? null;
+  const footerHeight = req.body.footerHeight ?? null;
+
+  let query = queryStore;
+  if (queryStore != "member" && queryStore != "memberByRunningMembership") {
+    query = (await QueryStoreService.getById(queryStore)).query;
+  }
+
+  let data = await DynamicQueryBuilder.executeQuery({
+    query: query.startsWith("{") ? JSON.parse(query) : query,
+    noLimit: true,
+  });
+
+  if (data.stats == "error") {
+    throw new InternalException("Failed executing Query");
+  }
+
+  let pdf = await PdfExport.renderFile({
+    title: title,
+    template: "listprint",
+    saveToDisk: false,
+    data: {
+      today: new Date(),
+      list: data.rows,
+    },
+    customTemplate: {
+      headerId,
+      footerId,
+      bodyId,
+      headerHeight,
+      footerHeight,
+    },
+  });
+
+  let pdfbuffer = Buffer.from(pdf);
+
+  res.setHeader("Content-Type", "application/pdf");
+  res.setHeader("Content-Length", pdfbuffer.byteLength);
+  res.setHeader("Content-Disposition", "inline; filename=preview.pdf");
+
+  res.send(pdfbuffer);
+}

src/controller/admin/club/memberController.ts

@@ -305,33 +305,6 @@ export async function getCommunicationByMemberAndRecord(req: Request, res: Respo
   res.json(CommunicationFactory.mapToSingle(communication));
 }
 
-/**
- * @description create member printout list
- * @param req {Request} Express req object
- * @param res {Response} Express res object
- * @returns {Promise<*>}
- */
-export async function createMemberPrintoutList(req: Request, res: Response): Promise<any> {
-  let members = await MemberService.getByRunningMembership();
-
-  let pdf = await PdfExport.renderFile({
-    title: "Mitgliederliste",
-    template: "member.list",
-    saveToDisk: false,
-    data: {
-      member: members,
-    },
-  });
-
-  let pdfbuffer = Buffer.from(pdf);
-
-  res.setHeader("Content-Type", "application/pdf");
-  res.setHeader("Content-Length", pdfbuffer.byteLength);
-  res.setHeader("Content-Disposition", "inline; filename=preview.pdf");
-
-  res.send(pdfbuffer);
-}
-
 /**
  * @description create member
  * @param req {Request} Express req object

src/data-source.ts

@@ -48,6 +48,7 @@ import { salutation } from "./entity/configuration/salutation";
 import { BackupAndResetDatabase1738166124200 } from "./migrations/1738166124200-BackupAndResetDatabase";
 import { CreateSchema1738166167472 } from "./migrations/1738166167472-CreateSchema";
 import { MemberPrintoutTemplates1742207245862 } from "./migrations/1742207245862-memberPrintoutTemplates";
+import { Listprinting1742311486232 } from "./migrations/1742311486232-listprinting";
 
 const dataSource = new DataSource({
   type: DB_TYPE as any,
@@ -101,7 +102,12 @@ const dataSource = new DataSource({
     webapi,
     webapiPermission,
   ],
-  migrations: [BackupAndResetDatabase1738166124200, CreateSchema1738166167472, MemberPrintoutTemplates1742207245862],
+  migrations: [
+    BackupAndResetDatabase1738166124200,
+    CreateSchema1738166167472,
+    MemberPrintoutTemplates1742207245862,
+    Listprinting1742311486232,
+  ],
   migrationsRun: true,
   migrationsTransactionMode: "each",
   subscribers: [],

src/demodata/member.list.data.ts

@@ -1,13 +0,0 @@
-import { member } from "../entity/club/member/member";
-import { protocolAgenda } from "../entity/club/protocol/protocolAgenda";
-import { protocolDecision } from "../entity/club/protocol/protocolDecision";
-import { protocolVoting } from "../entity/club/protocol/protocolVoting";
-
-export const memberlistDemoData: { member: Array<Partial<member>> } = {
-  member: [
-    {
-      firstname: "Julian",
-      lastname: "Krauser",
-    },
-  ]
-}

src/handlebars.config.ts

@@ -0,0 +1,32 @@
+import Handlebars from "handlebars";
+
+Handlebars.registerHelper("date", function (aString) {
+  return new Date(aString).toLocaleDateString("de-DE", {
+    day: "2-digit",
+    month: "2-digit",
+    year: "numeric",
+  });
+});
+
+Handlebars.registerHelper("longdate", function (aString) {
+  return new Date(aString).toLocaleDateString("de-DE", {
+    weekday: "long",
+    day: "2-digit",
+    month: "2-digit",
+    year: "numeric",
+  });
+});
+
+Handlebars.registerHelper("datetime", function (aString) {
+  return new Date(aString).toLocaleDateString("de-DE", {
+    day: "2-digit",
+    month: "2-digit",
+    year: "numeric",
+    hour: "2-digit",
+    minute: "2-digit",
+  });
+});
+
+Handlebars.registerHelper("json", function (context) {
+  return JSON.stringify(context);
+});

src/helpers/demoDataHelper.ts

@@ -1,7 +1,6 @@
 import { newsletterDemoData } from "../demodata/newsletter.data";
 import { protocolDemoData } from "../demodata/protocol.data";
 import { PermissionModule } from "../type/permissionTypes";
-import { memberlistDemoData } from "../demodata/member.list.data";
 import { memberDemoData } from "../demodata/member.data";
 
 export abstract class DemoDataHelper {
@@ -11,8 +10,6 @@ export abstract class DemoDataHelper {
         return protocolDemoData;
       case "newsletter":
         return newsletterDemoData;
-      case "member.list":
-        return memberlistDemoData;
       case "member":
         return memberDemoData;
       default:

src/helpers/dynamicQueryBuilder.ts

@@ -314,6 +314,13 @@ export default abstract class DynamicQueryBuilder {
         count: number;
       }
   > {
+    if (query == "member") {
+      query = memberQuery;
+    }
+    if (query == "memberByRunningMembership") {
+      query = memberByRunningMembershipQuery;
+    }
+
     if (typeof query == "string") {
       const upperQuery = query.trim().toUpperCase();
       if (!upperQuery.startsWith("SELECT") || /INSERT|UPDATE|DELETE|ALTER|DROP|CREATE|TRUNCATE/.test(upperQuery)) {
@@ -330,7 +337,7 @@ export default abstract class DynamicQueryBuilder {
 
         return await dataSource
           .transaction(async (manager) => {
-            data = await manager.query(query);
+            data = await manager.query(query.toString());
 
             throw new Error("AllwaysRollbackQuery");
           })
@@ -382,3 +389,29 @@ export default abstract class DynamicQueryBuilder {
     }
   }
 }
+
+const memberQuery: DynamicQueryStructure = {
+  select: "*",
+  table: "member",
+  orderBy: [
+    { column: "lastname", order: "ASC" },
+    { column: "firstname", order: "ASC" },
+  ],
+};
+
+const memberByRunningMembershipQuery: DynamicQueryStructure = {
+  select: "*",
+  table: "member",
+  join: [
+    {
+      select: "*",
+      table: "membership",
+      where: [{ structureType: "condition", concat: "_", operation: "null", column: "end", value: "" }],
+      foreignColumn: "memberships",
+    },
+  ],
+  orderBy: [
+    { column: "lastname", order: "ASC" },
+    { column: "firstname", order: "ASC" },
+  ],
+};

src/helpers/pdfExport.ts

@@ -12,6 +12,7 @@ export abstract class PdfExport {
     data = {},
     saveToDisk = true,
     folder = "",
+    customTemplate = undefined,
   }: {
     template: `${PermissionModule}` | `${PermissionModule}.${string}`;
     title?: string;
@@ -19,16 +20,35 @@ export abstract class PdfExport {
     data?: any;
     saveToDisk?: boolean;
     folder?: string;
+    customTemplate?: {
+      headerId?: number;
+      footerId?: number;
+      bodyId?: string | number;
+      headerHeight: number;
+      footerHeight: number;
+    };
   }) {
     if (folder != "") FileSystemHelper.createFolder(folder);
 
-    const { header, footer, body, headerMargin, footerMargin } = await TemplateHelper.renderFileForModule({
-      module: template,
-      headerData: data,
-      bodyData: data,
-      footerData: data,
-      title: title,
-    });
+    let header: string, footer: string, body: string, headerMargin: number, footerMargin: number;
+    if (!customTemplate) {
+      ({ header, footer, body, headerMargin, footerMargin } = await TemplateHelper.renderFileForModule({
+        module: template,
+        headerData: data,
+        bodyData: data,
+        footerData: data,
+        title: title,
+      }));
+    } else {
+      ({ header, footer, body, headerMargin, footerMargin } = await TemplateHelper.renderFileForCustom({
+        module: template,
+        customTemplate,
+        headerData: data,
+        bodyData: data,
+        footerData: data,
+        title: title,
+      }));
+    }
 
     const browser = await puppeteer.launch({
       headless: true,

src/helpers/templateHelper.ts

@@ -4,36 +4,15 @@ import TemplateUsageService from "../service/configuration/templateUsageService"
 import Handlebars, { template } from "handlebars";
 import { FileSystemHelper } from "./fileSystemHelper";
 
-Handlebars.registerHelper("date", function (aString) {
-  return new Date(aString).toLocaleDateString("de-DE", {
-    day: "2-digit",
-    month: "2-digit",
-    year: "numeric",
-  });
-});
-
-Handlebars.registerHelper("longdate", function (aString) {
-  return new Date(aString).toLocaleDateString("de-DE", {
-    weekday: "long",
-    day: "2-digit",
-    month: "2-digit",
-    year: "numeric",
-  });
-});
-
-Handlebars.registerHelper("datetime", function (aString) {
-  return new Date(aString).toLocaleDateString("de-DE", {
-    day: "2-digit",
-    month: "2-digit",
-    year: "numeric",
-    hour: "2-digit",
-    minute: "2-digit",
-  });
-});
-
 export abstract class TemplateHelper {
   static getTemplateFromFile(template: string) {
-    return FileSystemHelper.readTemplateFile(`/src/templates/${template}.template.html`);
+    let tmpFile;
+    try {
+      tmpFile = FileSystemHelper.readTemplateFile(`/src/templates/${template}.template.html`);
+    } catch (err) {
+      tmpFile = FileSystemHelper.readTemplateFile(`/src/templates/${template.split(".")[1]}.template.html`);
+    }
+    return tmpFile;
   }
 
   static async getTemplateFromStore(templateId: number): Promise<string> {
@@ -83,14 +62,14 @@ export abstract class TemplateHelper {
     } else {
       footer = this.getTemplateFromFile(module + ".footer");
     }
-    footer = this.applyDataToTemplate(footer, footerData);
+    footer = this.applyDataToTemplate(footer, { title, ...footerData });
 
     if (moduleTemplate.bodyId) {
       body = await this.getTemplateFromStore(moduleTemplate.bodyId);
     } else {
       body = this.getTemplateFromFile(module + ".body");
     }
-    body = this.applyDataToTemplate(body, bodyData);
+    body = this.applyDataToTemplate(body, { title, ...bodyData });
 
     return {
       header,
@@ -100,4 +79,57 @@ export abstract class TemplateHelper {
       footerMargin: moduleTemplate.footerHeight,
     };
   }
+
+  static async renderFileForCustom({
+    module,
+    title = "pdf-export FF Admin",
+    headerData = {},
+    bodyData = {},
+    footerData = {},
+    customTemplate,
+  }: {
+    module: `${PermissionModule}` | `${PermissionModule}.${string}`;
+    title?: string;
+    headerData?: any;
+    bodyData?: any;
+    footerData?: any;
+    customTemplate: {
+      headerId?: number;
+      footerId?: number;
+      bodyId?: string | number;
+      headerHeight: number;
+      footerHeight: number;
+    };
+  }): Promise<{ header: string; body: string; footer: string; headerMargin?: number; footerMargin?: number }> {
+    let header = `<h1 style="font-size:10px; text-align:center; width:100%;">${title}</h1>`;
+    let footer = "";
+    let body = "";
+
+    if (customTemplate.headerId) {
+      header = await this.getTemplateFromStore(customTemplate.headerId);
+      header = this.applyDataToTemplate(header, { title, ...headerData });
+    }
+
+    if (customTemplate.footerId) {
+      footer = await this.getTemplateFromStore(customTemplate.footerId);
+    } else {
+      footer = this.getTemplateFromFile(module + ".footer");
+    }
+    footer = this.applyDataToTemplate(footer, { title, ...footerData });
+
+    if (customTemplate.bodyId && typeof customTemplate.bodyId == "number") {
+      body = await this.getTemplateFromStore(customTemplate.bodyId);
+    } else {
+      body = this.getTemplateFromFile((customTemplate.bodyId || module) + ".body");
+    }
+    body = this.applyDataToTemplate(body, { title, ...bodyData });
+
+    return {
+      header,
+      footer,
+      body,
+      headerMargin: customTemplate.headerHeight,
+      footerMargin: customTemplate.footerHeight,
+    };
+  }
 }

src/index.ts

@@ -1,4 +1,5 @@
 import "dotenv/config";
+import "./handlebars.config";
 import express from "express";
 
 import { BACKUP_AUTO_RESTORE, configCheck, SERVER_PORT } from "./env.defaults";

src/migrations/1742311486232-listprinting.ts

@@ -0,0 +1,25 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { templateUsage } from "../entity/configuration/templateUsage";
+
+export class Listprinting1742311486232 implements MigrationInterface {
+  name = "Listprinting1742311486232";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.manager
+      .createQueryBuilder()
+      .delete()
+      .from(templateUsage)
+      .where({ scope: "member.list" })
+      .execute();
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.manager
+      .createQueryBuilder()
+      .insert()
+      .into(templateUsage)
+      .values([{ scope: "member.list" }])
+      .orUpdate(["headerId", "bodyId", "footerId", "headerHeight", "footerHeight"], ["scope"])
+      .execute();
+  }
+}

src/routes/admin/club/listprint.ts

@@ -0,0 +1,10 @@
+import express, { Request, Response } from "express";
+import { printListByQueryAndTemplate } from "../../../controller/admin/club/listprintController";
+
+var router = express.Router({ mergeParams: true });
+
+router.post("/", async (req: Request, res: Response) => {
+  await printListByQueryAndTemplate(req, res);
+});
+
+export default router;

src/routes/admin/club/member.ts

@@ -6,7 +6,6 @@ import {
   addMembershipToMember,
   addQualificationToMember,
   createMember,
-  createMemberPrintoutList,
   deleteAwardOfMember,
   deleteCommunicationOfMember,
   deleteExecutivePositionOfMember,
@@ -60,10 +59,6 @@ router.get("/:id/print", async (req: Request, res: Response) => {
   await getMemberPrintoutById(req, res);
 });
 
-router.get("/print/namelist", async (req: Request, res: Response) => {
-  await createMemberPrintoutList(req, res);
-});
-
 router.get("/:memberId/memberships", async (req: Request, res: Response) => {
   await getMembershipsByMember(req, res);
 });

src/routes/admin/index.ts

@@ -19,6 +19,7 @@ import protocol from "./club/protocol";
 import calendar from "./club/calendar";
 import queryBuilder from "./club/queryBuilder";
 import newsletter from "./club/newsletter";
+import listprint from "./club/listprint";
 
 import role from "./management/role";
 import user from "./management/user";
@@ -84,7 +85,14 @@ router.use(
   ]),
   calendarType
 );
-router.use("/querystore", PermissionHelper.passCheckMiddleware("read", "configuration", "query_store"), queryStore);
+router.use(
+  "/querystore",
+  PermissionHelper.passCheckSomeMiddleware([
+    { requiredPermissions: "read", section: "configuration", module: "query_store" },
+    { requiredPermissions: "read", section: "club", module: "listprint" },
+  ]),
+  queryStore
+);
 router.use("/template", PermissionHelper.passCheckMiddleware("read", "configuration", "template"), template);
 router.use(
   "/templateusage",
@@ -132,6 +140,7 @@ router.use(
   ]),
   newsletter
 );
+router.use("/listprint", PermissionHelper.passCheckMiddleware("read", "club", "listprint"), listprint);
 
 router.use("/role", PermissionHelper.passCheckMiddleware("read", "management", "role"), role);
 router.use(

src/templates/listprint.body.template.html

@@ -0,0 +1,48 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Listen-Druck</title>
+  </head>
+  <body>
+    <h1>{{title}}</h1>
+    <p>Ausdruck Stand {{longdate today}}</p>
+    <br />
+
+    <table style="width: 100%">
+      {{#each list}}
+      <tr>
+        <td style="width: 100%; padding: 10px 5px">{{json this}}</td>
+      </tr>
+      {{/each}}
+    </table>
+  </body>
+  <style>
+    h2,
+    h3,
+    p,
+    span,
+    ul,
+    li {
+      padding: 0;
+      margin: 0;
+    }
+
+    h1,
+    h2 {
+      color: #990b00;
+    }
+
+    h2 {
+      margin-bottom: 5px;
+    }
+
+    table,
+    th,
+    td {
+      border: 1px solid black;
+      border-collapse: collapse;
+      text-align: start;
+    }
+  </style>
+</html>

src/templates/listprint.member.body.template.html

@@ -6,15 +6,16 @@
   </head>
   <body>
     <h1>Mitgliederliste</h1>
+    <p>Ausdruck Stand {{longdate today}}</p>
     <br />
 
     <table style="width: 100%">
-      {{#each member}}
+      {{#each list}}
       <tr>
-        <th style="width: 35%; padding: 10px 5px">
+        <td style="width: 35%; padding: 10px 5px">
           {{this.lastname}} {{this.firstname}}{{#if this.nameaffix}} - {{this.nameaffix}}{{/if}}
-        </th>
-        <th style="width: 65%; padding: 10px 0"></th>
+        </td>
+        <td style="width: 65%; padding: 10px 0"></td>
       </tr>
       {{/each}}
     </table>

src/templates/member.list.footer.template.html

@@ -1,3 +0,0 @@
-<div style="font-size: 10px; text-align: center; width: 100%; color: #888">
-  Seite <span class="pageNumber"></span> von <span class="totalPages"></span>
-</div>

src/templates/protocol.footer.template.html

@@ -1,3 +0,0 @@
-<div style="font-size: 10px; text-align: center; width: 100%; color: #888">
-  Seite <span class="pageNumber"></span> von <span class="totalPages"></span>
-</div>

src/type/permissionTypes.ts

@@ -6,6 +6,7 @@ export type PermissionModule =
   | "newsletter"
   | "newsletter_config"
   | "protocol"
+  | "listprint"
   | "qualification"
   | "award"
   | "executive_position"
@@ -50,6 +51,7 @@ export const permissionModules: Array<PermissionModule> = [
   "newsletter",
   "newsletter_config",
   "protocol",
+  "listprint",
   "qualification",
   "award",
   "executive_position",
@@ -68,7 +70,7 @@ export const permissionModules: Array<PermissionModule> = [
 ];
 export const permissionTypes: Array<PermissionType> = ["read", "create", "update", "delete"];
 export const sectionsAndModules: SectionsAndModulesObject = {
-  club: ["member", "calendar", "newsletter", "protocol", "query"],
+  club: ["member", "calendar", "newsletter", "protocol", "query", "listprint"],
   configuration: [
     "qualification",
     "award",