From 7afb01e4889761f4b420b37d626a8c96f41434fa Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Tue, 23 Jul 2024 12:24:42 +0200 Subject: Redirect help to about page when locale but no topic specified in URL --- Zotlabs/Module/Help.php | 5 +++++ tests/unit/Module/HelpTest.php | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/Zotlabs/Module/Help.php b/Zotlabs/Module/Help.php index fd5cacee6..4adf95692 100644 --- a/Zotlabs/Module/Help.php +++ b/Zotlabs/Module/Help.php @@ -6,6 +6,7 @@ use Michelf\MarkdownExtra; /** * You can create local site resources in doc/Site.md and either link to doc/Home.md for the standard resources * or use our include mechanism to include it on your local page. + * *@code * #include doc/Home.md; *@endcode @@ -160,6 +161,10 @@ class Help extends \Zotlabs\Web\Controller { array_shift($args); } + if (empty($args)) { + goaway("/help/{$this->lang['language']}/about/about"); + } + // Keep the first remaining arg as the heading slug $this->heading_slug = $args[0]; diff --git a/tests/unit/Module/HelpTest.php b/tests/unit/Module/HelpTest.php index c345d5e52..353a40def 100644 --- a/tests/unit/Module/HelpTest.php +++ b/tests/unit/Module/HelpTest.php @@ -104,6 +104,11 @@ class HelpTest extends \Zotlabs\Tests\Unit\Module\TestCase { $this->get('help'); } + public function test_getting_locale_with_no_topic_should_redirect_to_about_page_for_locale(): void { + $this->expectRedirectTo('help/de/about/about'); + $this->get('help/de'); + } + public function test_find_help_file_returns_first_match(): void { // Stub file exists, to always return true $fe_stub = $this->getFunctionMock('Zotlabs\Lib\Traits', 'file_exists'); -- cgit v1.2.3 From 9df96fa03b73513ded6163de7d08afc318c61575 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Tue, 23 Jul 2024 12:56:48 +0200 Subject: Don't modify address bar when loading help topic. Modifying the current URL like this causes several problems, and is imo bad practice. When requesting a help topic without specifying the language in the URL (like `help/member/member_guide`) the locale for the current channel is used to fetch the topic. On the other hand, if fetching a topic with the language in the URL, the detected language will be used. Since the channel locale may not match the locale supported by the help system, weird situations may arise. I.e. fetching the topic without language in the URL works, but as the URL has now been rewritten, reloading the page will fail with a 404 status. Being a bit less clever solves this issue, and leaves the web browser to behave more as expected by the user. --- view/js/mod_help.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/view/js/mod_help.js b/view/js/mod_help.js index 9c3591498..b87e300fa 100644 --- a/view/js/mod_help.js +++ b/view/js/mod_help.js @@ -97,8 +97,6 @@ $(document).ready(function () { } } - // Update the address bar to reflect the loaded language - window.history.replaceState({}, '', '/' + pathParts.join('/')); // Highlight the language in the language selector that is currently viewed $('.lang-selector').find('.lang-choice:contains("' + help_language + '")').addClass('active'); -- cgit v1.2.3 From 202b797fe683fd47e02f1c0e22b50085851e5ed3 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Tue, 23 Jul 2024 13:26:44 +0200 Subject: Remove language selector from help pages. It is not in sync with the languages available for the rest of the Hubzilla UI, so it was confusing and in the way of just supporting localized help using the same mechanism as the rest of the code. Also allowed deleting a good chunck of javascript from the help logic. --- view/js/mod_help.js | 48 ------------------------------------------------ view/tpl/help.tpl | 16 ---------------- 2 files changed, 64 deletions(-) diff --git a/view/js/mod_help.js b/view/js/mod_help.js index b87e300fa..e2b1f4785 100644 --- a/view/js/mod_help.js +++ b/view/js/mod_help.js @@ -69,52 +69,4 @@ $(document).ready(function () { var newref = p.protocol + '//' + p.hostname + portstr + p.pathname + p.hash.split('?').shift(); location.replace(newref) } - - - // Determine language translations available from the language selector menu itself - var langChoices = []; - $('.lang-selector').find('.lang-choice').each(function (idx, a) { - langChoices.push($(a).html()); - }); - // Parse the URL and insert the language code for the loaded language, based - // on the variable "help_language" that is declared in the help.tpl page template - var path = window.location.pathname.split('/'); - var pathParts = []; - var pick_me = true; - for (var i = 0; i < path.length; i++) { - if(i === 2 && pick_me ) { - if(path[i].length > 0) { - pathParts.push(help_language); - pick_me = false; - if($.inArray(path[i], langChoices) < 0) { - i--; - } - } - } else { - if(path[i].length > 0) { - pathParts.push(path[i]); - } - } - - } - - // Highlight the language in the language selector that is currently viewed - $('.lang-selector').find('.lang-choice:contains("' + help_language + '")').addClass('active'); - - // Construct the links to the available translations based and populate the selector menu - $('.lang-selector').find('.lang-choice').each(function (idx, a) { - var langLink = []; - - for (var i = 0; i < pathParts.length; i++) { - - if(i === 1) { - langLink.push($(a).html()); - } else { - langLink.push(pathParts[i]); - } - - } - $(a).attr('href', '/' + langLink.join('/')); - }); - }); diff --git a/view/tpl/help.tpl b/view/tpl/help.tpl index ba61a43ce..1cc66d258 100644 --- a/view/tpl/help.tpl +++ b/view/tpl/help.tpl @@ -1,18 +1,5 @@
-
-
- -
- de - en - es - fr -
-
-

{{$module->get_page_title()}}

@@ -26,6 +13,3 @@ {{$module->render_content()}}
- -- cgit v1.2.3 From 63a01c02148ad51823acb7c6a7c64129ecd6a665 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Tue, 23 Jul 2024 18:47:39 +0200 Subject: Replace $Projectname in help index/toc file. --- Zotlabs/Widget/Helpindex.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Zotlabs/Widget/Helpindex.php b/Zotlabs/Widget/Helpindex.php index 5264e1947..fd9204c9e 100644 --- a/Zotlabs/Widget/Helpindex.php +++ b/Zotlabs/Widget/Helpindex.php @@ -22,7 +22,9 @@ class Helpindex { $this->find_help_file('toc', $this->lang['language']); if (! empty($this->file_name)) { - $this->contents = file_get_contents($this->file_name); + $this->contents = translate_projectname( + file_get_contents($this->file_name) + ); } $tpl = get_markup_template('widget.tpl'); -- cgit v1.2.3 From 898fb4f80039bf1ec920f931d4e8c00162bf4ef8 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Tue, 23 Jul 2024 18:51:22 +0200 Subject: Refactor HelpTest.php. Move default stubs to a function to make them reusable. --- tests/unit/Module/HelpTest.php | 52 +++++++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/tests/unit/Module/HelpTest.php b/tests/unit/Module/HelpTest.php index 353a40def..64e4a2663 100644 --- a/tests/unit/Module/HelpTest.php +++ b/tests/unit/Module/HelpTest.php @@ -31,30 +31,7 @@ class HelpTest extends \Zotlabs\Tests\Unit\Module\TestCase { * ["html"] */ public function test_get_request_when_help_file_exists(string $ext): void { - // Stub file exists, to only retur true for the file with the current - // extension - $fe_stub = $this->getFunctionMock('Zotlabs\Lib\Traits', 'file_exists'); - $fe_stub - ->expects($this->any()) - ->willReturnCallback( - fn (string $path) => $path === "doc/en/about/help_topic.{$ext}" - ); - - // Use a value map to make the `file_get_contents` stub return the - // correct content for the file types. - $file_content_map = [ - [ 'doc/en/about/help_topic.md', "### Help heading\n\$Projectname help content" ], - [ 'doc/en/about/help_topic.bb', "[h3]Help heading[/h3]\n\n\$Projectname help content" ], - [ 'doc/en/about/help_topic.html', "

Help heading

\$Projectname help content

" ], - ]; - - // Stub `file_get_contents` to plant our own content. - $fgc_stub = $this->getFunctionMock('Zotlabs\Module', 'file_get_contents'); - $fgc_stub - ->expects($this->once()) - ->willReturnMap($file_content_map); - - + $stubs = $this->prepare_stubs($ext); $this->get("help/about/help_topic"); // Check that markdown content was correctly rendered @@ -181,4 +158,31 @@ class HelpTest extends \Zotlabs\Tests\Unit\Module\TestCase { $this->assertPageContains('

This is the included file.

'); } + + private function prepare_stubs(string $ext): array { + // Stub file exists, to only retur true for the file with the current + // extension + $fe_stub = $this->getFunctionMock('Zotlabs\Lib\Traits', 'file_exists'); + $fe_stub + ->expects($this->any()) + ->willReturnCallback( + fn (string $path) => $path === "doc/en/about/help_topic.{$ext}" + ); + + // Use a value map to make the `file_get_contents` stub return the + // correct content for the file types. + $file_content_map = [ + [ 'doc/en/about/help_topic.md', "### Help heading\n\$Projectname help content" ], + [ 'doc/en/about/help_topic.bb', "[h3]Help heading[/h3]\n\n\$Projectname help content" ], + [ 'doc/en/about/help_topic.html', "

Help heading

\$Projectname help content

" ], + ]; + + // Stub `file_get_contents` to plant our own content. + $fgc_stub = $this->getFunctionMock('Zotlabs\Module', 'file_get_contents'); + $fgc_stub + ->expects($this->once()) + ->willReturnMap($file_content_map); + + return [ 'file_exists' => $fe_stub, 'file_get_contents' => $fgc_stub ]; + } } -- cgit v1.2.3 From 1bd52867fb463a4b34cd2c4a9b9ace8b570e18b4 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Tue, 23 Jul 2024 18:52:12 +0200 Subject: Fallback to english help topic if localized topic is not found. --- Zotlabs/Lib/Traits/HelpHelperTrait.php | 8 ++++++-- tests/unit/Module/HelpTest.php | 9 +++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/Zotlabs/Lib/Traits/HelpHelperTrait.php b/Zotlabs/Lib/Traits/HelpHelperTrait.php index b7711bbd5..9e4fefa4b 100644 --- a/Zotlabs/Lib/Traits/HelpHelperTrait.php +++ b/Zotlabs/Lib/Traits/HelpHelperTrait.php @@ -53,10 +53,10 @@ trait HelpHelperTrait { // Use local variable until we can use trait constants. $valid_file_ext = ['md', 'bb', 'html']; - $base_path = "doc/{$lang}/${base_path}"; + $base_path_with_lang = "doc/{$lang}/${base_path}"; foreach ($valid_file_ext as $ext) { - $path = "{$base_path}.{$ext}"; + $path = "{$base_path_with_lang}.{$ext}"; if (file_exists($path)) { $this->file_name = $path; $this->file_type = $ext; @@ -64,5 +64,9 @@ trait HelpHelperTrait { break; } } + + if (empty($this->file_name) && $lang !== 'en') { + $this->find_help_file($base_path, 'en'); + } } } diff --git a/tests/unit/Module/HelpTest.php b/tests/unit/Module/HelpTest.php index 64e4a2663..2e5494f7c 100644 --- a/tests/unit/Module/HelpTest.php +++ b/tests/unit/Module/HelpTest.php @@ -103,6 +103,15 @@ class HelpTest extends \Zotlabs\Tests\Unit\Module\TestCase { $this->get('help/first'); } + public function test_fall_back_to_english_if_localized_topic_dont_exist(): void { + \App::$language = 'nb'; + + $stubs = $this->prepare_stubs('bb'); + $this->get('help/about/help_topic'); + + $this->assertPageContains('Hubzilla Documentation: About'); + } + public function test_includes(): void { // Stub `file_get_contents` to plant our own content. $fgc_stub = $this->getFunctionMock('Zotlabs\Module', 'file_get_contents'); -- cgit v1.2.3 From 7067a0adc2e37168401e761c29e78392229ec168 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Wed, 24 Jul 2024 10:59:03 +0200 Subject: Move language member to HelpHelperTrait. Should have been there from the start, was just a miss. --- Zotlabs/Lib/Traits/HelpHelperTrait.php | 8 ++++++++ Zotlabs/Module/Help.php | 8 -------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Zotlabs/Lib/Traits/HelpHelperTrait.php b/Zotlabs/Lib/Traits/HelpHelperTrait.php index 9e4fefa4b..2a54e2db2 100644 --- a/Zotlabs/Lib/Traits/HelpHelperTrait.php +++ b/Zotlabs/Lib/Traits/HelpHelperTrait.php @@ -14,6 +14,14 @@ trait HelpHelperTrait { private string $file_name = ''; private string $file_type = ''; + /** + * Associative array containing the detected language. + */ + private array $lang = [ + 'language' => 'en', //! Detected language, 2-letter ISO 639-1 code ("en") + 'from_url' => false, //! true if language from URL overrides browser default + ]; + /** * Determines help language. * diff --git a/Zotlabs/Module/Help.php b/Zotlabs/Module/Help.php index 4adf95692..851776591 100644 --- a/Zotlabs/Module/Help.php +++ b/Zotlabs/Module/Help.php @@ -19,14 +19,6 @@ class Help extends \Zotlabs\Web\Controller { private string $heading_slug = ''; - /** - * Associative array containing the detected language. - */ - public array $lang = [ - 'language' => 'en', //! Detected language, 2-letter ISO 639-1 code ("en") - 'from_url' => false, //! true if language from URL overrides browser default - ]; - /** * Pre-check before processing request. * -- cgit v1.2.3 From 61f9ad8274d662a056aff05407771fb450a2ab35 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Wed, 24 Jul 2024 11:46:18 +0200 Subject: Add a notice to help pages when defaulting to english. --- Zotlabs/Lib/Traits/HelpHelperTrait.php | 26 ++++++++++++++++++-------- tests/unit/Module/HelpTest.php | 1 + view/tpl/help.tpl | 5 +++++ 3 files changed, 24 insertions(+), 8 deletions(-) diff --git a/Zotlabs/Lib/Traits/HelpHelperTrait.php b/Zotlabs/Lib/Traits/HelpHelperTrait.php index 2a54e2db2..0ce586d08 100644 --- a/Zotlabs/Lib/Traits/HelpHelperTrait.php +++ b/Zotlabs/Lib/Traits/HelpHelperTrait.php @@ -20,6 +20,7 @@ trait HelpHelperTrait { private array $lang = [ 'language' => 'en', //! Detected language, 2-letter ISO 639-1 code ("en") 'from_url' => false, //! true if language from URL overrides browser default + 'missing' => false, //! true if topic not found in detected language ]; /** @@ -36,17 +37,15 @@ trait HelpHelperTrait { $languages = $language_repository->getList(); if(array_key_exists(argv(1), $languages)) { - $lang = argv(1); - $from_url = true; + $this->lang['language'] = argv(1); + $this->lang['from_url'] = true; } else { - $lang = \App::$language; - if(! isset($lang)) - $lang = 'en'; + if(isset(\App::$language)) { + $this->lang['language'] = \App::$language; + } - $from_url = false; + $this->lang['from_url'] = false; } - - $this->lang = array('language' => $lang, 'from_url' => $from_url); } /** @@ -74,7 +73,18 @@ trait HelpHelperTrait { } if (empty($this->file_name) && $lang !== 'en') { + $this->lang['missing'] = true; $this->find_help_file($base_path, 'en'); } } + + public function missing_translation(): bool { + return !!$this->lang['missing']; + } + + public function missing_translation_message(): string { + return bbcode( + t("This page is not yet available in your preferred language. See [observer.baseurl]/help/developer/developer_guide#Translations for information about how to help.") + ); + } } diff --git a/tests/unit/Module/HelpTest.php b/tests/unit/Module/HelpTest.php index 2e5494f7c..81d2e9287 100644 --- a/tests/unit/Module/HelpTest.php +++ b/tests/unit/Module/HelpTest.php @@ -110,6 +110,7 @@ class HelpTest extends \Zotlabs\Tests\Unit\Module\TestCase { $this->get('help/about/help_topic'); $this->assertPageContains('Hubzilla Documentation: About'); + $this->assertPageContains('This page is not yet available in your preferred language'); } public function test_includes(): void { diff --git a/view/tpl/help.tpl b/view/tpl/help.tpl index 1cc66d258..0dc9bc686 100644 --- a/view/tpl/help.tpl +++ b/view/tpl/help.tpl @@ -2,6 +2,11 @@

{{$module->get_page_title()}}

+ {{if $module->missing_translation()}} +
+ {{$module->missing_translation_message()}} +
+ {{/if}}

-- cgit v1.2.3 From d3093dce1bfd4685d5e11f828689630862f77bda Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Wed, 24 Jul 2024 11:57:41 +0200 Subject: Improve translation message for help pages. Display the target language instead of "your preferred language". Makes it a bit more explicit. --- Zotlabs/Lib/Traits/HelpHelperTrait.php | 7 ++++++- tests/unit/Module/HelpTest.php | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Zotlabs/Lib/Traits/HelpHelperTrait.php b/Zotlabs/Lib/Traits/HelpHelperTrait.php index 0ce586d08..63b0eb22e 100644 --- a/Zotlabs/Lib/Traits/HelpHelperTrait.php +++ b/Zotlabs/Lib/Traits/HelpHelperTrait.php @@ -83,8 +83,13 @@ trait HelpHelperTrait { } public function missing_translation_message(): string { + $prefered_language_name = get_language_name( + $this->lang['language'], + $this->lang['language'] + ); + return bbcode( - t("This page is not yet available in your preferred language. See [observer.baseurl]/help/developer/developer_guide#Translations for information about how to help.") + t("This page is not yet available in {$prefered_language_name}. See [observer.baseurl]/help/developer/developer_guide#Translations for information about how to help.") ); } } diff --git a/tests/unit/Module/HelpTest.php b/tests/unit/Module/HelpTest.php index 81d2e9287..2c1d31570 100644 --- a/tests/unit/Module/HelpTest.php +++ b/tests/unit/Module/HelpTest.php @@ -110,7 +110,7 @@ class HelpTest extends \Zotlabs\Tests\Unit\Module\TestCase { $this->get('help/about/help_topic'); $this->assertPageContains('Hubzilla Documentation: About'); - $this->assertPageContains('This page is not yet available in your preferred language'); + $this->assertPageContains('This page is not yet available in norsk bokmål'); } public function test_includes(): void { -- cgit v1.2.3