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

[ticket/11150] Add ability to manage extensions through composer

Browse Source 
PHPBB3-11150
This commit is contained in:
Tristan Darricau
2015-09-09 19:56:52 +02:00
committed by Tristan Darricau
parent 712626d845
commit fbb85e2f4f
13 changed files with 1523 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

190
phpBB/phpbb/composer/manager.php Normal file
View File

@@ -0,0 +1,190 @@
<?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\composer;
use phpbb\composer\exception\runtime_exception;
/**
* Class to manage packages through composer.
*/
class manager
{
/**
* @var installer Composer packages installer
*/
protected $installer;
/**
* @var string Type of packages (phpbb-packages per example)
*/
protected $package_type;
/**
* @var string Prefix used for the exception's language string
*/
protected $exception_prefix;
/**
* @var array Caches the managed packages list
*/
private $managed_packages;
/**
* @var array Caches the available packages list
*/
private $available_packages;
/**
* @param installer $installer Installer object
* @param string $package_type Composer type of managed packages
* @param string $exception_prefix Exception prefix to use
*/
public function __construct(installer $installer, $package_type, $exception_prefix)
{
$this->installer = $installer;
$this->package_type = $package_type;
$this->exception_prefix = $exception_prefix;
}
/**
* Installs (if necessary) a set of packages
*
* @param array $packages Packages to install.
* Each entry may be a name or an array associating a version constraint to a name
* @throws runtime_exception
*/
public function install(array $packages)
{
$packages = $this->normalize_version($packages);
$already_managed = array_intersect(array_keys($this->get_managed_packages()), array_keys($packages));
if (count($already_managed) !== 0)
{
throw new runtime_exception($this->exception_prefix, 'ALREADY_INSTALLED', [implode('|', $already_managed)]);
}
$managed_packages = array_merge($this->get_managed_packages(), $packages);
ksort($managed_packages);
$this->installer->install($managed_packages, array_keys($packages));
$this->managed_packages = null;
}
/**
* Updates or installs a set of packages
*
* @param array $packages Packages to update.
* Each entry may be a name or an array associating a version constraint to a name
* @throws runtime_exception
*/
public function update(array $packages)
{
$packages = $this->normalize_version($packages);
// TODO: if the extension is already enabled, we should disabled and re-enable it
$not_managed = array_diff_key($packages, $this->get_managed_packages());
if (count($not_managed) !== 0)
{
throw new runtime_exception($this->exception_prefix, 'NOT_MANAGED', [implode('|', array_keys($not_managed))]);
}
$managed_packages = array_merge($this->get_managed_packages(), $packages);
ksort($managed_packages);
$this->installer->install($managed_packages, array_keys($packages));
}
/**
* Removes a set of packages
*
* @param array $packages Packages to remove.
* Each entry may be a name or an array associating a version constraint to a name
* @throws runtime_exception
*/
public function remove(array $packages)
{
$packages = $this->normalize_version($packages);
// TODO: if the extension is already enabled, we should disabled (with an option for purge)
$not_managed = array_diff_key($packages, $this->get_managed_packages());
if (count($not_managed) !== 0)
{
throw new runtime_exception($this->exception_prefix, 'NOT_MANAGED', [implode('|', array_keys($not_managed))]);
}
$managed_packages = array_diff_key($this->get_managed_packages(), $packages);
ksort($managed_packages);
$this->installer->install($managed_packages, array_keys($packages));
$this->managed_packages = null;
}
/**
* Tells whether or not a package is managed by Composer.
*
* @param string $packages Package name
* @return bool
*/
public function is_managed($packages)
{
return array_key_exists($packages, $this->get_managed_packages());
}
/**
* Returns the list of managed packages
*
* @return array The managed packages associated to their version.
*/
public function get_managed_packages()
{
if ($this->managed_packages === null)
{
$this->managed_packages = $this->installer->get_installed_packages($this->package_type);
}
return $this->managed_packages;
}
/**
* Returns the list of available packages
*
* @return array The name of the available packages, associated to their definition. Ordered by name.
*/
public function get_available_packages()
{
if ($this->available_packages === null)
{
$this->available_packages = $this->installer->get_available_packages($this->package_type);
}
return $this->available_packages;
}
protected function normalize_version($packages)
{
$normalized_packages = [];
foreach ($packages as $package)
{
if (!is_array($package))
{
$normalized_packages[$package] = '*';
}
}
return $normalized_packages;
}
}