From 87c1e631efba4569cceb26d9287567fe96c9ae92 Mon Sep 17 00:00:00 2001 From: lionel-rowe Date: Sat, 2 Apr 2022 18:10:53 +0100 Subject: [PATCH] [ticket/16977] Move HTML rendering logic to template PHPBB3-16977 --- .../default/container/services_cron.yml | 1 + phpBB/phpbb/controller/helper.php | 4 +-- phpBB/phpbb/cron/manager.php | 11 ++++++-- phpBB/phpbb/cron/task/wrapper.php | 26 ++++++++++++++++++- phpBB/styles/all/template/cron.html | 7 +++++ .../prosilver/template/overall_footer.html | 2 +- phpBB/viewforum.php | 8 +++--- 7 files changed, 49 insertions(+), 10 deletions(-) create mode 100644 phpBB/styles/all/template/cron.html diff --git a/phpBB/config/default/container/services_cron.yml b/phpBB/config/default/container/services_cron.yml index 44030c1750..0117339e29 100644 --- a/phpBB/config/default/container/services_cron.yml +++ b/phpBB/config/default/container/services_cron.yml @@ -6,6 +6,7 @@ services: - '@routing.helper' - '%core.root_path%' - '%core.php_ext%' + - '@template' cron.lock_db: class: phpbb\lock\db diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php index d4eef1c374..9c564f55ae 100644 --- a/phpBB/phpbb/controller/helper.php +++ b/phpBB/phpbb/controller/helper.php @@ -363,8 +363,8 @@ class helper if ($task) { - $url = $task->get_url(); - $this->template->assign_var('RUN_CRON_TASK', ''); + $cron_task_tag = $task->get_html_tag(); + $this->template->assign_var('RUN_CRON_TASK', $cron_task_tag); } else { diff --git a/phpBB/phpbb/cron/manager.php b/phpBB/phpbb/cron/manager.php index a8fdb13857..f717f23a6c 100644 --- a/phpBB/phpbb/cron/manager.php +++ b/phpBB/phpbb/cron/manager.php @@ -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); } } diff --git a/phpBB/phpbb/cron/task/wrapper.php b/phpBB/phpbb/cron/task/wrapper.php index 4dc3a7fb95..58de195acf 100644 --- a/phpBB/phpbb/cron/task/wrapper.php +++ b/phpBB/phpbb/cron/task/wrapper.php @@ -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. * diff --git a/phpBB/styles/all/template/cron.html b/phpBB/styles/all/template/cron.html new file mode 100644 index 0000000000..5e4c901263 --- /dev/null +++ b/phpBB/styles/all/template/cron.html @@ -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. +#} + diff --git a/phpBB/styles/prosilver/template/overall_footer.html b/phpBB/styles/prosilver/template/overall_footer.html index c07c1e1de2..5d872e2415 100644 --- a/phpBB/styles/prosilver/template/overall_footer.html +++ b/phpBB/styles/prosilver/template/overall_footer.html @@ -60,7 +60,7 @@
- {RUN_CRON_TASK} + {% if not S_IS_BOT %}{{ RUN_CRON_TASK }}{% endif %}
diff --git a/phpBB/viewforum.php b/phpBB/viewforum.php index 4eba9bde25..7f5cdd34da 100644 --- a/phpBB/viewforum.php +++ b/phpBB/viewforum.php @@ -244,8 +244,8 @@ if (!$config['use_system_cron']) if ($task->is_ready()) { - $url = $task->get_url(); - $template->assign_var('RUN_CRON_TASK', ''); + $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', ''); + $cron_task_tag = $task->get_html_tag(); + $template->assign_var('RUN_CRON_TASK', $cron_task_tag); } } }