]> git.mxchange.org Git - friendica.git/blobdiff - src/Console/ServerBlock.php
Merge pull request #11249 from MrPetovan/bug/11248-getinfofromurl-cache-key
[friendica.git] / src / Console / ServerBlock.php
index 7c17fdc5756a353d09c767f8043294a2904dc72a..9bf2c0eccafe5b4b65f646404574d8d71ff9ef44 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -24,7 +24,7 @@ namespace Friendica\Console;
 use Asika\SimpleConsole\CommandArgsException;
 use Asika\SimpleConsole\Console;
 use Console_Table;
-use Friendica\Core\Config\IConfig;
+use Friendica\Core\Config\Capability\IManageConfigValues;
 
 /**
  * Manage blocked servers
@@ -39,7 +39,7 @@ class ServerBlock extends Console
        protected $helpOptions = ['h', 'help', '?'];
 
        /**
-        * @var IConfig
+        * @var IManageConfigValues
         */
        private $config;
 
@@ -48,31 +48,31 @@ class ServerBlock extends Console
                $help = <<<HELP
 console serverblock - Manage blocked server domain patterns
 Usage
-       bin/console serverblock [-h|--help|-?] [-v]
-       bin/console serverblock add <pattern> <reason> [-h|--help|-?] [-v]
-       bin/console serverblock remove <pattern> [-h|--help|-?] [-v]
-       bin/console serverblock export <filename>
-       bin/console serverblock import <filename>
+    bin/console serverblock [-h|--help|-?] [-v]
+    bin/console serverblock add <pattern> <reason> [-h|--help|-?] [-v]
+    bin/console serverblock remove <pattern> [-h|--help|-?] [-v]
+    bin/console serverblock export <filename>
+    bin/console serverblock import <filename>
 
 Description
-       With this tool, you can list the current blocked server domain patterns
-       or you can add / remove a blocked server domain pattern from the list.
-       Using the export and import options you can share your server blocklist
-       with other node admins by CSV files.
-       
-       Patterns are case-insensitive shell wildcard comprising the following special characters:
-       - * : Any number of characters
-       - ? : Any single character
-       - [<char1><char2>...] : char1 or char2 or...
+    With this tool, you can list the current blocked server domain patterns
+    or you can add / remove a blocked server domain pattern from the list.
+    Using the export and import options you can share your server blocklist
+    with other node admins by CSV files.
+
+    Patterns are case-insensitive shell wildcard comprising the following special characters:
+    - * : Any number of characters
+    - ? : Any single character
+    - [<char1><char2>...] : char1 or char2 or...
 
 Options
-       -h|--help|-? Show help information
-       -v                 Show more debug information.
+    -h|--help|-? Show help information
+    -v           Show more debug information.
 HELP;
                return $help;
        }
 
-       public function __construct(IConfig $config, $argv = null)
+       public function __construct(IManageConfigValues $config, $argv = null)
        {
                parent::__construct($argv);
 
@@ -105,13 +105,16 @@ HELP;
         * Exports the list of blocked domains including the reason for the
         * block to a CSV file.
         *
-        * @param IConfig $config
+        * @param IManageConfigValues $config
         */
-       private function exportBlockedServers(IConfig $config)
+       private function exportBlockedServers(IManageConfigValues $config)
        {
                $filename = $this->getArgument(1);
                $blocklist = $config->get('system', 'blocklist', []);
                $fp = fopen($filename, 'w');
+               if (!$fp) {
+                       throw new Exception(sprintf('The file "%s" could not be created.', $filename));
+               }
                foreach ($blocklist as $domain) {
                        fputcsv($fp, $domain);
                }
@@ -120,17 +123,17 @@ HELP;
         * Imports a list of domains and a reason for the block from a CSV
         * file, e.g. created with the export function.
         *
-        * @param IConfig $config
+        * @param IManageConfigValues $config
         */
-       private function importBlockedServers(IConfig $config)
+       private function importBlockedServers(IManageConfigValues $config)
        {
                $filename = $this->getArgument(1);
                $currBlockList = $config->get('system', 'blocklist', []);
                $newBlockList = [];
-               if (($fp = fopen($filename, 'r')) !== FALSE) {
-                       while (($data = fgetcsv($fp, 1000, ',')) !== FALSE) {
+               if (($fp = fopen($filename, 'r')) !== false) {
+                       while (($data = fgetcsv($fp, 1000, ',')) !== false) {
                                $domain = $data[0];
-                               if (count($data)  == 0) {
+                               if (count($data) == 0) {
                                        $reason = self::DEFAULT_REASON;
                                } else {
                                        $reason = $data[1];
@@ -139,12 +142,14 @@ HELP;
                                        'domain' => $domain,
                                        'reason' => $reason
                                ];
-                               if (!in_array($data, $newBlockList))
+                               if (!in_array($data, $newBlockList)) {
                                        $newBlockList[] = $data;
+                               }
                        }
                        foreach ($currBlockList as $blocked) {
-                               if (!in_array($blocked, $newBlockList))
+                               if (!in_array($blocked, $newBlockList)) {
                                        $newBlockList[] = $blocked;
+                               }
                        }
                        if ($config->set('system', 'blocklist', $newBlockList)) {
                                $this->out(sprintf("Entries from %s that were not blocked before are now blocked", $filename));
@@ -154,15 +159,17 @@ HELP;
                                return 1;
                        }
 
+               } else {
+                       throw new Exception(sprintf('The file "%s" could not be opened for importing', $filename));
                }
        }
 
        /**
         * Prints the whole list of blocked domains including the reason
         *
-        /* @param IConfig $config
+        * @param IManageConfigValues $config
         */
-       private function printBlockedServers(IConfig $config)
+       private function printBlockedServers(IManageConfigValues $config)
        {
                $table = new Console_Table();
                $table->setHeaders(['Domain', 'Reason']);
@@ -176,11 +183,11 @@ HELP;
        /**
         * Adds a server to the blocked list
         *
-        * @param IConfig $config
+        * @param IManageConfigValues $config
         *
         * @return int The return code (0 = success, 1 = failed)
         */
-       private function addBlockedServer(IConfig $config)
+       private function addBlockedServer(IManageConfigValues $config)
        {
                if (count($this->args) < 2 || count($this->args) > 3) {
                        throw new CommandArgsException('Add needs a domain and optional a reason.');
@@ -228,11 +235,11 @@ HELP;
        /**
         * Removes a server from the blocked list
         *
-        * @param IConfig $config
+        * @param IManageConfigValues $config
         *
         * @return int The return code (0 = success, 1 = failed)
         */
-       private function removeBlockedServer(IConfig $config)
+       private function removeBlockedServer(IManageConfigValues $config)
        {
                if (count($this->args) !== 2) {
                        throw new CommandArgsException('Remove needs a second parameter.');