friendica/src/Console/ServerBlock.php

276 lines
7.4 KiB
PHP
Raw Normal View History

2019-04-20 10:42:28 +02:00
<?php
2020-02-09 15:45:36 +01:00
/**
2022-01-02 08:27:47 +01:00
* @copyright Copyright (C) 2010-2022, the Friendica project
2020-02-09 15:45:36 +01:00
*
* @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/>.
*
*/
2019-04-20 10:42:28 +02:00
2019-05-02 23:17:35 +02:00
namespace Friendica\Console;
2019-04-20 10:42:28 +02:00
use Asika\SimpleConsole\CommandArgsException;
use Asika\SimpleConsole\Console;
use Console_Table;
2021-10-26 21:44:29 +02:00
use Friendica\Core\Config\Capability\IManageConfigValues;
2019-04-20 10:42:28 +02:00
/**
2020-01-19 07:05:23 +01:00
* Manage blocked servers
2019-04-20 10:42:28 +02:00
*
* With this tool, you can list the current blocked servers
* or you can add / remove a blocked server from the list
*/
2019-04-20 16:40:27 +02:00
class ServerBlock extends Console
2019-04-20 10:42:28 +02:00
{
2019-04-20 12:53:17 +02:00
const DEFAULT_REASON = 'blocked';
2019-04-20 10:42:28 +02:00
protected $helpOptions = ['h', 'help', '?'];
/**
2021-10-26 21:44:29 +02:00
* @var IManageConfigValues
*/
private $config;
2019-04-20 10:42:28 +02:00
protected function getHelp()
{
$help = <<<HELP
console serverblock - Manage blocked server domain patterns
2019-04-20 10:42:28 +02:00
Usage
2020-08-07 11:49:25 +02:00
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>
2019-04-20 10:42:28 +02:00
Description
2020-08-07 11:49:25 +02:00
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...
2019-04-20 10:42:28 +02:00
Options
2020-08-07 11:49:25 +02:00
-h|--help|-? Show help information
-v Show more debug information.
2019-04-20 10:42:28 +02:00
HELP;
return $help;
}
2021-10-26 21:44:29 +02:00
public function __construct(IManageConfigValues $config, $argv = null)
2019-04-20 10:42:28 +02:00
{
parent::__construct($argv);
2019-04-20 10:42:28 +02:00
$this->config = $config;
}
protected function doExecute()
{
2019-04-20 10:42:28 +02:00
if (count($this->args) == 0) {
$this->printBlockedServers($this->config);
2019-04-20 10:42:28 +02:00
return 0;
}
switch ($this->getArgument(0)) {
case 'add':
return $this->addBlockedServer($this->config);
2019-04-20 10:42:28 +02:00
case 'remove':
return $this->removeBlockedServer($this->config);
case 'export':
return $this->exportBlockedServers($this->config);
case 'import':
return $this->importBlockedServers($this->config);
2019-04-20 10:42:28 +02:00
default:
throw new CommandArgsException('Unknown command.');
break;
}
}
/**
* Exports the list of blocked domains including the reason for the
* block to a CSV file.
2019-04-20 10:42:28 +02:00
*
2021-10-26 21:44:29 +02:00
* @param IManageConfigValues $config
2019-04-20 10:42:28 +02:00
*/
2021-10-26 21:44:29 +02:00
private function exportBlockedServers(IManageConfigValues $config)
{
$filename = $this->getArgument(1);
$blocklist = $config->get('system', 'blocklist', []);
$fp = fopen($filename, 'w');
2020-08-08 08:47:21 +02:00
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.
*
2021-10-26 21:44:29 +02:00
* @param IManageConfigValues $config
*/
2021-10-26 21:44:29 +02:00
private function importBlockedServers(IManageConfigValues $config)
{
$filename = $this->getArgument(1);
$currBlockList = $config->get('system', 'blocklist', []);
$newBlockList = [];
2020-08-08 08:35:34 +02:00
if (($fp = fopen($filename, 'r')) !== false) {
while (($data = fgetcsv($fp, 1000, ',')) !== false) {
$domain = $data[0];
2020-08-08 08:35:34 +02:00
if (count($data) == 0) {
$reason = self::DEFAULT_REASON;
} else {
$reason = $data[1];
}
$data = [
'domain' => $domain,
'reason' => $reason
];
2020-08-08 08:35:34 +02:00
if (!in_array($data, $newBlockList)) {
$newBlockList[] = $data;
2020-08-08 15:49:25 +02:00
}
}
foreach ($currBlockList as $blocked) {
2020-08-08 08:35:34 +02:00
if (!in_array($blocked, $newBlockList)) {
$newBlockList[] = $blocked;
2020-08-08 15:49:25 +02:00
}
}
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;
}
2020-08-08 08:47:21 +02:00
} 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
*
2021-10-26 21:44:29 +02:00
* @param IManageConfigValues $config
*/
2021-10-26 21:44:29 +02:00
private function printBlockedServers(IManageConfigValues $config)
2019-04-20 10:42:28 +02:00
{
$table = new Console_Table();
$table->setHeaders(['Domain', 'Reason']);
$blocklist = $config->get('system', 'blocklist', []);
2019-04-20 10:42:28 +02:00
foreach ($blocklist as $domain) {
$table->addRow($domain);
}
$this->out($table->getTable());
}
/**
* Adds a server to the blocked list
*
2021-10-26 21:44:29 +02:00
* @param IManageConfigValues $config
2019-04-20 10:42:28 +02:00
*
* @return int The return code (0 = success, 1 = failed)
*/
2021-10-26 21:44:29 +02:00
private function addBlockedServer(IManageConfigValues $config)
2019-04-20 10:42:28 +02:00
{
if (count($this->args) < 2 || count($this->args) > 3) {
throw new CommandArgsException('Add needs a domain and optional a reason.');
}
$domain = $this->getArgument(1);
$reason = (count($this->args) === 3) ? $this->getArgument(2) : self::DEFAULT_REASON;
2019-04-20 10:42:28 +02:00
$update = false;
$currBlockList = $config->get('system', 'blocklist', []);
$newBlockList = [];
foreach ($currBlockList as $blocked) {
2019-04-20 10:42:28 +02:00
if ($blocked['domain'] === $domain) {
$update = true;
$newBlockList[] = [
'domain' => $domain,
'reason' => $reason,
];
} else {
$newBlockList[] = $blocked;
2019-04-20 10:42:28 +02:00
}
}
if (!$update) {
$newBlockList[] = [
'domain' => $domain,
'reason' => $reason,
];
}
2019-04-20 10:42:28 +02:00
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));
}
2019-04-20 10:42:28 +02:00
return 0;
} else {
$this->out(sprintf("Couldn't save '%s' as blocked server", $domain));
return 1;
}
}
/**
* Removes a server from the blocked list
*
2021-10-26 21:44:29 +02:00
* @param IManageConfigValues $config
2019-04-20 10:42:28 +02:00
*
* @return int The return code (0 = success, 1 = failed)
*/
2021-10-26 21:44:29 +02:00
private function removeBlockedServer(IManageConfigValues $config)
2019-04-20 10:42:28 +02:00
{
if (count($this->args) !== 2) {
throw new CommandArgsException('Remove needs a second parameter.');
}
$domain = $this->getArgument(1);
$found = false;
$currBlockList = $config->get('system', 'blocklist', []);
2019-04-20 10:42:28 +02:00
$newBlockList = [];
foreach ($currBlockList as $blocked) {
2019-04-20 10:42:28 +02:00
if ($blocked['domain'] === $domain) {
$found = true;
} else {
$newBlockList[] = $blocked;
}
}
if (!$found) {
$this->out(sprintf("The domain '%s' is not blocked.", $domain));
2019-04-20 10:42:28 +02:00
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;
}
}
}