Coverage index

src/Service/DeviceService.php

Lines: 80.95%

LineHitsSource
1
<?php
2
3
namespace Drupal\visitors\Service;
4
5
use DeviceDetector\ClientHints;
6
use DeviceDetector\DeviceDetector;
7
use Drupal\Core\Database\Connection;
8
use Drupal\visitors\VisitorsDeviceInterface;
9
10
/**
11
 * Detects the device type.
12
 *
13
 * @package Drupal\visitors\Service
14
 */
15
class DeviceService implements VisitorsDeviceInterface {
16
17
  /**
18
   * The database connection.
19
   *
20
   * @var \Drupal\Core\Database\Connection
21
   */
22
  protected $database;
23
24
  /**
25
   * DeviceService constructor.
26
   *
27
   * @param \Drupal\Core\Database\Connection $database
28
   *   The database connection.
29
   */
30
  public function __construct(Connection $database) {
3111
    $this->database = $database;
32
  }
33
34
  /**
35
   * Gets the device detector.
36
   *
37
   * @param string $user_agent
38
   *   The user agent string.
39
   * @param array $server
40
   *   The server array.
41
   *
42
   * @return \DeviceDetector\DeviceDetector
43
   *   The device detector.
44
   */
45
  protected function getDeviceDetector(string $user_agent, ?array $server = NULL): DeviceDetector {
4611
    $client_hints = NULL;
4711
    if ($server) {
4811
      $client_hints = ClientHints::factory($server);
49
    }
50
5111
    $dd = new DeviceDetector($user_agent, $client_hints);
5211
    $dd->parse();
53
5411
    return $dd;
55
  }
56
57
  /**
58
   * {@inheritdoc}
59
   */
60
  public function doDeviceFields(array &$fields, string $user_agent, ?array $server = NULL): void {
6111
    $dd = $this->getDeviceDetector($user_agent, $server);
6211
    $this->setDeviceFields($fields, $dd);
63
64
  }
65
66
  /**
67
   * Assigns the device fields to the fields array.
68
   *
69
   * @param array $fields
70
   *   The fields array.
71
   * @param \DeviceDetector\DeviceDetector $dd
72
   *   The DeviceDetector object.
73
   */
74
  protected function setDeviceFields(&$fields, DeviceDetector $dd): void {
7511
    $fields['config_browser_engine'] = $dd->getClient('engine');
7611
    $fields['config_browser_name'] = $dd->getClient('short_name');
7711
    $fields['config_browser_version'] = $dd->getClient('version');
7811
    $fields['config_client_type'] = $dd->getClient('type');
7911
    $fields['config_device_brand'] = $dd->getBrandName();
8011
    $fields['config_device_model'] = $dd->getModel();
8111
    $fields['config_device_type'] = $dd->getDeviceName();
8211
    $fields['config_os'] = $dd->getOs('short_name');
8311
    $fields['config_os_version'] = $dd->getOs('version');
8411
    $name = '';
8511
    $bot = $dd->getBot();
8611
    if (is_array($bot)) {
872
      $raw = $bot['name'] ?? '';
882
      if (is_string($raw)) {
892
        $name = $raw;
90
      }
91
    }
9211
    if ($name !== '') {
931
      $fields['bot'] = 1;
941
      $fields['bot_name'] = mb_substr($name, 0, 255);
95
    }
96
    else {
9711
      $fields['bot'] = 0;
9811
      $fields['bot_name'] = NULL;
99
    }
100
1010
    $nullable = [
1020
      'config_browser_engine',
1030
      'config_browser_name',
1040
      'config_browser_version',
1050
      'config_client_type',
1060
      'config_os',
1070
      'config_os_version',
1080
    ];
10911
    foreach ($nullable as $field) {
11011
      $value = strtolower($fields[$field]);
11111
      if ($value == 'unk') {
11211
        $fields[$field] = NULL;
113
      }
114
    }
115
  }
116
117
  /**
118
   * {@inheritdoc}
119
   */
120
  public function hasLibrary($class_name = 'DeviceDetector\ClientHints'): bool {
12111
    return class_exists($class_name);
122
  }
123
124
}