Skip to content

[ticket/16957] Improve ACP extension explanations and remove HTML #6986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ECYaz wants to merge 1 commit into
base: master
Choose a base branch
from
+41 −8
Open

[ticket/16957] Improve ACP extension explanations and remove HTML #6986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion phpBB/adm/style/acp_ext_catalog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

<h1>{{ lang( 'EXTENSIONS_CATALOG') }}</h1>

<p>{{ lang( 'EXTENSIONS_CATALOG_EXPLAIN') }}</p>
<p>{{ lang('EXTENSIONS_CATALOG_EXPLAIN') }}</p>
<p><strong class="error">{{ lang('WARNING') }}{{ lang('COLON') }}</strong> {{ lang('EXTENSIONS_CATALOG_WARNING') }}</p>

<fieldset class="quick quick-left">
<span class="small"><a href="https://www.phpbb.com/go/customise/extensions/{{ PHPBB_MAJOR }}" target="_blank">{{ lang('BROWSE_EXTENSIONS_DATABASE') }}</a> &bull; <a href="javascript:phpbb.toggleDisplay('catalog_settings');">{{ lang('SETTINGS') }}</a></span>
Expand Down
11 changes: 6 additions & 5 deletions phpBB/language/en/acp/extensions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@
'DISABLING_EXTENSIONS' => 'Disabling extensions',

'EXTENSIONS_CATALOG' => 'Extensions Catalog',
'EXTENSIONS_CATALOG_EXPLAIN' => 'Here you can browse all the extensions available for your phpBB board. Extensions can easily be installed or removed with just a click. Adjust the settings to allow instant enabling and purging of extensions.<br><br><strong>Warning:</strong> Please be aware that the Extensions Catalog is currently in an Alpha development phase. Enabling this in a production environment carries a significant risk and is strongly discouraged.',
'EXTENSIONS_CATALOG_EXPLAIN' => 'Here you can browse all the extensions available for your phpBB board. Extensions can easily be installed or removed with just a click. Adjust the settings to allow instant enabling and purging of extensions.',
'EXTENSIONS_CATALOG_WARNING' => 'Please be aware that the Extensions Catalog is currently in an Alpha development phase. Enabling this in a production environment carries a significant risk and is strongly discouraged.',

'EXTENSION' => 'Extension',
'EXTENSIONS' => 'Extensions',
Expand All @@ -76,8 +77,8 @@
'EXTENSION_DELETE_DATA_EXPLAIN' => 'Deleting an extension’s data removes all of its data and settings. The extension files are retained so it can be enabled again.',
'EXTENSION_DISABLE_EXPLAIN' => 'Disabling an extension retains its files, data and settings but removes any functionality added by the extension.',
'EXTENSION_ENABLE_EXPLAIN' => 'Enabling an extension allows you to use it on your board.',
'EXTENSION_REMOVE_EXPLAIN' => 'Removing an extension removes all of its files, data and settings.',
'EXTENSION_UPDATE_EXPLAIN' => 'Updating an extension will install the latest version compatible with your board, removing old files and replacing them with new ones, and updating the database if necessary.',
'EXTENSION_REMOVE_EXPLAIN' => 'Removing an extension will remove all of its data and settings and delete the extension’s files from the filesystem.',
'EXTENSION_UPDATE_EXPLAIN' => 'Updating an extension will disable the currently installed extension and delete the extension’s files from the filesystem. The extension’s most recent compatible release will be uploaded to your board and re-enabled.',

'EXTENSION_DELETE_DATA_IN_PROGRESS' => 'The extension’s data is currently being deleted. Please do not leave or refresh this page until it is completed.',
'EXTENSION_DISABLE_IN_PROGRESS' => 'The extension is currently being disabled. Please do not leave or refresh this page until it is completed.',
Expand All @@ -93,7 +94,7 @@

'EXTENSION_INSTALLING_HEADLINE' => 'Installing an extension',
'EXTENSION_INSTALLING_EXPLAIN_STEP1' => 'Download an extension from phpBB’s extensions database',
'EXTENSION_INSTALLING_EXPLAIN_STEP2' => 'Unzip the extension and upload it to the <samp>ext/</samp> directory of your phpBB board',
'EXTENSION_INSTALLING_EXPLAIN_STEP2' => 'Unzip the extension and upload it to the “ext/” directory of your phpBB board',
'EXTENSION_INSTALLING_EXPLAIN_STEP3' => 'Enable the extension, here in the Extensions manager',

'EXTENSION_REMOVING_HEADLINE' => 'Deleting an extension from your board',
Expand Down Expand Up @@ -178,6 +179,6 @@
'STABILITY_DEV' => 'dev',

'COMPOSER_MINIMUM_STABILITY' => 'Minimum stability',
'COMPOSER_MINIMUM_STABILITY_EXPLAIN' => 'Always use <samp>stable</samp> versions on a live forum. Non-stable versions may still be in development and could cause unexpected problems with your forum and should only be used for development purposes in local or staging environments.',
'COMPOSER_MINIMUM_STABILITY_EXPLAIN' => 'Always use “stable” versions on a live forum. Non-stable versions may still be in development and could cause unexpected problems with your forum and should only be used for development purposes in local or staging environments.',

));
35 changes: 33 additions & 2 deletions tests/functional/extension_acp_test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,13 @@ public function test_list()
$this->assertStringNotContainsString('barfoo', $crawler->filter('.table1')->text());

$this->assertStringNotContainsString('vendor3/bar', $crawler->filter('.table1')->text());

// Action tooltips are rendered as title attributes and must not
// contain HTML, as it would be displayed literally. See PHPBB-16957.
foreach ($crawler->filter('a[title]') as $link)
{
$this->assertStringNotContainsString('<', $link->getAttribute('title'));
}
}

public function test_details()
Expand Down Expand Up @@ -266,6 +273,11 @@ public function test_extensions_catalog()
$this->assertContainsLang('BROWSE_EXTENSIONS_DATABASE', $crawler->filter('fieldset[class="quick quick-left"] > span > a')->eq(0)->text());
$this->assertContainsLang('SETTINGS', $crawler->filter('fieldset[class="quick quick-left"] > span > a')->eq(1)->text());

// The alpha-phase warning is rendered by the template, separately
// from the HTML-free explanation. See PHPBB-16957.
$this->assertContainsLang('EXTENSIONS_CATALOG_EXPLAIN', $this->get_content());
$this->assertContainsLang('EXTENSIONS_CATALOG_WARNING', $this->get_content());

$form = $crawler->selectButton('Submit')->form();
$form['minimum_stability']->select('dev');
$form['repositories'] = 'https://satis.phpbb.com/';
Expand Down Expand Up @@ -337,6 +349,19 @@ function ($node, $i) use ($extension_name)
// Ensure installed extension appears in available extensions list
$crawler = self::request('GET', 'adm/index.php?i=acp_extensions&mode=main&sid=' . $this->sid);
$this->assertStringContainsString('VigLink', $crawler->filter('strong[title="phpbb/viglink"]')->text());

// The composer-managed extension row offers the remove action; its
// tooltip carries the HTML-free explanation. See PHPBB-16957.
$viglink_row = $crawler->filter('tr')->reduce(
function ($node, $i)
{
return strpos($node->text(), 'VigLink') !== false;
}
);
$this->assertSame(
$this->lang('EXTENSION_REMOVE_EXPLAIN'),
$viglink_row->selectLink($this->lang('EXTENSION_REMOVE'))->attr('title')
);
}

public function test_extensions_catalog_updating_extension()
Expand All @@ -356,12 +381,18 @@ function ($node, $i)

// Update 'VigLink' enabled extension
$crawler = self::request('GET', 'adm/index.php?i=acp_extensions&mode=main&sid=' . $this->sid);
$viglink_update_link = $crawler->filter('tr')->reduce(
$viglink_update_node = $crawler->filter('tr')->reduce(
function ($node, $i)
{
return (bool) (strpos($node->text(), 'VigLink') !== false);
}
)->selectLink($this->lang('EXTENSION_UPDATE'))->link();
)->selectLink($this->lang('EXTENSION_UPDATE'));

// The update tooltip of the composer-managed extension carries the
// HTML-free explanation. See PHPBB-16957.
$this->assertSame($this->lang('EXTENSION_UPDATE_EXPLAIN'), $viglink_update_node->attr('title'));

$viglink_update_link = $viglink_update_node->link();
$crawler = self::$client->click($viglink_update_link);
$this->assertContainsLang('EXTENSIONS_UPDATED', $crawler->filter('.successbox > p')->text());
// Assert there's console log output
Expand Down
Loading