Initial commit: hook to store trackable URLs in Redis

CRM/Traxivi/Cache.php

+<?php
+
+/**
+ * The core CiviCRM Redis cache serialises all values before storing them.
+ * This PHP-specific transformation prevents external software not written in PHP
+ * from easily reading the values, so this class is used as a cache implementation
+ * to store the URLs to be read by the Traxy frontend.
+ * Another different from the core implementation is that entries have no timeout.
+ */
+class CRM_Traxivi_Cache implements CRM_Utils_Cache_Interface {
+
+  // We only write to this cache, so no need for actual implementations
+  use CRM_Utils_Cache_NaiveMultipleTrait;
+  use CRM_Utils_Cache_NaiveHasTrait;
+
+  const DEFAULT_HOST    = 'localhost';
+  const DEFAULT_PORT    = 6379;
+  const DEFAULT_PREFIX  = 'Traxy/';
+
+  /**
+   * The prefix prepended to cache keys.
+   */
+  protected $_prefix = self::DEFAULT_PREFIX;
+
+  /**
+   * The actual redis object
+   *
+   * @var Redis
+   */
+  protected $_cache;
+
+  /**
+   * Create a connection. If a connection is already created by CRM_Utils_Cache_Redis (very likely), re-use it.
+   * Mostly copied from CRM_Utils_Cache_Redis
+   * @param array $config
+   * @return Redis
+   */
+  public static function connect($config) {
+		$clazz = 'CRM_Utils_Cache_Redis';
+    $host = $config['host'] ?? self::DEFAULT_HOST;
+    $port = $config['port'] ?? self::DEFAULT_PORT;
+    // Ugh.
+    $pass = CRM_Utils_Constant::value('CIVICRM_DB_CACHE_PASSWORD');
+    $id = implode(':', ['connect', $host, $port /* $pass is constant */]);
+    if (!isset(Civi::$statics[$clazz][$id])) {
+      // Ideally, we'd track the connection in the service-container
+      $redis = new Redis();
+      if (!$redis->connect($host, $port)) {
+        // dont use fatal here since we can go in an infinite loop
+        echo 'Could not connect to redisd server';
+        CRM_Utils_System::civiExit();
+      }
+      if ($pass) {
+        $redis->auth($pass);
+      }
+      Civi::$statics[$clazz][$id] = $redis;
+    }
+    return Civi::$statics[$clazz][$id];
+  }
+
+  /**
+   * Factory called by the service container
+   */
+	public static function create($params = []) {
+    $settings = CRM_Utils_Cache::getCacheSettings(CIVICRM_DB_CACHE_CLASS);
+    return new CRM_Traxivi_Cache($settings);
+  }
+
+  /**
+   * @param array $config
+   *   An array of configuration params.
+   */
+  public function __construct($config) {
+    $this->_cache = self::connect($config);
+  }
+
+  /**
+   * @param $key
+   * @param string $value
+   * @param null|int|\DateInterval $ttl Delete the key if negative, ignored otherwise
+   *
+   * @return bool whether operation was successful
+   * @throws Exception
+   */
+  public function set($key, $value, $ttl = NULL) {
+    CRM_Utils_Cache::assertValidKey($key);
+    if (is_int($ttl) && $ttl <= 0) {
+      return $this->delete($key);
+    }
+    $res = $this->_cache->set($this->_prefix . $key, $value);
+    if (!$res) {
+      if (PHP_SAPI === 'cli' || (Civi\Core\Container::isContainerBooted() && CRM_Core_Permission::check('view debug output'))) {
+        throw new CRM_Utils_Cache_CacheException("Redis set ($key) failed: " . $this->_cache->getLastError());
+      }
+      else {
+        Civi::log()->error("Redis set ($key) failed: " . $this->_cache->getLastError());
+        throw new CRM_Utils_Cache_CacheException("Redis set ($key) failed");
+      }
+      return FALSE;
+    }
+    return TRUE;
+  }
+
+  /**
+   * @param $key
+   * @param mixed $default
+   *
+   * @return mixed
+   */
+  public function get($key, $default = NULL) {
+    CRM_Utils_Cache::assertValidKey($key);
+    $result = $this->_cache->get($this->_prefix . $key);
+    return ($result === FALSE) ? $default : $result;
+  }
+
+  /**
+   * @param $key
+   *
+   * @return bool
+   */
+  public function delete($key) {
+    CRM_Utils_Cache::assertValidKey($key);
+    $this->_cache->delete($this->_prefix . $key);
+    return TRUE;
+  }
+
+  public function flush() {
+    $keys = $this->_cache->keys($this->_prefix . '*');
+    $this->_cache->del($keys);
+    return TRUE;
+  }
+
+  public function clear() {
+    return $this->flush();
+  }
+
+}
+

README.md

+# Traxivi
+
+This extension is to integrate CiviCRM with [Traxy](https://gitlab.wemove.eu/wemove/traxy).
+It provides a hook to store all trackable URLs created by CiviCRM in a Redis table (to be read by Traxy),
+and an AMQP consumer to store the click and open counts of CiviCRM mailings.
+
+The extension is licensed under [AGPL-3.0](LICENSE.txt).
+
+## Installation
+
+### Requirements
+
+ * CiviCRM configured to use Redis as cache back-end
+
+### CLI, Zip
+
+Sysadmins and developers may download the `.zip` file for this extension and
+install it with the command-line tool [cv](https://github.com/civicrm/cv).
+
+```bash
+cd <extension-dir>
+cv dl eu.wemove.traxivi@https://github.com/FIXME/eu.wemove.traxivi/archive/master.zip
+```
+
+### CLI, Git
+
+Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
+install it with the command-line tool [cv](https://github.com/civicrm/cv).
+
+```bash
+git clone https://github.com/FIXME/eu.wemove.traxivi.git
+cv en traxivi
+```
+
+## Getting Started
+
+ * Make sure Traxy and CiviCRM point to the same Redis database
+ * Configure your reverse proxy so that extern/url.php is served by Traxy
+
+## Known Issues
+
+ * Traxy must use the default prefix (not configurable yet in this extension)

info.xml

+<?xml version="1.0"?>
+<extension key="eu.wemove.traxivi" type="module">
+  <file>traxivi</file>
+  <name>Traxivi</name>
+  <description>CiviCRM extension for Traxy click and open tracker</description>
+  <license>AGPL-3.0</license>
+  <maintainer>
+    <author>Romain Thouvenin</author>
+    <email>romain@wemove.eu</email>
+  </maintainer>
+  <urls>
+    <url desc="Main Extension Page">https://gitlab.wemove.eu/wemove/traxivi</url>
+    <url desc="Documentation">https://gitlab.wemove.eu/wemove/traxivi</url>
+    <url desc="Support">https://gitlab.wemove.eu/wemove/traxivi</url>
+    <url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
+  </urls>
+  <releaseDate>2021-08-09</releaseDate>
+  <version>0.1</version>
+  <compatibility>
+    <ver>5.0</ver>
+  </compatibility>
+  <classloader>
+    <psr4 prefix="Civi\" path="Civi"/>
+  </classloader>
+  <civix>
+    <namespace>CRM/Traxivi</namespace>
+  </civix>
+</extension>

traxivi.civix.php

+<?php
+
+// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
+
+/**
+ * The ExtensionUtil class provides small stubs for accessing resources of this
+ * extension.
+ */
+class CRM_Traxivi_ExtensionUtil {
+  const SHORT_NAME = 'traxivi';
+  const LONG_NAME = 'eu.wemove.traxivi';
+  const CLASS_PREFIX = 'CRM_Traxivi';
+
+  /**
+   * Translate a string using the extension's domain.
+   *
+   * If the extension doesn't have a specific translation
+   * for the string, fallback to the default translations.
+   *
+   * @param string $text
+   *   Canonical message text (generally en_US).
+   * @param array $params
+   * @return string
+   *   Translated text.
+   * @see ts
+   */
+  public static function ts($text, $params = []) {
+    if (!array_key_exists('domain', $params)) {
+      $params['domain'] = [self::LONG_NAME, NULL];
+    }
+    return ts($text, $params);
+  }
+
+  /**
+   * Get the URL of a resource file (in this extension).
+   *
+   * @param string|NULL $file
+   *   Ex: NULL.
+   *   Ex: 'css/foo.css'.
+   * @return string
+   *   Ex: 'http://example.org/sites/default/ext/org.example.foo'.
+   *   Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
+   */
+  public static function url($file = NULL) {
+    if ($file === NULL) {
+      return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
+    }
+    return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
+  }
+
+  /**
+   * Get the path of a resource file (in this extension).
+   *
+   * @param string|NULL $file
+   *   Ex: NULL.
+   *   Ex: 'css/foo.css'.
+   * @return string
+   *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
+   *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
+   */
+  public static function path($file = NULL) {
+    // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
+    return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
+  }
+
+  /**
+   * Get the name of a class within this extension.
+   *
+   * @param string $suffix
+   *   Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
+   * @return string
+   *   Ex: 'CRM_Foo_Page_HelloWorld'.
+   */
+  public static function findClass($suffix) {
+    return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
+  }
+
+}
+
+use CRM_Traxivi_ExtensionUtil as E;
+
+/**
+ * (Delegated) Implements hook_civicrm_config().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
+ */
+function _traxivi_civix_civicrm_config(&$config = NULL) {
+  static $configured = FALSE;
+  if ($configured) {
+    return;
+  }
+  $configured = TRUE;
+
+  $template =& CRM_Core_Smarty::singleton();
+
+  $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
+  $extDir = $extRoot . 'templates';
+
+  if (is_array($template->template_dir)) {
+    array_unshift($template->template_dir, $extDir);
+  }
+  else {
+    $template->template_dir = [$extDir, $template->template_dir];
+  }
+
+  $include_path = $extRoot . PATH_SEPARATOR . get_include_path();
+  set_include_path($include_path);
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_xmlMenu().
+ *
+ * @param $files array(string)
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
+ */
+function _traxivi_civix_civicrm_xmlMenu(&$files) {
+  foreach (_traxivi_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
+    $files[] = $file;
+  }
+}
+
+/**
+ * Implements hook_civicrm_install().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
+ */
+function _traxivi_civix_civicrm_install() {
+  _traxivi_civix_civicrm_config();
+  if ($upgrader = _traxivi_civix_upgrader()) {
+    $upgrader->onInstall();
+  }
+}
+
+/**
+ * Implements hook_civicrm_postInstall().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
+ */
+function _traxivi_civix_civicrm_postInstall() {
+  _traxivi_civix_civicrm_config();
+  if ($upgrader = _traxivi_civix_upgrader()) {
+    if (is_callable([$upgrader, 'onPostInstall'])) {
+      $upgrader->onPostInstall();
+    }
+  }
+}
+
+/**
+ * Implements hook_civicrm_uninstall().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
+ */
+function _traxivi_civix_civicrm_uninstall() {
+  _traxivi_civix_civicrm_config();
+  if ($upgrader = _traxivi_civix_upgrader()) {
+    $upgrader->onUninstall();
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_enable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
+ */
+function _traxivi_civix_civicrm_enable() {
+  _traxivi_civix_civicrm_config();
+  if ($upgrader = _traxivi_civix_upgrader()) {
+    if (is_callable([$upgrader, 'onEnable'])) {
+      $upgrader->onEnable();
+    }
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_disable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
+ * @return mixed
+ */
+function _traxivi_civix_civicrm_disable() {
+  _traxivi_civix_civicrm_config();
+  if ($upgrader = _traxivi_civix_upgrader()) {
+    if (is_callable([$upgrader, 'onDisable'])) {
+      $upgrader->onDisable();
+    }
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_upgrade().
+ *
+ * @param $op string, the type of operation being performed; 'check' or 'enqueue'
+ * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
+ *
+ * @return mixed
+ *   based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
+ *   for 'enqueue', returns void
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
+ */
+function _traxivi_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
+  if ($upgrader = _traxivi_civix_upgrader()) {
+    return $upgrader->onUpgrade($op, $queue);
+  }
+}
+
+/**
+ * @return CRM_Traxivi_Upgrader
+ */
+function _traxivi_civix_upgrader() {
+  if (!file_exists(__DIR__ . '/CRM/Traxivi/Upgrader.php')) {
+    return NULL;
+  }
+  else {
+    return CRM_Traxivi_Upgrader_Base::instance();
+  }
+}
+
+/**
+ * Search directory tree for files which match a glob pattern.
+ *
+ * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
+ * Note: Delegate to CRM_Utils_File::findFiles(), this function kept only
+ * for backward compatibility of extension code that uses it.
+ *
+ * @param string $dir base dir
+ * @param string $pattern , glob pattern, eg "*.txt"
+ *
+ * @return array
+ */
+function _traxivi_civix_find_files($dir, $pattern) {
+  return CRM_Utils_File::findFiles($dir, $pattern);
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_managed().
+ *
+ * Find any *.mgd.php files, merge their content, and return.
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
+ */
+function _traxivi_civix_civicrm_managed(&$entities) {
+  $mgdFiles = _traxivi_civix_find_files(__DIR__, '*.mgd.php');
+  sort($mgdFiles);
+  foreach ($mgdFiles as $file) {
+    $es = include $file;
+    foreach ($es as $e) {
+      if (empty($e['module'])) {
+        $e['module'] = E::LONG_NAME;
+      }
+      if (empty($e['params']['version'])) {
+        $e['params']['version'] = '3';
+      }
+      $entities[] = $e;
+    }
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_caseTypes().
+ *
+ * Find any and return any files matching "xml/case/*.xml"
+ *
+ * Note: This hook only runs in CiviCRM 4.4+.
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
+ */
+function _traxivi_civix_civicrm_caseTypes(&$caseTypes) {
+  if (!is_dir(__DIR__ . '/xml/case')) {
+    return;
+  }
+
+  foreach (_traxivi_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
+    $name = preg_replace('/\.xml$/', '', basename($file));
+    if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
+      $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name));
+      throw new CRM_Core_Exception($errorMessage);
+    }
+    $caseTypes[$name] = [
+      'module' => E::LONG_NAME,
+      'name' => $name,
+      'file' => $file,
+    ];
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_angularModules().
+ *
+ * Find any and return any files matching "ang/*.ang.php"
+ *
+ * Note: This hook only runs in CiviCRM 4.5+.
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
+ */
+function _traxivi_civix_civicrm_angularModules(&$angularModules) {
+  if (!is_dir(__DIR__ . '/ang')) {
+    return;
+  }
+
+  $files = _traxivi_civix_glob(__DIR__ . '/ang/*.ang.php');
+  foreach ($files as $file) {
+    $name = preg_replace(':\.ang\.php$:', '', basename($file));
+    $module = include $file;
+    if (empty($module['ext'])) {
+      $module['ext'] = E::LONG_NAME;
+    }
+    $angularModules[$name] = $module;
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_themes().
+ *
+ * Find any and return any files matching "*.theme.php"
+ */
+function _traxivi_civix_civicrm_themes(&$themes) {
+  $files = _traxivi_civix_glob(__DIR__ . '/*.theme.php');
+  foreach ($files as $file) {
+    $themeMeta = include $file;
+    if (empty($themeMeta['name'])) {
+      $themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
+    }
+    if (empty($themeMeta['ext'])) {
+      $themeMeta['ext'] = E::LONG_NAME;
+    }
+    $themes[$themeMeta['name']] = $themeMeta;
+  }
+}
+
+/**
+ * Glob wrapper which is guaranteed to return an array.
+ *
+ * The documentation for glob() says, "On some systems it is impossible to
+ * distinguish between empty match and an error." Anecdotally, the return
+ * result for an empty match is sometimes array() and sometimes FALSE.
+ * This wrapper provides consistency.
+ *
+ * @link http://php.net/glob
+ * @param string $pattern
+ *
+ * @return array
+ */
+function _traxivi_civix_glob($pattern) {
+  $result = glob($pattern);
+  return is_array($result) ? $result : [];
+}
+
+/**
+ * Inserts a navigation menu item at a given place in the hierarchy.
+ *
+ * @param array $menu - menu hierarchy
+ * @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
+ *    'Mailing', or 'Administer/System Settings'
+ * @param array $item - the item to insert (parent/child attributes will be
+ *    filled for you)
+ *
+ * @return bool
+ */
+function _traxivi_civix_insert_navigation_menu(&$menu, $path, $item) {
+  // If we are done going down the path, insert menu
+  if (empty($path)) {
+    $menu[] = [
+      'attributes' => array_merge([
+        'label'      => CRM_Utils_Array::value('name', $item),
+        'active'     => 1,
+      ], $item),
+    ];
+    return TRUE;
+  }
+  else {
+    // Find an recurse into the next level down
+    $found = FALSE;
+    $path = explode('/', $path);
+    $first = array_shift($path);
+    foreach ($menu as $key => &$entry) {
+      if ($entry['attributes']['name'] == $first) {
+        if (!isset($entry['child'])) {
+          $entry['child'] = [];
+        }
+        $found = _traxivi_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
+      }
+    }
+    return $found;
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_navigationMenu().
+ */
+function _traxivi_civix_navigationMenu(&$nodes) {
+  if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
+    _traxivi_civix_fixNavigationMenu($nodes);
+  }
+}
+
+/**
+ * Given a navigation menu, generate navIDs for any items which are
+ * missing them.
+ */
+function _traxivi_civix_fixNavigationMenu(&$nodes) {
+  $maxNavID = 1;
+  array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
+    if ($key === 'navID') {
+      $maxNavID = max($maxNavID, $item);
+    }
+  });
+  _traxivi_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
+}
+
+function _traxivi_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
+  $origKeys = array_keys($nodes);
+  foreach ($origKeys as $origKey) {
+    if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
+      $nodes[$origKey]['attributes']['parentID'] = $parentID;
+    }
+    // If no navID, then assign navID and fix key.
+    if (!isset($nodes[$origKey]['attributes']['navID'])) {
+      $newKey = ++$maxNavID;
+      $nodes[$origKey]['attributes']['navID'] = $newKey;