File: BotRequestProcessor.php

package info (click to toggle)
matomo 5.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 95,068 kB
  • sloc: php: 289,425; xml: 127,249; javascript: 112,130; python: 202; sh: 178; makefile: 20; sql: 10
file content (149 lines) | stat: -rw-r--r-- 4,089 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

declare(strict_types=1);

namespace Piwik\Plugins\BotTracking\Tracker;

use Piwik\Date;
use Piwik\Log\LoggerInterface;
use Piwik\Plugins\BotTracking\BotDetector;
use Piwik\Plugins\BotTracking\Dao\BotRequestsDao;
use Piwik\Tracker\Action;
use Piwik\Tracker\PageUrl;
use Piwik\Tracker\Request;
use Piwik\Tracker\TableLogAction;

/**
 * Handles bot tracking requests
 */
class BotRequestProcessor extends \Piwik\Tracker\BotRequestProcessor
{
    /**
     * @var BotRequestsDao
     */
    private $dao;

    /**
     * @var LoggerInterface
     */
    private $logger;

    public function __construct(BotRequestsDao $dao, LoggerInterface $logger)
    {
        $this->dao = $dao;
        $this->logger = $logger;
    }

    public function handleRequest(Request $request): bool
    {
        $userAgent = $request->getUserAgent();
        $botDetector = new BotDetector($userAgent);

        if (!$botDetector->isBot()) {
            return false;
        }

        $botInfo = $botDetector->getDetectionResult();

        if (empty($botInfo)) {
            return false;
        }

        try {
            $idSite = $request->getIdSite();

            $timestamp = $request->getCurrentTimestamp();
            $serverTime = Date::factory($timestamp)->getDatetime();

            $idActionUrl = $this->getActionId($request);

            $rawParams = new \Piwik\Request($request->getRawParams());

            $httpStatusCode = $rawParams->getIntegerParameter('http_status', -1);
            if ($httpStatusCode < 0) {
                $httpStatusCode = null;
            }

            $responseSizeBytes = $rawParams->getIntegerParameter('bw_bytes', -1);
            if ($responseSizeBytes < 0) {
                $responseSizeBytes = null;
            }

            $serverTimeMs = $rawParams->getIntegerParameter('pf_srv', -1);
            if ($serverTimeMs < 0) {
                $serverTimeMs = null;
            }

            $source = $rawParams->getStringParameter('source', '');
            if ($source === '') {
                $source = null;
            }

            $data = [
                'idsite' => $idSite,
                'server_time' => $serverTime,
                'idaction_url' => $idActionUrl,
                'bot_name' => $botInfo['bot_name'],
                'bot_type' => $botInfo['bot_type'],
                'http_status_code' => $httpStatusCode,
                'response_size_bytes' => $responseSizeBytes,
                'response_time_ms' => $serverTimeMs,
                'source' => $source,
            ];

            $idRequest = $this->dao->insert($data);

            $this->logger->debug('Bot request recorded: idrequest=' . $idRequest);
        } catch (\Exception $e) {
            $this->logger->debug('Error recording bot request: ' . $e->getMessage());
            // Don't throw - we don't want to break tracking for other processors
        }

        return true;
    }

    /**
     * Get or create action ID for the URL
     *
     */
    private function getActionId(Request $request): ?int
    {
        $url = $request->getParam('url');
        $actionType = Action::TYPE_PAGE_URL;

        $downloadUrl = $request->getParam('download');
        if ($downloadUrl !== false && $downloadUrl !== '') {
            $url = $downloadUrl;
            $actionType = Action::TYPE_DOWNLOAD;
        }

        if ($url === false || $url === '') {
            return null;
        }

        $urlInfo = PageUrl::normalizeUrl($url);

        $actionsToLookup = [
            [$urlInfo['url'], $actionType, $urlInfo['prefixId']],
        ];

        try {
            [$actionId] = TableLogAction::loadIdsAction($actionsToLookup);

            if (isset($actionId)) {
                return (int) $actionId;
            }
        } catch (\Exception $e) {
            $this->logger->debug('Error resolving action ID: ' . $e->getMessage());
        }

        return null;
    }
}