]> git.mxchange.org Git - friendica.git/commitdiff
New command "BlockedServers"
authorPhilipp Holzer <admin@philipp.info>
Sat, 20 Apr 2019 08:42:28 +0000 (10:42 +0200)
committerPhilipp Holzer <admin@philipp.info>
Sat, 20 Apr 2019 08:42:28 +0000 (10:42 +0200)
composer.json
composer.lock
src/Core/Console.php
src/Core/Console/BlockedServers.php [new file with mode: 0644]
tests/src/Core/Console/BlockedServerConsoleTest.php [new file with mode: 0644]

index 3f910cbe92dc7fbef10bd19ad6fab6373d4ccab6..b0c51f9bfb75ff43f9e0f1f64357e10f6a585e6f 100644 (file)
@@ -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": [
                {
index b8eabaeb9bbd1734ba1b11ee9c5e2bf383951c12..06952e05eff8eefb294a99eb7628f60b979bde99 100644 (file)
@@ -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",
             ],
             "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",
                 }
             ],
             "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",
                 }
             ],
             "description": "Provides functionality to handle HHVM/PHP environments",
-            "homepage": "http://www.github.com/sebastianbergmann/environment",
+            "homepage": "https://github.com/sebastianbergmann/environment",
             "keywords": [
                 "Xdebug",
                 "environment",
                 }
             ],
             "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"
                 }
             ],
             "description": "Snapshotting of global state",
-            "homepage": "http://www.github.com/sebastianbergmann/global-state",
+            "homepage": "https://github.com/sebastianbergmann/global-state",
             "keywords": [
                 "global state"
             ],
                 }
             ],
             "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"
         },
         {
                 },
                 {
                     "name": "Gert de Pagter",
-                    "email": "backendtea@gmail.com"
+                    "email": "BackEndTea@gmail.com"
                 }
             ],
             "description": "Symfony polyfill for ctype functions",
index c60f36296a56010c2d2be0c4d2c87187654639d3..d115143e474f4e9d3fe9a33dc5a86af48735f9e1 100644 (file)
@@ -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|-?] <command> [<args>] [-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 (file)
index 0000000..29c0887
--- /dev/null
@@ -0,0 +1,156 @@
+<?php
+
+namespace Friendica\Core\Console;
+
+use Asika\SimpleConsole\CommandArgsException;
+use Asika\SimpleConsole\Console;
+use Console_Table;
+use Friendica\BaseObject;
+use Friendica\Core\Config\Configuration;
+
+/**
+ * @brief Manage blocked servers
+ *
+ * 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
+{
+       protected $helpOptions = ['h', 'help', '?'];
+
+       protected function getHelp()
+       {
+               $help = <<<HELP
+console blockedservers - Manage blocked servers
+Usage
+       bin/console blockedservers [-h|--help|-?] [-v]
+       bin/console blockedservers add <server> <description> [-h|--help|-?] [-v]
+       bin/console blockedservers remove <server> [-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 (file)
index 0000000..3156c5a
--- /dev/null
@@ -0,0 +1,86 @@
+<?php
+
+namespace Friendica\Test\src\Core\Console;
+
+use Friendica\Core\Console\BlockedServers;
+
+/**
+ *
+ */
+class BlockedServerConsoleTest extends ConsoleTest
+{
+       protected $defaultBlockList =[
+               [
+                       'domain' => '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 = <<<CONS
++----------------------------+-----------------+
+| Domain                     | Reason          |
++----------------------------+-----------------+
+| social.nobodyhasthe.biz    | Illegal content |
+| pod.ordoevangelistarum.com | Illegal content |
++----------------------------+-----------------+
+
+
+CONS;
+
+               $this->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);
+       }
+}