PDF rausgenommen

This commit is contained in:
aschwarz
2023-01-23 11:03:31 +01:00
parent 82d562a322
commit a6523903eb
28078 changed files with 4247552 additions and 2 deletions

View File

@ -0,0 +1,142 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* A base class for extensions without custom enable/disable/purge code.
*/
class base implements \phpbb\extension\extension_interface
{
/** @var ContainerInterface */
protected $container;
/** @var \phpbb\finder */
protected $extension_finder;
/** @var \phpbb\db\migrator */
protected $migrator;
/** @var string */
protected $extension_name;
/** @var string */
protected $extension_path;
/** @var string[] */
private $migrations = false;
/**
* Constructor
*
* @param ContainerInterface $container Container object
* @param \phpbb\finder $extension_finder
* @param \phpbb\db\migrator $migrator
* @param string $extension_name Name of this extension (from ext.manager)
* @param string $extension_path Relative path to this extension
*/
public function __construct(ContainerInterface $container, \phpbb\finder $extension_finder, \phpbb\db\migrator $migrator, $extension_name, $extension_path)
{
$this->container = $container;
$this->extension_finder = $extension_finder;
$this->migrator = $migrator;
$this->extension_name = $extension_name;
$this->extension_path = $extension_path;
}
/**
* {@inheritdoc}
*/
public function is_enableable()
{
return true;
}
/**
* Single enable step that installs any included migrations
*
* @param mixed $old_state State returned by previous call of this method
* @return false Indicates no further steps are required
*/
public function enable_step($old_state)
{
$this->get_migration_file_list();
$this->migrator->update();
return !$this->migrator->finished();
}
/**
* Single disable step that does nothing
*
* @param mixed $old_state State returned by previous call of this method
* @return false Indicates no further steps are required
*/
public function disable_step($old_state)
{
return false;
}
/**
* Single purge step that reverts any included and installed migrations
*
* @param mixed $old_state State returned by previous call of this method
* @return false Indicates no further steps are required
*/
public function purge_step($old_state)
{
$migrations = $this->get_migration_file_list();
foreach ($migrations as $migration)
{
while ($this->migrator->migration_state($migration) !== false)
{
$this->migrator->revert($migration);
return true;
}
}
return false;
}
/**
* Get the list of migration files from this extension
*
* @return array
*/
protected function get_migration_file_list()
{
if ($this->migrations !== false)
{
return $this->migrations;
}
// Only have the finder search in this extension path directory
$migrations = $this->extension_finder
->extension_directory('/migrations')
->find_from_extension($this->extension_name, $this->extension_path);
$migrations = $this->extension_finder->get_classes_from_files($migrations);
$this->migrator->set_migrations($migrations);
$migrations = $this->migrator->get_migrations();
return $migrations;
}
}

View File

@ -0,0 +1,138 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension\di;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Resource\FileResource;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
/**
* Container core extension
*/
class extension_base extends Extension
{
/**
* Name of the extension (vendor/name)
*
* @var string
*/
protected $extension_name;
/**
* Path to the extension.
*
* @var string
*/
protected $ext_path;
/**
* Constructor
*
* @param string $extension_name Name of the extension (vendor/name)
* @param string $ext_path Path to the extension
*/
public function __construct($extension_name, $ext_path)
{
$this->extension_name = $extension_name;
$this->ext_path = $ext_path;
}
/**
* Loads a specific configuration.
*
* @param array $configs An array of configuration values
* @param ContainerBuilder $container A ContainerBuilder instance
*
* @throws \InvalidArgumentException When provided tag is not defined in this extension
*/
public function load(array $configs, ContainerBuilder $container)
{
$this->load_services($container);
}
/**
* Loads the services.yml file.
*
* @param ContainerBuilder $container A ContainerBuilder instance
*/
protected function load_services(ContainerBuilder $container)
{
$services_directory = false;
$services_file = false;
if (file_exists($this->ext_path . 'config/' . $container->getParameter('core.environment') . '/container/environment.yml'))
{
$services_directory = $this->ext_path . 'config/' . $container->getParameter('core.environment') . '/container/';
$services_file = 'environment.yml';
}
else if (!is_dir($this->ext_path . 'config/' . $container->getParameter('core.environment')))
{
if (file_exists($this->ext_path . 'config/default/container/environment.yml'))
{
$services_directory = $this->ext_path . 'config/default/container/';
$services_file = 'environment.yml';
}
else if (!is_dir($this->ext_path . 'config/default') && file_exists($this->ext_path . '/config/services.yml'))
{
$services_directory = $this->ext_path . 'config';
$services_file = 'services.yml';
}
}
if ($services_directory && $services_file)
{
$filesystem = new \phpbb\filesystem\filesystem();
$loader = new YamlFileLoader($container, new FileLocator($filesystem->realpath($services_directory)));
$loader->load($services_file);
}
}
/**
* {@inheritdoc}
*/
public function getConfiguration(array $config, ContainerBuilder $container)
{
$reflected = new \ReflectionClass($this);
$namespace = $reflected->getNamespaceName();
$class = $namespace . '\\di\configuration';
if (class_exists($class))
{
$r = new \ReflectionClass($class);
$container->addResource(new FileResource($r->getFileName()));
if (!method_exists($class, '__construct'))
{
$configuration = new $class();
return $configuration;
}
}
}
/**
* Returns the recommended alias to use in XML.
*
* This alias is also the mandatory prefix to use when using YAML.
*
* @return string The alias
*/
public function getAlias()
{
return str_replace('/', '_', $this->extension_name);
}
}

View File

@ -0,0 +1,21 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension;
/**
* Exception class for metadata
*/
class exception extends \phpbb\exception\runtime_exception
{
}

View File

@ -0,0 +1,70 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension;
/**
* The interface extension meta classes have to implement to run custom code
* on enable/disable/purge.
*/
interface extension_interface
{
/**
* Indicate whether or not the extension can be enabled.
*
* @return bool
*/
public function is_enableable();
/**
* enable_step is executed on enabling an extension until it returns false.
*
* Calls to this function can be made in subsequent requests, when the
* function is invoked through a webserver with a too low max_execution_time.
*
* @param mixed $old_state The return value of the previous call
* of this method, or false on the first call
* @return mixed Returns false after last step, otherwise
* temporary state which is passed as an
* argument to the next step
*/
public function enable_step($old_state);
/**
* Disables the extension.
*
* Calls to this function can be made in subsequent requests, when the
* function is invoked through a webserver with a too low max_execution_time.
*
* @param mixed $old_state The return value of the previous call
* of this method, or false on the first call
* @return mixed Returns false after last step, otherwise
* temporary state which is passed as an
* argument to the next step
*/
public function disable_step($old_state);
/**
* purge_step is executed on purging an extension until it returns false.
*
* Calls to this function can be made in subsequent requests, when the
* function is invoked through a webserver with a too low max_execution_time.
*
* @param mixed $old_state The return value of the previous call
* of this method, or false on the first call
* @return mixed Returns false after last step, otherwise
* temporary state which is passed as an
* argument to the next step
*/
public function purge_step($old_state);
}

View File

@ -0,0 +1,633 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension;
use phpbb\exception\runtime_exception;
use phpbb\file_downloader;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* The extension manager provides means to activate/deactivate extensions.
*/
class manager
{
/** @var ContainerInterface */
protected $container;
protected $db;
protected $config;
protected $cache;
protected $php_ext;
protected $extensions;
protected $extension_table;
protected $phpbb_root_path;
protected $cache_name;
/**
* Creates a manager and loads information from database
*
* @param ContainerInterface $container A container
* @param \phpbb\db\driver\driver_interface $db A database connection
* @param \phpbb\config\config $config Config object
* @param \phpbb\filesystem\filesystem_interface $filesystem
* @param string $extension_table The name of the table holding extensions
* @param string $phpbb_root_path Path to the phpbb includes directory.
* @param string $php_ext php file extension, defaults to php
* @param \phpbb\cache\service $cache A cache instance or null
* @param string $cache_name The name of the cache variable, defaults to _ext
*/
public function __construct(ContainerInterface $container, \phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\filesystem\filesystem_interface $filesystem, $extension_table, $phpbb_root_path, $php_ext = 'php', \phpbb\cache\service $cache = null, $cache_name = '_ext')
{
$this->cache = $cache;
$this->cache_name = $cache_name;
$this->config = $config;
$this->container = $container;
$this->db = $db;
$this->extension_table = $extension_table;
$this->filesystem = $filesystem;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
$this->extensions = ($this->cache) ? $this->cache->get($this->cache_name) : false;
if ($this->extensions === false)
{
$this->load_extensions();
}
}
/**
* Loads all extension information from the database
*
* @return null
*/
public function load_extensions()
{
$this->extensions = array();
// Do not try to load any extensions if the extension table
// does not exist or when installing or updating.
// Note: database updater invokes this code, and in 3.0
// there is no extension table therefore the rest of this function
// fails
if (defined('IN_INSTALL') || version_compare($this->config['version'], '3.1.0-dev', '<'))
{
return;
}
$sql = 'SELECT *
FROM ' . $this->extension_table;
$result = $this->db->sql_query($sql);
$extensions = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
foreach ($extensions as $extension)
{
$extension['ext_path'] = $this->get_extension_path($extension['ext_name']);
$this->extensions[$extension['ext_name']] = $extension;
}
ksort($this->extensions);
if ($this->cache)
{
$this->cache->put($this->cache_name, $this->extensions);
}
}
/**
* Generates the path to an extension
*
* @param string $name The name of the extension
* @param bool $phpbb_relative Whether the path should be relative to phpbb root
* @return string Path to an extension
*/
public function get_extension_path($name, $phpbb_relative = false)
{
$name = str_replace('.', '', $name);
return (($phpbb_relative) ? $this->phpbb_root_path : '') . 'ext/' . $name . '/';
}
/**
* Instantiates the extension meta class for the extension with the given name
*
* @param string $name The extension name
* @return \phpbb\extension\extension_interface Instance of the extension meta class or
* \phpbb\extension\base if the class does not exist
*/
public function get_extension($name)
{
$extension_class_name = str_replace('/', '\\', $name) . '\\ext';
$migrator = $this->container->get('migrator');
if (class_exists($extension_class_name))
{
return new $extension_class_name($this->container, $this->get_finder(), $migrator, $name, $this->get_extension_path($name, true));
}
else
{
return new \phpbb\extension\base($this->container, $this->get_finder(), $migrator, $name, $this->get_extension_path($name, true));
}
}
/**
* Instantiates the metadata manager for the extension with the given name
*
* @param string $name The extension name
* @return \phpbb\extension\metadata_manager Instance of the metadata manager
*/
public function create_extension_metadata_manager($name)
{
if (!isset($this->extensions[$name]['metadata']))
{
$metadata = new \phpbb\extension\metadata_manager($name, $this->get_extension_path($name, true));
$this->extensions[$name]['metadata'] = $metadata;
}
return $this->extensions[$name]['metadata'];
}
/**
* Runs a step of the extension enabling process.
*
* Allows the exentension to enable in a long running script that works
* in multiple steps across requests. State is kept for the extension
* in the extensions table.
*
* @param string $name The extension's name
* @return bool False if enabling is finished, true otherwise
*/
public function enable_step($name)
{
// ignore extensions that are already enabled
if ($this->is_enabled($name))
{
return false;
}
$old_state = (isset($this->extensions[$name]['ext_state'])) ? unserialize($this->extensions[$name]['ext_state']) : false;
$extension = $this->get_extension($name);
if (!$extension->is_enableable())
{
return false;
}
$state = $extension->enable_step($old_state);
$active = ($state === false);
$extension_data = array(
'ext_name' => $name,
'ext_active' => $active,
'ext_state' => serialize($state),
);
$this->extensions[$name] = $extension_data;
$this->extensions[$name]['ext_path'] = $this->get_extension_path($extension_data['ext_name']);
ksort($this->extensions);
$sql = 'SELECT COUNT(ext_name) as row_count
FROM ' . $this->extension_table . "
WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
$result = $this->db->sql_query($sql);
$count = $this->db->sql_fetchfield('row_count');
$this->db->sql_freeresult($result);
if ($count)
{
$sql = 'UPDATE ' . $this->extension_table . '
SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
$this->db->sql_query($sql);
}
else
{
$sql = 'INSERT INTO ' . $this->extension_table . '
' . $this->db->sql_build_array('INSERT', $extension_data);
$this->db->sql_query($sql);
}
if ($this->cache)
{
$this->cache->purge();
}
if ($active)
{
$this->config->increment('assets_version', 1);
}
return !$active;
}
/**
* Enables an extension
*
* This method completely enables an extension. But it could be long running
* so never call this in a script that has a max_execution time.
*
* @param string $name The extension's name
* @return null
*/
public function enable($name)
{
// @codingStandardsIgnoreStart
while ($this->enable_step($name));
// @codingStandardsIgnoreEnd
}
/**
* Disables an extension
*
* Calls the disable method on the extension's meta class to allow it to
* process the event.
*
* @param string $name The extension's name
* @return bool False if disabling is finished, true otherwise
*/
public function disable_step($name)
{
// ignore extensions that are not enabled
if (!$this->is_enabled($name))
{
return false;
}
$old_state = unserialize($this->extensions[$name]['ext_state']);
$extension = $this->get_extension($name);
$state = $extension->disable_step($old_state);
// continue until the state is false
if ($state !== false)
{
$extension_data = array(
'ext_state' => serialize($state),
);
$this->extensions[$name]['ext_state'] = serialize($state);
$sql = 'UPDATE ' . $this->extension_table . '
SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
$this->db->sql_query($sql);
if ($this->cache)
{
$this->cache->purge();
}
return true;
}
$extension_data = array(
'ext_active' => false,
'ext_state' => serialize(false),
);
$this->extensions[$name]['ext_active'] = false;
$this->extensions[$name]['ext_state'] = serialize(false);
$sql = 'UPDATE ' . $this->extension_table . '
SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
$this->db->sql_query($sql);
if ($this->cache)
{
$this->cache->purge();
}
return false;
}
/**
* Disables an extension
*
* Disables an extension completely at once. This process could run for a
* while so never call this in a script that has a max_execution time.
*
* @param string $name The extension's name
* @return null
*/
public function disable($name)
{
// @codingStandardsIgnoreStart
while ($this->disable_step($name));
// @codingStandardsIgnoreEnd
}
/**
* Purge an extension
*
* Disables the extension first if active, and then calls purge on the
* extension's meta class to delete the extension's database content.
*
* @param string $name The extension's name
* @return bool False if purging is finished, true otherwise
*/
public function purge_step($name)
{
// ignore extensions that are not configured
if (!$this->is_configured($name))
{
return false;
}
// disable first if necessary
if ($this->extensions[$name]['ext_active'])
{
$this->disable($name);
}
$old_state = unserialize($this->extensions[$name]['ext_state']);
$extension = $this->get_extension($name);
$state = $extension->purge_step($old_state);
// continue until the state is false
if ($state !== false)
{
$extension_data = array(
'ext_state' => serialize($state),
);
$this->extensions[$name]['ext_state'] = serialize($state);
$sql = 'UPDATE ' . $this->extension_table . '
SET ' . $this->db->sql_build_array('UPDATE', $extension_data) . "
WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
$this->db->sql_query($sql);
if ($this->cache)
{
$this->cache->purge();
}
return true;
}
unset($this->extensions[$name]);
$sql = 'DELETE FROM ' . $this->extension_table . "
WHERE ext_name = '" . $this->db->sql_escape($name) . "'";
$this->db->sql_query($sql);
if ($this->cache)
{
$this->cache->purge();
}
return false;
}
/**
* Purge an extension
*
* Purges an extension completely at once. This process could run for a while
* so never call this in a script that has a max_execution time.
*
* @param string $name The extension's name
* @return null
*/
public function purge($name)
{
// @codingStandardsIgnoreStart
while ($this->purge_step($name));
// @codingStandardsIgnoreEnd
}
/**
* Retrieves a list of all available extensions on the filesystem
*
* @return array An array with extension names as keys and paths to the
* extension as values
*/
public function all_available()
{
$available = array();
if (!is_dir($this->phpbb_root_path . 'ext/'))
{
return $available;
}
$iterator = new \RecursiveIteratorIterator(
new \phpbb\recursive_dot_prefix_filter_iterator(
new \RecursiveDirectoryIterator($this->phpbb_root_path . 'ext/', \FilesystemIterator::NEW_CURRENT_AND_KEY | \FilesystemIterator::FOLLOW_SYMLINKS)
),
\RecursiveIteratorIterator::SELF_FIRST
);
$iterator->setMaxDepth(2);
foreach ($iterator as $file_info)
{
if ($file_info->isFile() && $file_info->getFilename() == 'composer.json')
{
$ext_name = $iterator->getInnerIterator()->getSubPath();
$ext_name = str_replace(DIRECTORY_SEPARATOR, '/', $ext_name);
if ($this->is_available($ext_name))
{
$available[$ext_name] = $this->get_extension_path($ext_name, true);
}
}
}
ksort($available);
return $available;
}
/**
* Retrieves all configured extensions.
*
* All enabled and disabled extensions are considered configured. A purged
* extension that is no longer in the database is not configured.
*
* @param bool $phpbb_relative Whether the path should be relative to phpbb root
*
* @return array An array with extension names as keys and and the
* database stored extension information as values
*/
public function all_configured($phpbb_relative = true)
{
$configured = array();
foreach ($this->extensions as $name => $data)
{
if ($this->is_configured($name))
{
unset($data['metadata']);
$data['ext_path'] = ($phpbb_relative ? $this->phpbb_root_path : '') . $data['ext_path'];
$configured[$name] = $data;
}
}
return $configured;
}
/**
* Retrieves all enabled extensions.
* @param bool $phpbb_relative Whether the path should be relative to phpbb root
*
* @return array An array with extension names as keys and and the
* database stored extension information as values
*/
public function all_enabled($phpbb_relative = true)
{
$enabled = array();
foreach ($this->extensions as $name => $data)
{
if ($this->is_enabled($name))
{
$enabled[$name] = ($phpbb_relative ? $this->phpbb_root_path : '') . $data['ext_path'];
}
}
return $enabled;
}
/**
* Retrieves all disabled extensions.
*
* @param bool $phpbb_relative Whether the path should be relative to phpbb root
*
* @return array An array with extension names as keys and and the
* database stored extension information as values
*/
public function all_disabled($phpbb_relative = true)
{
$disabled = array();
foreach ($this->extensions as $name => $data)
{
if ($this->is_disabled($name))
{
$disabled[$name] = ($phpbb_relative ? $this->phpbb_root_path : '') . $data['ext_path'];
}
}
return $disabled;
}
/**
* Check to see if a given extension is available on the filesystem
*
* @param string $name Extension name to check NOTE: Can be user input
* @return bool Depending on whether or not the extension is available
*/
public function is_available($name)
{
$md_manager = $this->create_extension_metadata_manager($name);
try
{
return $md_manager->get_metadata('all') && $md_manager->validate_enable();
}
catch (\phpbb\extension\exception $e)
{
return false;
}
}
/**
* Check to see if a given extension is enabled
*
* @param string $name Extension name to check
* @return bool Depending on whether or not the extension is enabled
*/
public function is_enabled($name)
{
return isset($this->extensions[$name]['ext_active']) && $this->extensions[$name]['ext_active'];
}
/**
* Check to see if a given extension is disabled
*
* @param string $name Extension name to check
* @return bool Depending on whether or not the extension is disabled
*/
public function is_disabled($name)
{
return isset($this->extensions[$name]['ext_active']) && !$this->extensions[$name]['ext_active'];
}
/**
* Check to see if a given extension is configured
*
* All enabled and disabled extensions are considered configured. A purged
* extension that is no longer in the database is not configured.
*
* @param string $name Extension name to check
* @return bool Depending on whether or not the extension is configured
*/
public function is_configured($name)
{
return isset($this->extensions[$name]['ext_active']);
}
/**
* Check the version and return the available updates (for an extension).
*
* @param \phpbb\extension\metadata_manager $md_manager The metadata manager for the version to check.
* @param bool $force_update Ignores cached data. Defaults to false.
* @param bool $force_cache Force the use of the cache. Override $force_update.
* @param string $stability Force the stability (null by default).
* @return array
* @throws runtime_exception
*/
public function version_check(\phpbb\extension\metadata_manager $md_manager, $force_update = false, $force_cache = false, $stability = null)
{
$meta = $md_manager->get_metadata('all');
if (!isset($meta['extra']['version-check']))
{
throw new runtime_exception('NO_VERSIONCHECK');
}
$version_check = $meta['extra']['version-check'];
$version_helper = new \phpbb\version_helper($this->cache, $this->config, new file_downloader());
$version_helper->set_current_version($meta['version']);
$version_helper->set_file_location($version_check['host'], $version_check['directory'], $version_check['filename'], isset($version_check['ssl']) ? $version_check['ssl'] : false);
$version_helper->force_stability($stability);
return $version_helper->get_ext_update_on_branch($force_update, $force_cache);
}
/**
* Check to see if a given extension is purged
*
* An extension is purged if it is available, not enabled and not disabled.
*
* @param string $name Extension name to check
* @return bool Depending on whether or not the extension is purged
*/
public function is_purged($name)
{
return $this->is_available($name) && !$this->is_configured($name);
}
/**
* Instantiates a \phpbb\finder.
*
* @param bool $use_all_available Should we load all extensions, or just enabled ones
* @return \phpbb\finder An extension finder instance
*/
public function get_finder($use_all_available = false)
{
$finder = new \phpbb\finder($this->filesystem, $this->phpbb_root_path, $this->cache, $this->php_ext, $this->cache_name . '_finder');
if ($use_all_available)
{
$finder->set_extensions(array_keys($this->all_available()));
}
else
{
$finder->set_extensions(array_keys($this->all_enabled()));
}
return $finder;
}
}

View File

@ -0,0 +1,260 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension;
/**
* The extension metadata manager validates and gets meta-data for extensions
*/
class metadata_manager
{
/**
* Name (including vendor) of the extension
* @var string
*/
protected $ext_name;
/**
* Metadata from the composer.json file
* @var array
*/
protected $metadata;
/**
* Link (including root path) to the metadata file
* @var string
*/
protected $metadata_file;
/**
* Creates the metadata manager
*
* @param string $ext_name Name (including vendor) of the extension
* @param string $ext_path Path to the extension directory including root path
*/
public function __construct($ext_name, $ext_path)
{
$this->ext_name = $ext_name;
$this->metadata = array();
$this->metadata_file = $ext_path . 'composer.json';
}
/**
* Processes and gets the metadata requested
*
* @param string $element All for all metadata that it has and is valid, otherwise specify which section you want by its shorthand term.
* @return array Contains all of the requested metadata, throws an exception on failure
*/
public function get_metadata($element = 'all')
{
// Fetch and clean the metadata if not done yet
if ($this->metadata === array())
{
$this->fetch_metadata_from_file();
}
switch ($element)
{
case 'all':
default:
$this->validate();
return $this->metadata;
break;
case 'version':
case 'name':
$this->validate($element);
return $this->metadata[$element];
break;
case 'display-name':
return (isset($this->metadata['extra']['display-name'])) ? $this->metadata['extra']['display-name'] : $this->get_metadata('name');
break;
}
}
/**
* Gets the metadata file contents and cleans loaded file
*
* @throws \phpbb\extension\exception
*/
private function fetch_metadata_from_file()
{
if (!file_exists($this->metadata_file))
{
throw new \phpbb\extension\exception('FILE_NOT_FOUND', array($this->metadata_file));
}
if (!($file_contents = file_get_contents($this->metadata_file)))
{
throw new \phpbb\extension\exception('FILE_CONTENT_ERR', array($this->metadata_file));
}
if (($metadata = json_decode($file_contents, true)) === null)
{
throw new \phpbb\extension\exception('FILE_JSON_DECODE_ERR', array($this->metadata_file));
}
array_walk_recursive($metadata, array($this, 'sanitize_json'));
$this->metadata = $metadata;
}
/**
* Sanitize input from JSON array using htmlspecialchars()
*
* @param mixed $value Value of array row
* @param string $key Key of array row
*/
public function sanitize_json(&$value, $key)
{
$value = htmlspecialchars($value);
}
/**
* Validate fields
*
* @param string $name ("all" for display and enable validation
* "display" for name, type, and authors
* "name", "type")
* @return Bool True if valid, throws an exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate($name = 'display')
{
// Basic fields
$fields = array(
'name' => '#^[a-zA-Z0-9_\x7f-\xff]{2,}/[a-zA-Z0-9_\x7f-\xff]{2,}$#',
'type' => '#^phpbb-extension$#',
'license' => '#.+#',
'version' => '#.+#',
);
switch ($name)
{
case 'all':
$this->validate_enable();
// no break
case 'display':
foreach ($fields as $field => $data)
{
$this->validate($field);
}
$this->validate_authors();
break;
default:
if (isset($fields[$name]))
{
if (!isset($this->metadata[$name]))
{
throw new \phpbb\extension\exception('META_FIELD_NOT_SET', array($name));
}
if (!preg_match($fields[$name], $this->metadata[$name]))
{
throw new \phpbb\extension\exception('META_FIELD_INVALID', array($name));
}
}
break;
}
return true;
}
/**
* Validates the contents of the authors field
*
* @return boolean True when passes validation, throws exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate_authors()
{
if (empty($this->metadata['authors']))
{
throw new \phpbb\extension\exception('META_FIELD_NOT_SET', array('authors'));
}
foreach ($this->metadata['authors'] as $author)
{
if (!isset($author['name']))
{
throw new \phpbb\extension\exception('META_FIELD_NOT_SET', array('author name'));
}
}
return true;
}
/**
* This array handles the verification that this extension can be enabled on this board
*
* @return bool True if validation succeeded, throws an exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate_enable()
{
// Check for valid directory & phpBB, PHP versions
return $this->validate_dir() && $this->validate_require_phpbb() && $this->validate_require_php();
}
/**
* Validates the most basic directory structure to ensure it follows <vendor>/<ext> convention.
*
* @return boolean True when passes validation, throws an exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate_dir()
{
if (substr_count($this->ext_name, '/') !== 1 || $this->ext_name != $this->get_metadata('name'))
{
throw new \phpbb\extension\exception('EXTENSION_DIR_INVALID');
}
return true;
}
/**
* Validates the contents of the phpbb requirement field
*
* @return boolean True when passes validation, throws an exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate_require_phpbb()
{
if (!isset($this->metadata['extra']['soft-require']['phpbb/phpbb']))
{
throw new \phpbb\extension\exception('META_FIELD_NOT_SET', array('soft-require'));
}
return true;
}
/**
* Validates the contents of the php requirement field
*
* @return boolean True when passes validation, throws an exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate_require_php()
{
if (!isset($this->metadata['require']['php']))
{
throw new \phpbb\extension\exception('META_FIELD_NOT_SET', array('require php'));
}
return true;
}
}

View File

@ -0,0 +1,72 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension;
/**
* Provides a set of items found in extensions.
*
* This abstract class is essentially a wrapper around item-specific
* finding logic. It handles storing the extension manager via constructor
* for the finding logic to use to find the items, and provides an
* iterator interface over the items found by the finding logic.
*
* Items could be anything, for example template paths or cron task names.
* Derived classes completely define what the items are.
*/
abstract class provider implements \IteratorAggregate
{
/**
* Array holding all found items
* @var array|null
*/
protected $items = null;
/**
* An extension manager to search for items in extensions
* @var \phpbb\extension\manager
*/
protected $extension_manager;
/**
* Constructor. Loads all available items.
*
* @param \phpbb\extension\manager $extension_manager phpBB extension manager
*/
public function __construct(\phpbb\extension\manager $extension_manager)
{
$this->extension_manager = $extension_manager;
}
/**
* Finds items using the extension manager.
*
* @return array List of task names
*/
abstract protected function find();
/**
* Retrieve an iterator over all items
*
* @return \ArrayIterator An iterator for the array of template paths
*/
public function getIterator()
{
if ($this->items === null)
{
$this->items = $this->find();
}
return new \ArrayIterator($this->items);
}
}