Client
2 years ago
Device
2 years ago
AbstractBotParser.php
2 years ago
AbstractParser.php
2 years ago
Bot.php
2 years ago
OperatingSystem.php
2 years ago
VendorFragment.php
2 years ago
Bot.php
79 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Device Detector - The Universal Device Detection library for parsing User Agents |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * |
| 8 | * @license http://www.gnu.org/licenses/lgpl.html LGPL v3 or later |
| 9 | */ |
| 10 | declare (strict_types=1); |
| 11 | namespace IAWP_SCOPED\DeviceDetector\Parser; |
| 12 | |
| 13 | /** |
| 14 | * Class Bot |
| 15 | * |
| 16 | * Parses a user agent for bot information |
| 17 | * |
| 18 | * Detected bots are defined in regexes/bots.yml |
| 19 | * @internal |
| 20 | */ |
| 21 | class Bot extends AbstractBotParser |
| 22 | { |
| 23 | /** |
| 24 | * @var string |
| 25 | */ |
| 26 | protected $fixtureFile = 'regexes/bots.yml'; |
| 27 | /** |
| 28 | * @var string |
| 29 | */ |
| 30 | protected $parserName = 'bot'; |
| 31 | /** |
| 32 | * @var bool |
| 33 | */ |
| 34 | protected $discardDetails = \false; |
| 35 | /** |
| 36 | * Enables information discarding |
| 37 | */ |
| 38 | public function discardDetails() : void |
| 39 | { |
| 40 | $this->discardDetails = \true; |
| 41 | } |
| 42 | /** |
| 43 | * Parses the current UA and checks whether it contains bot information |
| 44 | * |
| 45 | * @see bots.yml for list of detected bots |
| 46 | * |
| 47 | * Step 1: Build a big regex containing all regexes and match UA against it |
| 48 | * -> If no matches found: return |
| 49 | * -> Otherwise: |
| 50 | * Step 2: Walk through the list of regexes in bots.yml and try to match every one |
| 51 | * -> Return the matched data |
| 52 | * |
| 53 | * If $discardDetails is set to TRUE, the Step 2 will be skipped |
| 54 | * $bot will be set to TRUE instead |
| 55 | * |
| 56 | * NOTE: Doing the big match before matching every single regex speeds up the detection |
| 57 | * |
| 58 | * @return array|null |
| 59 | */ |
| 60 | public function parse() : ?array |
| 61 | { |
| 62 | $result = null; |
| 63 | if ($this->preMatchOverall()) { |
| 64 | if ($this->discardDetails) { |
| 65 | return [\true]; |
| 66 | } |
| 67 | foreach ($this->getRegexes() as $regex) { |
| 68 | $matches = $this->matchUserAgent($regex['regex']); |
| 69 | if ($matches) { |
| 70 | unset($regex['regex']); |
| 71 | $result = $regex; |
| 72 | break; |
| 73 | } |
| 74 | } |
| 75 | } |
| 76 | return $result; |
| 77 | } |
| 78 | } |
| 79 |