vendor/bugbuster/contao-banner-bundle/src/Resources/contao/classes/BannerCount.php line 58

Open in your IDE?
  1. <?php
  3. /**
  4.  * Extension for Contao Open Source CMS, Copyright (C) 2005-2022 Leo Feyer
  5.  *
  6.  * Class BannerCount - Frontend
  7.  *
  8.  * @copyright  Glen Langer 2022 <http://contao.ninja>
  9.  * @author     Glen Langer (BugBuster)
  10.  * @licence    LGPL
  11.  * @filesource
  12.  * @see           https://github.com/BugBuster1701/contao-banner-bundle
  13.  */
  15. /**
  16.  * Run in a custom namespace, so the class can be replaced
  17.  */
  19. namespace BugBuster\Banner;
  21. use BugBuster\Banner\BannerLog;
  22. use BugBuster\Banner\BannerLogic;
  23. use BugBuster\BotDetection\ModuleBotDetection;
  25. /**
  26.  * Class BannerCount
  27.  *
  28.  * @copyright  Glen Langer 2022 <http://contao.ninja>
  29.  * @author     Glen Langer (BugBuster)
  30.  * @license    LGPL
  31.  */
  32. class BannerCount extends \System
  33. {
  34.     /**
  35.      * Banner Data, for BannerStatViewUpdate
  36.      */
  37.     protected $arrBannerData = [];
  39.     protected $banner_useragent = '';
  41.     protected $module_id = 0;
  43.     /**
  44.      * public constructor for phpunit
  45.      */
  46.     public function __construct($arrBannerData, $banner_useragent, $module_id)
  47.     {
  48.         $this->arrBannerData    = $arrBannerData;
  49.         $this->banner_useragent = $banner_useragent;
  50.         $this->module_id        = $module_id;
  52.         parent::__construct();
  53.     }
  55.     /**
  56.      * Insert/Update Banner View Stat
  57.      */
  58.     public function setStatViewUpdate()
  59.     {
  60.         if ($this->bannerCheckBot() === true) {
  61.             BannerLog::writeLog(__METHOD__, __LINE__, 'Bot gefunden, wird nicht gezaehlt');
  63.             return; //Bot gefunden, wird nicht gezaehlt
  64.         }
  65.         if ($this->checkUserAgent() === true) {
  66.             BannerLog::writeLog(__METHOD__, __LINE__, 'User Agent Filterung, wird nicht gezaehlt');
  68.             return; //User Agent Filterung
  69.         }
  71.         $BannerChecks = new BannerChecks();
  72.         if ($BannerChecks->checkBE() === true) {
  73.             BannerLog::writeLog(__METHOD__, __LINE__, 'Backend Login, wird nicht gezaehlt');
  75.             return; //Backend Login
  76.         }
  77.         $BannerChecks = null;
  78.         unset($BannerChecks);
  80.         // Blocker
  81.         $lastBanner = array_pop($this->arrBannerData);
  82.         $BannerID = $lastBanner['banner_id'];
  83.         if ($BannerID == 0) { // kein Banner, nichts zu tun
  84.             BannerLog::writeLog(__METHOD__, __LINE__, 'kein Banner, nichts zu tun');
  86.             return;
  87.         }
  89.         if ($this->getStatViewUpdateBlockerId($BannerID, $this->module_id) === true) {
  90.             // Eintrag innerhalb der Blockzeit
  91.             BannerLog::writeLog(__METHOD__, __LINE__, 'Eintrag innerhalb der Blockzeit, wird nicht gezaehlt');
  93.             return; // blocken, nicht zählen, raus hier
  94.         } else {
  95.             // nichts geblockt, also blocken für den nächsten Aufruf
  96.             BannerLog::writeLog(__METHOD__, __LINE__, 'blocken fuer den naechsten Aufruf');
  97.             $this->setStatViewUpdateBlockerId($BannerID, $this->module_id);
  98.         }
  100.         //Zählung, Insert
  101.         $arrSet =
  102.         [
  103.                 'id' => $BannerID,
  104.                 'tstamp' => time(),
  105.                 'banner_views' => 1
  106.         ];
  107.         $objInsert = \Database::getInstance()->prepare("INSERT IGNORE INTO tl_banner_stat %s")
  108.                                             ->set($arrSet)
  109.                                             ->execute();
  110.         if ($objInsert->insertId == 0) {
  111.             //Zählung, Update
  112.             \Database::getInstance()->prepare("UPDATE
  113.                                                 `tl_banner_stat`
  114.                                                 SET
  115.                                                 `tstamp`=?
  116.                                                 , `banner_views` = `banner_views`+1
  117.                                                 WHERE
  118.                                                 `id`=?")
  119.                                     ->execute(time(), $BannerID);
  120.         }
  121.         BannerLog::writeLog(__METHOD__, __LINE__, 'Zaehlung erfolgt fuer Banner ID: '.$BannerID);
  122.     }//BannerStatViewUpdate()
  124.     /**
  125.      * StatViewUpdate Blocker, Set Banner ID and timestamp
  126.      *
  127.      * @param integer $banner_id
  128.      */
  129.     protected function setStatViewUpdateBlockerId($banner_id=0)
  130.     {
  131.         if ($banner_id==0) {
  132.             return;
  133.         }// keine Banner ID, nichts zu tun
  134.         //das können mehrere sein!, mergen!
  135.         $objBannerLogic = new BannerLogic();
  136.         $objBannerLogic->setSession('StatViewUpdateBlocker'.$this->module_id, [$banner_id => time()], true);
  138.         return;
  139.     }
  141.     /**
  142.      * StatViewUpdate Blocker, Get Banner ID if the timestamp ....
  143.      *
  144.      * @param boolean    true if blocked | false
  145.      */
  146.     protected function getStatViewUpdateBlockerId($banner_id=0)
  147.     {
  148.         $objBannerLogic = new BannerLogic();
  149.         $session = $objBannerLogic->getSession('StatViewUpdateBlocker'.$this->module_id);
  150.         if (\count($session)) {
  151.             reset($session);
  152.             foreach ($session as $key => $val) {
  153.                 if ($key == $banner_id &&
  154.                     true === $this->removeStatViewUpdateBlockerId($key, $val, $session)
  155.                 ) {
  156.                     // Key ist noch gültig und es muss daher geblockt werden
  157.                     //DEBUG log_message('getStatViewUpdateBlockerId Banner ID:'.$key,'Banner.log');
  158.                     return true;
  159.                 }
  160.             }
  161.         }
  163.         return false;
  164.     }
  166.     /**
  167.      * StatViewUpdate Blocker, Remove old Banner ID
  168.      *
  169.      * @param  integer $banner_id
  170.      * @return boolean true = Key is valid, it must be blocked | false = key is invalid
  171.      */
  172.     protected function removeStatViewUpdateBlockerId($banner_id, $tstmap, $session)
  173.     {
  174.         $BannerBlockTime = time() - 60*5;  // 5 Minuten, 0-5 min wird geblockt
  175.         if (isset($GLOBALS['TL_CONFIG']['mod_banner_block_time'])
  176.          && (int) ($GLOBALS['TL_CONFIG']['mod_banner_block_time'])>0
  177.         ) {
  178.             $BannerBlockTime = time() - 60*1*(int) ($GLOBALS['TL_CONFIG']['mod_banner_block_time']);
  179.         }
  181.         if ($tstmap >  $BannerBlockTime) {
  182.             return true;
  183.         } else {
  184.             //wenn mehrere dann nur den Teil, nicht die ganze Session
  185.             unset($session[$banner_id]);
  186.             //wenn Anzahl Banner in Session nun 0 dann Session loeschen
  187.             if (\count($session) == 0) {
  188.                 //komplett löschen
  189.                 \Session::getInstance()->remove('StatViewUpdateBlocker'.$this->module_id);
  190.             } else { //sonst neu setzen
  191.                 //gekuerzte Session neu setzen
  192.                 $objBannerLogic = new BannerLogic();
  193.                 $objBannerLogic->setSession('StatViewUpdateBlocker'.$this->module_id, $session, false);
  194.                 $objBannerLogic = null;
  195.                 unset($objBannerLogic);
  196.             }
  197.         }
  199.         return false;
  200.     }
  202.     /**
  203.      * Spider Bot Check
  204.      */
  205.     protected function bannerCheckBot()
  206.     {
  207.         if (isset($GLOBALS['TL_CONFIG']['mod_banner_bot_check'])
  208.           && (int) $GLOBALS['TL_CONFIG']['mod_banner_bot_check'] == 0
  209.         ) {
  210.             //DEBUG log_message('bannerCheckBot abgeschaltet','Banner.log');
  211.             return false; //Bot Suche abgeschaltet ueber localconfig.php
  212.         }
  214.         $bundles = array_keys(\System::getContainer()->getParameter('kernel.bundles')); // old \ModuleLoader::getActive()
  215.         if (!\in_array('BugBusterBotdetectionBundle', $bundles)) {
  216.             //botdetection Modul fehlt, Abbruch
  217.             BannerLog::log('contao-botdetection-bundle extension required for extension: contao-banner-bundle!', 'BannerCount::bannerCheckBot', TL_ERROR);
  219.             return false;
  220.         }
  222.         // Import Helperclass ModuleBotDetection
  223.         $ModuleBotDetection = new ModuleBotDetection();
  224.         if ($ModuleBotDetection->checkBotAllTests()) {
  225.             //DEBUG log_message('bannerCheckBot True','Banner.log');
  226.             return true;
  227.         }
  228.         //DEBUG log_message('bannerCheckBot False','Banner.log');
  229.         return false;
  230.     } //bannerCheckBot
  232.     /**
  233.      * HTTP_USER_AGENT Special Check
  234.      */
  235.     protected function checkUserAgent()
  236.     {
  237.         if (\Environment::get('httpUserAgent')) {
  238.             $UserAgent = trim(\Environment::get('httpUserAgent'));
  239.         } else {
  240.             return false; // Ohne Absender keine Suche
  241.         }
  242.         $arrUserAgents = explode(",", $this->banner_useragent);
  243.         if (\strlen(trim($arrUserAgents[0])) == 0) {
  244.             return false; // keine Angaben im Modul
  245.         }
  246.         array_walk($arrUserAgents, ['self', 'trimBannerArrayValue']);  // trim der array values
  247.         // grobe Suche
  248.         $CheckUserAgent = str_replace($arrUserAgents, '#', $UserAgent);
  249.         if ($UserAgent != $CheckUserAgent) {   // es wurde ersetzt also was gefunden
  250.             //DEBUG log_message('CheckUserAgent Filterung; Treffer!','Banner.log');
  251.             return true;
  252.         }
  254.         return false;
  255.     } //checkUserAgent
  256.     public static function trimBannerArrayValue(&$data)
  257.     {
  258.         $data = trim($data);
  260.         return;
  261.     }
  262. }