[ticket/13697] Moving filesystem related functions to filesystem service

* Moving filesystem service to \phpbb\filesystem namespace * Wraping Symfony's Filesystem component * Moving filesystem related functions from includes/functions.php into \phpbb\filesystem\filesystem Functions moved (and deprecated): - phpbb_chmod - phpbb_is_writable - phpbb_is_absolute - phpbb_own_realpath - phpbb_realpath * Adding interface for filesystem service PHPBB3-13697
LukeWCS · Apr 16, 2015 · 4bdef6f · 4bdef6f
1 parent f86c5d9
commit 4bdef6f
Show file tree

Hide file tree

Showing 82 changed files with 1,860 additions and 658 deletions.
diff --git a/phpBB/common.php b/phpBB/common.php
@@ -59,7 +59,7 @@
 
 	// Eliminate . and .. from the path
 	require($phpbb_root_path . 'phpbb/filesystem.' . $phpEx);
-	$phpbb_filesystem = new phpbb\filesystem();
+	$phpbb_filesystem = new phpbb\filesystem\filesystem();
 	$script_path = $phpbb_filesystem->clean_path($script_path);
 
 	$url = (($secure) ? 'https://' : 'http://') . $server_name;

diff --git a/phpBB/composer.json b/phpBB/composer.json
@@ -32,6 +32,7 @@
 		"symfony/console": "2.7.*@dev",
 		"symfony/dependency-injection": "2.7.*@dev",
 		"symfony/event-dispatcher": "2.7.*@dev",
+		"symfony/filesystem": "2.7.*@dev",
 		"symfony/http-kernel": "2.7.*@dev",
 		"symfony/routing": "2.7.*@dev",
 		"symfony/security-core": "2.7.*@dev",
@@ -51,7 +52,6 @@
 		"symfony/css-selector": "2.7.*@dev",
 		"symfony/debug": "2.7.*@dev",
 		"symfony/dom-crawler": "2.7.*@dev",
-		"symfony/filesystem": "2.7.*@dev",
 		"symfony/finder": "2.7.*@dev",
 		"symfony/http-foundation": "2.7.*@dev",
 		"symfony/process": "2.7.*@dev"

diff --git a/phpBB/config/default/container/services.yml b/phpBB/config/default/container/services.yml
@@ -103,7 +103,7 @@ services:
             - @cache.driver
 
     filesystem:
-        class: phpbb\filesystem
+        class: phpbb\filesystem\filesystem
 
     file_downloader:
         class: phpbb\file_downloader
@@ -159,6 +159,7 @@ services:
     router:
         class: phpbb\routing\router
         arguments:
+            - @filesystem
             - @ext.manager
             - %core.root_path%
             - %core.php_ext%

diff --git a/phpBB/config/default/container/services_avatar.yml b/phpBB/config/default/container/services_avatar.yml
@@ -58,6 +58,7 @@ services:
             - @config
             - %core.root_path%
             - %core.php_ext%
+            - @filesystem
             - @path_helper
             - @mimetype.guesser
             - @cache.driver

diff --git a/phpBB/config/default/container/services_console.yml b/phpBB/config/default/container/services_console.yml
@@ -84,6 +84,7 @@ services:
             - @config
             - @cache
             - @log
+            - @filesystem
             - %core.root_path%
         tags:
             - { name: console.command }

diff --git a/phpBB/config/default/container/services_twig.yml b/phpBB/config/default/container/services_twig.yml
@@ -19,6 +19,8 @@ services:
 
     template.twig.loader:
         class: phpbb\template\twig\loader
+        arguments:
+            - @filesystem
 
     template.twig.extensions.collection:
         class: phpbb\di\service_collection

diff --git a/phpBB/develop/create_schema_files.php b/phpBB/develop/create_schema_files.php
@@ -43,7 +43,7 @@
 $phpbb_class_loader = new \phpbb\class_loader('phpbb\\', "{$phpbb_root_path}phpbb/", $phpEx);
 $phpbb_class_loader->register();
 
-$finder = new \phpbb\finder(new \phpbb\filesystem(), $phpbb_root_path);
+$finder = new \phpbb\finder(new \phpbb\filesystem\filesystem(), $phpbb_root_path);
 $classes = $finder->core_path('phpbb/')
 	->directory('/db/migration/data')
 	->get_classes();

diff --git a/phpBB/develop/mysql_upgrader.php b/phpBB/develop/mysql_upgrader.php
@@ -62,7 +62,7 @@
 
 @set_time_limit(0);
 
-$finder = new \phpbb\finder(new \phpbb\filesystem(), $phpbb_root_path);
+$finder = new \phpbb\finder(new \phpbb\filesystem\filesystem(), $phpbb_root_path);
 $classes = $finder->core_path('phpbb/')
 	->directory('/db/migration/data')
 	->get_classes();

diff --git a/phpBB/includes/acp/acp_attachments.php b/phpBB/includes/acp/acp_attachments.php
@@ -36,13 +36,16 @@ class acp_attachments
 	/** @var \phpbb\user */
 	protected $user;
 
+	/** @var  \phpbb\filesystem\filesystem_interface */
+	protected $filesystem;
+
 	public $id;
 	public $u_action;
 	protected $new_config;
 
 	function main($id, $mode)
 	{
-		global $db, $user, $auth, $template, $cache, $phpbb_container;
+		global $db, $user, $auth, $template, $cache, $phpbb_container, $phpbb_filesystem;
 		global $config, $phpbb_admin_path, $phpbb_root_path, $phpEx, $phpbb_log, $request;
 
 		$this->id = $id;
@@ -51,6 +54,7 @@ function main($id, $mode)
 		$this->template = $template;
 		$this->user = $user;
 		$this->phpbb_container = $phpbb_container;
+		$this->filesystem = $phpbb_filesystem;
 
 		$user->add_lang(array('posting', 'viewtopic', 'acp/attachments'));
 
@@ -1501,7 +1505,15 @@ function test_upload(&$error, $upload_dir, $create_directory = false)
 			if (!file_exists($phpbb_root_path . $upload_dir))
 			{
 				@mkdir($phpbb_root_path . $upload_dir, 0777);
-				phpbb_chmod($phpbb_root_path . $upload_dir, CHMOD_READ | CHMOD_WRITE);
+
+				try
+				{
+					$this->filesystem->phpbb_chmod($phpbb_root_path . $upload_dir, CHMOD_READ | CHMOD_WRITE);
+				}
+				catch (\phpbb\filesystem\exception\filesystem_exception $e)
+				{
+					// Do nothing
+				}
 			}
 		}
 
@@ -1517,7 +1529,7 @@ function test_upload(&$error, $upload_dir, $create_directory = false)
 			return;
 		}
 
-		if (!phpbb_is_writable($phpbb_root_path . $upload_dir))
+		if (!$this->filesystem->is_writable($phpbb_root_path . $upload_dir))
 		{
 			$error[] = sprintf($user->lang['NO_WRITE_UPLOAD'], $upload_dir);
 			return;

diff --git a/phpBB/includes/acp/acp_main.php b/phpBB/includes/acp/acp_main.php
@@ -26,7 +26,7 @@ class acp_main
 	function main($id, $mode)
 	{
 		global $config, $db, $cache, $user, $auth, $template, $request, $phpbb_log;
-		global $phpbb_root_path, $phpbb_admin_path, $phpEx, $phpbb_container, $phpbb_dispatcher;
+		global $phpbb_root_path, $phpbb_admin_path, $phpEx, $phpbb_container, $phpbb_dispatcher, $phpbb_filesystem;
 
 		// Show restore permissions notice
 		if ($user->data['user_perm_from'] && $auth->acl_get('a_switchperm'))
@@ -644,7 +644,7 @@ function main($id, $mode)
 			}
 		}
 
-		if (!defined('PHPBB_DISABLE_CONFIG_CHECK') && file_exists($phpbb_root_path . 'config.' . $phpEx) && phpbb_is_writable($phpbb_root_path . 'config.' . $phpEx))
+		if (!defined('PHPBB_DISABLE_CONFIG_CHECK') && file_exists($phpbb_root_path . 'config.' . $phpEx) && $phpbb_filesystem->is_writable($phpbb_root_path . 'config.' . $phpEx))
 		{
 			// World-Writable? (000x)
 			$template->assign_var('S_WRITABLE_CONFIG', (bool) (@fileperms($phpbb_root_path . 'config.' . $phpEx) & 0x0002));

diff --git a/phpBB/includes/bbcode.php b/phpBB/includes/bbcode.php
@@ -129,7 +129,7 @@ function bbcode_second_pass(&$message, $bbcode_uid = '', $bbcode_bitfield = fals
 	*/
 	function bbcode_cache_init()
 	{
-		global $phpbb_root_path, $phpEx, $config, $user, $phpbb_dispatcher, $phpbb_extension_manager, $phpbb_path_helper, $phpbb_container;
+		global $phpbb_root_path, $phpEx, $config, $user, $phpbb_dispatcher, $phpbb_extension_manager, $phpbb_path_helper, $phpbb_container, $phpbb_filesystem;
 
 		if (empty($this->template_filename))
 		{
@@ -146,7 +146,9 @@ function bbcode_cache_init()
 					$phpbb_container,
 					$phpbb_container->getParameter('core.root_path') . 'cache/',
 					$phpbb_container->get('ext.manager'),
-					new \phpbb\template\twig\loader()
+					new \phpbb\template\twig\loader(
+						$phpbb_filesystem
+					)
 				),
 				$phpbb_container->getParameter('core.root_path') . 'cache/',
 				$phpbb_container->get('template.twig.extensions.collection'),

diff --git a/phpBB/includes/compatibility_globals.php b/phpBB/includes/compatibility_globals.php
@@ -48,7 +48,7 @@
 /* @var $symfony_request \phpbb\symfony_request */
 $symfony_request = $phpbb_container->get('symfony_request');
 
-/* @var $phpbb_filesystem \phpbb\filesystem */
+/* @var $phpbb_filesystem \phpbb\filesystem\filesystem_interface */
 $phpbb_filesystem = $phpbb_container->get('filesystem');
 
 /* @var $phpbb_path_helper \phpbb\path_helper */
-Original file line number
+Diff line change
@@ Expand Up / @@ -84,6 +84,7 @@ services: @@
                 - @config
                 - @cache
                 - @log
+                - @filesystem
                 - %core.root_path%
             tags:
                 - { name: console.command }
@@ Expand Down @@