Merge branch '3.2.x'

phpBB/phpbb/console/command/update/check.php

@@ -0,0 +1,331 @@
+<?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\console\command\update;
+
+use phpbb\config\config;
+use phpbb\exception\exception_interface;
+use phpbb\language\language;
+use phpbb\user;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class check extends \phpbb\console\command\command
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	/** @var \Symfony\Component\DependencyInjection\ContainerBuilder */
+	protected $phpbb_container;
+	/**
+	 * @var language
+	 */
+	private $language;
+
+	/**
+	* Construct method
+	*/
+	public function __construct(user $user, config $config, ContainerInterface $phpbb_container, language $language)
+	{
+		$this->config = $config;
+		$this->phpbb_container = $phpbb_container;
+		$this->language = $language;
+
+		$this->language->add_lang(array('acp/common', 'acp/extensions'));
+
+		parent::__construct($user);
+	}
+
+	/**
+	* Configures the service.
+	*
+	* Sets the name and description of the command.
+	*
+	* @return null
+	*/
+	protected function configure()
+	{
+		$this
+			->setName('update:check')
+			->setDescription($this->language->lang('CLI_DESCRIPTION_UPDATE_CHECK'))
+			->addArgument('ext-name', InputArgument::OPTIONAL, $this->language->lang('CLI_DESCRIPTION_UPDATE_CHECK_ARGUMENT_1'))
+			->addOption('stability', null, InputOption::VALUE_REQUIRED, $this->language->lang('CLI_DESCRIPTION_UPDATE_CHECK_OPTION_STABILITY'))
+			->addOption('cache', 'c', InputOption::VALUE_NONE, $this->language->lang('CLI_DESCRIPTION_UPDATE_CHECK_OPTION_CACHE'))
+		;
+	}
+
+	/**
+	* Executes the command.
+	*
+	* Checks if an update is available.
+	* If at least one is available, a message is printed and if verbose mode is set the list of possible updates is printed.
+	* If their is none, nothing is printed unless verbose mode is set.
+	*
+	* @param InputInterface $input Input stream, used to get the options.
+	* @param OutputInterface $output Output stream, used to print messages.
+	* @return int 0 if the board is up to date, 1 if it is not and 2 if an error occured.
+	* @throws \RuntimeException
+	*/
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$io = new SymfonyStyle($input, $output);
+
+		$recheck = true;
+		if ($input->getOption('cache'))
+		{
+			$recheck = false;
+		}
+
+		$stability = null;
+		if ($input->getOption('stability'))
+		{
+			$stability = $input->getOption('stability');
+			if (!($stability == 'stable') && !($stability == 'unstable'))
+			{
+				$io->error($this->language->lang('CLI_ERROR_INVALID_STABILITY', $stability));
+				return 3;
+			}
+		}
+
+		$ext_name = $input->getArgument('ext-name');
+		if ($ext_name != null)
+		{
+			if ($ext_name == 'all')
+			{
+				return $this->check_all_ext($io, $stability, $recheck);
+			}
+			else
+			{
+				return $this->check_ext($input, $io, $stability, $recheck, $ext_name);
+			}
+		}
+		else
+		{
+			return $this->check_core($input, $io, $stability, $recheck);
+		}
+	}
+
+	/**
+	 * Check if a given extension is up to date
+	 *
+	 * @param InputInterface	$input		Input stream, used to get the options.
+	 * @param SymfonyStyle		$io			IO handler, for formatted and unified IO
+	 * @param string			$stability	Force a given stability
+	 * @param bool				$recheck	Disallow the use of the cache
+	 * @param string			$ext_name	The extension name
+	 * @return int
+	 */
+	protected function check_ext(InputInterface $input, SymfonyStyle $io, $stability, $recheck, $ext_name)
+	{
+		try
+		{
+			$ext_manager = $this->phpbb_container->get('ext.manager');
+			$md_manager = $ext_manager->create_extension_metadata_manager($ext_name, null);
+			$updates_available = $ext_manager->version_check($md_manager, $recheck, false, $stability);
+
+			$metadata = $md_manager->get_metadata('all');
+			if ($input->getOption('verbose'))
+			{
+				$io->title($md_manager->get_metadata('display-name'));
+
+				$io->note($this->language->lang('CURRENT_VERSION') . $this->language->lang('COLON') . ' ' . $metadata['version']);
+			}
+
+			if (!empty($updates_available))
+			{
+				if ($input->getOption('verbose'))
+				{
+					$io->caution($this->language->lang('NOT_UP_TO_DATE', $metadata['name']));
+
+					$this->display_versions($io, $updates_available);
+				}
+
+				return 1;
+			}
+			else
+			{
+				if ($input->getOption('verbose'))
+				{
+					$io->success($this->language->lang('UPDATE_NOT_NEEDED'));
+				}
+
+				return 0;
+			}
+		}
+		catch (\RuntimeException $e)
+		{
+			$io->error($this->language->lang('EXTENSION_NOT_INSTALLED', $ext_name));
+
+			return 1;
+		}
+	}
+
+	/**
+	 * Check if the core is up to date
+	 *
+	 * @param InputInterface	$input		Input stream, used to get the options.
+	 * @param SymfonyStyle		$io			IO handler, for formatted and unified IO
+	 * @param string			$stability	Force a given stability
+	 * @param bool				$recheck	Disallow the use of the cache
+	 * @return int
+	 */
+	protected function check_core(InputInterface $input, SymfonyStyle $io, $stability, $recheck)
+	{
+		$version_helper = $this->phpbb_container->get('version_helper');
+		$version_helper->force_stability($stability);
+
+		$updates_available = $version_helper->get_suggested_updates($recheck);
+
+		if ($input->getOption('verbose'))
+		{
+			$io->title('phpBB core');
+
+			$io->note( $this->language->lang('CURRENT_VERSION') . $this->language->lang('COLON') . ' ' . $this->config['version']);
+		}
+
+		if (!empty($updates_available))
+		{
+			$io->caution($this->language->lang('UPDATE_NEEDED'));
+
+			if ($input->getOption('verbose'))
+			{
+				$this->display_versions($io, $updates_available);
+			}
+
+			return 1;
+		}
+		else
+		{
+			if ($input->getOption('verbose'))
+			{
+				$io->success($this->language->lang('UPDATE_NOT_NEEDED'));
+			}
+
+			return 0;
+		}
+	}
+
+	/**
+	* Check if all the available extensions are up to date
+	*
+	* @param SymfonyStyle	$io			IO handler, for formatted and unified IO
+	* @param bool			$recheck	Disallow the use of the cache
+	* @return int
+	*/
+	protected function check_all_ext(SymfonyStyle $io, $stability, $recheck)
+	{
+		/** @var \phpbb\extension\manager $ext_manager */
+		$ext_manager = $this->phpbb_container->get('ext.manager');
+
+		$rows = [];
+
+		foreach ($ext_manager->all_available() as $ext_name => $ext_path)
+		{
+			$row = [];
+			$row[] = sprintf("<info>%s</info>", $ext_name);
+			$md_manager = $ext_manager->create_extension_metadata_manager($ext_name);
+			try
+			{
+				$metadata = $md_manager->get_metadata('all');
+				if (isset($metadata['extra']['version-check']))
+				{
+					try {
+						$updates_available = $ext_manager->version_check($md_manager, $recheck, false, $stability);
+						if (!empty($updates_available))
+						{
+							$versions = array_map(function($entry)
+							{
+								return $entry['current'];
+							}, $updates_available);
+
+							$row[] = sprintf("<comment>%s</comment>", $metadata['version']);
+							$row[] = implode(', ', $versions);
+						}
+						else
+						{
+							$row[] = sprintf("<info>%s</info>", $metadata['version']);
+							$row[] = '';
+						}
+					} catch (\RuntimeException $e) {
+						$row[] = $metadata['version'];
+						$row[] = '';
+					}
+				}
+				else
+				{
+					$row[] = $metadata['version'];
+					$row[] = '';
+				}
+			}
+			catch (exception_interface $e)
+			{
+				$exception_message = call_user_func_array(array($this->user, 'lang'), array_merge(array($e->getMessage()), $e->get_parameters()));
+				$row[] = '<error>' . $exception_message . '</error>';
+			}
+			catch (\RuntimeException $e)
+			{
+				$row[] = '<error>' . $e->getMessage() . '</error>';
+			}
+
+			$rows[] = $row;
+		}
+
+		$io->table([
+			$this->language->lang('EXTENSION_NAME'),
+			$this->language->lang('CURRENT_VERSION'),
+			$this->language->lang('LATEST_VERSION'),
+		], $rows);
+
+		return 0;
+	}
+
+	/**
+	* Display the details of the available updates
+	*
+	* @param SymfonyStyle	$io					IO handler, for formatted and unified IO
+	* @param array			$updates_available	The list of the available updates
+	*/
+	protected function display_versions(SymfonyStyle $io, $updates_available)
+	{
+		$io->section($this->language->lang('UPDATES_AVAILABLE'));
+
+		$rows = [];
+		foreach ($updates_available as $version_data)
+		{
+			$row = ['', '', ''];
+			$row[0] = $version_data['current'];
+
+			if (isset($version_data['announcement']))
+			{
+				$row[1] = $version_data['announcement'];
+			}
+
+			if (isset($version_data['download']))
+			{
+				$row[2] = $version_data['download'];
+			}
+
+			$rows[] = $row;
+		}
+
+		$io->table([
+			$this->language->lang('VERSION'),
+			$this->language->lang('ANNOUNCEMENT_TOPIC'),
+		    $this->language->lang('DOWNLOAD_LATEST'),
+		], $rows);
+	}
+}

phpBB/phpbb/exception/version_check_exception.php

@@ -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\exception;
+
+/**
+ * Define an exception related to the version checker.
+ */
+class version_check_exception extends runtime_exception
+{
+}

phpBB/phpbb/extension/manager.php

@@ -13,6 +13,8 @@
 
 namespace phpbb\extension;
 
+use phpbb\exception\runtime_exception;
+use phpbb\file_downloader;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -42,10 +44,10 @@ class manager
 	* @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\driver\driver_interface $cache A cache instance or null
+	* @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\driver\driver_interface $cache = null, $cache_name = '_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;
@@ -146,12 +148,11 @@ class manager
 	* Instantiates the metadata manager for the extension with the given name
 	*
 	* @param string $name The extension name
-	* @param \phpbb\template\template $template The template manager
 	* @return \phpbb\extension\metadata_manager Instance of the metadata manager
 	*/
-	public function create_extension_metadata_manager($name, \phpbb\template\template $template)
+	public function create_extension_metadata_manager($name)
 	{
-		return new \phpbb\extension\metadata_manager($name, $this->config, $this, $template, $this->phpbb_root_path);
+		return new \phpbb\extension\metadata_manager($name, $this->config, $this, $this->phpbb_root_path);
 	}
 
 	/**
@@ -565,6 +566,35 @@ class manager
 		return isset($this->extensions[$name]);
 	}
 
+	/**
+	* 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 string
+	* @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']);
+		$version_helper->force_stability($stability);
+
+		return $updates = $version_helper->get_suggested_updates($force_update, $force_cache);
+	}
+
 	/**
 	* Check to see if a given extension is purged
 	*

phpBB/phpbb/extension/metadata_manager.php

@@ -30,12 +30,6 @@ class metadata_manager
 	*/
 	protected $extension_manager;
 
-	/**
-	* phpBB Template instance
-	* @var \phpbb\template\template
-	*/
-	protected $template;
-
 	/**
 	* phpBB root path
 	* @var string
@@ -66,14 +60,12 @@ class metadata_manager
 	* @param string				$ext_name			Name (including vendor) of the extension
 	* @param \phpbb\config\config		$config				phpBB Config instance
 	* @param \phpbb\extension\manager	$extension_manager	An instance of the phpBB extension manager
-	* @param \phpbb\template\template	$template			phpBB Template instance
 	* @param string				$phpbb_root_path	Path to the phpbb includes directory.
 	*/
-	public function __construct($ext_name, \phpbb\config\config $config, \phpbb\extension\manager $extension_manager, \phpbb\template\template $template, $phpbb_root_path)
+	public function __construct($ext_name, \phpbb\config\config $config, \phpbb\extension\manager $extension_manager, $phpbb_root_path)
 	{
 		$this->config = $config;
 		$this->extension_manager = $extension_manager;
-		$this->template = $template;
 		$this->phpbb_root_path = $phpbb_root_path;
 
 		$this->ext_name = $ext_name;
@@ -336,11 +328,11 @@ class metadata_manager
 	/**
 	* Outputs the metadata into the template
 	*
-	* @return null
+	* @param \phpbb\template\template	$template	phpBB Template instance
 	*/
-	public function output_template_data()
+	public function output_template_data(\phpbb\template\template $template)
 	{
-		$this->template->assign_vars(array(
+		$template->assign_vars(array(
 			'META_NAME'			=> $this->metadata['name'],
 			'META_TYPE'			=> $this->metadata['type'],
 			'META_DESCRIPTION'	=> (isset($this->metadata['description'])) ? $this->metadata['description'] : '',
@@ -360,7 +352,7 @@ class metadata_manager
 
 		foreach ($this->metadata['authors'] as $author)
 		{
-			$this->template->assign_block_vars('meta_authors', array(
+			$template->assign_block_vars('meta_authors', array(
 				'AUTHOR_NAME'		=> $author['name'],
 				'AUTHOR_EMAIL'		=> (isset($author['email'])) ? $author['email'] : '',
 				'AUTHOR_HOMEPAGE'	=> (isset($author['homepage'])) ? $author['homepage'] : '',

phpBB/phpbb/finder.php

@@ -50,12 +50,12 @@ class finder
 	*
 	* @param \phpbb\filesystem\filesystem_interface $filesystem Filesystem instance
 	* @param string $phpbb_root_path Path to the phpbb root directory
-	* @param \phpbb\cache\driver\driver_interface $cache A cache instance or null
+	* @param \phpbb\cache\service $cache A cache instance or null
 	* @param string $php_ext php file extension
 	* @param string $cache_name The name of the cache variable, defaults to
 	*                           _ext_finder
 	*/
-	public function __construct(\phpbb\filesystem\filesystem_interface $filesystem, $phpbb_root_path = '', \phpbb\cache\driver\driver_interface $cache = null, $php_ext = 'php', $cache_name = '_ext_finder')
+	public function __construct(\phpbb\filesystem\filesystem_interface $filesystem, $phpbb_root_path = '', \phpbb\cache\service $cache = null, $php_ext = 'php', $cache_name = '_ext_finder')
 	{
 		$this->filesystem = $filesystem;
 		$this->phpbb_root_path = $phpbb_root_path;

phpBB/phpbb/version_helper.php

@@ -13,6 +13,8 @@
 
 namespace phpbb;
 
+use phpbb\exception\version_check_exception;
+
 /**
  * Class to handle version checking and comparison
  */
@@ -58,23 +60,18 @@ class version_helper
 	/** @var \phpbb\file_downloader */
 	protected $file_downloader;
 
-	/** @var \phpbb\user */
-	protected $user;
-
 	/**
 	 * Constructor
 	 *
 	 * @param \phpbb\cache\service $cache
 	 * @param \phpbb\config\config $config
 	 * @param \phpbb\file_downloader $file_downloader
-	 * @param \phpbb\user $user
 	 */
-	public function __construct(\phpbb\cache\service $cache, \phpbb\config\config $config, \phpbb\file_downloader $file_downloader, \phpbb\user $user)
+	public function __construct(\phpbb\cache\service $cache, \phpbb\config\config $config, \phpbb\file_downloader $file_downloader)
 	{
 		$this->cache = $cache;
 		$this->config = $config;
 		$this->file_downloader = $file_downloader;
-		$this->user = $user;
 
 		if (defined('PHPBB_QA'))
 		{
@@ -175,7 +172,7 @@ class version_helper
 	* @param bool $force_update Ignores cached data. Defaults to false.
 	* @param bool $force_cache Force the use of the cache. Override $force_update.
 	* @return string
-	* @throws \RuntimeException
+	* @throws version_check_exception
 	*/
 	public function get_latest_on_current_branch($force_update = false, $force_cache = false)
 	{
@@ -206,7 +203,7 @@ class version_helper
 	* @param bool $force_update Ignores cached data. Defaults to false.
 	* @param bool $force_cache Force the use of the cache. Override $force_update.
 	* @return string
-	* @throws \RuntimeException
+	* @throws version_check_exception
 	*/
 	public function get_suggested_updates($force_update = false, $force_cache = false)
 	{
@@ -227,7 +224,7 @@ class version_helper
 	* @param bool $force_update Ignores cached data. Defaults to false.
 	* @param bool $force_cache Force the use of the cache. Override $force_update.
 	* @return string Version info
-	* @throws \RuntimeException
+	* @throws version_check_exception
 	*/
 	public function get_versions_matching_stability($force_update = false, $force_cache = false)
 	{
@@ -247,7 +244,7 @@ class version_helper
 	* @param bool $force_update Ignores cached data. Defaults to false.
 	* @param bool $force_cache Force the use of the cache. Override $force_update.
 	* @return string Version info, includes stable and unstable data
-	* @throws \RuntimeException
+	* @throws version_check_exception
 	*/
 	public function get_versions($force_update = false, $force_cache = false)
 	{
@@ -257,23 +254,16 @@ class version_helper
 
 		if ($info === false && $force_cache)
 		{
-			throw new \RuntimeException($this->user->lang('VERSIONCHECK_FAIL'));
+			throw new version_check_exception('VERSIONCHECK_FAIL');
 		}
 		else if ($info === false || $force_update)
 		{
-			try {
-				$info = $this->file_downloader->get($this->host, $this->path, $this->file, $this->use_ssl ? 443 : 80);
-			}
-			catch (\phpbb\exception\runtime_exception $exception)
-			{
-				$prepare_parameters = array_merge(array($exception->getMessage()), $exception->get_parameters());
-				throw new \RuntimeException(call_user_func_array(array($this->user, 'lang'), $prepare_parameters));
-			}
+			$info = $this->file_downloader->get($this->host, $this->path, $this->file, $this->use_ssl ? 443 : 80);
 			$error_string = $this->file_downloader->get_error_string();
 
 			if (!empty($error_string))
 			{
-				throw new \RuntimeException($error_string);
+				throw new version_check_exception($error_string);
 			}
 
 			$info = json_decode($info, true);
@@ -290,9 +280,7 @@ class version_helper
 
 			if (empty($info['stable']) && empty($info['unstable']))
 			{
-				$this->user->add_lang('acp/common');
-
-				throw new \RuntimeException($this->user->lang('VERSIONCHECK_FAIL'));
+				throw new version_check_exception('VERSIONCHECK_FAIL');
 			}
 
 			$info['stable'] = (empty($info['stable'])) ? array() : $info['stable'];