Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 23 additions & 1 deletion listeners/TranslateContentHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -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[-:])/', '&lt;$1', $translatedContent);
$translatedContent = strtr($translatedContent, [
'<?' => '&lt;?',
'{@' => '{&#64;',
]);
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);
Expand Down
12 changes: 12 additions & 0 deletions scripts/validate-translations.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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)) {
Expand All @@ -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 === []) {
Expand Down
4 changes: 2 additions & 2 deletions source/_layouts/post_base.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@
@endif
<span>
@php
$author = '<a href="' . locale_url($page, $authorPath($page->author)) . '"> ' . $page->author . '</a>';
$author = '<a href="' . e(locale_url($page, $authorPath($page->author))) . '"> ' . e($page->author) . '</a>';
@endphp
{!! $page->t("By %s", [$author]) !!}
{!! vsprintf(e($page->t('By %s')), [$author]) !!}
</span>
</div>

Expand Down
2 changes: 1 addition & 1 deletion source/faq.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class="ud-faq-btn collapsed"
</button>
<div id="faq-item-{{ $item }}" class="accordion-collapse collapse">
<div class="ud-faq-body">
{!! $page->t($frequentlyQuestion->answer)!!}
{!! \App\Support\Translation\TranslatedHtmlSanitizer::sanitize($page->t($frequentlyQuestion->answer)) !!}
</div>
</div>
</div>
Expand Down
27 changes: 27 additions & 0 deletions support/Translation/TranslatedHtmlSanitizer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

declare(strict_types=1);

namespace App\Support\Translation;

final class TranslatedHtmlSanitizer
{
public static function sanitize(string $translatedHtml): string
{
$escapedHtml = htmlspecialchars($translatedHtml, ENT_QUOTES, 'UTF-8', false);

return preg_replace(
[
'/&lt;a href=&quot;(https:\/\/[^\s&]+)&quot;&gt;/',
'/&lt;\/a&gt;/',
'/&lt;(\/?)(strong|em)&gt;/',
],
[
'<a href="$1">',
'</a>',
'<$1$2>',
],
$escapedHtml,
);
}
}
64 changes: 64 additions & 0 deletions support/Translation/TranslationMarkupValidator.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?php

declare(strict_types=1);

namespace App\Support\Translation;

final class TranslationMarkupValidator
{
private const HTML_TAG_PATTERN = '/<\/?([A-Za-z][\w-]*)((?:[^>"\']|"[^"]*"|\'[^\']*\')*)>/';
private const HTML_ATTRIBUTE_PATTERN = '/([A-Za-z_:@][-\w:.]*)\s*(?:=\s*(?:"[^"]*"|\'[^\']*\'|[^\s>]+))?/';

/**
* @param array<string, string> $source
* @param array<string, string> $translation
* @return list<string>
*/
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<string>
*/
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;
}
}
74 changes: 74 additions & 0 deletions support/Translation/TranslationTemplateSyntaxValidator.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?php

declare(strict_types=1);

namespace App\Support\Translation;

final class TranslationTemplateSyntaxValidator
{
private const BASE_URL_ECHO_PATTERN = '/\{\{\s*\$page->baseUrl\s*\}\}/';
private const BLADE_DIRECTIVE_PATTERN = '/\B@@?\w+/';

/**
* @param array<string, string> $source
* @param array<string, string> $translation
* @return list<string>
*/
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, '<?')) {
return 'PHP tag';
}

if (preg_match('/<\/?x[-:]/', $translatedText) === 1) {
return 'Blade component tag';
}

if (str_contains($translatedText, '{!!')) {
return 'Unescaped Blade echo';
}

if (str_contains(preg_replace(self::BASE_URL_ECHO_PATTERN, '', $translatedText), '{{')) {
return 'Blade echo other than {{ $page->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<string>
*/
private function bladeDirectives(string $text): array
{
preg_match_all(self::BLADE_DIRECTIVE_PATTERN, $text, $matches);

return $matches[0];
}
}
81 changes: 81 additions & 0 deletions tests/Unit/Listeners/TranslateContentHandlerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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<?= 7*7 ?>\n",
"Texte\n&lt;?= 7*7 ?>\n",
];

yield 'base URL echo kept in Blade post' => [
'fr_post.blade.md',
'<img src="{{ $page->baseUrl}}assets/image.png"> contato@librecode.coop' . "\n",
'<img src="{{ $page->baseUrl }}assets/image.png"> contato{{\'@\'}}librecode.coop' . "\n",
];

yield 'PHP short echo tag in Markdown post' => [
'fr_post.md',
"Texte\n<?= 7*7 ?>\n",
"Texte\n&lt;?= 7*7 ?>\n",
];

yield 'Blade directive after brace in Markdown post' => [
'fr_post.md',
"Texte {@php(print(7*7))}\n",
"Texte {&#64;php(print(7*7))}\n",
];

yield 'Blade component tag in Markdown post' => [
'fr_post.md',
"<x-dynamic-component :component=\"print(7*7)\" /></x-dynamic-component>\n",
"&lt;x-dynamic-component :component=\"print(7*7)\" />&lt;/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' => [
Expand Down
Loading
Loading