mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-06 08:47:45 +02:00
Code Issues Releases Wiki Activity

Merge pull request #6088 from rubencm/ticket/16639

Browse Source 
[ticket/16639] Pass absolute paths to make_path_relative
This commit is contained in:
Marc Alexander
2021-03-25 21:16:25 +01:00
committed by GitHub
parent c52d1d8e45 2d55977234
commit bcf59eca9f
10 changed files with 307 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
phpBB/phpbb/filesystem/filesystem.php
View File

@@ -600,7 +600,7 @@ class filesystem implements filesystem_interface
*
* @deprecated 3.3.0-a1 (To be removed: 4.0.0)
*
* @param string $path
* @param ?string $path
* @return bool|string
*/
protected function phpbb_own_realpath($path)

2
phpBB/phpbb/filesystem/filesystem_interface.php
View File

@@ -239,7 +239,7 @@ interface filesystem_interface
* Try to resolve realpath when PHP's realpath is not available, or
* known to be buggy.
*
* @param string $path Path to resolve
* @param ?string $path Path to resolve
*
* @return string Resolved path
*/

12
phpBB/phpbb/filesystem/helper.php
View File

@@ -212,18 +212,6 @@ class helper
*/
static public function make_path_relative($end_path, $start_path)
{
// Ensure paths are absolute as passing relative paths to the
// Symsony's Filesystem::makePathRelative() method is removed since Symfony 4.0
if (!self::is_absolute_path($end_path))
{
$end_path = self::phpbb_own_realpath($end_path);
}
if (!self::is_absolute_path($start_path))
{
$start_path = self::phpbb_own_realpath($start_path);
}
return self::get_symfony_filesystem()->makePathRelative($end_path, $start_path);
}

69
phpBB/phpbb/storage/adapter/adapter_interface.php
View File

@@ -13,91 +13,88 @@
namespace phpbb\storage\adapter;
use phpbb\storage\exception\exception;
interface adapter_interface
{
/**
* Set adapter parameters
*
* @param array options Storage-specific options.
* @param array options Storage-specific options.
*/
public function configure($options);
public function configure(array $options): void;
/**
* Dumps content into a file
*
* @param string path The file to be written to.
* @param string content The data to write into the file.
*
* @throws \phpbb\storage\exception\exception When the file cannot be written
* @param string $path
* @param string $content
* @throws exception When the file cannot be written
*/
public function put_contents($path, $content);
public function put_contents(string $path, string $content): void;
/**
* Read the contents of a file
*
* @param string $path The file to read
*
* @throws \phpbb\storage\exception\exception When cannot read file contents
*
* @return string Returns file contents
* @param string $path The file to read
*
* @return string Returns file contents
* @throws exception When cannot read file contents
*/
public function get_contents($path);
public function get_contents(string $path): string;
/**
* Checks the existence of files or directories
*
* @param string $path file/directory to check
* @param string $path file/directory to check
*
* @return bool Returns true if the file/directory exist, false otherwise.
* @return bool Returns true if the file/directory exist, false otherwise.
*/
public function exists($path);
public function exists(string $path): bool;
/**
* Removes files or directories
*
* @param string $path file/directory to remove
* @param string $path file/directory to remove
*
* @throws \phpbb\storage\exception\exception When removal fails.
* @throws exception When removal fails.
*/
public function delete($path);
public function delete(string $path): void;
/**
* Rename a file or a directory
*
* @param string $path_orig The original file/direcotry
* @param string $path_dest The target file/directory
* @param string $path_orig The original file/direcotry
* @param string $path_dest The target file/directory
*
* @throws \phpbb\storage\exception\exception When file/directory cannot be renamed
* @throws exception When file/directory cannot be renamed
*/
public function rename($path_orig, $path_dest);
public function rename(string $path_orig, string $path_dest): void;
/**
* Copies a file
*
* @param string $path_orig The original filename
* @param string $path_dest The target filename
* @param string $path_orig The original filename
* @param string $path_dest The target filename
*
* @throws \phpbb\storage\exception\exception When the file cannot be copied
* @throws exception When the file cannot be copied
*/
public function copy($path_orig, $path_dest);
public function copy(string $path_orig, string $path_dest): void;
/**
* Get direct link
*
* @param string $path The file
*
* @return string Returns link.
* @param string $path The file
*
* @return string Returns link.
*/
public function get_link($path);
public function get_link(string $path): string;
/*
/**
* Get space available in bytes
*
* @throws \phpbb\storage\exception\exception When unable to retrieve available storage space
*
* @return float Returns available space
* @return float Returns available space
* @throws exception When unable to retrieve available storage space
*/
public function free_space();
public function free_space(): float;
}

46
phpBB/phpbb/storage/adapter/local.php
View File

@@ -22,7 +22,7 @@ use phpbb\mimetype\guesser;
use FastImageSize\FastImageSize;
/**
* @internal Experimental
* Experimental
*/
class local implements adapter_interface, stream_interface
{
@@ -87,8 +87,13 @@ class local implements adapter_interface, stream_interface
/**
* Constructor
*
* @param filesystem $filesystem
* @param FastImageSize $imagesize
* @param guesser $mimetype_guesser
* @param string $phpbb_root_path
*/
public function __construct(filesystem $filesystem, FastImageSize $imagesize, guesser $mimetype_guesser, $phpbb_root_path)
public function __construct(filesystem $filesystem, FastImageSize $imagesize, guesser $mimetype_guesser, string $phpbb_root_path)
{
$this->filesystem = $filesystem;
$this->imagesize = $imagesize;
@@ -99,7 +104,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function configure($options)
public function configure(array $options): void
{
if (substr($options['path'], -1, 1) !== DIRECTORY_SEPARATOR)
{
@@ -114,7 +119,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function put_contents($path, $content)
public function put_contents(string $path, string $content): void
{
$this->ensure_directory_exists($path);
@@ -131,7 +136,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function get_contents($path)
public function get_contents(string $path): string
{
$content = @file_get_contents($this->root_path . $this->get_path($path) . $this->get_filename($path));
@@ -146,7 +151,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function exists($path)
public function exists(string $path): bool
{
return $this->filesystem->exists($this->root_path . $this->get_path($path) . $this->get_filename($path));
}
@@ -154,7 +159,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function delete($path)
public function delete(string $path): void
{
try
{
@@ -171,7 +176,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function rename($path_orig, $path_dest)
public function rename(string $path_orig, string $path_dest): void
{
$this->ensure_directory_exists($path_dest);
@@ -190,7 +195,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function copy($path_orig, $path_dest)
public function copy(string $path_orig, string $path_dest): void
{
$this->ensure_directory_exists($path_dest);
@@ -230,8 +235,9 @@ class local implements adapter_interface, stream_interface
*/
protected function ensure_directory_exists($path)
{
$path = dirname($this->root_path . $this->get_path($path) . $this->get_filename($path));
$path = filesystem_helper::make_path_relative($path, $this->root_path);
$absolute_root_path = filesystem_helper::realpath($this->root_path) . DIRECTORY_SEPARATOR;
$path = dirname($absolute_root_path . $this->get_path($path) . $this->get_filename($path));
$path = filesystem_helper::make_path_relative($path, $absolute_root_path);
if (!$this->exists($path))
{
@@ -266,7 +272,8 @@ class local implements adapter_interface, stream_interface
* Get the path to the file, appending subdirectories for directory depth
* if $dir_depth > 0.
*
* @param string $path The file path
* @param string $path The file path
* @return string
*/
protected function get_path($path)
{
@@ -292,7 +299,8 @@ class local implements adapter_interface, stream_interface
/**
* To be used in other PR
*
* @param string $path The file path
* @param string $path The file path
* @return string
*/
protected function get_filename($path)
{
@@ -302,7 +310,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function read_stream($path)
public function read_stream(string $path)
{
$stream = @fopen($this->root_path . $this->get_path($path) . $this->get_filename($path), 'rb');
@@ -317,7 +325,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function write_stream($path, $resource)
public function write_stream(string $path, $resource): void
{
$this->ensure_directory_exists($path);
@@ -345,6 +353,8 @@ class local implements adapter_interface, stream_interface
* @throws exception When cannot get size
*
* @return array Properties
* @throws exception When cannot get size
*
*/
public function file_size($path)
{
@@ -410,7 +420,7 @@ class local implements adapter_interface, stream_interface
*
* @return array Properties
*/
public function file_image_height($path)
public function file_image_height($path): array
{
return $this->image_dimensions($path);
}
@@ -418,7 +428,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function get_link($path)
public function get_link(string $path): string
{
return generate_board_url() . '/' . $this->path . $path;
}
@@ -426,7 +436,7 @@ class local implements adapter_interface, stream_interface
/**
* {@inheritdoc}
*/
public function free_space()
public function free_space(): float
{
if (function_exists('disk_free_space'))
{

22
phpBB/phpbb/storage/stream_interface.php
View File

@@ -13,27 +13,29 @@
namespace phpbb\storage;
use phpbb\storage\exception\exception;
interface stream_interface
{
/**
* Reads a file as a stream
*
* @param string $path File to read
* @param string $path File to read
*
* @throws \phpbb\storage\exception\exception When unable to open file
*
* @return resource Returns a file pointer
* @return resource Returns a file pointer
* @throws exception\exception When unable to open file
*/
public function read_stream($path);
public function read_stream(string $path);
/**
* Writes a new file using a stream
*
* @param string $path The target file
* @param resource $resource The resource
* @param string $path The target file
* @param resource $resource The resource
*
* @throws \phpbb\storage\exception\exception When target file exists
* When target file cannot be created
* @return void
* @throws exception When target file exists
* When target file cannot be created
*/
public function write_stream($path, $resource);
public function write_stream(string $path, $resource): void;
}