From 869e00a23b0400b9ad81c1130227cc4c29d6a38d Mon Sep 17 00:00:00 2001
From: Joas Schilling <nickvergessen@gmx.de>
Date: Wed, 17 Apr 2013 17:45:49 +0200
Subject: [ticket/11362] Move phpbb_clean_path into a simple filesystem service

PHPBB3-11362
---
 phpBB/config/services.yml            |  4 +++
 phpBB/includes/filesystem.php        | 52 ++++++++++++++++++++++++++++++++++++
 phpBB/includes/functions.php         | 30 ---------------------
 tests/filesystem/clean_path_test.php | 48 +++++++++++++++++++++++++++++++++
 tests/functions/clean_path_test.php  | 44 ------------------------------
 5 files changed, 104 insertions(+), 74 deletions(-)
 create mode 100644 phpBB/includes/filesystem.php
 create mode 100644 tests/filesystem/clean_path_test.php
 delete mode 100644 tests/functions/clean_path_test.php

diff --git a/phpBB/config/services.yml b/phpBB/config/services.yml
index b9c71844dc..5febe76c49 100644
--- a/phpBB/config/services.yml
+++ b/phpBB/config/services.yml
@@ -142,9 +142,13 @@ services:
             - @ext.manager
             - %core.root_path%
             - @cache.driver
+            - @filesystem
             - .%core.php_ext%
             - _ext_finder
 
+    filesystem:
+        class: phpbb_filesystem
+
     groupposition.legend:
         class: phpbb_groupposition_legend
         arguments:
diff --git a/phpBB/includes/filesystem.php b/phpBB/includes/filesystem.php
new file mode 100644
index 0000000000..27cab48fb0
--- /dev/null
+++ b/phpBB/includes/filesystem.php
@@ -0,0 +1,52 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* A class with various functions that are related to paths, files and the filesystem
+* @package phpBB3
+*/
+class phpbb_filesystem
+{
+	/**
+	* Eliminates useless . and .. components from specified path.
+	*
+	* @param string $path Path to clean
+	* @return string Cleaned path
+	*/
+	public function clean_path($path)
+	{
+		$exploded = explode('/', $path);
+		$filtered = array();
+		foreach ($exploded as $part)
+		{
+			if ($part === '.' && !empty($filtered))
+			{
+				continue;
+			}
+
+			if ($part === '..' && !empty($filtered) && $filtered[sizeof($filtered) - 1] !== '..')
+			{
+				array_pop($filtered);
+			}
+			else
+			{
+				$filtered[] = $part;
+			}
+		}
+		$path = implode('/', $filtered);
+		return $path;
+	}
+}
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php
index 98a2c0db79..39a8dbc880 100644
--- a/phpBB/includes/functions.php
+++ b/phpBB/includes/functions.php
@@ -1046,36 +1046,6 @@ else
 	}
 }
 
-/**
-* Eliminates useless . and .. components from specified path.
-*
-* @param string $path Path to clean
-* @return string Cleaned path
-*/
-function phpbb_clean_path($path)
-{
-	$exploded = explode('/', $path);
-	$filtered = array();
-	foreach ($exploded as $part)
-	{
-		if ($part === '.' && !empty($filtered))
-		{
-			continue;
-		}
-
-		if ($part === '..' && !empty($filtered) && $filtered[sizeof($filtered) - 1] !== '..')
-		{
-			array_pop($filtered);
-		}
-		else
-		{
-			$filtered[] = $part;
-		}
-	}
-	$path = implode('/', $filtered);
-	return $path;
-}
-
 // functions used for building option fields
 
 /**
diff --git a/tests/filesystem/clean_path_test.php b/tests/filesystem/clean_path_test.php
new file mode 100644
index 0000000000..50951fc88c
--- /dev/null
+++ b/tests/filesystem/clean_path_test.php
@@ -0,0 +1,48 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2012 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+class phpbb_filesystem_clean_path_test extends phpbb_test_case
+{
+	protected $filesystem;
+
+	public function setUp()
+	{
+		parent::setUp();
+		$this->filesystem = new phpbb_filesystem();
+	}
+
+	public function clean_path_data()
+	{
+		return array(
+			array('foo', 'foo'),
+			array('foo/bar', 'foo/bar'),
+			array('foo/bar/', 'foo/bar/'),
+			array('foo/./bar', 'foo/bar'),
+			array('foo/./././bar', 'foo/bar'),
+			array('foo/bar/.', 'foo/bar'),
+			array('./foo/bar', './foo/bar'),
+			array('../foo/bar', '../foo/bar'),
+			array('one/two/three', 'one/two/three'),
+			array('one/two/../three', 'one/three'),
+			array('one/../two/three', 'two/three'),
+			array('one/two/..', 'one'),
+			array('one/two/../', 'one/'),
+			array('one/two/../three/../four', 'one/four'),
+			array('one/two/three/../../four', 'one/four'),
+		);
+	}
+
+	/**
+	* @dataProvider clean_path_data
+	*/
+	public function test_clean_path($input, $expected)
+	{
+		$this->assertEquals($expected, $this->filesystem->clean_path($input));
+	}
+}
diff --git a/tests/functions/clean_path_test.php b/tests/functions/clean_path_test.php
deleted file mode 100644
index bcbe9838d9..0000000000
--- a/tests/functions/clean_path_test.php
+++ /dev/null
@@ -1,44 +0,0 @@
-<?php
-/**
-*
-* @package testing
-* @copyright (c) 2012 phpBB Group
-* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
-*
-*/
-
-require_once dirname(__FILE__) . '/../../phpBB/includes/functions.php';
-
-class phpbb_clean_path_test extends phpbb_test_case
-{
-	public function clean_path_test_data()
-	{
-		return array(
-			array('foo', 'foo'),
-			array('foo/bar', 'foo/bar'),
-			array('foo/bar/', 'foo/bar/'),
-			array('foo/./bar', 'foo/bar'),
-			array('foo/./././bar', 'foo/bar'),
-			array('foo/bar/.', 'foo/bar'),
-			array('./foo/bar', './foo/bar'),
-			array('../foo/bar', '../foo/bar'),
-			array('one/two/three', 'one/two/three'),
-			array('one/two/../three', 'one/three'),
-			array('one/../two/three', 'two/three'),
-			array('one/two/..', 'one'),
-			array('one/two/../', 'one/'),
-			array('one/two/../three/../four', 'one/four'),
-			array('one/two/three/../../four', 'one/four'),
-		);
-	}
-
-	/**
-	* @dataProvider clean_path_test_data
-	*/
-	public function test_clean_path($input, $expected)
-	{
-		$output = phpbb_clean_path($input);
-
-		$this->assertEquals($expected, $output);
-	}
-}
-- 
cgit v1.2.1