mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-04-20 07:42:09 +02:00
Code Issues Releases Wiki Activity

Merge pull request #6376 from lionel-rowe/ticket/16977

Browse Source 
[ticket/16977] Fix cron-job img tag layout and accessibility
This commit is contained in:
Marc Alexander 2022-04-10 22:34:03 +02:00
commit 3ee1efe7e0
No known key found for this signature in database
GPG Key ID: 50E0D2423696F995
12 changed files with 64 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
phpBB/config/default/container/services_cron.yml
View File

@ -6,6 +6,7 @@ services:
- '@routing.helper'
- '%core.root_path%'
- '%core.php_ext%'
- '@template'
cron.lock_db:
class: phpbb\lock\db

4
phpBB/phpbb/controller/helper.php
View File

@ -363,8 +363,8 @@ class helper
if ($task)
{
$url = $task->get_url();
$this->template->assign_var('RUN_CRON_TASK', '<img src="' . $url . '" width="1" height="1" alt="cron" />');
$cron_task_tag = $task->get_html_tag();
$this->template->assign_var('RUN_CRON_TASK', $cron_task_tag);
}
else
{

11
phpBB/phpbb/cron/manager.php
View File

@ -59,6 +59,11 @@ class manager
*/
protected $php_ext;
/**
* @var \phpbb\template\template
*/
protected $template;
/**
* Constructor. Loads all available tasks.
*
@ -66,13 +71,15 @@ class manager
* @param helper $routing_helper Routing helper
* @param string $phpbb_root_path Relative path to phpBB root
* @param string $php_ext PHP file extension
* @param \phpbb\template\template $template
*/
public function __construct(ContainerInterface $phpbb_container, helper $routing_helper, $phpbb_root_path, $php_ext)
public function __construct(ContainerInterface $phpbb_container, helper $routing_helper, $phpbb_root_path, $php_ext, $template)
{
$this->phpbb_container = $phpbb_container;
$this->routing_helper = $routing_helper;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
$this->template = $template;
}
/**
@ -193,6 +200,6 @@ class manager
*/
public function wrap_task(\phpbb\cron\task\task $task)
{
return new wrapper($task, $this->routing_helper, $this->phpbb_root_path, $this->php_ext);
return new wrapper($task, $this->routing_helper, $this->phpbb_root_path, $this->php_ext, $this->template);
}
}

26
phpBB/phpbb/cron/task/wrapper.php
View File

@ -41,6 +41,11 @@ class wrapper
*/
protected $php_ext;
/**
* @var \phpbb\template\template
*/
protected $template;
/**
* Constructor.
*
@ -50,13 +55,15 @@ class wrapper
* @param helper $routing_helper Routing helper for route generation
* @param string $phpbb_root_path Relative path to phpBB root
* @param string $php_ext PHP file extension
* @param \phpbb\template\template $template
*/
public function __construct(task $task, helper $routing_helper, $phpbb_root_path, $php_ext)
public function __construct(task $task, helper $routing_helper, $phpbb_root_path, $php_ext, $template)
{
$this->task = $task;
$this->routing_helper = $routing_helper;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
$this->template = $template;
}
/**
@ -105,6 +112,23 @@ class wrapper
return $this->routing_helper->route('phpbb_cron_run', $params);
}
/**
* Returns HTML for an invisible `img` tag that can be displayed on page
* load to trigger a request to the relevant cron task endpoint.
*
* @return string HTML to render to trigger cron task
*/
public function get_html_tag()
{
$this->template->set_filenames([
'cron_html_tag' => 'cron.html',
]);
$this->template->assign_var('CRON_TASK_URL', $this->get_url());
return $this->template->assign_display('cron_html_tag');
}
/**
* Forwards all other method calls to the wrapped task implementation.
*

7
phpBB/styles/all/template/cron.html Normal file
View File

@ -0,0 +1,7 @@
{#
Runs the cron task by triggering server request to the URL on load. `img` is
preferred over JS to ensure maximum compatibility. We use `class="sr-only"`
to hide visually and `aria-hidden="true"` to hide from screen-readers; using
`hidden` or `display: none` would prevent the task from running.
#}
<img class="sr-only" aria-hidden="true" src="{{ CRON_TASK_URL|e('html_attr') }}" width="1" height="1" alt="">

2
phpBB/styles/prosilver/template/overall_footer.html
View File

@ -60,7 +60,7 @@
<div>
<a id="bottom" class="anchor" accesskey="z"></a>
<!-- IF not S_IS_BOT -->{RUN_CRON_TASK}<!-- ENDIF -->
{% if not S_IS_BOT %}{{ RUN_CRON_TASK }}{% endif %}
</div>
<script src="{T_JQUERY_LINK}"></script>

8
phpBB/viewforum.php
View File

@ -244,8 +244,8 @@ if (!$config['use_system_cron'])
if ($task->is_ready())
{
$url = $task->get_url();
$template->assign_var('RUN_CRON_TASK', '<img src="' . $url . '" width="1" height="1" alt="cron" />');
$cron_task_tag = $task->get_html_tag();
$template->assign_var('RUN_CRON_TASK', $cron_task_tag);
}
else
{
@ -255,8 +255,8 @@ if (!$config['use_system_cron'])
if ($task->is_ready())
{
$url = $task->get_url();
$template->assign_var('RUN_CRON_TASK', '<img src="' . $url . '" width="1" height="1" alt="cron" />');
$cron_task_tag = $task->get_html_tag();
$template->assign_var('RUN_CRON_TASK', $cron_task_tag);
}
}
}

2
tests/console/cron/cron_list_test.php
View File

@ -105,7 +105,7 @@ class phpbb_console_command_cron_list_test extends phpbb_test_case
$mock_container = new phpbb_mock_container_builder();
$mock_container->set('cron.task_collection', []);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $pathEx);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $pathEx, null);
$this->cron_manager->load_tasks($tasks);
}

6
tests/console/cron/run_test.php
View File

@ -81,7 +81,7 @@ class phpbb_console_command_cron_run_test extends phpbb_database_test_case
$mock_container = new phpbb_mock_container_builder();
$mock_container->set('cron.task_collection', []);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx, null);
$this->cron_manager->load_tasks($tasks);
$this->assertSame('0', $config['cron_lock']);
@ -160,7 +160,7 @@ class phpbb_console_command_cron_run_test extends phpbb_database_test_case
$mock_container = new phpbb_mock_container_builder();
$mock_container->set('cron.task_collection', []);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx, null);
$this->cron_manager->load_tasks($tasks);
$command_tester = $this->get_command_tester();
@ -208,7 +208,7 @@ class phpbb_console_command_cron_run_test extends phpbb_database_test_case
$mock_container = new phpbb_mock_container_builder();
$mock_container->set('cron.task_collection', []);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx);
$this->cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx, null);
$this->cron_manager->load_tasks($tasks);
$command_tester = $this->get_command_tester();

18
tests/controller/common_helper_route.php
View File

@ -212,7 +212,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -275,7 +275,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -338,7 +338,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -401,7 +401,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -464,7 +464,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -527,7 +527,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -587,7 +587,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -650,7 +650,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,
@ -701,7 +701,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_database_test_
$this->auth,
$this->cache,
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, $this->root_path, 'php', null),
$this->db,
$this->dispatcher,
$this->language,

2
tests/cron/manager_test.php
View File

@ -105,7 +105,7 @@ class phpbb_cron_manager_test extends \phpbb_test_case
$mock_container = new phpbb_mock_container_builder();
$mock_container->set('cron.task_collection', []);
$cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx);
$cron_manager = new \phpbb\cron\manager($mock_container, $routing_helper, $phpbb_root_path, $phpEx, null);
$cron_manager->load_tasks($tasks);
return $cron_manager;

2
tests/pagination/pagination_test.php
View File

@ -70,7 +70,7 @@ class phpbb_pagination_pagination_test extends phpbb_template_template_test_case
new \phpbb\auth\auth(),
new \phpbb\cache\driver\dummy(),
$this->config,
new \phpbb\cron\manager($mock_container, $this->routing_helper, '', 'php'),
new \phpbb\cron\manager($mock_container, $this->routing_helper, '', 'php', null),
$db,
new phpbb_mock_event_dispatcher(),
new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx)),