blockbot/blockbot.php

   1 <?php
   2 /**
   3  * Name: blockbot
   4  * Description: Blocking bots based on detecting bots/crawlers/spiders via the user agent and http_from header.
   5  * Version: 0.1
   6  * Author: Philipp Holzer <admin@philipp.info>
   7  *
   8  */
   9
  10 use Friendica\App;
  11 use Friendica\Core\Config;
  12 use Friendica\Core\Hook;
  13 use Friendica\Core\System;
  14 use Jaybizzle\CrawlerDetect\CrawlerDetect;
  15 use Friendica\Core\Logger;
  16
  17 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
  18
  19 function blockbot_install() {
  20         Hook::register('init_1', __FILE__, 'blockbot_init_1');
  21 }
  22
  23
  24 function blockbot_uninstall() {
  25         Hook::unregister('init_1', __FILE__, 'blockbot_init_1');
  26 }
  27
  28 function blockbot_init_1(App $a) {
  29         if (empty($_SERVER['HTTP_USER_AGENT'])) {
  30                 return;
  31         }
  32
  33         $logdata = ['agent' => $_SERVER['HTTP_USER_AGENT'], 'uri' => $_SERVER['REQUEST_URI']];
  34
  35         // List of known crawlers.
  36         $agents = ['SEMrushBot', 's~feedly-nikon3', 'Qwantify/Bleriot/', 'ltx71', 'Sogou web spider/',
  37                 'Diffbot/', 'Twitterbot/', 'YisouSpider/', 'evc-batch/', 'LivelapBot/', 'TrendsmapResolver/',
  38                 'PaperLiBot/', 'Nuzzel', 'um-LN/', 'Google Favicon', 'Datanyze', 'BLEXBot/', '360Spider',
  39                 'adscanner/', 'HeadlessChrome', 'wpif', 'startmebot/', 'Googlebot/', 'Applebot/',
  40                 'facebookexternalhit/', 'GoogleImageProxy', 'bingbot/', 'heritrix/', 'ldspider',
  41                 'AwarioRssBot/', 'Zabbix'];
  42
  43         foreach ($agents as $agent) {
  44                 if (stristr($_SERVER['HTTP_USER_AGENT'], $agent)) {
  45                         System::httpExit(403, 'Bots are not allowed');
  46                 }
  47         }
  48
  49         // This switch here is only meant for developers who want to add more bots to the list above, it is not safe for production.
  50         if (!Config::get('blockbot', 'training')) {
  51                 return;
  52         }
  53
  54         $crawlerDetect = new CrawlerDetect();
  55
  56         if (!$crawlerDetect->isCrawler()) {
  57                 logger::debug('Good user agent detected', $logdata);
  58                 return;
  59         }
  60
  61         // List of false positives' strings of known "good" agents.
  62         $agents = ['fediverse.network crawler', 'Active_Pods_CheckBot_3.0', 'Social-Relay/',
  63                 'curl', 'zgrab', 'Go-http-client', 'curb', 'github.com', 'reqwest', 'Feedly/',
  64                 'Python-urllib/', 'Liferea/', 'aiohttp/', 'WordPress.com Reader', 'hackney/',
  65                 'Faraday v', 'okhttp', 'UniversalFeedParser', 'PixelFedBot', 'python-requests',
  66                 'WordPress/', 'http.rb/', 'Apache-HttpClient/', 'WordPress.com;', 'Pleroma'];
  67
  68         foreach ($agents as $agent) {
  69                 if (stristr($_SERVER['HTTP_USER_AGENT'], $agent)) {
  70                         logger::notice('False positive', $logdata);
  71                         return;
  72                 }
  73         }
  74
  75         logger::info('Blocked bot', $logdata);
  76         System::httpExit(403, 'Bots are not allowed');
  77 }