keith/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #8900 from tobiasd/20200718-serverblocklistcsv

Browse source 
added CSV import/export of server blocklist
This commit is contained in:
Hypolite Petovan 2020-08-08 09:57:41 -04:00 committed by GitHub
commit 5e0b4b8a8f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 90 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

91
src/Console/ServerBlock.php
View file

@ -48,14 +48,18 @@ 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 [-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
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
@ -87,6 +91,10 @@ HELP;
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;
@ -94,10 +102,73 @@ HELP;
}
/**
* Prints the whole list of blocked domains including the reason
* 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();
@ -127,9 +198,9 @@ HELP;
$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[] = [
@ -178,9 +249,9 @@ HELP;
$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 {

14
tests/src/Console/ServerBlockConsoleTest.php
View file

@ -334,14 +334,18 @@ CONS;
$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 [-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
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