<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
namespace Friendica\Console;
use Asika\SimpleConsole\CommandArgsException;
use Asika\SimpleConsole\Console;
use Console_Table;
-use Friendica\BaseObject;
-use Friendica\Core\Config\Configuration;
+use Friendica\Core\Config\Capability\IManageConfigValues;
/**
- * @brief Manage blocked servers
+ * Manage blocked servers
*
* With this tool, you can list the current blocked servers
* or you can add / remove a blocked server from the list
protected $helpOptions = ['h', 'help', '?'];
+ /**
+ * @var IManageConfigValues
+ */
+ private $config;
+
protected function getHelp()
{
$help = <<<HELP
-console serverblock - Manage blocked servers
+console serverblock - Manage blocked server domain patterns
Usage
- bin/console serverblock [-h|--help|-?] [-v]
- bin/console serverblock add <server> <reason> [-h|--help|-?] [-v]
- bin/console serverblock remove <server> [-h|--help|-?] [-v]
+ 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 servers
- or you can add / remove a blocked server from the list
+ 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
return $help;
}
- protected function doExecute()
+ public function __construct(IManageConfigValues $config, $argv = null)
{
- $a = BaseObject::getApp();
+ parent::__construct($argv);
+ $this->config = $config;
+ }
+
+ protected function doExecute()
+ {
if (count($this->args) == 0) {
- $this->printBlockedServers($a->getConfig());
+ $this->printBlockedServers($this->config);
return 0;
}
switch ($this->getArgument(0)) {
case 'add':
- return $this->addBlockedServer($a->getConfig());
+ return $this->addBlockedServer($this->config);
case 'remove':
- return $this->removeBlockedServer($a->getConfig());
+ return $this->removeBlockedServer($this->config);
+ case 'export':
+ return $this->exportBlockedServers($this->config);
+ case 'import':
+ return $this->importBlockedServers($this->config);
default:
throw new CommandArgsException('Unknown command.');
break;
}
}
+ /**
+ * Exports the list of blocked domains including the reason for the
+ * block to a CSV file.
+ *
+ * @param IManageConfigValues $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);
+ }
+ }
+ /**
+ * Imports a list of domains and a reason for the block from a CSV
+ * file, e.g. created with the export function.
+ *
+ * @param IManageConfigValues $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) {
+ $domain = $data[0];
+ if (count($data) == 0) {
+ $reason = self::DEFAULT_REASON;
+ } else {
+ $reason = $data[1];
+ }
+ $data = [
+ 'domain' => $domain,
+ 'reason' => $reason
+ ];
+ if (!in_array($data, $newBlockList)) {
+ $newBlockList[] = $data;
+ }
+ }
+ foreach ($currBlockList as $blocked) {
+ 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));
+ return 0;
+ } else {
+ $this->out(sprintf("Couldn't save '%s' as blocked server", $domain));
+ 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 Configuration $config
+ * @param IManageConfigValues $config
*/
- private function printBlockedServers(Configuration $config)
+ private function printBlockedServers(IManageConfigValues $config)
{
$table = new Console_Table();
$table->setHeaders(['Domain', 'Reason']);
- $blocklist = $config->get('system', 'blocklist');
+ $blocklist = $config->get('system', 'blocklist', []);
foreach ($blocklist as $domain) {
$table->addRow($domain);
}
/**
* Adds a server to the blocked list
*
- * @param Configuration $config
+ * @param IManageConfigValues $config
*
* @return int The return code (0 = success, 1 = failed)
*/
- private function addBlockedServer(Configuration $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.');
$update = false;
- $currBlocklist = $config->get('system', 'blocklist');
+ $currBlockList = $config->get('system', 'blocklist', []);
$newBlockList = [];
- foreach ($currBlocklist as $blocked) {
+ foreach ($currBlockList as $blocked) {
if ($blocked['domain'] === $domain) {
$update = true;
$newBlockList[] = [
/**
* Removes a server from the blocked list
*
- * @param Configuration $config
+ * @param IManageConfigValues $config
*
* @return int The return code (0 = success, 1 = failed)
*/
- private function removeBlockedServer(Configuration $config)
+ private function removeBlockedServer(IManageConfigValues $config)
{
if (count($this->args) !== 2) {
throw new CommandArgsException('Remove needs a second parameter.');
$found = false;
- $currBlocklist = $config->get('system', 'blocklist');
+ $currBlockList = $config->get('system', 'blocklist', []);
$newBlockList = [];
- foreach ($currBlocklist as $blocked) {
+ foreach ($currBlockList as $blocked) {
if ($blocked['domain'] === $domain) {
$found = true;
} else {
projects / friendica.git / blobdiff