diff --git a/phpBB/config/default/container/services.yml b/phpBB/config/default/container/services.yml index ba78673211..73260f7a92 100644 --- a/phpBB/config/default/container/services.yml +++ b/phpBB/config/default/container/services.yml @@ -45,6 +45,7 @@ services: - '@cache.driver' - '@config' - '@dbal.conn' + - '@dispatcher' - '%core.root_path%' - '%core.php_ext%' diff --git a/phpBB/phpbb/cache/service.php b/phpBB/phpbb/cache/service.php index 7534c417e8..e5ef4240aa 100644 --- a/phpBB/phpbb/cache/service.php +++ b/phpBB/phpbb/cache/service.php @@ -15,6 +15,7 @@ namespace phpbb\cache; use phpbb\cache\driver\driver_interface; use phpbb\config\config; +use phpbb\event\dispatcher; use phpbb\json\sanitizer as json_sanitizer; /** @@ -22,6 +23,12 @@ use phpbb\json\sanitizer as json_sanitizer; */ class service { + /** @var string Name of event used for cache purging */ + private const PURGE_DEFERRED_ON_EVENT = 'core.garbage_collection'; + + /** @var bool Flag whether cache purge has been deferred */ + private $cache_purge_deferred = false; + /** * Cache driver. * @@ -43,6 +50,9 @@ class service */ protected $db; + /** @var dispatcher phpBB Event dispatcher */ + protected $dispatcher; + /** * Root path. * @@ -63,14 +73,16 @@ class service * @param driver_interface $driver The cache driver * @param config $config The config * @param \phpbb\db\driver\driver_interface $db Database connection + * @param dispatcher $dispatcher Event dispatcher * @param string $phpbb_root_path Root path * @param string $php_ext PHP file extension */ - public function __construct(driver_interface $driver, config $config, \phpbb\db\driver\driver_interface $db, $phpbb_root_path, $php_ext) + public function __construct(driver_interface $driver, config $config, \phpbb\db\driver\driver_interface $db, dispatcher $dispatcher, $phpbb_root_path, $php_ext) { $this->set_driver($driver); $this->config = $config; $this->db = $db; + $this->dispatcher = $dispatcher; $this->phpbb_root_path = $phpbb_root_path; $this->php_ext = $php_ext; } @@ -85,6 +97,25 @@ class service return $this->driver; } + /** + * Deferred purge of the cache. + * + * A deferred purge will be executed after rendering a page. + * It is recommended to be used in cases where an instant purge of the cache + * is not required, i.e. when the goal of a cache purge is to start from a + * clear cache at the next page load. + * + * @return void + */ + public function deferred_purge(): void + { + if (!$this->cache_purge_deferred) + { + $this->dispatcher->addListener(self::PURGE_DEFERRED_ON_EVENT, [$this, 'purge']); + $this->cache_purge_deferred = true; + } + } + /** * Replaces the cache driver used by this cache service. * diff --git a/phpBB/phpbb/extension/manager.php b/phpBB/phpbb/extension/manager.php index 768c88f3c2..c012d9a989 100644 --- a/phpBB/phpbb/extension/manager.php +++ b/phpBB/phpbb/extension/manager.php @@ -196,7 +196,7 @@ class manager if ($this->cache) { - $this->cache->purge(); + $this->cache->deferred_purge(); } } diff --git a/tests/attachment/upload_test.php b/tests/attachment/upload_test.php index 6e47ef35ee..298ffcfd98 100644 --- a/tests/attachment/upload_test.php +++ b/tests/attachment/upload_test.php @@ -87,7 +87,8 @@ class phpbb_attachment_upload_test extends \phpbb_database_test_case $config = $this->config; $this->phpbb_root_path = $phpbb_root_path; $this->db = $this->new_dbal(); - $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), $this->config, $this->db, $phpbb_root_path, $phpEx); + $this->phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), $this->config, $this->db, $this->phpbb_dispatcher, $phpbb_root_path, $phpEx); $this->request = $this->createMock('\phpbb\request\request'); $this->filesystem = new \phpbb\filesystem\filesystem(); diff --git a/tests/cache/common_test_case.php b/tests/cache/common_test_case.php index 023fa7e962..cb98b15086 100644 --- a/tests/cache/common_test_case.php +++ b/tests/cache/common_test_case.php @@ -74,7 +74,8 @@ abstract class phpbb_cache_common_test_case extends phpbb_database_test_case global $db, $cache, $phpbb_root_path, $phpEx; $config = new phpbb\config\config(array()); $db = $this->new_dbal(); - $cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_root_path, $phpEx); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_dispatcher, $phpbb_root_path, $phpEx); $sql = "SELECT * FROM phpbb_config WHERE config_name = 'foo'"; diff --git a/tests/cache/dummy_driver_test.php b/tests/cache/dummy_driver_test.php index c26d507e4e..f73155542f 100644 --- a/tests/cache/dummy_driver_test.php +++ b/tests/cache/dummy_driver_test.php @@ -52,7 +52,8 @@ class phpbb_cache_dummy_driver_test extends phpbb_database_test_case global $db, $cache, $phpbb_root_path, $phpEx; $config = new phpbb\config\config(array()); $db = $this->new_dbal(); - $cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_root_path, $phpEx); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_dispatcher, $phpbb_root_path, $phpEx); $sql = "SELECT * FROM phpbb_config WHERE config_name = 'foo'"; diff --git a/tests/dbal/migrator_tool_module_test.php b/tests/dbal/migrator_tool_module_test.php index 80dc8f1182..2d5daa298c 100644 --- a/tests/dbal/migrator_tool_module_test.php +++ b/tests/dbal/migrator_tool_module_test.php @@ -32,13 +32,13 @@ class phpbb_dbal_migrator_tool_module_test extends phpbb_database_test_case $skip_add_log = true; $db = $this->db = $this->new_dbal(); - $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_root_path, $phpEx); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx); $lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx); $lang = new \phpbb\language\language($lang_loader); $user = $this->user = new \phpbb\user($lang, '\phpbb\datetime'); $cache = new phpbb_mock_cache; - $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); $auth = $this->createMock('\phpbb\auth\auth'); $phpbb_log = new \phpbb\log\log($db, $user, $auth, $phpbb_dispatcher, $phpbb_root_path, 'adm/', $phpEx, LOG_TABLE); diff --git a/tests/dbal/migrator_tool_permission_role_test.php b/tests/dbal/migrator_tool_permission_role_test.php index 48e45bf2d5..55bda8c0ce 100644 --- a/tests/dbal/migrator_tool_permission_role_test.php +++ b/tests/dbal/migrator_tool_permission_role_test.php @@ -64,7 +64,8 @@ class phpbb_dbal_migrator_tool_permission_role_test extends phpbb_database_test_ parent::setup(); $db = $this->db = $this->new_dbal(); - $cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_root_path, $phpEx); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx); $this->auth = new \phpbb\auth\auth(); // Initialize this auth_admin instance later after adding new auth options via this->tool->add() diff --git a/tests/dbal/migrator_tool_permission_test.php b/tests/dbal/migrator_tool_permission_test.php index 4009b3ceb3..e1ea2e7b51 100644 --- a/tests/dbal/migrator_tool_permission_test.php +++ b/tests/dbal/migrator_tool_permission_test.php @@ -38,7 +38,8 @@ class phpbb_dbal_migrator_tool_permission_test extends phpbb_database_test_case parent::setUp(); $db = $this->db = $this->new_dbal(); - $cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_root_path, $phpEx); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx); $this->auth = new \phpbb\auth\auth(); $this->tool = new \phpbb\db\migration\tool\permission($this->db, $this->cache, $this->auth, $phpbb_root_path, $phpEx); diff --git a/tests/extension/manager_test.php b/tests/extension/manager_test.php index d8b899ad7f..68e31d0af0 100644 --- a/tests/extension/manager_test.php +++ b/tests/extension/manager_test.php @@ -159,6 +159,7 @@ class phpbb_extension_manager_test extends phpbb_database_test_case $config = new \phpbb\config\config(array('version' => PHPBB_VERSION)); $db = $this->new_dbal(); $db_doctrine = $this->new_doctrine_dbal(); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); $factory = new \phpbb\db\tools\factory(); $finder_factory = new \phpbb\finder\factory(null, false, $phpbb_root_path, $php_ext); $db_tools = $factory->get($db_doctrine); @@ -188,7 +189,7 @@ class phpbb_extension_manager_test extends phpbb_database_test_case $finder_factory, 'phpbb_ext', __DIR__ . '/', - ($with_cache) ? new \phpbb\cache\service(new phpbb_mock_cache(), $config, $db, $phpbb_root_path, $php_ext) : null + ($with_cache) ? new \phpbb\cache\service(new phpbb_mock_cache(), $config, $db, $phpbb_dispatcher, $phpbb_root_path, $php_ext) : null ); } } diff --git a/tests/extension/metadata_manager_test.php b/tests/extension/metadata_manager_test.php index df246ffeab..d120d78109 100644 --- a/tests/extension/metadata_manager_test.php +++ b/tests/extension/metadata_manager_test.php @@ -42,13 +42,14 @@ class phpbb_extension_metadata_manager_test extends phpbb_database_test_case )); $this->db = $this->new_dbal(); $this->db_doctrine = $this->new_doctrine_dbal(); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); $factory = new \phpbb\db\tools\factory(); $this->db_tools = $factory->get($this->db_doctrine); $finder_factory = $this->createMock('\phpbb\finder\factory'); $this->phpbb_root_path = __DIR__ . '/'; $this->phpEx = 'php'; - $this->cache = new \phpbb\cache\service(new phpbb_mock_cache(), $this->config, $this->db, $this->phpbb_root_path, $this->phpEx); + $this->cache = new \phpbb\cache\service(new phpbb_mock_cache(), $this->config, $this->db, $phpbb_dispatcher, $this->phpbb_root_path, $this->phpEx); $this->table_prefix = 'phpbb_'; @@ -72,7 +73,7 @@ class phpbb_extension_metadata_manager_test extends phpbb_database_test_case $cache_path, null, $loader, - new \phpbb\event\dispatcher(), + $phpbb_dispatcher, array( 'cache' => false, 'debug' => false, diff --git a/tests/mention/controller_test.php b/tests/mention/controller_test.php index c473da9db6..664ab2bc92 100644 --- a/tests/mention/controller_test.php +++ b/tests/mention/controller_test.php @@ -59,18 +59,19 @@ class phpbb_mention_controller_test extends phpbb_database_test_case 'mention_names_limit' => 3, )); + // Event dispatcher + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $cache_driver = new \phpbb\cache\driver\dummy(); $cache = new \phpbb\cache\service( $cache_driver, $config, $db, + $phpbb_dispatcher, $phpbb_root_path, $phpEx ); - // Event dispatcher - $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); - // Language $lang = new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx)); diff --git a/tests/notification/base.php b/tests/notification/base.php index d1ceb9aabd..ec1f6e065b 100644 --- a/tests/notification/base.php +++ b/tests/notification/base.php @@ -84,17 +84,17 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case $this->user = $user; $this->user_loader = new \phpbb\user_loader($avatar_helper, $this->db, $phpbb_root_path, $phpEx, 'phpbb_users'); $auth = $this->auth = new phpbb_mock_notifications_auth(); + $this->phpbb_dispatcher = new phpbb_mock_event_dispatcher(); $cache_driver = new \phpbb\cache\driver\dummy(); $cache = $this->cache = new \phpbb\cache\service( $cache_driver, $this->config, $this->db, + $this->phpbb_dispatcher, $phpbb_root_path, $phpEx ); - $this->phpbb_dispatcher = new phpbb_mock_event_dispatcher(); - $phpbb_container = $this->container = new ContainerBuilder(); $loader = new YamlFileLoader($phpbb_container, new FileLocator(__DIR__ . '/fixtures')); $loader->load('services_notification.yml'); diff --git a/tests/notification/notification_method_email_test.php b/tests/notification/notification_method_email_test.php index 2c71b0eda9..12cd802cbd 100644 --- a/tests/notification/notification_method_email_test.php +++ b/tests/notification/notification_method_email_test.php @@ -61,17 +61,17 @@ class notification_method_email_test extends phpbb_tests_notification_base $this->user = $user; $this->user_loader = new \phpbb\user_loader($avatar_helper, $this->db, $phpbb_root_path, $phpEx, 'phpbb_users'); $auth = $this->auth = new phpbb_mock_notifications_auth(); + $this->phpbb_dispatcher = new phpbb_mock_event_dispatcher(); $cache_driver = new \phpbb\cache\driver\dummy(); $cache = $this->cache = new \phpbb\cache\service( $cache_driver, $this->config, $this->db, + $this->phpbb_dispatcher, $phpbb_root_path, $phpEx ); - $this->phpbb_dispatcher = new phpbb_mock_event_dispatcher(); - $phpbb_container = $this->container = new ContainerBuilder(); $loader = new YamlFileLoader($phpbb_container, new FileLocator(__DIR__ . '/fixtures')); $loader->load('services_notification.yml'); diff --git a/tests/notification/submit_post_base.php b/tests/notification/submit_post_base.php index c0ef8f3caa..db3ad6bd34 100644 --- a/tests/notification/submit_post_base.php +++ b/tests/notification/submit_post_base.php @@ -82,18 +82,19 @@ abstract class phpbb_notification_submit_post_base extends phpbb_database_test_c 'allow_mentions' => true, )); + // Event dispatcher + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + $cache_driver = new \phpbb\cache\driver\dummy(); $cache = new \phpbb\cache\service( $cache_driver, $config, $db, + $phpbb_dispatcher, $phpbb_root_path, $phpEx ); - // Event dispatcher - $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); - // Language $lang = new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx)); diff --git a/tests/notification/user_list_trim_test.php b/tests/notification/user_list_trim_test.php index 2704b36c01..6ae225b667 100644 --- a/tests/notification/user_list_trim_test.php +++ b/tests/notification/user_list_trim_test.php @@ -35,6 +35,7 @@ class phpbb_notification_user_list_trim_test extends phpbb_database_test_case new \phpbb\cache\driver\dummy(), $config, $db, + $phpbb_dispatcher, $phpbb_root_path, $phpEx ); diff --git a/tests/session/check_ban_test.php b/tests/session/check_ban_test.php index 147274398d..7b0aac060c 100644 --- a/tests/session/check_ban_test.php +++ b/tests/session/check_ban_test.php @@ -58,6 +58,10 @@ class phpbb_session_check_ban_test extends phpbb_session_test_case $phpbb_filesystem = new \phpbb\filesystem\filesystem(); $this->backup_cache = $cache; + + // Event dispatcher + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); + // Change the global cache object for this test because // the mock cache object does not hit the database as is needed // for this test. @@ -65,6 +69,7 @@ class phpbb_session_check_ban_test extends phpbb_session_test_case new \phpbb\cache\driver\file(), $config, $this->db, + $phpbb_dispatcher, $phpbb_root_path, $phpEx ); diff --git a/tests/test_framework/phpbb_functional_test_case.php b/tests/test_framework/phpbb_functional_test_case.php index cce113d144..84d9d08c55 100644 --- a/tests/test_framework/phpbb_functional_test_case.php +++ b/tests/test_framework/phpbb_functional_test_case.php @@ -268,8 +268,15 @@ class phpbb_functional_test_case extends phpbb_test_case array(), new \phpbb\db\migration\helper() ); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); $container->set('migrator', $migrator); - $container->set('dispatcher', new phpbb_mock_event_dispatcher()); + $container->set('dispatcher', $phpbb_dispatcher); + $cache = $this->getMockBuilder('\phpbb\cache\service') + ->setConstructorArgs([$this->get_cache_driver(), $config, $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx]) + ->setMethods(['deferred_purge']) + ->getMock(); + $cache->method('deferred_purge') + ->willReturnCallback([$cache, 'purge']); $extension_manager = new \phpbb\extension\manager( $container, @@ -278,7 +285,7 @@ class phpbb_functional_test_case extends phpbb_test_case $finder_factory, self::$config['table_prefix'] . 'ext', __DIR__ . '/', - new \phpbb\cache\service($this->get_cache_driver(), $config, $this->db, $phpbb_root_path, $phpEx) + $cache ); return $extension_manager; diff --git a/tests/version/version_helper_remote_test.php b/tests/version/version_helper_remote_test.php index 7e0fbbbdb4..de88c281ff 100644 --- a/tests/version/version_helper_remote_test.php +++ b/tests/version/version_helper_remote_test.php @@ -30,10 +30,11 @@ class version_helper_remote_test extends \phpbb_test_case 'version' => '3.1.0', )); $container = new \phpbb_mock_container_builder(); + $phpbb_dispatcher = new phpbb_mock_event_dispatcher(); $db = new \phpbb\db\driver\factory($container); $this->cache = $this->getMockBuilder('\phpbb\cache\service') ->setMethods(array('get')) - ->setConstructorArgs(array(new \phpbb\cache\driver\dummy(), $config, $db, '../../', 'php')) + ->setConstructorArgs(array(new \phpbb\cache\driver\dummy(), $config, $db, $phpbb_dispatcher, '../../', 'php')) ->getMock(); $this->cache->expects($this->any())