[ticket/16649] Add compiler pass to make all services public

This also handles BC for phpBB extensions

PHPBB3-16639

phpBB/config/default/container/services.yml

@@ -36,8 +36,6 @@ imports:
     - { resource: parameters.yml }
 
 services:
-    _defaults: { public: true }
-
     cache:
         class: phpbb\cache\service
         arguments:

phpBB/config/default/container/services_attachment.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     attachment.delete:
         class: phpbb\attachment\delete
         shared: false

phpBB/config/default/container/services_auth.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
 # ----- Auth management -----
     auth:
         class: phpbb\auth\auth

phpBB/config/default/container/services_avatar.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     avatar.manager:
         class: phpbb\avatar\manager
         arguments:

phpBB/config/default/container/services_captcha.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     captcha.factory:
         class: phpbb\captcha\factory
         arguments:

phpBB/config/default/container/services_console.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     console.exception_subscriber:
         class: phpbb\console\exception_subscriber
         arguments:

phpBB/config/default/container/services_content.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     content.visibility:
         class: phpbb\content_visibility
         arguments:

phpBB/config/default/container/services_cron.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     cron.manager:
         class: phpbb\cron\manager
         arguments:

phpBB/config/default/container/services_db.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     dbal.conn:
         class: phpbb\db\driver\factory
         arguments:

phpBB/config/default/container/services_event.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     dispatcher:
         class: phpbb\event\dispatcher
         arguments:

phpBB/config/default/container/services_extensions.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     ext.manager:
         class: phpbb\extension\manager
         arguments:

phpBB/config/default/container/services_feed.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     phpbb.feed.controller:
         class: phpbb\feed\controller\feed
         arguments:

phpBB/config/default/container/services_files.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     files.factory:
         class: phpbb\files\factory
         arguments:

phpBB/config/default/container/services_filesystem.yml

@@ -2,8 +2,6 @@ parameters:
     core.filesystem.cache_temp_dir: '%core.cache_dir%tmp/'
 
 services:
-    _defaults: { public: true }
-
     filesystem:
         class: phpbb\filesystem\filesystem
 

phpBB/config/default/container/services_help.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     phpbb.help.manager:
         class: phpbb\help\manager
         arguments:

phpBB/config/default/container/services_http.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     http_kernel:
         class: Symfony\Component\HttpKernel\HttpKernel
         arguments:

phpBB/config/default/container/services_language.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     language.helper.language_file:
         class: phpbb\language\language_file_helper
         arguments:

phpBB/config/default/container/services_migrator.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
 # ----- Migrator -----
     migrator:
         class: phpbb\db\migrator

phpBB/config/default/container/services_mimetype_guesser.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     mimetype.guesser_collection:
         class: phpbb\di\service_collection
         arguments:

phpBB/config/default/container/services_module.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     module.manager:
         class: phpbb\module\module_manager
         arguments:

phpBB/config/default/container/services_notification.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     notification_manager:
         class: phpbb\notification\manager
         arguments:

phpBB/config/default/container/services_password.yml

@@ -5,8 +5,6 @@ parameters:
     passwords.driver.bcrypt_cost: 10
 
 services:
-    _defaults: { public: true }
-
 # ----- Password management -----
     passwords.manager:
         class: phpbb\passwords\manager

phpBB/config/default/container/services_php.yml

@@ -1,5 +1,3 @@
 services:
-    _defaults: { public: true }
-
     php_ini:
         class: bantu\IniGetWrapper\IniGetWrapper

phpBB/config/default/container/services_profilefield.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     profilefields.manager:
         class: phpbb\profilefields\manager
         arguments:

phpBB/config/default/container/services_report.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
 # ----- Report controller -----
     phpbb.report.controller:
         class: phpbb\report\controller\report

phpBB/config/default/container/services_routing.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     router:
         class: phpbb\routing\router
         arguments:

phpBB/config/default/container/services_storage.yml

@@ -1,5 +1,4 @@
 services:
-    _defaults: { public: true }
 
 # Storages
     storage.attachment:

phpBB/config/default/container/services_text_formatter.yml

@@ -4,8 +4,6 @@ parameters:
     text_formatter.cache.renderer.key: _text_formatter_renderer
 
 services:
-    _defaults: { public: true }
-
     text_formatter.acp_utils:
         class: phpbb\textformatter\s9e\acp_utils
         arguments:

phpBB/config/default/container/services_text_reparser.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     text_reparser.manager:
         class: phpbb\textreparser\manager
         arguments:

phpBB/config/default/container/services_twig.yml

@@ -2,8 +2,6 @@ parameters:
     core.template.cache_path: '%core.cache_dir%twig/'
 
 services:
-    _defaults: { public: true }
-
     template.twig.environment:
         class: phpbb\template\twig\environment
         arguments:

phpBB/config/default/container/services_twig_extensions.yml

@@ -1,8 +1,6 @@
 # Twig extensions not needed by the installer
 
 services:
-    _defaults: { public: true }
-
     template.twig.extensions.icon:
         class: phpbb\template\twig\extension\icon
         arguments:

phpBB/config/default/container/services_ucp.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     phpbb.ucp.controller.reset_password:
         class: phpbb\ucp\controller\reset_password
         arguments:

phpBB/config/default/container/services_user.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     acl.permissions:
         class: phpbb\permissions
         arguments:

phpBB/config/installer/container/services.yml

@@ -9,8 +9,6 @@ imports:
     - { resource: ../../default/container/services_twig.yml }
 
 services:
-    _defaults: { public: true }
-
     cache.driver:
         class: '%cache.driver.class%'
         arguments:

phpBB/config/installer/container/services_file_updater.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.file_updater.factory:
         class: phpbb\install\helper\file_updater\factory
         arguments:

phpBB/config/installer/container/services_install_console.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     console.installer.command_collection:
         class: phpbb\di\service_collection
         arguments:

phpBB/config/installer/container/services_install_controller.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     phpbb.installer.controller.welcome:
         class: phpbb\install\controller\installer_index
         arguments:

phpBB/config/installer/container/services_install_database.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.install_database.create_schema_file:
         class: phpbb\install\module\install_database\task\create_schema_file
         arguments:

phpBB/config/installer/container/services_install_filesystem.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.install_filesystem.create_config_file:
         class: phpbb\install\module\install_filesystem\task\create_config_file
         arguments:

phpBB/config/installer/container/services_install_finish.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.install_finish.populate_migrations:
         class: phpbb\install\module\install_finish\task\populate_migrations
         arguments:

phpBB/config/installer/container/services_install_navigation.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.navigation.provider:
         class: phpbb\install\helper\navigation\navigation_provider
         arguments:

phpBB/config/installer/container/services_install_obtain_data.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.obtain_data.obtain_admin_data:
         class: phpbb\install\module\obtain_data\task\obtain_admin_data
         arguments:

phpBB/config/installer/container/services_install_requirements.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.requirements.check_filesystem:
         class: phpbb\install\module\requirements\task\check_filesystem
         arguments:

phpBB/config/installer/container/services_installer.yml

@@ -15,8 +15,6 @@ imports:
     - { resource: services_update_requirements.yml }
 
 services:
-    _defaults: { public: true }
-
 # -------- Installer helpers ------------------------
     installer.helper.config:
         class: phpbb\install\helper\config

phpBB/config/installer/container/services_update_database.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.update_database.update_task:
         class: phpbb\install\module\update_database\task\update
         arguments:

phpBB/config/installer/container/services_update_filesystem.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.update_filesystem.check_task:
         class: phpbb\install\module\update_filesystem\task\file_check
         arguments:

phpBB/config/installer/container/services_update_obtain_data.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.obtain_data.update_options:
         class: phpbb\install\module\obtain_data\task\obtain_update_settings
         arguments:

phpBB/config/installer/container/services_update_requirements.yml

@@ -1,6 +1,4 @@
 services:
-    _defaults: { public: true }
-
     installer.requirements.check_filesystem_update:
         class: phpbb\install\module\requirements\task\check_filesystem
         arguments:

phpBB/phpbb/di/container_builder.php

@@ -198,6 +198,9 @@ class container_builder
 
 				$this->container = $this->create_container($this->container_extensions);
 
+				// Mark all services public
+				$this->container->addCompilerPass(new pass\markpublic_pass());
+
 				// Easy collections through tags
 				$this->container->addCompilerPass(new pass\collection_pass());
 

phpBB/phpbb/di/pass/markpublic_pass.php

@@ -0,0 +1,40 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\di\pass;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+/**
+* Marks all services public
+*/
+class markpublic_pass implements CompilerPassInterface
+{
+	/**
+	* Modify the container before it is passed to the rest of the code
+	*
+	* @param ContainerBuilder $container ContainerBuilder object
+	* @return null
+	*/
+	public function process(ContainerBuilder $container)
+	{
+		foreach ($container->getDefinitions() as $definition)
+		{
+			if ($definition->isPrivate())
+			{
+				$definition->setPublic(true);
+			}
+		}
+	}
+}

tests/controller/config/services.yml

@@ -1,4 +1,3 @@
 services:
-    _defaults: { public: true }
     core_foo.controller:
         class: phpbb\controller\foo

tests/controller/ext/vendor2/bar/config/services.yml

@@ -1,4 +1,3 @@
 services:
-    _defaults: { public: true }
     bar.controller:
         class: bar\controller

tests/controller/ext/vendor2/foo/config/services.yml

@@ -1,4 +1,3 @@
 services:
-    _defaults: { public: true }
     foo.controller:
         class: foo\controller

tests/di/fixtures/config/production/container/environment.yml

@@ -5,7 +5,6 @@ parameters:
     tables.acl_roles: '%core.table_prefix%acl_roles'
 
 services:
-    _defaults: { public: true }
     config.php:
         synthetic: true
 

tests/di/fixtures/config/test/container/environment.yml

@@ -5,7 +5,6 @@ parameters:
     tables.acl_roles: '%core.table_prefix%acl_roles'
 
 services:
-    _defaults: { public: true }
     config.php:
         synthetic: true
 

tests/di/fixtures/other_config/production/container/environment.yml

@@ -2,7 +2,6 @@ parameters:
     other_config: true
 
 services:
-    _defaults: { public: true }
     config.php:
         synthetic: true
 

tests/di/fixtures/other_config/test/container/environment.yml

@@ -2,7 +2,6 @@ parameters:
     other_config: true
 
 services:
-    _defaults: { public: true }
     config.php:
         synthetic: true
 

tests/functional/fixtures/ext/foo/bar/config/services.yml

@@ -1,5 +1,4 @@
 services:
-    _defaults: { public: true }
     foo_bar.controller:
         class: foo\bar\controller\controller
         arguments:

tests/functional/fixtures/ext/foo/foo/config/services.yml

@@ -1,4 +1,3 @@
 services:
-    _defaults: { public: true }
     foo_foo.controller:
         class: foo\foo\controller\controller

tests/notification/fixtures/services_notification.yml

@@ -2,7 +2,6 @@ imports:
     - { resource: ../../../phpBB/config/default/container/services_notification.yml }
 
 services:
-    _defaults: { public: true }
     notification_manager:
         synthetic: true