From e25f269aab500a94ca0100641e056b15b6b04e06 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sat, 20 Apr 2019 10:42:28 +0200 Subject: [PATCH 1/5] New command "BlockedServers" --- composer.json | 3 +- composer.lock | 69 +++++++- src/Core/Console.php | 2 + src/Core/Console/BlockedServers.php | 156 ++++++++++++++++++ .../Core/Console/BlockedServerConsoleTest.php | 86 ++++++++++ 5 files changed, 308 insertions(+), 8 deletions(-) create mode 100644 src/Core/Console/BlockedServers.php create mode 100644 tests/src/Core/Console/BlockedServerConsoleTest.php diff --git a/composer.json b/composer.json index 3f910cbe92..b0c51f9bfb 100644 --- a/composer.json +++ b/composer.json @@ -53,7 +53,8 @@ "npm-asset/moment": "^2.20.1", "npm-asset/fullcalendar": "^3.0.1", "npm-asset/cropperjs": "1.2.2", - "npm-asset/imagesloaded": "4.1.4" + "npm-asset/imagesloaded": "4.1.4", + "pear/console_table": "^1.3" }, "repositories": [ { diff --git a/composer.lock b/composer.lock index b8eabaeb9b..06952e05ef 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "1a2754551c042d350e99817b744705d8", + "content-hash": "7fc5e358b089ca47cdb5cac0e22d15d8", "packages": [ { "name": "asika/simple-console", @@ -1824,6 +1824,61 @@ ], "time": "2018-09-22T03:59:58+00:00" }, + { + "name": "pear/console_table", + "version": "v1.3.1", + "source": { + "type": "git", + "url": "https://github.com/pear/Console_Table.git", + "reference": "1930c11897ca61fd24b95f2f785e99e0f36dcdea" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/pear/Console_Table/zipball/1930c11897ca61fd24b95f2f785e99e0f36dcdea", + "reference": "1930c11897ca61fd24b95f2f785e99e0f36dcdea", + "shasum": "" + }, + "require": { + "php": ">=5.2.0" + }, + "suggest": { + "pear/Console_Color2": ">=0.1.2" + }, + "type": "library", + "autoload": { + "classmap": [ + "Table.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-2-Clause" + ], + "authors": [ + { + "name": "Jan Schneider", + "homepage": "http://pear.php.net/user/yunosh" + }, + { + "name": "Tal Peer", + "homepage": "http://pear.php.net/user/tal" + }, + { + "name": "Xavier Noguer", + "homepage": "http://pear.php.net/user/xnoguer" + }, + { + "name": "Richard Heyes", + "homepage": "http://pear.php.net/user/richard" + } + ], + "description": "Library that makes it easy to build console style tables.", + "homepage": "http://pear.php.net/package/Console_Table/", + "keywords": [ + "console" + ], + "time": "2018-01-25T20:47:17+00:00" + }, { "name": "pear/text_languagedetect", "version": "v1.0.0", @@ -3226,7 +3281,7 @@ } ], "description": "Provides the functionality to compare PHP values for equality", - "homepage": "http://www.github.com/sebastianbergmann/comparator", + "homepage": "https://github.com/sebastianbergmann/comparator", "keywords": [ "comparator", "compare", @@ -3328,7 +3383,7 @@ } ], "description": "Provides functionality to handle HHVM/PHP environments", - "homepage": "http://www.github.com/sebastianbergmann/environment", + "homepage": "https://github.com/sebastianbergmann/environment", "keywords": [ "Xdebug", "environment", @@ -3396,7 +3451,7 @@ } ], "description": "Provides the functionality to export PHP variables for visualization", - "homepage": "http://www.github.com/sebastianbergmann/exporter", + "homepage": "https://github.com/sebastianbergmann/exporter", "keywords": [ "export", "exporter" @@ -3448,7 +3503,7 @@ } ], "description": "Snapshotting of global state", - "homepage": "http://www.github.com/sebastianbergmann/global-state", + "homepage": "https://github.com/sebastianbergmann/global-state", "keywords": [ "global state" ], @@ -3550,7 +3605,7 @@ } ], "description": "Provides functionality to recursively process PHP variables", - "homepage": "http://www.github.com/sebastianbergmann/recursion-context", + "homepage": "https://github.com/sebastianbergmann/recursion-context", "time": "2016-11-19T07:33:16+00:00" }, { @@ -3683,7 +3738,7 @@ }, { "name": "Gert de Pagter", - "email": "backendtea@gmail.com" + "email": "BackEndTea@gmail.com" } ], "description": "Symfony polyfill for ctype functions", diff --git a/src/Core/Console.php b/src/Core/Console.php index c60f36296a..d115143e47 100644 --- a/src/Core/Console.php +++ b/src/Core/Console.php @@ -14,6 +14,7 @@ class Console extends \Asika\SimpleConsole\Console protected $customHelpOptions = ['h', 'help', '?']; protected $subConsoles = [ + 'blockedservers' => __NAMESPACE__ . '\Console\BlockedServers', 'cache' => __NAMESPACE__ . '\Console\Cache', 'config' => __NAMESPACE__ . '\Console\Config', 'createdoxygen' => __NAMESPACE__ . '\Console\CreateDoxygen', @@ -39,6 +40,7 @@ class Console extends \Asika\SimpleConsole\Console Usage: bin/console [--version] [-h|--help|-?] [] [-v] Commands: + blockedservers Manage blocked servers cache Manage node cache config Edit site config createdoxygen Generate Doxygen headers diff --git a/src/Core/Console/BlockedServers.php b/src/Core/Console/BlockedServers.php new file mode 100644 index 0000000000..29c0887067 --- /dev/null +++ b/src/Core/Console/BlockedServers.php @@ -0,0 +1,156 @@ + [-h|--help|-?] [-v] + bin/console blockedservers remove [-h|--help|-?] [-v] + +Description + With this tool, you can list the current blocked servers + or you can add / remove a blocked server from the list + +Options + -h|--help|-? Show help information + -v Show more debug information. +HELP; + return $help; + } + + protected function doExecute() + { + $a = BaseObject::getApp(); + + if (count($this->args) == 0) { + $this->printBlockedServers($a->getConfig()); + return 0; + } + + switch ($this->getArgument(0)) { + case 'add': + return $this->addBlockedServer($a->getConfig()); + case 'remove': + return $this->removeBlockedServer($a->getConfig()); + default: + throw new CommandArgsException('Unknown command.'); + break; + } + } + + /** + * Prints the whole list of blocked domains including the reason + * + * @param Configuration $config + */ + private function printBlockedServers(Configuration $config) + { + $table = new Console_Table(); + $table->setHeaders(['Domain', 'Reason']); + $blocklist = $config->get('system', 'blocklist'); + foreach ($blocklist as $domain) { + $table->addRow($domain); + } + $this->out($table->getTable()); + } + + /** + * Adds a server to the blocked list + * + * @param Configuration $config + * + * @return int The return code (0 = success, 1 = failed) + */ + private function addBlockedServer(Configuration $config) + { + if (count($this->args) < 2 || count($this->args) > 3) { + throw new CommandArgsException('Add needs a domain and optional a reason.'); + } + + $domain = $this->getArgument(1); + + $blocklist = $config->get('system', 'blocklist'); + foreach ($blocklist as $blocked) { + if ($blocked['domain'] === $domain) { + $this->out(sprintf("The domain '%s' is already blocked. (Reason: '%s')", $domain, $blocked['reason'])); + return 1; + } + } + + $reason = (count($this->args) === 3) ? $this->getArgument(2) : 'blocked'; + + $blocklist[] = [ + 'domain' => $domain, + 'reason' => $reason, + ]; + + if ($config->set('system', 'blocklist', $blocklist)) { + $this->out(sprintf("The domain '%s' is now blocked. (Reason: '%s')", $domain, $reason)); + return 0; + } else { + $this->out(sprintf("Couldn't save '%s' as blocked server", $domain)); + return 1; + } + } + + /** + * Removes a server from the blocked list + * + * @param Configuration $config + * + * @return int The return code (0 = success, 1 = failed) + */ + private function removeBlockedServer(Configuration $config) + { + if (count($this->args) !== 2) { + throw new CommandArgsException('Remove needs a second parameter.'); + } + + $domain = $this->getArgument(1); + + $found = false; + + $currBlocklist = $config->get('system', 'blocklist'); + $newBlockList = []; + foreach ($currBlocklist as $blocked) { + if ($blocked['domain'] === $domain) { + $found = true; + } else { + $newBlockList[] = $blocked; + } + } + + if (!$found) { + $this->out(sprintf("Domain '%s' is not blocked.", $domain)); + return 1; + } + + if ($config->set('system', 'blocklist', $newBlockList)) { + $this->out(sprintf("The domain '%s' is not more blocked", $domain)); + return 0; + } else { + $this->out(sprintf("Couldn't remove '%s' from blocked servers", $domain)); + return 1; + } + } +} diff --git a/tests/src/Core/Console/BlockedServerConsoleTest.php b/tests/src/Core/Console/BlockedServerConsoleTest.php new file mode 100644 index 0000000000..3156c5a41e --- /dev/null +++ b/tests/src/Core/Console/BlockedServerConsoleTest.php @@ -0,0 +1,86 @@ + 'social.nobodyhasthe.biz', + 'reason' => 'Illegal content', + ], + [ + 'domain' => 'pod.ordoevangelistarum.com', + 'reason' => 'Illegal content', + ] + ]; + + protected function setUp() + { + parent::setUp(); + + $this->mockApp($this->root); + } + + /** + * Test to list the default blocked servers + */ + public function testBlockedServerList() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $txt = $this->dumpExecute($console); + + $output = <<assertEquals($output, $txt); + } + + public function testAddBlockedServer() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $newBlockList = $this->defaultBlockList; + $newBlockList[] = [ + 'domain' => 'testme.now', + 'reason' => 'I like it!', + ]; + + $this->configMock + ->shouldReceive('set') + ->with('system', 'blocklist', $newBlockList) + ->andReturn(true) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'add'); + $console->setArgument(1, 'testme.now'); + $console->setArgument(2, 'I like it!'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'I like it!\')' . PHP_EOL, $txt); + } +} From 55d2473ec2250cb7a7e67c3781600eb540d06d3e Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sat, 20 Apr 2019 12:53:17 +0200 Subject: [PATCH 2/5] Add tests & default reason --- src/Core/Console/BlockedServers.php | 4 +- .../Core/Console/BlockedServerConsoleTest.php | 86 ------ .../Console/BlockedServersConsoleTest.php | 281 ++++++++++++++++++ 3 files changed, 284 insertions(+), 87 deletions(-) delete mode 100644 tests/src/Core/Console/BlockedServerConsoleTest.php create mode 100644 tests/src/Core/Console/BlockedServersConsoleTest.php diff --git a/src/Core/Console/BlockedServers.php b/src/Core/Console/BlockedServers.php index 29c0887067..493701392d 100644 --- a/src/Core/Console/BlockedServers.php +++ b/src/Core/Console/BlockedServers.php @@ -16,6 +16,8 @@ use Friendica\Core\Config\Configuration; */ class BlockedServers extends Console { + const DEFAULT_REASON = 'blocked'; + protected $helpOptions = ['h', 'help', '?']; protected function getHelp() @@ -97,7 +99,7 @@ HELP; } } - $reason = (count($this->args) === 3) ? $this->getArgument(2) : 'blocked'; + $reason = (count($this->args) === 3) ? $this->getArgument(2) : self::DEFAULT_REASON; $blocklist[] = [ 'domain' => $domain, diff --git a/tests/src/Core/Console/BlockedServerConsoleTest.php b/tests/src/Core/Console/BlockedServerConsoleTest.php deleted file mode 100644 index 3156c5a41e..0000000000 --- a/tests/src/Core/Console/BlockedServerConsoleTest.php +++ /dev/null @@ -1,86 +0,0 @@ - 'social.nobodyhasthe.biz', - 'reason' => 'Illegal content', - ], - [ - 'domain' => 'pod.ordoevangelistarum.com', - 'reason' => 'Illegal content', - ] - ]; - - protected function setUp() - { - parent::setUp(); - - $this->mockApp($this->root); - } - - /** - * Test to list the default blocked servers - */ - public function testBlockedServerList() - { - $this->configMock - ->shouldReceive('get') - ->with('system', 'blocklist') - ->andReturn($this->defaultBlockList) - ->once(); - - $console = new BlockedServers($this->consoleArgv); - $txt = $this->dumpExecute($console); - - $output = <<assertEquals($output, $txt); - } - - public function testAddBlockedServer() - { - $this->configMock - ->shouldReceive('get') - ->with('system', 'blocklist') - ->andReturn($this->defaultBlockList) - ->once(); - - $newBlockList = $this->defaultBlockList; - $newBlockList[] = [ - 'domain' => 'testme.now', - 'reason' => 'I like it!', - ]; - - $this->configMock - ->shouldReceive('set') - ->with('system', 'blocklist', $newBlockList) - ->andReturn(true) - ->once(); - - $console = new BlockedServers($this->consoleArgv); - $console->setArgument(0, 'add'); - $console->setArgument(1, 'testme.now'); - $console->setArgument(2, 'I like it!'); - $txt = $this->dumpExecute($console); - - $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'I like it!\')' . PHP_EOL, $txt); - } -} diff --git a/tests/src/Core/Console/BlockedServersConsoleTest.php b/tests/src/Core/Console/BlockedServersConsoleTest.php new file mode 100644 index 0000000000..1f1d8af7db --- /dev/null +++ b/tests/src/Core/Console/BlockedServersConsoleTest.php @@ -0,0 +1,281 @@ + 'social.nobodyhasthe.biz', + 'reason' => 'Illegal content', + ], + [ + 'domain' => 'pod.ordoevangelistarum.com', + 'reason' => 'Illegal content', + ] + ]; + + protected function setUp() + { + parent::setUp(); + + $this->mockApp($this->root); + } + + /** + * Test to list the default blocked servers + */ + public function testBlockedServersList() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $txt = $this->dumpExecute($console); + + $output = <<assertEquals($output, $txt); + } + + /** + * Test blockedservers add command + */ + public function testAddBlockedServer() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $newBlockList = $this->defaultBlockList; + $newBlockList[] = [ + 'domain' => 'testme.now', + 'reason' => 'I like it!', + ]; + + $this->configMock + ->shouldReceive('set') + ->with('system', 'blocklist', $newBlockList) + ->andReturn(true) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'add'); + $console->setArgument(1, 'testme.now'); + $console->setArgument(2, 'I like it!'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'I like it!\')' . PHP_EOL, $txt); + } + + /** + * Test blockedservers add command with the default reason + */ + public function testAddBlockedServerWithDefaultReason() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $newBlockList = $this->defaultBlockList; + $newBlockList[] = [ + 'domain' => 'testme.now', + 'reason' => BlockedServers::DEFAULT_REASON, + ]; + + $this->configMock + ->shouldReceive('set') + ->with('system', 'blocklist', $newBlockList) + ->andReturn(true) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'add'); + $console->setArgument(1, 'testme.now'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'' . BlockedServers::DEFAULT_REASON .'\')' . PHP_EOL, $txt); + } + + /** + * Test blockedservers remove command + */ + public function testRemoveBlockedServer() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $newBlockList = [ + [ + 'domain' => 'social.nobodyhasthe.biz', + 'reason' => 'Illegal content', + ], + ]; + + $this->configMock + ->shouldReceive('set') + ->with('system', 'blocklist', $newBlockList) + ->andReturn(true) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'remove'); + $console->setArgument(1, 'pod.ordoevangelistarum.com'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('The domain \'pod.ordoevangelistarum.com\' is not more blocked' . PHP_EOL, $txt); + } + + /** + * Test blockedservers with a wrong command + */ + public function testBlockedServersWrongCommand() + { + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'wrongcommand'); + $txt = $this->dumpExecute($console); + + $this->assertStringStartsWith('[Warning] Unknown command', $txt); + } + + /** + * Test blockedservers add command without argument + */ + public function testAddBlockedServerMissingArgument() + { + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'add'); + $txt = $this->dumpExecute($console); + + $this->assertStringStartsWith('[Warning] Add needs a domain and optional a reason.', $txt); + } + + /** + * Test blockedservers add command without save + */ + public function testAddBlockedServerNoSave() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $newBlockList = $this->defaultBlockList; + $newBlockList[] = [ + 'domain' => 'testme.now', + 'reason' => BlockedServers::DEFAULT_REASON, + ]; + + $this->configMock + ->shouldReceive('set') + ->with('system', 'blocklist', $newBlockList) + ->andReturn(false) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'add'); + $console->setArgument(1, 'testme.now'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('Couldn\'t save \'testme.now\' as blocked server' . PHP_EOL, $txt); + } + + /** + * Test blockedservers remove command without save + */ + public function testRemoveBlockedServerNoSave() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $newBlockList = [ + [ + 'domain' => 'social.nobodyhasthe.biz', + 'reason' => 'Illegal content', + ], + ]; + + $this->configMock + ->shouldReceive('set') + ->with('system', 'blocklist', $newBlockList) + ->andReturn(false) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'remove'); + $console->setArgument(1, 'pod.ordoevangelistarum.com'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('Couldn\'t remove \'pod.ordoevangelistarum.com\' from blocked servers' . PHP_EOL, $txt); + } + + /** + * Test blockedservers remove command without argument + */ + public function testRemoveBlockedServerMissingArgument() + { + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'remove'); + $txt = $this->dumpExecute($console); + + $this->assertStringStartsWith('[Warning] Remove needs a second parameter.', $txt); + } + + /** + * Test the blockedservers help + */ + public function testBlockedServersHelp() + { + $console = new BlockedServers($this->consoleArgv); + $console->setOption('help', true); + $txt = $this->dumpExecute($console); + + $help = << [-h|--help|-?] [-v] + bin/console blockedservers remove [-h|--help|-?] [-v] + +Description + With this tool, you can list the current blocked servers + or you can add / remove a blocked server from the list + +Options + -h|--help|-? Show help information + -v Show more debug information. + +HELP; + + $this->assertEquals($help, $txt); + } +} From 7ce76d153a6521f348bba6675f9ba3e1f982cf65 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sat, 20 Apr 2019 12:54:38 +0200 Subject: [PATCH 3/5] rename description to reason --- src/Core/Console/BlockedServers.php | 2 +- tests/src/Core/Console/BlockedServersConsoleTest.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Core/Console/BlockedServers.php b/src/Core/Console/BlockedServers.php index 493701392d..07c4ee62d1 100644 --- a/src/Core/Console/BlockedServers.php +++ b/src/Core/Console/BlockedServers.php @@ -26,7 +26,7 @@ class BlockedServers extends Console console blockedservers - Manage blocked servers Usage bin/console blockedservers [-h|--help|-?] [-v] - bin/console blockedservers add [-h|--help|-?] [-v] + bin/console blockedservers add [-h|--help|-?] [-v] bin/console blockedservers remove [-h|--help|-?] [-v] Description diff --git a/tests/src/Core/Console/BlockedServersConsoleTest.php b/tests/src/Core/Console/BlockedServersConsoleTest.php index 1f1d8af7db..c454a14b9b 100644 --- a/tests/src/Core/Console/BlockedServersConsoleTest.php +++ b/tests/src/Core/Console/BlockedServersConsoleTest.php @@ -263,7 +263,7 @@ CONS; console blockedservers - Manage blocked servers Usage bin/console blockedservers [-h|--help|-?] [-v] - bin/console blockedservers add [-h|--help|-?] [-v] + bin/console blockedservers add [-h|--help|-?] [-v] bin/console blockedservers remove [-h|--help|-?] [-v] Description From f05f02409ed5b9332eeb19d84e1b032d30682281 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sat, 20 Apr 2019 13:24:33 +0200 Subject: [PATCH 4/5] Add update possibility to BlockedServers --- src/Core/Console/BlockedServers.php | 39 ++++++++----- .../Console/BlockedServersConsoleTest.php | 58 ++++++++++++++++++- 2 files changed, 83 insertions(+), 14 deletions(-) diff --git a/src/Core/Console/BlockedServers.php b/src/Core/Console/BlockedServers.php index 07c4ee62d1..cd9d212984 100644 --- a/src/Core/Console/BlockedServers.php +++ b/src/Core/Console/BlockedServers.php @@ -90,24 +90,37 @@ HELP; } $domain = $this->getArgument(1); + $reason = (count($this->args) === 3) ? $this->getArgument(2) : self::DEFAULT_REASON; - $blocklist = $config->get('system', 'blocklist'); - foreach ($blocklist as $blocked) { + $update = false; + + $currBlocklist = $config->get('system', 'blocklist'); + $newBlockList = []; + foreach ($currBlocklist as $blocked) { if ($blocked['domain'] === $domain) { - $this->out(sprintf("The domain '%s' is already blocked. (Reason: '%s')", $domain, $blocked['reason'])); - return 1; + $update = true; + $newBlockList[] = [ + 'domain' => $domain, + 'reason' => $reason, + ]; + } else { + $newBlockList[] = $blocked; } } - $reason = (count($this->args) === 3) ? $this->getArgument(2) : self::DEFAULT_REASON; + if (!$update) { + $newBlockList[] = [ + 'domain' => $domain, + 'reason' => $reason, + ]; + } - $blocklist[] = [ - 'domain' => $domain, - 'reason' => $reason, - ]; - - if ($config->set('system', 'blocklist', $blocklist)) { - $this->out(sprintf("The domain '%s' is now blocked. (Reason: '%s')", $domain, $reason)); + if ($config->set('system', 'blocklist', $newBlockList)) { + if ($update) { + $this->out(sprintf("The domain '%s' is now updated. (Reason: '%s')", $domain, $reason)); + } else { + $this->out(sprintf("The domain '%s' is now blocked. (Reason: '%s')", $domain, $reason)); + } return 0; } else { $this->out(sprintf("Couldn't save '%s' as blocked server", $domain)); @@ -143,7 +156,7 @@ HELP; } if (!$found) { - $this->out(sprintf("Domain '%s' is not blocked.", $domain)); + $this->out(sprintf("The domain '%s' is not blocked.", $domain)); return 1; } diff --git a/tests/src/Core/Console/BlockedServersConsoleTest.php b/tests/src/Core/Console/BlockedServersConsoleTest.php index c454a14b9b..f33a8de31c 100644 --- a/tests/src/Core/Console/BlockedServersConsoleTest.php +++ b/tests/src/Core/Console/BlockedServersConsoleTest.php @@ -116,7 +116,44 @@ CONS; $console->setArgument(1, 'testme.now'); $txt = $this->dumpExecute($console); - $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'' . BlockedServers::DEFAULT_REASON .'\')' . PHP_EOL, $txt); + $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'' . BlockedServers::DEFAULT_REASON . '\')' . PHP_EOL, $txt); + } + + /** + * Test blockedservers add command on existed domain + */ + public function testUpdateBlockedServer() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $newBlockList = [ + [ + 'domain' => 'social.nobodyhasthe.biz', + 'reason' => 'Illegal content', + ], + [ + 'domain' => 'pod.ordoevangelistarum.com', + 'reason' => 'Other reason', + ] + ]; + + $this->configMock + ->shouldReceive('set') + ->with('system', 'blocklist', $newBlockList) + ->andReturn(true) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'add'); + $console->setArgument(1, 'pod.ordoevangelistarum.com'); + $console->setArgument(2, 'Other reason'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('The domain \'pod.ordoevangelistarum.com\' is now updated. (Reason: \'Other reason\')' . PHP_EOL, $txt); } /** @@ -163,6 +200,25 @@ CONS; $this->assertStringStartsWith('[Warning] Unknown command', $txt); } + /** + * Test blockedservers remove with not existing domain + */ + public function testRemoveBlockedServerNotExist() + { + $this->configMock + ->shouldReceive('get') + ->with('system', 'blocklist') + ->andReturn($this->defaultBlockList) + ->once(); + + $console = new BlockedServers($this->consoleArgv); + $console->setArgument(0, 'remove'); + $console->setArgument(1, 'not.exiting'); + $txt = $this->dumpExecute($console); + + $this->assertEquals('The domain \'not.exiting\' is not blocked.' . PHP_EOL, $txt); + } + /** * Test blockedservers add command without argument */ From 8660f6d86fc5d8f8f997b4b6a537b80d7ffbedff Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sat, 20 Apr 2019 16:40:27 +0200 Subject: [PATCH 5/5] Rename BlockedServers to ServerBlock --- src/Core/Console.php | 44 +++++++++---------- .../{BlockedServers.php => ServerBlock.php} | 10 ++--- ...oleTest.php => ServerBlockConsoleTest.php} | 42 +++++++++--------- 3 files changed, 48 insertions(+), 48 deletions(-) rename src/Core/Console/{BlockedServers.php => ServerBlock.php} (93%) rename tests/src/Core/Console/{BlockedServersConsoleTest.php => ServerBlockConsoleTest.php} (86%) diff --git a/src/Core/Console.php b/src/Core/Console.php index d115143e47..0cc63a5913 100644 --- a/src/Core/Console.php +++ b/src/Core/Console.php @@ -13,34 +13,12 @@ class Console extends \Asika\SimpleConsole\Console protected $helpOptions = []; protected $customHelpOptions = ['h', 'help', '?']; - protected $subConsoles = [ - 'blockedservers' => __NAMESPACE__ . '\Console\BlockedServers', - 'cache' => __NAMESPACE__ . '\Console\Cache', - 'config' => __NAMESPACE__ . '\Console\Config', - 'createdoxygen' => __NAMESPACE__ . '\Console\CreateDoxygen', - 'docbloxerrorchecker' => __NAMESPACE__ . '\Console\DocBloxErrorChecker', - 'dbstructure' => __NAMESPACE__ . '\Console\DatabaseStructure', - 'extract' => __NAMESPACE__ . '\Console\Extract', - 'globalcommunityblock' => __NAMESPACE__ . '\Console\GlobalCommunityBlock', - 'globalcommunitysilence' => __NAMESPACE__ . '\Console\GlobalCommunitySilence', - 'archivecontact' => __NAMESPACE__ . '\Console\ArchiveContact', - 'autoinstall' => __NAMESPACE__ . '\Console\AutomaticInstallation', - 'maintenance' => __NAMESPACE__ . '\Console\Maintenance', - 'newpassword' => __NAMESPACE__ . '\Console\NewPassword', - 'php2po' => __NAMESPACE__ . '\Console\PhpToPo', - 'po2php' => __NAMESPACE__ . '\Console\PoToPhp', - 'typo' => __NAMESPACE__ . '\Console\Typo', - 'postupdate' => __NAMESPACE__ . '\Console\PostUpdate', - 'storage' => __NAMESPACE__ . '\Console\Storage', - ]; - protected function getHelp() { $help = << [] [-v] Commands: - blockedservers Manage blocked servers cache Manage node cache config Edit site config createdoxygen Generate Doxygen headers @@ -58,6 +36,7 @@ Commands: po2php Generate a strings.php file from a messages.po file typo Checks for parse errors in Friendica files postupdate Execute pending post update scripts (can last days) + serverblock Manage blocked servers storage Manage storage backend Options: @@ -67,6 +46,27 @@ HELP; return $help; } + protected $subConsoles = [ + 'cache' => __NAMESPACE__ . '\Console\Cache', + 'config' => __NAMESPACE__ . '\Console\Config', + 'createdoxygen' => __NAMESPACE__ . '\Console\CreateDoxygen', + 'docbloxerrorchecker' => __NAMESPACE__ . '\Console\DocBloxErrorChecker', + 'dbstructure' => __NAMESPACE__ . '\Console\DatabaseStructure', + 'extract' => __NAMESPACE__ . '\Console\Extract', + 'globalcommunityblock' => __NAMESPACE__ . '\Console\GlobalCommunityBlock', + 'globalcommunitysilence' => __NAMESPACE__ . '\Console\GlobalCommunitySilence', + 'archivecontact' => __NAMESPACE__ . '\Console\ArchiveContact', + 'autoinstall' => __NAMESPACE__ . '\Console\AutomaticInstallation', + 'maintenance' => __NAMESPACE__ . '\Console\Maintenance', + 'newpassword' => __NAMESPACE__ . '\Console\NewPassword', + 'php2po' => __NAMESPACE__ . '\Console\PhpToPo', + 'po2php' => __NAMESPACE__ . '\Console\PoToPhp', + 'typo' => __NAMESPACE__ . '\Console\Typo', + 'postupdate' => __NAMESPACE__ . '\Console\PostUpdate', + 'serverblock' => __NAMESPACE__ . '\Console\ServerBlock', + 'storage' => __NAMESPACE__ . '\Console\Storage', + ]; + protected function doExecute() { if ($this->getOption('v')) { diff --git a/src/Core/Console/BlockedServers.php b/src/Core/Console/ServerBlock.php similarity index 93% rename from src/Core/Console/BlockedServers.php rename to src/Core/Console/ServerBlock.php index cd9d212984..94c97e1ddd 100644 --- a/src/Core/Console/BlockedServers.php +++ b/src/Core/Console/ServerBlock.php @@ -14,7 +14,7 @@ use Friendica\Core\Config\Configuration; * With this tool, you can list the current blocked servers * or you can add / remove a blocked server from the list */ -class BlockedServers extends Console +class ServerBlock extends Console { const DEFAULT_REASON = 'blocked'; @@ -23,11 +23,11 @@ class BlockedServers extends Console protected function getHelp() { $help = << [-h|--help|-?] [-v] - bin/console blockedservers remove [-h|--help|-?] [-v] + bin/console serverblock [-h|--help|-?] [-v] + bin/console serverblock add [-h|--help|-?] [-v] + bin/console serverblock remove [-h|--help|-?] [-v] Description With this tool, you can list the current blocked servers diff --git a/tests/src/Core/Console/BlockedServersConsoleTest.php b/tests/src/Core/Console/ServerBlockConsoleTest.php similarity index 86% rename from tests/src/Core/Console/BlockedServersConsoleTest.php rename to tests/src/Core/Console/ServerBlockConsoleTest.php index f33a8de31c..512a416f5e 100644 --- a/tests/src/Core/Console/BlockedServersConsoleTest.php +++ b/tests/src/Core/Console/ServerBlockConsoleTest.php @@ -2,13 +2,13 @@ namespace Friendica\Test\src\Core\Console; -use Friendica\Core\Console\BlockedServers; +use Friendica\Core\Console\ServerBlock; /** * @runTestsInSeparateProcesses * @preserveGlobalState disabled */ -class BlockedServersConsoleTest extends ConsoleTest +class ServerBlockConsoleTest extends ConsoleTest { protected $defaultBlockList = [ [ @@ -39,7 +39,7 @@ class BlockedServersConsoleTest extends ConsoleTest ->andReturn($this->defaultBlockList) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $txt = $this->dumpExecute($console); $output = <<andReturn(true) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'add'); $console->setArgument(1, 'testme.now'); $console->setArgument(2, 'I like it!'); @@ -102,7 +102,7 @@ CONS; $newBlockList = $this->defaultBlockList; $newBlockList[] = [ 'domain' => 'testme.now', - 'reason' => BlockedServers::DEFAULT_REASON, + 'reason' => ServerBlock::DEFAULT_REASON, ]; $this->configMock @@ -111,12 +111,12 @@ CONS; ->andReturn(true) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'add'); $console->setArgument(1, 'testme.now'); $txt = $this->dumpExecute($console); - $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'' . BlockedServers::DEFAULT_REASON . '\')' . PHP_EOL, $txt); + $this->assertEquals('The domain \'testme.now\' is now blocked. (Reason: \'' . ServerBlock::DEFAULT_REASON . '\')' . PHP_EOL, $txt); } /** @@ -147,7 +147,7 @@ CONS; ->andReturn(true) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'add'); $console->setArgument(1, 'pod.ordoevangelistarum.com'); $console->setArgument(2, 'Other reason'); @@ -180,7 +180,7 @@ CONS; ->andReturn(true) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'remove'); $console->setArgument(1, 'pod.ordoevangelistarum.com'); $txt = $this->dumpExecute($console); @@ -193,7 +193,7 @@ CONS; */ public function testBlockedServersWrongCommand() { - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'wrongcommand'); $txt = $this->dumpExecute($console); @@ -211,7 +211,7 @@ CONS; ->andReturn($this->defaultBlockList) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'remove'); $console->setArgument(1, 'not.exiting'); $txt = $this->dumpExecute($console); @@ -224,7 +224,7 @@ CONS; */ public function testAddBlockedServerMissingArgument() { - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'add'); $txt = $this->dumpExecute($console); @@ -245,7 +245,7 @@ CONS; $newBlockList = $this->defaultBlockList; $newBlockList[] = [ 'domain' => 'testme.now', - 'reason' => BlockedServers::DEFAULT_REASON, + 'reason' => ServerBlock::DEFAULT_REASON, ]; $this->configMock @@ -254,7 +254,7 @@ CONS; ->andReturn(false) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'add'); $console->setArgument(1, 'testme.now'); $txt = $this->dumpExecute($console); @@ -286,7 +286,7 @@ CONS; ->andReturn(false) ->once(); - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'remove'); $console->setArgument(1, 'pod.ordoevangelistarum.com'); $txt = $this->dumpExecute($console); @@ -299,7 +299,7 @@ CONS; */ public function testRemoveBlockedServerMissingArgument() { - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setArgument(0, 'remove'); $txt = $this->dumpExecute($console); @@ -311,16 +311,16 @@ CONS; */ public function testBlockedServersHelp() { - $console = new BlockedServers($this->consoleArgv); + $console = new ServerBlock($this->consoleArgv); $console->setOption('help', true); $txt = $this->dumpExecute($console); $help = << [-h|--help|-?] [-v] - bin/console blockedservers remove [-h|--help|-?] [-v] + bin/console serverblock [-h|--help|-?] [-v] + bin/console serverblock add [-h|--help|-?] [-v] + bin/console serverblock remove [-h|--help|-?] [-v] Description With this tool, you can list the current blocked servers