3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Console;
24 use Asika\SimpleConsole\CommandArgsException;
25 use Asika\SimpleConsole\Console;
27 use Friendica\Core\Config\IConfig;
30 * Manage blocked servers
32 * With this tool, you can list the current blocked servers
33 * or you can add / remove a blocked server from the list
35 class ServerBlock extends Console
37 const DEFAULT_REASON = 'blocked';
39 protected $helpOptions = ['h', 'help', '?'];
46 protected function getHelp()
49 console serverblock - Manage blocked server domain patterns
51 bin/console serverblock [-h|--help|-?] [-v]
52 bin/console serverblock add <pattern> <reason> [-h|--help|-?] [-v]
53 bin/console serverblock remove <pattern> [-h|--help|-?] [-v]
54 bin/console serverblock export <filename>
55 bin/console serverblock import <filename>
58 With this tool, you can list the current blocked server domain patterns
59 or you can add / remove a blocked server domain pattern from the list.
60 Using the export and import options you can share your server blocklist
61 with other node admins by CSV files.
63 Patterns are case-insensitive shell wildcard comprising the following special characters:
64 - * : Any number of characters
65 - ? : Any single character
66 - [<char1><char2>...] : char1 or char2 or...
69 -h|--help|-? Show help information
70 -v Show more debug information.
76 public function __construct(IConfig $config, $argv = null)
78 parent::__construct($argv);
80 $this->config = $config;
83 protected function doExecute()
85 if (count($this->args) == 0) {
86 $this->printBlockedServers($this->config);
90 switch ($this->getArgument(0)) {
92 return $this->addBlockedServer($this->config);
94 return $this->removeBlockedServer($this->config);
96 return $this->exportBlockedServers($this->config);
98 return $this->importBlockedServers($this->config);
100 throw new CommandArgsException('Unknown command.');
106 * Exports the list of blocked domains including the reason for the
107 * block to a CSV file.
109 * @param IConfig $config
111 private function exportBlockedServers(IConfig $config)
113 $filename = $this->getArgument(1);
114 $blocklist = $config->get('system', 'blocklist', []);
115 $fp = fopen($filename, 'w');
116 foreach ($blocklist as $domain) {
117 fputcsv($fp, $domain);
121 * Imports a list of domains and a reason for the block from a CSV
122 * file, e.g. created with the export function.
124 * @param IConfig $config
126 private function importBlockedServers(IConfig $config)
128 $filename = $this->getArgument(1);
129 $currBlockList = $config->get('system', 'blocklist', []);
131 if (($fp = fopen($filename, 'r')) !== FALSE) {
132 while (($data = fgetcsv($fp, 1000, ',')) !== FALSE) {
134 if (count($data) == 0) {
135 $reason = self::DEFAULT_REASON;
143 if (!in_array($data, $newBlockList))
144 $newBlockList[] = $data;
146 foreach ($currBlockList as $blocked) {
147 if (!in_array($blocked, $newBlockList))
148 $newBlockList[] = $blocked;
150 if ($config->set('system', 'blocklist', $newBlockList)) {
151 $this->out(sprintf("Entries from %s that were not blocked before are now blocked", $filename));
154 $this->out(sprintf("Couldn't save '%s' as blocked server", $domain));
162 * Prints the whole list of blocked domains including the reason
164 /* @param IConfig $config
166 private function printBlockedServers(IConfig $config)
168 $table = new Console_Table();
169 $table->setHeaders(['Domain', 'Reason']);
170 $blocklist = $config->get('system', 'blocklist', []);
171 foreach ($blocklist as $domain) {
172 $table->addRow($domain);
174 $this->out($table->getTable());
178 * Adds a server to the blocked list
180 * @param IConfig $config
182 * @return int The return code (0 = success, 1 = failed)
184 private function addBlockedServer(IConfig $config)
186 if (count($this->args) < 2 || count($this->args) > 3) {
187 throw new CommandArgsException('Add needs a domain and optional a reason.');
190 $domain = $this->getArgument(1);
191 $reason = (count($this->args) === 3) ? $this->getArgument(2) : self::DEFAULT_REASON;
195 $currBlockList = $config->get('system', 'blocklist', []);
197 foreach ($currBlockList as $blocked) {
198 if ($blocked['domain'] === $domain) {
205 $newBlockList[] = $blocked;
216 if ($config->set('system', 'blocklist', $newBlockList)) {
218 $this->out(sprintf("The domain '%s' is now updated. (Reason: '%s')", $domain, $reason));
220 $this->out(sprintf("The domain '%s' is now blocked. (Reason: '%s')", $domain, $reason));
224 $this->out(sprintf("Couldn't save '%s' as blocked server", $domain));
230 * Removes a server from the blocked list
232 * @param IConfig $config
234 * @return int The return code (0 = success, 1 = failed)
236 private function removeBlockedServer(IConfig $config)
238 if (count($this->args) !== 2) {
239 throw new CommandArgsException('Remove needs a second parameter.');
242 $domain = $this->getArgument(1);
246 $currBlockList = $config->get('system', 'blocklist', []);
248 foreach ($currBlockList as $blocked) {
249 if ($blocked['domain'] === $domain) {
252 $newBlockList[] = $blocked;
257 $this->out(sprintf("The domain '%s' is not blocked.", $domain));
261 if ($config->set('system', 'blocklist', $newBlockList)) {
262 $this->out(sprintf("The domain '%s' is not more blocked", $domain));
265 $this->out(sprintf("Couldn't remove '%s' from blocked servers", $domain));