Merge pull request #1893 from nickvergessen/ticket/12039

[ticket/12039] Add config:* to the command line interface tool

* nickvergessen/ticket/12039:
  [ticket/12039] Allow getting the value without a new line at the end
  [ticket/12039] Do not print success message when config did not exist
  [ticket/12039] Do not colour returned value in get command
  [ticket/12039] Update command descriptions
  [ticket/12039] Remove debug code
  [ticket/12039] Fix option descriptions
  [ticket/12039] Use an abstract class and some more minor adjustments
  [ticket/12039] Add config:* to the command line interface tool

phpBB/config/console.yml

@@ -1,4 +1,39 @@
 services:
+    console.command.config.delete:
+        class: phpbb\console\command\config\delete
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
+    console.command.config.increment:
+        class: phpbb\console\command\config\increment
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
+    console.command.config.get:
+        class: phpbb\console\command\config\get
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
+    console.command.config.set:
+        class: phpbb\console\command\config\set
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
+    console.command.config.set_atomic:
+        class: phpbb\console\command\config\set_atomic
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
     console.command.extension.disable:
         class: phpbb\console\command\extension\disable
         arguments:

phpBB/phpbb/console/command/config/command.php

@@ -0,0 +1,22 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+abstract class command extends \phpbb\console\command\command
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	function __construct(\phpbb\config\config $config)
+	{
+		$this->config = $config;
+
+		parent::__construct();
+	}
+}

phpBB/phpbb/console/command/config/delete.php

@@ -0,0 +1,46 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class delete extends command
+{
+	protected function configure()
+	{
+		$this
+			->setName('config:delete')
+			->setDescription('Deletes a configuration option')
+			->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				"The configuration option's name"
+			)
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$key = $input->getArgument('key');
+
+		if (isset($this->config[$key]))
+		{
+			$this->config->delete($key);
+
+			$output->writeln("<info>Successfully deleted config $key</info>");
+		}
+		else
+		{
+			$output->writeln("<error>Config $key does not exist</error>");
+		}
+	}
+}

phpBB/phpbb/console/command/config/get.php

@@ -0,0 +1,54 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class get extends command
+{
+	protected function configure()
+	{
+		$this
+			->setName('config:get')
+			->setDescription("Gets a configuration option's value")
+			->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				"The configuration option's name"
+			)
+			->addOption(
+				'no-newline',
+				null,
+				InputOption::VALUE_NONE,
+				'Set this option if the value should be printed without a new line at the end.'
+			)
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$key = $input->getArgument('key');
+
+		if (isset($this->config[$key]) && $input->getOption('no-newline'))
+		{
+			$output->write($this->config[$key]);
+		}
+		elseif (isset($this->config[$key]))
+		{
+			$output->writeln($this->config[$key]);
+		}
+		else
+		{
+			$output->writeln("<error>Could not get config $key</error>");
+		}
+	}
+}

phpBB/phpbb/console/command/config/increment.php

@@ -0,0 +1,52 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class increment extends command
+{
+	protected function configure()
+	{
+		$this
+			->setName('config:increment')
+			->setDescription("Increments a configuration option's value")
+			->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				"The configuration option's name"
+			)
+			->addArgument(
+				'increment',
+				InputArgument::REQUIRED,
+				'Amount to increment by'
+			)
+			->addOption(
+				'dynamic',
+				'd',
+				InputOption::VALUE_NONE,
+				'Set this option if the configuration option changes too frequently to be efficiently cached.'
+			)
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$key = $input->getArgument('key');
+		$increment = $input->getArgument('increment');
+		$use_cache = !$input->getOption('dynamic');
+
+		$this->config->increment($key, $increment, $use_cache);
+
+		$output->writeln("<info>Successfully incremented config $key</info>");
+	}
+}

phpBB/phpbb/console/command/config/set.php

@@ -0,0 +1,52 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class set extends command
+{
+	protected function configure()
+	{
+		$this
+			->setName('config:set')
+			->setDescription("Sets a configuration option's value")
+			->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				"The configuration option's name"
+			)
+			->addArgument(
+				'value',
+				InputArgument::REQUIRED,
+				'New configuration value, use 0 and 1 to specify boolean values'
+			)
+			->addOption(
+				'dynamic',
+				'd',
+				InputOption::VALUE_NONE,
+				'Set this option if the configuration option changes too frequently to be efficiently cached.'
+			)
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$key = $input->getArgument('key');
+		$value = $input->getArgument('value');
+		$use_cache = !$input->getOption('dynamic');
+
+		$this->config->set($key, $value, $use_cache);
+
+		$output->writeln("<info>Successfully set config $key</info>");
+	}
+}

phpBB/phpbb/console/command/config/set_atomic.php

@@ -0,0 +1,65 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class set_atomic extends command
+{
+	protected function configure()
+	{
+		$this
+			->setName('config:set-atomic')
+			->setDescription("Sets a configuration option's value only if the old matches the current value.")
+			->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				"The configuration option's name"
+			)
+			->addArgument(
+				'old',
+				InputArgument::REQUIRED,
+				'Current configuration value, use 0 and 1 to specify boolean values'
+			)
+			->addArgument(
+				'new',
+				InputArgument::REQUIRED,
+				'New configuration value, use 0 and 1 to specify boolean values'
+			)
+			->addOption(
+				'dynamic',
+				'd',
+				InputOption::VALUE_NONE,
+				'Set this option if the configuration option changes too frequently to be efficiently cached.'
+			)
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$key = $input->getArgument('key');
+		$old_value = $input->getArgument('old');
+		$new_value = $input->getArgument('new');
+		$use_cache = !$input->getOption('dynamic');
+
+		if ($this->config->set_atomic($key, $old_value, $new_value, $use_cache))
+		{
+			$output->writeln("<info>Successfully set config $key</info>");
+			return 0;
+		}
+		else
+		{
+			$output->writeln("<error>Could not set config $key</error>");
+			return 1;
+		}
+	}
+}