Add ability to filter out visits from staff

config/schema/entity_metrics.schema.yml

@@ -0,0 +1,8 @@
+# Schema for the configuration files of the Entity Metrics module.
+entity_metrics.settings:
+  type: config_object
+  label: 'Entity Metrics settings'
+  mapping:
+    cookie:
+      type: string
+      label: 'Cookie'

entity_metrics.install

@@ -46,6 +46,12 @@ function entity_metrics_install() {
         'type' => 'int',
         'unsigned' => TRUE,
       ],
+      'cookie_set' => [
+        'type' => 'int',
+        'size' => 'tiny',
+        'not null' => TRUE,
+        'default' => 0,
+      ],
     ],
     'primary key' => ['id'],
     'indexes' => [
@@ -100,7 +106,6 @@ function entity_metrics_install() {
   ];
 
   Database::getConnection()->schema()->createTable('entity_metrics_regions', $schema);
-
 }
 
 /**
@@ -110,3 +115,22 @@ function entity_metrics_uninstall() {
   Database::getConnection()->schema()->dropTable('entity_metrics_data');
   Database::getConnection()->schema()->dropTable('entity_metrics_regions');
 }
+
+/**
+ * Add cookie_set field.
+ */
+function entity_metrics_update_10001() {
+  $schema = \Drupal::database()->schema();
+  if (!$schema->tableExists('entity_metrics_data')) {
+    return;
+  }
+  if ($schema->fieldExists('entity_metrics_data', 'cookie_set')) {
+    return;
+  }
+  $schema->addField('entity_metrics_data', 'cookie_set', [
+    'type' => 'int',
+    'size' => 'tiny',
+    'not null' => TRUE,
+    'default' => 0,
+  ]);
+}

entity_metrics.links.menu.yml

@@ -0,0 +1,6 @@
+entity_metrics.settings:
+  title: Entity Metrics
+  description: Configure the entity metrics module
+  parent: system.admin_config_system
+  route_name: entity_metrics.settings
+  weight: 10

entity_metrics.module

@@ -58,13 +58,16 @@ function entity_metrics_file_download($uri) {
         ':uri' => $uri,
       ])->fetchField();
     if ($mid) {
+      $config = \Drupal::config()->get('entity_metrics.settings');
+      $cookieName = $config && $config->get('cookie');
       \Drupal::database()->insert('entity_metrics_data')
         ->fields([
           'entity_type' => 'media',
           'entity_id' => $mid,
           'session_id' => \Drupal::service('session_manager')->getId(),
           'timestamp' => \Drupal::time()->getCurrentTime(),
           'ip_address' => $ip,
+          'cookie_set' => !empty($cookieName) && isset($_COOKIE[$cookieName]) && $_COOKIE[$cookieName] === '1' ? '1' : '0',
         ])
         ->execute();
     }

entity_metrics.routing.yml

@@ -14,3 +14,11 @@ entity_metrics.view:
   methods: [GET]
   requirements:
     _permission: 'access content'
+
+entity_metrics.settings:
+  path: '/admin/config/system/entity-metrics'
+  defaults:
+    _title: 'Entity Metrics Settings'
+    _form: 'Drupal\entity_metrics\Form\SettingsForm'
+  requirements:
+    _permission: 'administer site configuration'

src/Controller/VisitController.php

@@ -3,6 +3,7 @@
 namespace Drupal\entity_metrics\Controller;
 
 use Drupal\Component\Datetime\Time;
+use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\Database\Connection;
 use Drupal\Core\Session\SessionManager;
@@ -39,6 +40,13 @@ class VisitController extends ControllerBase {
    */
   protected $time;
 
+  /**
+   * The config factory service.
+   *
+   * @var \Drupal\Core\Config\ConfigFactoryInterface
+   */
+  protected $configFactory;
+
   /**
    * VisitController constructor.
    *
@@ -48,11 +56,14 @@ class VisitController extends ControllerBase {
    *   The database connection service.
    * @param \Drupal\Core\Datetime\TimeInterface $time
    *   The time service.
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   *   The config factory service.
    */
-  public function __construct(SessionManager $session, Connection $database, Time $time) {
+  public function __construct(SessionManager $session, Connection $database, Time $time, ConfigFactoryInterface $configFactory) {
     $this->session = $session;
     $this->database = $database;
     $this->time = $time;
+    $this->configFactory = $configFactory;
   }
 
   /**
@@ -62,7 +73,8 @@ public static function create(ContainerInterface $container) {
     return new static(
       $container->get('session_manager'),
       $container->get('database'),
-      $container->get('datetime.time')
+      $container->get('datetime.time'),
+      $container->get('config.factory')
     );
   }
 
@@ -80,6 +92,8 @@ public function recordVisit(Request $request) {
       return $response;
     }
 
+    $config = $this->configFactory->get('entity_metrics.settings');
+    $cookieName = $config->get('cookie');
     $currentPath = explode('/', $request->request->get('currentPath'));
     $entity_id = array_pop($currentPath);
     $this->database->insert('entity_metrics_data')
@@ -89,6 +103,7 @@ public function recordVisit(Request $request) {
         'session_id' => $this->session->getId(),
         'timestamp' => $this->time->getCurrentTime(),
         'ip_address' => $ip,
+        'cookie_set' => !empty($cookieName) && isset($_COOKIE[$cookieName]) && $_COOKIE[$cookieName] === '1' ? '1' : '0',
       ])
       ->execute();
     $response = new Response();
@@ -104,14 +119,16 @@ public function getVisits($type, $id) {
       'monthly' => $this->database->query('SELECT COUNT(id) FROM {entity_metrics_data}
         WHERE entity_type = :type
           AND entity_id = :id
-          AND timestamp > :thirtyDays', [
+          AND timestamp > :thirtyDays
+          AND cookie_set = 0', [
             ':type' => $type,
             ':id' => $id,
             ':thirtyDays' => $this->time->getCurrentTime() - 2592000,
           ])->fetchField(),
       'total' => $this->database->query('SELECT COUNT(id) FROM {entity_metrics_data}
         WHERE entity_type = :type
-          AND entity_id = :id', [
+          AND entity_id = :id
+          AND cookie_set = 0', [
             ':type' => $type,
             ':id' => $id,
           ])->fetchField(),

src/Form/SettingsForm.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\entity_metrics\Form;
+
+use Drupal\Core\Form\ConfigFormBase;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Configure Entity Metrics settings for this site.
+ */
+final class SettingsForm extends ConfigFormBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId(): string {
+    return 'entity_metrics_settings';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getEditableConfigNames(): array {
+    return ['entity_metrics.settings'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state): array {
+    $form['cookie'] = [
+      '#type' => 'textfield',
+      '#title' => $this->t('Cookie name'),
+      '#description' => $this->t('<p>Name of cookie that when set and equal to "1" will set a flag to allow filtering out those metrics.</p>
+        <p>This allows not tracking things like staff page views.</p>
+        <p>The value will need set by some other service, this module does not handle setting the cookie. e.g. <a href="https://github.com/lehigh-university-libraries/cookie-toggler">cookie-toggler</a>.</p>'),
+      '#default_value' => $this->config('entity_metrics.settings')->get('cookie'),
+    ];
+    return parent::buildForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state): void {
+    $this->config('entity_metrics.settings')
+      ->set('cookie', $form_state->getValue('cookie'))
+      ->save();
+    parent::submitForm($form, $form_state);
+  }
+
+}