feat: custom signature template

Signed-off-by: Vitor Mattos <vitor@php.rio>

Author: vitormattos

lib/Handler/FooterHandler.php

@@ -158,7 +158,7 @@ private function getTemplate(): string {
 		if ($footerTemplate) {
 			return $footerTemplate;
 		}
-		return (string) file_get_contents(__DIR__ . '/Templates/footer.teig');
+		return (string)file_get_contents(__DIR__ . '/Templates/footer.teig');
 	}
 
 	private function getQrCodeImageBase64(string $text): string {

lib/Handler/ISignEngineHandler.php

@@ -19,4 +19,6 @@ public function setPassword(string $password): self;
 	public function getPassword(): string;
 	public function sign(): File;
 	public function getSignedContent(): string;
+	public function getSignatureText(): string;
+	public function setSignatureText(string $text): self;
 }

lib/Handler/JSignPdfHandler.php

@@ -121,18 +121,20 @@ private function signUsingVisibleElements(): string {
 			$param = $this->getJSignParam();
 			$originalParam = clone $param;
 			foreach ($visibleElements as $element) {
-				$param
-					->setJSignParameters(
-						$originalParam->getJSignParameters() .
-						' -pg ' . $element->getFileElement()->getPage() .
-						' -llx ' . $element->getFileElement()->getLlx() .
-						' -lly ' . $element->getFileElement()->getLly() .
-						' -urx ' . $element->getFileElement()->getUrx() .
-						' -ury ' . $element->getFileElement()->getUry() .
-						' --l2-text ""' .
-						' -V' .
-						' --bg-path ' . $element->getTempFile()
-					);
+				$params = [
+					'-pg' => $element->getFileElement()->getPage(),
+					'-llx' => $element->getFileElement()->getLlx(),
+					'-lly' => $element->getFileElement()->getLly(),
+					'-urx' => $element->getFileElement()->getUrx(),
+					'-ury' => $element->getFileElement()->getUry(),
+					'--l2-text' => $this->getSignatureText(),
+					'-V' => null,
+					'--bg-path' => $element->getTempFile(),
+				];
+				$param->setJSignParameters(
+					$originalParam->getJSignParameters() .
+					$this->listParamsToString($params)
+				);
 				$jSignPdf->setParam($param);
 				$signed = $this->signWrapper($jSignPdf);
 				$param->setPdf($signed);
@@ -142,6 +144,23 @@ private function signUsingVisibleElements(): string {
 		return '';
 	}
 
+	public function getSignatureText(): string {
+		$signatureText = parent::getSignatureText();
+		$signatureText = '"' . str_replace('"', '\"', $signatureText) . '"';
+		return $signatureText;
+	}
+
+	private function listParamsToString(array $params): string {
+		$paramString = '';
+		foreach ($params as $flag => $value) {
+			$paramString .= ' ' . $flag;
+			if ($value !== null && $value !== '') {
+				$paramString .= ' ' . $value;
+			}
+		}
+		return $paramString;
+	}
+
 	private function signWrapper(JSignPDF $jSignPDF): string {
 		try {
 			$param = $this->getJSignParam();

lib/Handler/Pkcs12Handler.php

@@ -81,7 +81,7 @@ public function updatePassword(string $uid, string $currentPrivateKey, string $n
 		return $this->savePfx($uid, $content);
 	}
 
-	public function readCertificate(string $uid, string $privateKey): array {
+	public function readCertificate(?string $uid = null, string $privateKey = ''): array {
 		$this->setPassword($privateKey);
 		$pfx = $this->getPfx($uid);
 		return $this->certificateEngineHandler->getEngine()->readCertificate(
@@ -422,6 +422,7 @@ public function sign(): File {
 			->setCertificate($this->getCertificate())
 			->setInputFile($this->getInputFile())
 			->setPassword($this->getPassword())
+			->setSignatureText($this->getSignatureText())
 			->setVisibleElements($this->getVisibleElements())
 			->getSignedContent();
 		$this->getInputFile()->putContent($signedContent);

lib/Handler/SignEngineHandler.php

@@ -17,6 +17,7 @@ abstract class SignEngineHandler implements ISignEngineHandler {
 	private string $password = '';
 	/** @var VisibleElementAssoc[] */
 	private array $visibleElements = [];
+	private string $signatureText = '';
 
 	/**
 	 * @return static
@@ -70,4 +71,13 @@ public function getVisibleElements(): array {
 	public function getSignedContent(): string {
 		return $this->sign()->getContent();
 	}
+
+	public function getSignatureText(): string {
+		return $this->signatureText;
+	}
+
+	public function setSignatureText(string $text): self {
+		$this->signatureText = $text;
+		return $this;
+	}
 }

lib/Service/SignFileService.php

@@ -97,6 +97,7 @@ public function __construct(
 		private ITempManager $tempManager,
 		private IdentifyMethodService $identifyMethodService,
 		private ITimeFactory $timeFactory,
+		private SignatureTextService $signatureTextService,
 	) {
 	}
 
@@ -263,11 +264,18 @@ public function sign(): File {
 		$pfxFileContent = $this->getPfxFile();
 		switch (strtolower($fileToSign->getExtension())) {
 			case 'pdf':
+				$pfxData = $this->getPfxData();
 				$signedFile = $this->pkcs12Handler
 					->setInputFile($fileToSign)
 					->setCertificate($pfxFileContent)
 					->setVisibleElements($this->elements)
 					->setPassword($this->password)
+					->setSignatureText($this->signatureTextService->parse(context: [
+						'SignerName' => '\${signer}',
+						'DocumentUUID' => $this->libreSignFile->getUuid(),
+						'IssuerCommonName' => $pfxData['issuer']['CN'],
+						'SignatureDate' => '\${timestamp}',
+					]))
 					->sign();
 				break;
 			default:
@@ -377,6 +385,10 @@ private function getPfxFile(): string {
 		return $this->pkcs12Handler->getPfx();
 	}
 
+	private function getPfxData(): array {
+		return $this->pkcs12Handler->readCertificate(privateKey: $this->password);
+	}
+
 	/**
 	 * Get file to sign
 	 *

lib/Service/SignatureTextService.php

@@ -25,15 +25,15 @@ public function save(string $template): string {
 		return $this->parse($template);
 	}
 
-	public function parse(string $template, array $context = []): string {
+	public function parse(string $template = '', array $context = []): string {
 		if (empty($template)) {
 			$template = $this->appConfig->getAppValueString('signature_text_template');
 		}
 		if (empty($context)) {
 			$context = [
 				'SignerName' => 'John Doe',
 				'DocumentUUID' => UUIDUtil::getUUID(),
-				'CommonName' => 'Acme Cooperative',
+				'IssuerCommonName' => 'Acme Cooperative',
 				'SignatureDate' => (new \DateTime())->format(DateTimeInterface::ATOM)
 			];
 		}
@@ -45,7 +45,7 @@ public function parse(string $template, array $context = []): string {
 				->createTemplate($template)
 				->render($context);
 		} catch (SyntaxError $e) {
-			return (string) preg_replace('/in "[^"]+" at line \d+/', '', $e->getMessage());
+			return (string)preg_replace('/in "[^"]+" at line \d+/', '', $e->getMessage());
 		}
 	}
 }