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', 'TweetmemeBot/', 'dcrawl/', 'PhantomJS/', 'Googlebot-Image/',
  42                 'CrowdTanglebot/', 'Mediapartners-Google', 'Baiduspider/', 'datagnionbot'];
  43
  44         foreach ($agents as $agent) {
  45                 if (stristr($_SERVER['HTTP_USER_AGENT'], $agent)) {
  46                         System::httpExit(403, 'Bots are not allowed');
  47                 }
  48         }
  49
  50         // This switch here is only meant for developers who want to add more bots to the list above, it is not safe for production.
  51         if (!Config::get('blockbot', 'training')) {
  52                 return;
  53         }
  54
  55         $crawlerDetect = new CrawlerDetect();
  56
  57         if (!$crawlerDetect->isCrawler()) {
  58                 logger::debug('Good user agent detected', $logdata);
  59                 return;
  60         }
  61
  62         // List of false positives' strings of known "good" agents.
  63         $agents = ['fediverse.network crawler', 'Active_Pods_CheckBot_3.0', 'Social-Relay/',
  64                 'curl', 'zgrab', 'Go-http-client', 'curb', 'github.com', 'reqwest', 'Feedly/',
  65                 'Python-urllib/', 'Liferea/', 'aiohttp/', 'WordPress.com Reader', 'hackney/',
  66                 'Faraday v', 'okhttp', 'UniversalFeedParser', 'PixelFedBot', 'python-requests',
  67                 'WordPress/', 'http.rb/', 'Apache-HttpClient/', 'WordPress.com;', 'Pleroma',
  68                 'Dispatch/'];
  69
  70         foreach ($agents as $agent) {
  71                 if (stristr($_SERVER['HTTP_USER_AGENT'], $agent)) {
  72                         logger::notice('False positive', $logdata);
  73                         return;
  74                 }
  75         }
  76
  77         logger::info('Blocked bot', $logdata);
  78         System::httpExit(403, 'Bots are not allowed');
  79 }