diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 15c662f4..ce20bb67 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -47,6 +47,8 @@ jobs: with: php-version: 8.3 - run: composer i + - name: Validate translation catalogs + run: composer validate-translations - run: composer prod - name: Extract source strings diff --git a/listeners/TranslateContentHandler.php b/listeners/TranslateContentHandler.php index 337e45c0..8248ca4c 100644 --- a/listeners/TranslateContentHandler.php +++ b/listeners/TranslateContentHandler.php @@ -75,11 +75,33 @@ private function translateContent(): void } $this->translated = str_replace( $content, - $this->pageData->page->t($content, [], $this->languageCode), + $this->neutralizeTemplateSyntax($this->pageData->page->t($content, [], $this->languageCode)), $this->translated ); } + private function neutralizeTemplateSyntax(string $translatedContent): string + { + $translatedContent = preg_replace('/<(\/?x[-:])/', '<$1', $translatedContent); + $translatedContent = strtr($translatedContent, [ + ' '<?', + '{@' => '{@', + ]); + if (!$this->file->isBladeFile()) { + return $translatedContent; + } + + $baseUrlPlaceholder = 'LIBRESIGN_TRANSLATED_BASE_URL'; + $translatedContent = preg_replace('/\{\{\s*\$page->baseUrl\s*\}\}/', $baseUrlPlaceholder, $translatedContent); + $translatedContent = strtr($translatedContent, [ + '@' => "{{'@'}}", + '{{' => '@{{', + '{!!' => '@{!!', + ]); + + return str_replace($baseUrlPlaceholder, '{{ $page->baseUrl }}', $translatedContent); + } + private function translateHeaders(): void { $header = $this->parser->getFrontMatter($this->translated); diff --git a/scripts/validate-translations.php b/scripts/validate-translations.php index 7acdbf58..ae8a0434 100644 --- a/scripts/validate-translations.php +++ b/scripts/validate-translations.php @@ -2,6 +2,8 @@ declare(strict_types=1); +use App\Support\Translation\TranslationMarkupValidator; +use App\Support\Translation\TranslationTemplateSyntaxValidator; use LibreSign\JigsawLocalization\Catalog\JsonTranslationCatalog; use LibreSign\JigsawLocalization\Catalog\TranslationCatalogValidator; @@ -11,6 +13,8 @@ $sourcePath = dirname(__DIR__)."/lang/{$sourceLocale}/main.json"; $source = (new JsonTranslationCatalog($sourcePath))->read(); $validator = new TranslationCatalogValidator(); +$templateSyntaxValidator = new TranslationTemplateSyntaxValidator(); +$markupValidator = new TranslationMarkupValidator(); $errors = []; if (in_array('--canonical-source', $argv, true)) { @@ -29,6 +33,14 @@ foreach ($validator->validatePlaceholders($source, $translation) as $error) { $errors[] = "{$locale}: {$error}"; } + + foreach ($templateSyntaxValidator->validate($source, $translation) as $error) { + $errors[] = "{$locale}: {$error}"; + } + + foreach ($markupValidator->validate($source, $translation) as $error) { + $errors[] = "{$locale}: {$error}"; + } } if ($errors === []) { diff --git a/source/_layouts/post_base.blade.php b/source/_layouts/post_base.blade.php index 7e66e67b..7bd3b353 100644 --- a/source/_layouts/post_base.blade.php +++ b/source/_layouts/post_base.blade.php @@ -51,9 +51,9 @@ @endif @php - $author = ' ' . $page->author . ''; + $author = ' ' . e($page->author) . ''; @endphp - {!! $page->t("By %s", [$author]) !!} + {!! vsprintf(e($page->t('By %s')), [$author]) !!} diff --git a/source/faq.blade.php b/source/faq.blade.php index bce29c3d..e0685cf3 100644 --- a/source/faq.blade.php +++ b/source/faq.blade.php @@ -54,7 +54,7 @@ class="ud-faq-btn collapsed"
- {!! $page->t($frequentlyQuestion->answer)!!} + {!! \App\Support\Translation\TranslatedHtmlSanitizer::sanitize($page->t($frequentlyQuestion->answer)) !!}
diff --git a/support/Translation/TranslatedHtmlSanitizer.php b/support/Translation/TranslatedHtmlSanitizer.php new file mode 100644 index 00000000..c47f7b65 --- /dev/null +++ b/support/Translation/TranslatedHtmlSanitizer.php @@ -0,0 +1,27 @@ +', + '', + '<$1$2>', + ], + $escapedHtml, + ); + } +} diff --git a/support/Translation/TranslationMarkupValidator.php b/support/Translation/TranslationMarkupValidator.php new file mode 100644 index 00000000..a36e2768 --- /dev/null +++ b/support/Translation/TranslationMarkupValidator.php @@ -0,0 +1,64 @@ +"\']|"[^"]*"|\'[^\']*\')*)>/'; + private const HTML_ATTRIBUTE_PATTERN = '/([A-Za-z_:@][-\w:.]*)\s*(?:=\s*(?:"[^"]*"|\'[^\']*\'|[^\s>]+))?/'; + + /** + * @param array $source + * @param array $translation + * @return list + */ + public function validate(array $source, array $translation): array + { + $errors = []; + + foreach ($translation as $key => $translatedText) { + if (!array_key_exists($key, $source)) { + continue; + } + + $sourceMarkup = $this->markup($source[$key]); + $translatedMarkup = $this->markup($translatedText); + if ($sourceMarkup === $translatedMarkup) { + continue; + } + + $errors[] = sprintf( + 'HTML markup mismatch in translation of "%s": expected [%s], got [%s].', + strtok($key, "\n"), + implode(', ', $sourceMarkup), + implode(', ', $translatedMarkup), + ); + } + + return $errors; + } + + /** + * @return list + */ + private function markup(string $text): array + { + $markup = []; + preg_match_all(self::HTML_TAG_PATTERN, $text, $tags, PREG_SET_ORDER); + foreach ($tags as [, $tagName, $attributes]) { + $tagName = strtolower($tagName); + $markup[] = $tagName; + preg_match_all(self::HTML_ATTRIBUTE_PATTERN, $attributes, $attributeMatches); + foreach ($attributeMatches[1] as $attributeName) { + $markup[] = $tagName . '[' . strtolower($attributeName) . ']'; + } + } + + $markup = array_values(array_unique($markup)); + sort($markup); + + return $markup; + } +} diff --git a/support/Translation/TranslationTemplateSyntaxValidator.php b/support/Translation/TranslationTemplateSyntaxValidator.php new file mode 100644 index 00000000..dd93218e --- /dev/null +++ b/support/Translation/TranslationTemplateSyntaxValidator.php @@ -0,0 +1,74 @@ +baseUrl\s*\}\}/'; + private const BLADE_DIRECTIVE_PATTERN = '/\B@@?\w+/'; + + /** + * @param array $source + * @param array $translation + * @return list + */ + public function validate(array $source, array $translation): array + { + $errors = []; + + foreach ($translation as $key => $translatedText) { + if (!array_key_exists($key, $source)) { + continue; + } + + $problem = $this->findProblem($source[$key], $translatedText); + if ($problem !== null) { + $errors[] = sprintf('%s in translation of "%s".', $problem, strtok($key, "\n")); + } + } + + return $errors; + } + + private function findProblem(string $sourceText, string $translatedText): ?string + { + if (str_contains($translatedText, 'baseUrl }}'; + } + + if (preg_match_all(self::BASE_URL_ECHO_PATTERN, $translatedText) !== preg_match_all(self::BASE_URL_ECHO_PATTERN, $sourceText)) { + return 'Base URL echo count differs from source'; + } + + $unexpectedDirectives = array_diff($this->bladeDirectives($translatedText), $this->bladeDirectives($sourceText)); + if ($unexpectedDirectives !== []) { + return sprintf('Blade directive %s', implode(', ', array_unique($unexpectedDirectives))); + } + + return null; + } + + /** + * @return list + */ + private function bladeDirectives(string $text): array + { + preg_match_all(self::BLADE_DIRECTIVE_PATTERN, $text, $matches); + + return $matches[0]; + } +} diff --git a/tests/Unit/Listeners/TranslateContentHandlerTest.php b/tests/Unit/Listeners/TranslateContentHandlerTest.php index cb3e12c8..0b4aba09 100644 --- a/tests/Unit/Listeners/TranslateContentHandlerTest.php +++ b/tests/Unit/Listeners/TranslateContentHandlerTest.php @@ -8,6 +8,7 @@ use Mni\FrontYAML\Parser; use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; +use TightenCo\Jigsaw\File\InputFile; use TightenCo\Jigsaw\PageData; use TightenCo\Jigsaw\PageVariable; use TightenCo\Jigsaw\Parsers\FrontMatterParser; @@ -47,6 +48,86 @@ public function testTranslatedHeadersRemainValidYaml(string $title, string $desc self::assertStringEndsWith("---\nBody text.\n", $output); } + #[DataProvider('translatedContentProvider')] + public function testTranslatedContentCannotInjectTemplateCode(string $filename, string $translatedBody, string $expectedBody): void + { + $parser = new FrontMatterParser(new Parser(markdownParser: new MarkdownParser())); + $listener = new TranslateContentHandler($parser, []); + $page = new PageVariable([ + 't' => static fn ($page, string $source, array $parameters, ?string $locale): string => $translatedBody, + ]); + + $reflection = new \ReflectionClass($listener); + $reflection->getProperty('file')->setValue($listener, new InputFile(new \SplFileInfo('/posts/' . $filename))); + $reflection->getProperty('pageData')->setValue($listener, new PageData(['page' => $page])); + $reflection->getProperty('languageCode')->setValue($listener, 'fr'); + $reflection->getProperty('translated')->setValue($listener, "---\ntitle: English title\n---\nEnglish body.\n"); + + $reflection->getMethod('translateContent')->invoke($listener); + + self::assertSame( + "---\ntitle: English title\n---\n" . $expectedBody, + $reflection->getProperty('translated')->getValue($listener), + ); + } + + public static function translatedContentProvider(): iterable + { + yield 'Blade echo in Blade post' => [ + 'fr_post.blade.md', + "Texte {{ 7*7 }}\n", + "Texte @{{ 7*7 }}\n", + ]; + + yield 'raw Blade echo in Blade post' => [ + 'fr_post.blade.md', + "Texte {!! 7*7 !!}\n", + "Texte @{!! 7*7 !!}\n", + ]; + + yield 'Blade directive in Blade post' => [ + 'fr_post.blade.md', + "Texte\n@php echo 7*7; @endphp\n", + "Texte\n{{'@'}}php echo 7*7; {{'@'}}endphp\n", + ]; + + yield 'PHP short echo tag in Blade post' => [ + 'fr_post.blade.md', + "Texte\n\n", + "Texte\n<?= 7*7 ?>\n", + ]; + + yield 'base URL echo kept in Blade post' => [ + 'fr_post.blade.md', + ' contato@librecode.coop' . "\n", + ' contato{{\'@\'}}librecode.coop' . "\n", + ]; + + yield 'PHP short echo tag in Markdown post' => [ + 'fr_post.md', + "Texte\n\n", + "Texte\n<?= 7*7 ?>\n", + ]; + + yield 'Blade directive after brace in Markdown post' => [ + 'fr_post.md', + "Texte {@php(print(7*7))}\n", + "Texte {@php(print(7*7))}\n", + ]; + + yield 'Blade component tag in Markdown post' => [ + 'fr_post.md', + "\n", + "<x-dynamic-component :component=\"print(7*7)\" /></x-dynamic-component>\n", + ]; + + yield 'Markdown post left for the Markdown handler to escape' => [ + 'fr_post.md', + "Texte {{ 7*7 }} contato@librecode.coop\n", + "Texte {{ 7*7 }} contato@librecode.coop\n", + ]; + } + public static function translatedHeadersProvider(): iterable { yield 'French SEO title with colon' => [ diff --git a/tests/Unit/Support/Translation/TranslatedHtmlSanitizerTest.php b/tests/Unit/Support/Translation/TranslatedHtmlSanitizerTest.php new file mode 100644 index 00000000..63d5a75e --- /dev/null +++ b/tests/Unit/Support/Translation/TranslatedHtmlSanitizerTest.php @@ -0,0 +1,47 @@ + [ + 'Code on GitHub.', + 'Code on GitHub.', + ]; + + yield 'emphasis' => ['Yes, free.', 'Yes, free.']; + + yield 'image with event handler' => [ + 'Oui ', + 'Oui <img src=x onerror="alert(1)">', + ]; + + yield 'script tag' => ['', '<script>alert(1)</script>']; + + yield 'link with extra attribute' => [ + 'x', + '<a href="https://example.org" onclick="alert(1)">x', + ]; + + yield 'javascript link' => [ + 'x', + '<a href="javascript:alert(1)">x', + ]; + + yield 'existing entity' => ['Q&A', 'Q&A']; + } +} diff --git a/tests/Unit/Support/Translation/TranslationMarkupValidatorTest.php b/tests/Unit/Support/Translation/TranslationMarkupValidatorTest.php new file mode 100644 index 00000000..535a382a --- /dev/null +++ b/tests/Unit/Support/Translation/TranslationMarkupValidatorTest.php @@ -0,0 +1,46 @@ +GitHub.\n\n
\n \"Settings\"\n
"; + $translation = "Código no GitHub.\n\n
\n \"Configurações\"\n
"; + + self::assertSame([], (new TranslationMarkupValidator())->validate([$source => $source], [$source => $translation])); + } + + public function testRejectsTagMissingFromSource(): void + { + $source = "## Post title\n\nPost body."; + $translation = "## Titre\n\nTexte "; + + self::assertSame( + ['HTML markup mismatch in translation of "## Post title": expected [], got [img, img[src]].'], + (new TranslationMarkupValidator())->validate([$source => $source], [$source => $translation]), + ); + } + + public function testRejectsAttributeMissingFromSource(): void + { + $source = 'See the site.'; + $translation = 'Voir le site.'; + + self::assertSame( + ['HTML markup mismatch in translation of "See the site.": expected [a, a[href]], got [a, a[href], a[onclick]].'], + (new TranslationMarkupValidator())->validate([$source => $source], [$source => $translation]), + ); + } + + public function testIgnoresKeysMissingFromSource(): void + { + self::assertSame([], (new TranslationMarkupValidator())->validate([], ['Removed' => '