/**
* Name: blockbot
* Description: Blocking bots based on detecting bots/crawlers/spiders via the user agent and http_from header.
- * Version: 0.1
+ * Version: 0.2
* Author: Philipp Holzer <admin@philipp.info>
+ * Author: Michael Vogel <https://pirati.ca/profile/heluecht>
*
*/
-use Friendica\App;
-use Friendica\Core\Config;
use Friendica\Core\Hook;
-use Friendica\Core\System;
+use Friendica\DI;
use Jaybizzle\CrawlerDetect\CrawlerDetect;
use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\Network\HTTPException\ForbiddenException;
require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
-function blockbot_install() {
+function blockbot_install()
+{
Hook::register('init_1', __FILE__, 'blockbot_init_1');
}
+function blockbot_addon_admin(string &$o)
+{
+ $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/blockbot/');
-function blockbot_uninstall() {
- Hook::unregister('init_1', __FILE__, 'blockbot_init_1');
+ $o = Renderer::replaceMacros($t, [
+ '$submit' => DI::l10n()->t('Save Settings'),
+ '$good_crawlers' => ['good_crawlers', DI::l10n()->t('Allow "good" crawlers'), DI::config()->get('blockbot', 'good_crawlers'), DI::l10n()->t("Don't block fediverse crawlers, relay servers and other bots with good purposes.")],
+ '$block_gab' => ['block_gab', DI::l10n()->t('Block GabSocial'), DI::config()->get('blockbot', 'block_gab'), DI::l10n()->t('Block the software GabSocial. This will block every access for that software. You can block dedicated gab instances in the blocklist settings in the admin section.')],
+ '$training' => ['training', DI::l10n()->t('Training mode'), DI::config()->get('blockbot', 'training'), DI::l10n()->t("Activates the training mode. This is only meant for developing purposes. Don't activate this on a production machine. This can cut communication with some systems.")],
+ ]);
}
-function blockbot_init_1(App $a) {
+function blockbot_addon_admin_post()
+{
+ DI::config()->set('blockbot', 'good_crawlers', $_POST['good_crawlers'] ?? false);
+ DI::config()->set('blockbot', 'block_gab', $_POST['block_gab'] ?? false);
+ DI::config()->set('blockbot', 'training', $_POST['training'] ?? false);
+}
+
+function blockbot_init_1()
+{
if (empty($_SERVER['HTTP_USER_AGENT'])) {
return;
}
$logdata = ['agent' => $_SERVER['HTTP_USER_AGENT'], 'uri' => $_SERVER['REQUEST_URI']];
+ // List of "good" crawlers
+ $good_agents = [
+ 'fediverse.space crawler', 'fediverse.network crawler', 'Active_Pods_CheckBot_3.0',
+ 'Social-Relay/', 'Test Certificate Info', 'Uptimebot/', 'GNUSocialBot', 'UptimeRobot/',
+ 'PTST/', 'Zabbix', 'Poduptime/'
+ ];
+
// List of known crawlers.
- $agents = ['SEMrushBot', 's~feedly-nikon3', 'Qwantify/Bleriot/', 'ltx71', 'Sogou web spider/',
- 'Diffbot/', 'Twitterbot/', 'YisouSpider/', 'evc-batch/', 'LivelapBot/', 'TrendsmapResolver/',
+ $agents = [
+ 'SemrushBot', 's~feedly-nikon3', 'Qwantify/Bleriot/', 'ltx71', 'Sogou web spider/',
+ 'Diffbot/', 'Twitterbot/', 'YisouSpider', 'evc-batch/', 'LivelapBot/', 'TrendsmapResolver/',
'PaperLiBot/', 'Nuzzel', 'um-LN/', 'Google Favicon', 'Datanyze', 'BLEXBot/', '360Spider',
'adscanner/', 'HeadlessChrome', 'wpif', 'startmebot/', 'Googlebot/', 'Applebot/',
'facebookexternalhit/', 'GoogleImageProxy', 'bingbot/', 'heritrix/', 'ldspider',
- 'AwarioRssBot/', 'Zabbix', 'TweetmemeBot/', 'dcrawl/', 'PhantomJS/', 'Googlebot-Image/'];
+ 'AwarioRssBot/', 'TweetmemeBot/', 'dcrawl/', 'PhantomJS/', 'Googlebot-Image/',
+ 'CrowdTanglebot/', 'Mediapartners-Google', 'Baiduspider/', 'datagnionbot',
+ 'MegaIndex.ru/', 'SMUrlExpander', 'Hatena-Favicon/', 'Wappalyzer', 'FlipboardProxy/',
+ 'NetcraftSurveyAgent/', 'Dataprovider.com', 'SMTBot/', 'Nimbostratus-Bot/',
+ 'DuckDuckGo-Favicons-Bot/', 'IndieWebCards/', 'proximic', 'netEstate NE Crawler',
+ 'AhrefsBot/', 'YandexBot/', 'Exabot/', 'Mediumbot-MetaTagFetcher/', 'WhatsApp/',
+ 'TelegramBot', 'SurdotlyBot/', 'BingPreview/', 'SabsimBot/', 'CCBot/', 'WbSrch/',
+ 'DuckDuckBot-Https/', 'HTTP Banner Detection', 'YandexImages/', 'archive.org_bot',
+ 'ArchiveTeam ArchiveBot/', 'yacybot', 'https://developers.google.com/+/web/snippet/',
+ 'Scrapy/', 'github-camo', 'MJ12bot/', 'DotBot/', 'Pinterestbot/', 'Jooblebot/',
+ 'Cliqzbot/', 'YaK/', 'Mediatoolkitbot', 'Snacktory', 'FunWebProducts', 'oBot/',
+ '7Siters/', 'KOCMOHABT', 'Google-SearchByImage', 'FemtosearchBot/',
+ 'HubSpot Crawler', 'DomainStatsBot/', 'Re-re Studio', 'AwarioSmartBot/',
+ 'SummalyBot/', 'DNSResearchBot/', 'PetalBot;', 'Nmap Scripting Engine;',
+ 'Google-Apps-Script; beanserver;', 'woorankreview/', 'Seekport Crawler;', 'AHC/',
+ 'SkypeUriPreview Preview/', 'Semanticbot/', 'Embed PHP library', 'XoviOnpageCrawler;',
+ 'GetHPinfo.com-Bot/', 'BoardReader Favicon Fetcher', 'Google-Adwords-Instant', 'newspaper/',
+ 'YurichevBot/', 'Crawling at Home Project', 'InfoTigerBot/'
+ ];
+
+ if (!DI::config()->get('blockbot', 'good_crawlers')) {
+ $agents = array_merge($agents, $good_agents);
+ } else {
+ foreach ($good_agents as $good_agent) {
+ if (stristr($_SERVER['HTTP_USER_AGENT'], $good_agent)) {
+ return;
+ }
+ }
+ }
+
+ if (DI::config()->get('blockbot', 'block_gab')) {
+ $agents[] = 'GabSocial/';
+ }
foreach ($agents as $agent) {
if (stristr($_SERVER['HTTP_USER_AGENT'], $agent)) {
- System::httpExit(403, 'Bots are not allowed');
+ throw new ForbiddenException('Bots are not allowed');
}
}
// This switch here is only meant for developers who want to add more bots to the list above, it is not safe for production.
- if (!Config::get('blockbot', 'training')) {
+ if (!DI::config()->get('blockbot', 'training')) {
return;
}
}
// List of false positives' strings of known "good" agents.
- $agents = ['fediverse.network crawler', 'Active_Pods_CheckBot_3.0', 'Social-Relay/',
+ $agents = [
'curl', 'zgrab', 'Go-http-client', 'curb', 'github.com', 'reqwest', 'Feedly/',
'Python-urllib/', 'Liferea/', 'aiohttp/', 'WordPress.com Reader', 'hackney/',
'Faraday v', 'okhttp', 'UniversalFeedParser', 'PixelFedBot', 'python-requests',
'WordPress/', 'http.rb/', 'Apache-HttpClient/', 'WordPress.com;', 'Pleroma',
- 'Dispatch/'];
+ 'Dispatch/', 'Ruby', 'Java/', 'libwww-perl/', 'Mastodon/', 'FeedlyApp/',
+ 'lua-resty-http/', 'Tiny Tiny RSS/', 'Wget/', 'PostmanRuntime/',
+ 'W3C_Validator/', 'NetNewsWire', 'FeedValidator/', 'theoldreader.com', 'axios/',
+ 'Paw/', 'PeerTube/', 'fedi.inex.dev', 'FediDB/', 'index.community crawler',
+ 'Slackbot-LinkExpanding'
+ ];
+
+ if (DI::config()->get('blockbot', 'good_crawlers')) {
+ $agents = array_merge($agents, $good_agents);
+ }
foreach ($agents as $agent) {
if (stristr($_SERVER['HTTP_USER_AGENT'], $agent)) {
- logger::notice('False positive', $logdata);
+ logger::info('False positive', $logdata);
return;
}
}
- logger::info('Blocked bot', $logdata);
- System::httpExit(403, 'Bots are not allowed');
+ logger::notice('Blocked bot', $logdata);
+ throw new ForbiddenException('Bots are not allowed');
}