lytics.module

<?php

use Drupal\lytics\Entity\LyticsWidget;


/**
 * Implements hook_page_attachments_alter().
 */
function lytics_page_attachments_alter(array &$attachments)
{
  $config = Drupal::config('lytics.settings');
  $attachments['#attached']['drupalSettings']['lytics'] = [
    'account_id' => $config->get('account_id'),
  ];
}

/**
 * Implements hook_page_attachments().
 */
function lytics_page_attachments(array &$attachments)
{
  $is_admin_route = Drupal::service('router.admin_context')->isAdminRoute();

  if (!$is_admin_route) {
    $user = Drupal::currentUser();
    $config = Drupal::config('lytics.settings');

    // If explicitly preventing admin users from being tracked, return early
    if ($config->get('ignore_admin_users') && $user->hasPermission('manage lytics connection')) {
      return;
    }

    if ($config->get('enable_tag')) {
      // Fetch the tag_config JSON string and decode it to a PHP array
      $tagConfigJson = $config->get('tag_config') ?: '{}';
      $tagConfigArray = json_decode($tagConfigJson, TRUE);

      // Add the 'src' key to the array
      $account_id = $config->get('account_id');
      $debug_mode = $config->get('debug_mode');
      $js_file = $debug_mode ? 'latest.js' : 'latest.min.js';
      $tagConfigArray['src'] = 'https://c.lytics.io/api/tag/' . $account_id . '/' . $js_file;

      // Re-encode the array back to a JSON string
      $modifiedTagConfigJson = json_encode($tagConfigArray);

      // Render any published Lytics widgets
      $widgets = LyticsWidget::loadMultiple();

      function convertJsonToJs($widget)
      {
        $rawConfig = $widget->getConfiguration();
        $cfgObj = json_decode($rawConfig);
        $details = $cfgObj->details;
        $payload = $cfgObj->config;
        $type = ucfirst($details->type);

        // special handler for recommendation since they are messages
        if ($type === 'Recommendation') {
          $type = 'Message';
        }

        // generate output
        $variable = '_pfacfg_' . $payload->id;
        $output = 'var ' . $variable . ' = {};' . "\n";;

        foreach ($payload as $key => $value) {
          if (is_string($value)) {
            if ($key === "onInit" || $key === "onLoad") {
              if ($value !== "") {
                $output .= $variable . '.' . $key . ' = ' . $value . ';' . "\n";
              }
            } else {
              $output .= $variable . '.' . $key . ' = "' . $value . '";' . "\n";;
            }
          } else {
            if ($key === "confirmAction" || $key === "cancelAction" || $key === "closeAction") {
              if ($value->callback !== "") {
                $output .= $variable . '.' . $key . ' = {
                  "name": "' . $value->name . '",
                  "callback": ' . $value->callback . '
                }' . "\n";
              }
            } else {
              $output .= $variable . '.' . $key . ' = ' . json_encode($value) . ';' . "\n";
            }
          }
        }

        $output .= '__ly_modules.push({
          "segment": "' . $details->audience . '",
          "widget": new pathfora.' . $type . '(_pfacfg_' . $payload->id . ')
        });' . "\n";;

        return $output;
      }

      $outputJS = 'var __ly_modules = [];';
      foreach ($widgets as $widget) {
        // if widget is not published then skip
        $status = $widget->getStatus();
        if ($status !== 'published') {
          continue;
        }

        $js = convertJsonToJs($widget);
        $outputJS .= $js;
      }

      // Render the actual Lytics JavaScript SDK
      $attachments['#attached']['html_head'][] = [
        [
          '#type' => 'inline_template',
          '#template' => "{% include '@lytics/lytics-install.html.twig' with {'config': config|raw} %}",
          '#context' => ['config' => $modifiedTagConfigJson],
        ],
        'lytics_install',
      ];

      $attachments['#attached']['html_head'][] = [
        [
          '#type' => 'inline_template',
          '#template' => '
            <script>
              var __ly_evaluate_widgets = function(entity){
                var segmentMembership = entity?.data?.user?.segments || []; 
                
                ' . $outputJS . '
                
                __ly_render_widgets = [];
                __ly_modules.forEach(function(module){
                  if(segmentMembership.includes(module.segment) || module.segment === ""){
                    __ly_render_widgets.push(module.widget);
                  }
                });
                pathfora.initializeWidgets(__ly_render_widgets);
              };
              
              jstag.on("pathfora.publish.done", function(){
                jstag.call("entityReady", __ly_evaluate_widgets);
              });
            </script>
          ',
        ],
        'lytics_hello_world',
      ];
    } else {
      Drupal::logger('lytics')->notice('Lytics tag is disabled.');
    }
  }
}

/**
 * Implements hook_help().
 *
 * Displays help and module information.
 *
 * @param string $route_name
 *   The route name of the current page.
 * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
 *   The current route match interface.
 *
 * @return string
 *   A localized string containing the help text.
 */
function lytics_help($route_name, $route_match)
{
  switch ($route_name) {
    case 'help.page.lytics':
      return '<h2>About</h2>'
        . '<p>Provides an overview and integration of analytics functionalities.</p>'
        . '<h2>Usage</h2>'
        . '<p>To configure the Lytics module, navigate to the settings form at Administration > Configuration > System > Lytics settings. Here you can enable the integration, enter your unique Lytics tag ID, and toggle debug mode.</p>';
  }
}

/**
 * Implements hook_preprocess_HOOK() for page templates.
 */
function lytics_preprocess_page(&$variables)
{
  // Example of how to add a CSS file from the module.
  $variables['#attached']['library'][] = 'lytics/global-styling';
}

/**
 * Implements hook_theme().
 */
function lytics_theme()
{
  return [
    'todo_item' => [
      'variables' => [
        'content' => NULL,
      ],
    ],
    'lytics_install' => [
      'variables' => [
        'config' => NULL,
      ],
    ],
    'lytics_widgets' => [
      'variables' => [
        'config' => NULL,
      ],
    ],
  ];
}