Skip to content

Commit c4b306e

Browse files
vitormattosvitormattos
authored
Merge pull request #4459 from LibreSign/chore/use-fallback-to-get-page-dimension
chore: use fallback to get page dimension
2 parents 73d1893 + c129b34 commit c4b306e

File tree

4 files changed

+142
-16
lines changed

4 files changed

+142
-16
lines changed

‎lib/Helper/ConfigureCheckHelper.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
use JsonSerializable;
1212

1313
/**
14+
* @method ConfigureCheckHelper setSuccessMessage(string $value)
15+
* @method ConfigureCheckHelper setInfoMessage(string $value)
16+
* @method ConfigureCheckHelper setErrorMessage(string $value)
1417
* @method ConfigureCheckHelper setStatus(string $value)
1518
* @method string getStatus()
1619
* @method ConfigureCheckHelper setMessage(string $value)

‎lib/Service/Install/ConfigureCheckService.php‎

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,17 @@ public function checkSign(): array {
6666
}
6767

6868
public function checkPoppler(): array {
69+
$return = $this->checkPdfSig();
70+
$return = array_merge($return, $this->checkPdfinfo());
71+
return $return;
72+
}
73+
74+
public function checkPdfSig(): array {
6975
if (shell_exec('which pdfsig') === null) {
7076
return [
7177
(new ConfigureCheckHelper())
7278
->setInfoMessage('Poppler utils not installed')
73-
->setResource('poppler-utils')
79+
->setResource('pdfsig')
7480
->setTip('Install the package poppler-utils at your operational system to be possible get more details about validation of signatures.'),
7581
];
7682
}
@@ -80,17 +86,17 @@ public function checkPoppler(): array {
8086
if (!$version) {
8187
return [
8288
(new ConfigureCheckHelper())
83-
->setInfoMessage('Fail to retrieve pdfsig version')
84-
->setResource('poppler-utils')
89+
->setErrorMessage('Fail to retrieve pdfsig version')
90+
->setResource('pdfsig')
8591
->setTip("The command <pdfsig -v> executed by PHP haven't any output."),
8692
];
8793
}
8894
$version = preg_match('/pdfsig version (?<version>.*)/', $version, $matches);
8995
if (!$version) {
9096
return [
9197
(new ConfigureCheckHelper())
92-
->setInfoMessage('Fail to retrieve pdfsig version')
93-
->setResource('poppler-utils')
98+
->setErrorMessage('Fail to retrieve pdfsig version')
99+
->setResource('pdfsig')
94100
->setTip("This is a poppler-utils dependency and wasn't possible to parse the output of command pdfsig -v"),
95101
];
96102
}
@@ -100,6 +106,41 @@ public function checkPoppler(): array {
100106
];
101107
}
102108

109+
public function checkPdfinfo(): array {
110+
if (shell_exec('which pdfinfo') === null) {
111+
return [
112+
(new ConfigureCheckHelper())
113+
->setInfoMessage('Poppler utils not installed')
114+
->setResource('pdfinfo')
115+
->setTip('Install the package poppler-utils at your operational system have a fallback to fetch page dimensions.'),
116+
];
117+
}
118+
// The output of this command go to STDERR and shell_exec get the STDOUT
119+
// With 2>&1 the STRERR is redirected to STDOUT
120+
$version = shell_exec('pdfinfo -v 2>&1');
121+
if (!$version) {
122+
return [
123+
(new ConfigureCheckHelper())
124+
->setErrorMessage('Fail to retrieve pdfinfo version')
125+
->setResource('pdfinfo')
126+
->setTip("The command <pdfinfo -v> executed by PHP haven't any output."),
127+
];
128+
}
129+
$version = preg_match('/pdfinfo version (?<version>.*)/', $version, $matches);
130+
if (!$version) {
131+
return [
132+
(new ConfigureCheckHelper())
133+
->setErrorMessage('Fail to retrieve pdfinfo version')
134+
->setResource('pdfinfo')
135+
->setTip("This is a poppler-utils dependency and wasn't possible to parse the output of command pdfinfo -v"),
136+
];
137+
}
138+
return [(new ConfigureCheckHelper())
139+
->setSuccessMessage('pdfinfo version: ' . $matches['version'])
140+
->setResource('pdfinfo')
141+
];
142+
}
143+
103144
/**
104145
* Check all requirements to use JSignPdf
105146
*

‎lib/Service/PdfParserService.php‎

Lines changed: 56 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,19 @@ public function setFile(File|string $file): self {
4141
return $this;
4242
}
4343

44+
private function getContent(): string {
45+
if (!$this->content) {
46+
throw new LibresignException('File not defined to be parsed.');
47+
}
48+
return $this->content;
49+
}
50+
4451
private function getDocument(): Document {
4552
if (!$this->document) {
46-
if (!$this->content) {
47-
throw new LibresignException('File not defined to be parsed.');
48-
}
53+
$content = $this->getContent();
4954
try {
5055
$parser = new \Smalot\PdfParser\Parser();
51-
$this->document = $parser->parseContent($this->content);
56+
$this->document = $parser->parseContent($content);
5257
return $this->document;
5358
} catch (\Throwable $th) {
5459
if ($th->getMessage() === 'Secured pdf file are currently not supported.') {
@@ -67,6 +72,13 @@ private function getDocument(): Document {
6772
* @psalm-return array{p: int, d?: non-empty-list<array{w: mixed, h: mixed}>}
6873
*/
6974
public function getPageDimensions(): array {
75+
if ($return = $this->getPageDimensionsWithPdfInfo()) {
76+
return $return;
77+
}
78+
return $this->getPageDimensionsWithSmalotPdfParser();
79+
}
80+
81+
private function getPageDimensionsWithSmalotPdfParser(): array {
7082
$document = $this->getDocument();
7183
$pages = $document->getPages();
7284
$output = [
@@ -78,15 +90,49 @@ public function getPageDimensions(): array {
7890
$pages = $document->getObjectsByType('Pages');
7991
$details = reset($pages)->getHeader()->getDetails();
8092
}
81-
$widthAndHeight = [
82-
'w' => $details['MediaBox'][2],
83-
'h' => $details['MediaBox'][3]
84-
];
85-
if (!is_numeric($widthAndHeight['w']) || !is_numeric($widthAndHeight['h'])) {
93+
if (!isset($details['MediaBox']) || !is_numeric($details['MediaBox'][2]) || !is_numeric($details['MediaBox'][3])) {
8694
$this->logger->error('Impossible get metadata from this file: Error to get page width and height. If possible, open an issue at github.com/libresign/libresign with the file that you used.');
8795
throw new LibresignException('Impossible get metadata from this file.');
8896
}
89-
$output['d'][] = $widthAndHeight;
97+
$output['d'][] = [
98+
'w' => $details['MediaBox'][2],
99+
'h' => $details['MediaBox'][3],
100+
];
101+
}
102+
$pending = $output['p'] - count($output['d']);
103+
if ($pending) {
104+
for ($i = 0; $i < $pending; $i++) {
105+
$output['d'][] = $output['d'][0];
106+
}
107+
}
108+
return $output;
109+
}
110+
111+
private function getPageDimensionsWithPdfInfo(): array {
112+
if (shell_exec('which pdfinfo') === null) {
113+
return [];
114+
}
115+
$content = $this->getContent();
116+
$filename = $this->tempManager->getTemporaryFile('.pdf');
117+
file_put_contents($filename, $content);
118+
119+
// The output of this command go to STDERR and shell_exec get the STDOUT
120+
// With 2>&1 the STRERR is redirected to STDOUT
121+
$pdfinfo = shell_exec('pdfinfo ' . $filename . ' -l -1 2>&1');
122+
if (!$pdfinfo) {
123+
return [];
124+
}
125+
if (!preg_match_all('/Page +\d+ +size: +(\d+\.?\d*) x (\d+\.?\d*)/', $pdfinfo, $pages)) {
126+
return [];
127+
}
128+
$output = [
129+
'p' => count($pages[1]),
130+
];
131+
foreach ($pages[1] as $page => $width) {
132+
$output['d'][] = [
133+
'w' => (float)$width,
134+
'h' => (float)$pages[2][$page],
135+
];
90136
}
91137
return $output;
92138
}

‎tests/Unit/Service/PdfParseServiceTest.php‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@
66
* SPDX-License-Identifier: AGPL-3.0-or-later
77
*/
88

9+
namespace OCA\Libresign\Service;
10+
11+
/**
12+
* Overwrite shell_exec in the OCA\Libresign\Service namespace.
13+
*/
14+
function shell_exec($command) {
15+
if (\OCA\Libresign\Tests\Unit\Service\PdfParseServiceTest::$disablePdfInfo) {
16+
return null;
17+
}
18+
return \shell_exec($command);
19+
}
20+
921
namespace OCA\Libresign\Tests\Unit\Service;
1022

1123
use OCA\Libresign\Exception\LibresignException;
@@ -21,6 +33,7 @@
2133
final class PdfParseServiceTest extends \OCA\Libresign\Tests\Unit\TestCase {
2234
private ITempManager $tempManager;
2335
private LoggerInterface&MockObject $loggerInterface;
36+
public static $disablePdfInfo = false;
2437

2538
public function setUp(): void {
2639
parent::setUp();
@@ -62,7 +75,8 @@ public static function dataGetMetadataWithFail(): array {
6275
/**
6376
* @dataProvider providerGetMetadataWithSuccess
6477
*/
65-
public function testGetMetadataWithSuccess(string $path, array $expected): void {
78+
public function testGetMetadataWithSuccess(bool $disablePdfInfo, string $path, array $expected): void {
79+
self::$disablePdfInfo = $disablePdfInfo;
6680
/** @var File|MockObject */
6781
$file = $this->createMock(File::class);
6882
$file->method('getContent')
@@ -76,6 +90,7 @@ public function testGetMetadataWithSuccess(string $path, array $expected): void
7690
public static function providerGetMetadataWithSuccess(): array {
7791
return [
7892
[
93+
'disablePdfInfo' => true,
7994
'tests/fixtures/small_valid.pdf',
8095
[
8196
'p' => 1,
@@ -85,6 +100,7 @@ public static function providerGetMetadataWithSuccess(): array {
85100
]
86101
],
87102
[
103+
'disablePdfInfo' => true,
88104
'tests/fixtures/small_valid-signed.pdf',
89105
[
90106
'p' => 1,
@@ -93,6 +109,26 @@ public static function providerGetMetadataWithSuccess(): array {
93109
],
94110
]
95111
],
112+
[
113+
'disablePdfInfo' => false,
114+
'tests/fixtures/small_valid.pdf',
115+
[
116+
'p' => 1,
117+
'd' => [
118+
['w' => 595.276, 'h' => 841.89],
119+
],
120+
]
121+
],
122+
[
123+
'disablePdfInfo' => false,
124+
'tests/fixtures/small_valid-signed.pdf',
125+
[
126+
'p' => 1,
127+
'd' => [
128+
['w' => 595.276, 'h' => 841.89],
129+
],
130+
]
131+
],
96132
];
97133
}
98134
}

0 commit comments

Comments
 (0)