friendica/src/Console/ServerBlock.php

<?php
/**
 * @copyright Copyright (C) 2010-2021, 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\Core\Config\IConfig;

/**
 * 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 ServerBlock extends Console
{
	const DEFAULT_REASON = 'blocked';

	protected $helpOptions = ['h', 'help', '?'];

	/**
	 * @var IConfig
	 */
	private $config;

	protected function getHelp()
	{
		$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>

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...

Options
    -h|--help|-? Show help information
    -v           Show more debug information.
HELP;
		return $help;
	}

	public function __construct(IConfig $config, $argv = null)
	{
		parent::__construct($argv);

		$this->config = $config;
	}

	protected function doExecute()
	{
		if (count($this->args) == 0) {
			$this->printBlockedServers($this->config);
			return 0;
		}

		switch ($this->getArgument(0)) {
			case 'add':
				return $this->addBlockedServer($this->config);
			case 'remove':
				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 IConfig $config
	 */
	private function exportBlockedServers(IConfig $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 IConfig $config
	 */
	private function importBlockedServers(IConfig $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 IConfig $config
	 */
	private function printBlockedServers(IConfig $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 IConfig $config
	 *
	 * @return int The return code (0 = success, 1 = failed)
	 */
	private function addBlockedServer(IConfig $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);
		$reason = (count($this->args) === 3) ? $this->getArgument(2) : self::DEFAULT_REASON;

		$update = false;

		$currBlockList = $config->get('system', 'blocklist', []);
		$newBlockList = [];
		foreach ($currBlockList  as $blocked) {
			if ($blocked['domain'] === $domain) {
				$update = true;
				$newBlockList[] = [
					'domain' => $domain,
					'reason' => $reason,
				];
			} else {
				$newBlockList[] = $blocked;
			}
		}

		if (!$update) {
			$newBlockList[] = [
				'domain' => $domain,
				'reason' => $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));
			return 1;
		}
	}

	/**
	 * Removes a server from the blocked list
	 *
	 * @param IConfig $config
	 *
	 * @return int The return code (0 = success, 1 = failed)
	 */
	private function removeBlockedServer(IConfig $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("The 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;
		}
	}
}