mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-30 21:40:43 +02:00
Code Issues Releases Wiki Activity

[ticket/11852] Split filesystem and path_helper into 2 classes

Browse Source 
PHPBB3-11852
This commit is contained in:
Joas Schilling
2013-09-26 15:34:44 +02:00
parent e8303bc319
commit 7525c49d45
26 changed files with 108 additions and 290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
phpBB/phpbb/filesystem.php
View File

@@ -23,151 +23,6 @@ if (!defined('IN_PHPBB'))
*/
class filesystem
{
/** @var \phpbb\symfony_request */
protected $symfony_request;
/** @var string */
protected $phpbb_root_path;
/** @var string */
protected $adm_relative_path;
/** @var string */
protected $php_ext;
/** @var string */
protected $web_root_path;
/**
* Constructor
*
* @param \phpbb\symfony_request $symfony_request
* @param string $phpbb_root_path Relative path to phpBB root
* @param string $php_ext PHP extension (php)
*/
public function __construct(\phpbb\symfony_request $symfony_request, $phpbb_root_path, $php_ext, $adm_relative_path = null)
{
$this->symfony_request = $symfony_request;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
$this->adm_relative_path = $adm_relative_path;
}
/**
* Get the phpBB root path
*
* @return string
*/
public function get_phpbb_root_path()
{
return $this->phpbb_root_path;
}
/**
* Get the adm root path
*
* @return string
*/
public function get_adm_relative_path()
{
return $this->adm_relative_path;
}
/**
* Get the php extension
*
* @return string
*/
public function get_php_ext()
{
return $this->php_ext;
}
/**
* 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 string $path The path to be updated
* @return string
*/
public function update_web_root_path($path)
{
$web_root_path = $this->get_web_root_path($this->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
*
* @return string
*/
public function get_web_root_path()
{
if ($this->symfony_request === null)
{
return $this->phpbb_root_path;
}
if (null !== $this->web_root_path)
{
return $this->web_root_path;
}
// Path info (e.g. /foo/bar)
$path_info = $this->clean_path($this->symfony_request->getPathInfo());
// Full request URI (e.g. phpBB/app.php/foo/bar)
$request_uri = $this->symfony_request->getRequestUri();
// Script name URI (e.g. phpBB/app.php)
$script_name = $this->symfony_request->getScriptName();
/*
* If the path info is empty (single /), then we're not using
* a route like app.php/foo/bar
*/
if ($path_info === '/')
{
return $this->web_root_path = $this->phpbb_root_path;
}
// How many corrections might we need?
$corrections = substr_count($path_info, '/');
/*
* If the script name (e.g. phpBB/app.php) exists in the
* requestUri (e.g. phpBB/app.php/foo/template), then we
* are have a non-rewritten URL.
*/
if (strpos($request_uri, $script_name) === 0)
{
/*
* Append ../ to the end of the phpbb_root_path as many times
* as / exists in path_info
*/
return $this->web_root_path = $this->phpbb_root_path . str_repeat('../', $corrections);
}
/*
* If we're here it means we're at a re-written path, so we must
* correct the relative path for web URLs. We must append ../
* to the end of the root path as many times as / exists in path_info
* less one time (because the script, e.g. /app.php, doesn't exist in
* the URL)
*/
return $this->web_root_path = $this->phpbb_root_path . str_repeat('../', $corrections - 1);
}
/**
* Eliminates useless . and .. components from specified path.
*

10
phpBB/phpbb/template/asset.php
View File

@@ -21,17 +21,17 @@ class asset
{
protected $components = array();
/** @var \phpbb\filesystem **/
protected $phpbb_filesystem;
/** @var \phpbb\path_helper **/
protected $path_helper;
/**
* Constructor
*
* @param string $url URL
*/
public function __construct($url, \phpbb\filesystem $phpbb_filesystem)
public function __construct($url, \phpbb\path_helper $path_helper)
{
$this->phpbb_filesystem = $phpbb_filesystem;
$this->path_helper = $path_helper;
$this->set_url($url);
}
@@ -119,7 +119,7 @@ class asset
*/
public function get_url()
{
return $this->phpbb_filesystem->update_web_root_path($this->join_url($this->components));
return $this->path_helper->update_web_root_path($this->join_url($this->components));
}
/**

22
phpBB/phpbb/template/twig/environment.php
View File

@@ -25,8 +25,8 @@ class environment extends \Twig_Environment
/** @var \phpbb\config\config */
protected $phpbb_config;
/** @var \phpbb\filesystem */
protected $phpbb_filesystem;
/** @var \phpbb\path_helper */
protected $phpbb_path_helper;
/** @var string */
protected $phpbb_root_path;
@@ -42,19 +42,19 @@ class environment extends \Twig_Environment
*
* @param \phpbb\config\config $phpbb_config
* @param array $phpbb_extensions Array of enabled extensions (name => path)
* @param \phpbb\filesystem
* @param \phpbb\path_helper
* @param string $phpbb_root_path
* @param Twig_LoaderInterface $loader
* @param array $options Array of options to pass to Twig
*/
public function __construct($phpbb_config, $phpbb_extensions, \phpbb\filesystem $phpbb_filesystem, \Twig_LoaderInterface $loader = null, $options = array())
public function __construct($phpbb_config, $phpbb_extensions, \phpbb\path_helper $path_helper, \Twig_LoaderInterface $loader = null, $options = array())
{
$this->phpbb_config = $phpbb_config;
$this->phpbb_extensions = $phpbb_extensions;
$this->phpbb_filesystem = $phpbb_filesystem;
$this->phpbb_root_path = $this->phpbb_filesystem->get_phpbb_root_path();
$this->web_root_path = $this->phpbb_filesystem->get_web_root_path();
$this->phpbb_path_helper = $path_helper;
$this->phpbb_root_path = $this->phpbb_path_helper->get_phpbb_root_path();
$this->web_root_path = $this->phpbb_path_helper->get_web_root_path();
return parent::__construct($loader, $options);
}
@@ -102,13 +102,13 @@ class environment extends \Twig_Environment
}
/**
* Get the phpbb_filesystem object
* Get the phpbb path helper object
*
* @return \phpbb\filesystem
* @return \phpbb\path_helper
*/
public function get_filesystem()
public function get_path_helper()
{
return $this->phpbb_filesystem;
return $this->phpbb_path_helper;
}
/**

2
phpBB/phpbb/template/twig/node/includeasset.php
View File

@@ -35,7 +35,7 @@ abstract class includeasset extends \Twig_Node
->write("\$asset_file = ")
->subcompile($this->getNode('expr'))
->raw(";\n")
->write("\$asset = new \phpbb\\template\\asset(\$asset_file, \$this->getEnvironment()->get_filesystem());\n")
->write("\$asset = new \phpbb\\template\\asset(\$asset_file, \$this->getEnvironment()->get_path_helper());\n")
->write("if (substr(\$asset_file, 0, 2) !== './' && \$asset->is_relative()) {\n")
->indent()
->write("\$asset_path = \$asset->get_path();")

22
phpBB/phpbb/template/twig/twig.php
View File

@@ -33,10 +33,10 @@ class twig extends \phpbb\template\base
private $cachepath = '';
/**
* phpBB filesystem
* @var \phpbb\filesystem
* phpBB path helper
* @var \phpbb\path_helper
*/
protected $phpbb_filesystem;
protected $path_helper;
/**
* phpBB root path
@@ -79,17 +79,17 @@ class twig extends \phpbb\template\base
/**
* Constructor.
*
* @param \phpbb\filesystem $phpbb_filesystem
* @param \phpbb\path_helper $path_helper
* @param \phpbb\config\config $config
* @param \phpbb\user $user
* @param \phpbb\template\context $context template context
* @param \phpbb\extension\manager $extension_manager extension manager, if null then template events will not be invoked
*/
public function __construct(\phpbb\filesystem $phpbb_filesystem, $config, $user, \phpbb\template\context $context, \phpbb\extension\manager $extension_manager = null)
public function __construct(\phpbb\path_helper $path_helper, $config, $user, \phpbb\template\context $context, \phpbb\extension\manager $extension_manager = null)
{
$this->phpbb_filesystem = $phpbb_filesystem;
$this->phpbb_root_path = $phpbb_filesystem->get_phpbb_root_path();
$this->php_ext = $phpbb_filesystem->get_php_ext();
$this->path_helper = $path_helper;
$this->phpbb_root_path = $path_helper->get_phpbb_root_path();
$this->php_ext = $path_helper->get_php_ext();
$this->config = $config;
$this->user = $user;
$this->context = $context;
@@ -103,7 +103,7 @@ class twig extends \phpbb\template\base
$this->twig = new \phpbb\template\twig\environment(
$this->config,
($this->extension_manager) ? $this->extension_manager->all_enabled() : array(),
$this->phpbb_filesystem,
$this->path_helper,
$loader,
array(
'cache' => (defined('IN_INSTALL')) ? false : $this->cachepath,
@@ -125,9 +125,9 @@ class twig extends \phpbb\template\base
$this->twig->setLexer($lexer);
// Add admin namespace
if ($this->phpbb_filesystem->get_adm_relative_path() !== null && is_dir($this->phpbb_root_path . $this->phpbb_filesystem->get_adm_relative_path() . 'style/'))
if ($this->path_helper->get_adm_relative_path() !== null && is_dir($this->phpbb_root_path . $this->path_helper->get_adm_relative_path() . 'style/'))
{
$this->twig->getLoader()->setPaths($this->phpbb_root_path . $this->phpbb_filesystem->get_adm_relative_path() . 'style/', 'admin');
$this->twig->getLoader()->setPaths($this->phpbb_root_path . $this->path_helper->get_adm_relative_path() . 'style/', 'admin');
}
}