aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/filesystem.php
blob: e8fd03d103eae9004d2bdff9b517619508b82ec2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<?php
/**
*
* @package phpBB3
* @copyright (c) 2013 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/

use Symfony\Component\HttpFoundation\Request;

/**
* @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
{
	/** @var string */
	protected $phpbb_root_path;

	/**
	* Constructor
	*
	* @param string $phpbb_root_path
	*/
	public function __construct($phpbb_root_path)
	{
		$this->phpbb_root_path = $phpbb_root_path;
	}

	/**
	* Get the phpBB root path
	*
	* @return string
	*/
	public function get_phpbb_root_path()
	{
		return $this->phpbb_root_path;
	}

	/**
	* Update a path to the correct relative root path
	*
	* This replaces $phpbb_root_path . some_url with
	*	get_web_root_path() . some_url OR if $phpbb_root_path
	*	is not at the beginning of $path, just prepends the
	*	web root path
	*
	* @param Request $symfony_request Symfony Request object
	* @return string
	*/
	public function update_web_root_path($path, Request $symfony_request = null)
	{
		$web_root_path = $this->get_web_root_path($symfony_request);

		if (strpos($path, $this->phpbb_root_path) === 0)
		{
			$path = substr($path, strlen($this->phpbb_root_path));
		}

		return $web_root_path . $path;
	}

	/**
	* Get a relative root path from the current URL
	*
	* @param Request $symfony_request Symfony Request object
	* @return string
	*/
	public function get_web_root_path(Request $symfony_request = null)
	{
		if ($symfony_request === null)
		{
			return $this->phpbb_root_path;
		}

		static $path;
		if (null !== $path)
		{
			return $path;
		}

		$path_info = $symfony_request->getPathInfo();
		if ($path_info === '/')
		{
			return $path = $this->phpbb_root_path;
		}

		$path_info = $this->clean_path($path_info);

		// Do not count / at start of path
		$corrections = substr_count(substr($path_info, 1), '/');

		// When URL Rewriting is enabled, app.php is optional. We have to
		// correct for it not being there
		if (strpos($symfony_request->getRequestUri(), $symfony_request->getScriptName()) === false)
		{
			$corrections -= 1;
		}

		return $path = $this->phpbb_root_path . str_repeat('../', $corrections);
	}

	/**
	* 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;
	}
}