1.0.0-beta

Civix upgrade should fix install error

de.systopia.civiproxy/CRM/Civiproxy/Mailer.php

@@ -17,12 +17,23 @@ class CRM_Civiproxy_Mailer {
    * this is the orginal, wrapped mailer
    */
   protected $mailer = NULL;
+  /**
+   * @var Mail Driver
+   */
+  protected $driver = NULL;
+
+  /**
+   * @var array Mail Params, currently not used
+   */
+  protected $params = [];
 
   /**
    * construct this mailer wrapping another one
    */
-  public function __construct($mailer) {
+  public function __construct($mailer, $driver, $params) {
     $this->mailer = $mailer;
+    $this->driver = $driver;
+    $this->params = $params;
   }
 
   /**
@@ -81,4 +92,11 @@ class CRM_Civiproxy_Mailer {
       $value = preg_replace("#{$system_base}civicrm/mailing/{$function}#i", $new_url, $value);
     }
   }
+
+    /**
+     * @return Mail|null
+     */
+    public function getDriver() {
+        return $this->driver;
+    }
 }

de.systopia.civiproxy/civiproxy.civix.php

@@ -7,9 +7,9 @@
  * extension.
  */
 class CRM_Civiproxy_ExtensionUtil {
-  const SHORT_NAME = "civiproxy";
+  const SHORT_NAME = 'civiproxy';
-  const LONG_NAME = "de.systopia.civiproxy";
+  const LONG_NAME = 'de.systopia.civiproxy';
-  const CLASS_PREFIX = "CRM_Civiproxy";
+  const CLASS_PREFIX = 'CRM_Civiproxy';
 
   /**
    * Translate a string using the extension's domain.
@@ -24,7 +24,7 @@ class CRM_Civiproxy_ExtensionUtil {
    *   Translated text.
    * @see ts
    */
-  public static function ts($text, $params = []) {
+  public static function ts($text, $params = []): string {
     if (!array_key_exists('domain', $params)) {
       $params['domain'] = [self::LONG_NAME, NULL];
     }
@@ -41,7 +41,7 @@ class CRM_Civiproxy_ExtensionUtil {
    *   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) {
+  public static function url($file = NULL): string {
     if ($file === NULL) {
       return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
     }
@@ -75,6 +75,7 @@ class CRM_Civiproxy_ExtensionUtil {
     return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
   }
 
+
 }
 
 use CRM_Civiproxy_ExtensionUtil as E;
@@ -84,40 +85,17 @@ use CRM_Civiproxy_ExtensionUtil as E;
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
  */
-function _civiproxy_civix_civicrm_config(&$config = NULL) {
+function _civiproxy_civix_civicrm_config($config = NULL) {
   static $configured = FALSE;
   if ($configured) {
     return;
   }
   $configured = TRUE;
 
-  $template =& CRM_Core_Smarty::singleton();
+  $extRoot = __DIR__ . DIRECTORY_SEPARATOR;
-
-  $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);
-}
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
-
-/**
- * (Delegated) Implements hook_civicrm_xmlMenu().
- *
- * @param $files array(string)
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
- */
-function _civiproxy_civix_civicrm_xmlMenu(&$files) {
-  foreach (_civiproxy_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
-    $files[] = $file;
-  }
 }
 
 /**
@@ -127,35 +105,7 @@ function _civiproxy_civix_civicrm_xmlMenu(&$files) {
  */
 function _civiproxy_civix_civicrm_install() {
   _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_civix_upgrader()) {
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
-    $upgrader->onInstall();
-  }
-}
-
-/**
- * Implements hook_civicrm_postInstall().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
- */
-function _civiproxy_civix_civicrm_postInstall() {
-  _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_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 _civiproxy_civix_civicrm_uninstall() {
-  _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_civix_upgrader()) {
-    $upgrader->onUninstall();
-  }
 }
 
 /**
@@ -163,212 +113,9 @@ function _civiproxy_civix_civicrm_uninstall() {
  *
  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
  */
-function _civiproxy_civix_civicrm_enable() {
+function _civiproxy_civix_civicrm_enable(): void {
   _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_civix_upgrader()) {
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
-    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 _civiproxy_civix_civicrm_disable() {
-  _civiproxy_civix_civicrm_config();
-  if ($upgrader = _civiproxy_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 _civiproxy_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
-  if ($upgrader = _civiproxy_civix_upgrader()) {
-    return $upgrader->onUpgrade($op, $queue);
-  }
-}
-
-/**
- * @return CRM_Civiproxy_Upgrader
- */
-function _civiproxy_civix_upgrader() {
-  if (!file_exists(__DIR__ . '/CRM/Civiproxy/Upgrader.php')) {
-    return NULL;
-  }
-  else {
-    return CRM_Civiproxy_Upgrader_Base::instance();
-  }
-}
-
-/**
- * Search directory tree for files which match a glob pattern.
- *
- * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
- * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
- *
- * @param string $dir base dir
- * @param string $pattern , glob pattern, eg "*.txt"
- *
- * @return array
- */
-function _civiproxy_civix_find_files($dir, $pattern) {
-  if (is_callable(['CRM_Utils_File', 'findFiles'])) {
-    return CRM_Utils_File::findFiles($dir, $pattern);
-  }
-
-  $todos = [$dir];
-  $result = [];
-  while (!empty($todos)) {
-    $subdir = array_shift($todos);
-    foreach (_civiproxy_civix_glob("$subdir/$pattern") as $match) {
-      if (!is_dir($match)) {
-        $result[] = $match;
-      }
-    }
-    if ($dh = opendir($subdir)) {
-      while (FALSE !== ($entry = readdir($dh))) {
-        $path = $subdir . DIRECTORY_SEPARATOR . $entry;
-        if ($entry[0] == '.') {
-        }
-        elseif (is_dir($path)) {
-          $todos[] = $path;
-        }
-      }
-      closedir($dh);
-    }
-  }
-  return $result;
-}
-
-/**
- * (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 _civiproxy_civix_civicrm_managed(&$entities) {
-  $mgdFiles = _civiproxy_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 _civiproxy_civix_civicrm_caseTypes(&$caseTypes) {
-  if (!is_dir(__DIR__ . '/xml/case')) {
-    return;
-  }
-
-  foreach (_civiproxy_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 _civiproxy_civix_civicrm_angularModules(&$angularModules) {
-  if (!is_dir(__DIR__ . '/ang')) {
-    return;
-  }
-
-  $files = _civiproxy_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 _civiproxy_civix_civicrm_themes(&$themes) {
-  $files = _civiproxy_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 _civiproxy_civix_glob($pattern) {
-  $result = glob($pattern);
-  return is_array($result) ? $result : [];
 }
 
 /**
@@ -387,8 +134,8 @@ function _civiproxy_civix_insert_navigation_menu(&$menu, $path, $item) {
   if (empty($path)) {
     $menu[] = [
       'attributes' => array_merge([
-        'label'      => CRM_Utils_Array::value('name', $item),
+        'label' => $item['name'] ?? NULL,
-        'active'     => 1,
+        'active' => 1,
       ], $item),
     ];
     return TRUE;
@@ -452,26 +199,3 @@ function _civiproxy_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID)
     }
   }
 }
-
-/**
- * (Delegated) Implements hook_civicrm_alterSettingsFolders().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
- */
-function _civiproxy_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
-  $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
-  if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
-    $metaDataFolders[] = $settingsDir;
-  }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_entityTypes().
- *
- * Find any *.entityType.php files, merge their content, and return.
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
- */
-function _civiproxy_civix_civicrm_entityTypes(&$entityTypes) {
-  $entityTypes = array_merge($entityTypes, []);
-}

de.systopia.civiproxy/civiproxy.php

@@ -15,7 +15,7 @@ require_once 'civiproxy.civix.php';
  * so we can mend all the URLs in outgoing emails
  */
 function civiproxy_civicrm_alterMailer(&$mailer, $driver, $params) {
-  $mailer = new CRM_Civiproxy_Mailer($mailer);
+  $mailer = new CRM_Civiproxy_Mailer($mailer, $driver, $params);
 }
 
 /**
@@ -25,15 +25,6 @@ function civiproxy_civicrm_config(&$config) {
   _civiproxy_civix_civicrm_config($config);
 }
 
-/**
- * Implementation of hook_civicrm_xmlMenu
- *
- * @param $files array(string)
- */
-function civiproxy_civicrm_xmlMenu(&$files) {
-  _civiproxy_civix_civicrm_xmlMenu($files);
-}
-
 /**
  * Implementation of hook_civicrm_install
  */
@@ -41,13 +32,6 @@ function civiproxy_civicrm_install() {
   return _civiproxy_civix_civicrm_install();
 }
 
-/**
- * Implementation of hook_civicrm_uninstall
- */
-function civiproxy_civicrm_uninstall() {
-  return _civiproxy_civix_civicrm_uninstall();
-}
-
 /**
  * Implementation of hook_civicrm_enable
  */
@@ -55,61 +39,9 @@ function civiproxy_civicrm_enable() {
   return _civiproxy_civix_civicrm_enable();
 }
 
-/**
- * Implementation of hook_civicrm_disable
- */
-function civiproxy_civicrm_disable() {
-  return _civiproxy_civix_civicrm_disable();
-}
-
-/**
- * Implementation of 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
- */
-function civiproxy_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
-  return _civiproxy_civix_civicrm_upgrade($op, $queue);
-}
-
-/**
- * Implementation of hook_civicrm_managed
- *
- * Generate a list of entities to create/deactivate/delete when this module
- * is installed, disabled, uninstalled.
- */
-function civiproxy_civicrm_managed(&$entities) {
-  return _civiproxy_civix_civicrm_managed($entities);
-}
-
-/**
- * Implementation of hook_civicrm_caseTypes
- *
- * Generate a list of case-types
- *
- * Note: This hook only runs in CiviCRM 4.4+.
- */
-function civiproxy_civicrm_caseTypes(&$caseTypes) {
-  _civiproxy_civix_civicrm_caseTypes($caseTypes);
-}
-
 /**
 * Implementation of hook_civicrm_alterSettingsFolders
 *
 * Scan for settings in custom folder and import them
 *
 */
-function civiproxy_civicrm_alterSettingsFolders(&$metaDataFolders = NULL){
-  static $configured = FALSE;
-  if ($configured) return;
-  $configured = TRUE;
-
-  $extRoot = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
-  $extDir = $extRoot . 'settings';
-  if(!in_array($extDir, $metaDataFolders)){
-    $metaDataFolders[] = $extDir;
-  }
-}

de.systopia.civiproxy/info.xml

@@ -14,14 +14,25 @@
     <url desc="Support">https://github.com/systopia/CiviProxy/issues</url>
     <url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
   </urls>
-  <releaseDate>2024-06-18</releaseDate>
+  <releaseDate>2024-01-07</releaseDate>
-  <version>0.7.0</version>
+  <version>1.0.0-beta</version>
-  <develStage>stable</develStage>
+  <develStage>beta</develStage>
   <compatibility>
-    <ver>5.0</ver>
+    <ver>5.45</ver>
   </compatibility>
   <comments>This is the companion extension to SYSTOPIA's CiviProxy security system</comments>
   <civix>
     <namespace>CRM/Civiproxy</namespace>
+    <format>24.09.1</format>
   </civix>
+  <mixins>
+    <mixin>menu-xml@1.0.0</mixin>
+    <mixin>setting-php@1.0.0</mixin>
+    <mixin>smarty-v2@1.0.3</mixin>
+    <mixin>entity-types-php@2.0.0</mixin>
+  </mixins>
+  <classloader>
+    <psr0 prefix="CRM_" path="."/>
+    <psr4 prefix="Civi\" path="Civi"/>
+  </classloader>
 </extension>

de.systopia.civiproxy/mixin/entity-types-php@2.0.0.mixin.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Auto-register entity declarations from `schema/*.entityType.php`.
+ *
+ * @mixinName entity-types-php
+ * @mixinVersion 2.0.0
+ * @since 5.73
+ *
+ * Changelog:
+ *  - v2.0 scans /schema directory instead of /xml/schema/*
+ *  - v2.0 supports only one entity per file
+ *  - v2.0 adds 'module' key to each entity
+ *
+ * @param CRM_Extension_MixInfo $mixInfo
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ * @param \CRM_Extension_BootCache $bootCache
+ *   On newer deployments, this will be an instance of BootCache. On older deployments, Civix may polyfill with a work-a-like.
+ */
+return function ($mixInfo, $bootCache) {
+
+  /**
+   * @param \Civi\Core\Event\GenericHookEvent $e
+   * @see CRM_Utils_Hook::entityTypes()
+   */
+  Civi::dispatcher()->addListener('hook_civicrm_entityTypes', function ($e) use ($mixInfo) {
+    // When deactivating on a polyfill/pre-mixin system, listeners may not cleanup automatically.
+    if (!$mixInfo->isActive() || !is_dir($mixInfo->getPath('schema'))) {
+      return;
+    }
+
+    $files = (array) glob($mixInfo->getPath('schema/*.entityType.php'));
+    foreach ($files as $file) {
+      $entity = include $file;
+      $entity['module'] = $mixInfo->longName;
+      $e->entityTypes[$entity['name']] = $entity;
+    }
+  });
+
+};

de.systopia.civiproxy/mixin/smarty-v2@1.0.3.mixin.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * Auto-register "templates/" folder.
+ *
+ * @mixinName smarty-v2
+ * @mixinVersion 1.0.3
+ * @since 5.59
+ *
+ * @deprecated - it turns out that the mixin is not version specific so the 'smarty'
+ * mixin is preferred over smarty-v2 (they are the same but not having the version
+ * in the name is less misleading.)
+ *
+ * @param CRM_Extension_MixInfo $mixInfo
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ * @param \CRM_Extension_BootCache $bootCache
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ */
+return function ($mixInfo, $bootCache) {
+  $dir = $mixInfo->getPath('templates');
+  if (!file_exists($dir)) {
+    return;
+  }
+
+  $register = function($newDirs) {
+    $smarty = CRM_Core_Smarty::singleton();
+    $v2 = isset($smarty->_version) && version_compare($smarty->_version, 3, '<');
+    $templateDirs = (array) ($v2 ? $smarty->template_dir : $smarty->getTemplateDir());
+    $templateDirs = array_merge($newDirs, $templateDirs);
+    $templateDirs = array_unique(array_map(function($v) {
+      $v = str_replace(DIRECTORY_SEPARATOR, '/', $v);
+      $v = rtrim($v, '/') . '/';
+      return $v;
+    }, $templateDirs));
+    if ($v2) {
+      $smarty->template_dir = $templateDirs;
+    }
+    else {
+      $smarty->setTemplateDir($templateDirs);
+    }
+  };
+
+  // Let's figure out what environment we're in -- so that we know the best way to call $register().
+
+  if (!empty($GLOBALS['_CIVIX_MIXIN_POLYFILL'])) {
+    // Polyfill Loader (v<=5.45): We're already in the middle of firing `hook_config`.
+    if ($mixInfo->isActive()) {
+      $register([$dir]);
+    }
+    return;
+  }
+
+  if (CRM_Extension_System::singleton()->getManager()->extensionIsBeingInstalledOrEnabled($mixInfo->longName)) {
+    // New Install, Standard Loader: The extension has just been enabled, and we're now setting it up.
+    // System has already booted. New templates may be needed for upcoming installation steps.
+    $register([$dir]);
+    return;
+  }
+
+  // Typical Pageview, Standard Loader: Defer the actual registration for a moment -- to ensure that Smarty is online.
+  // We need to bundle-up all dirs -- Smarty 3/4/5 is inefficient with processing repeated calls to `getTemplateDir()`+`setTemplateDir()`
+  if (!isset(Civi::$statics[__FILE__]['event'])) {
+    Civi::$statics[__FILE__]['event'] = 'civi.smarty-v2.addPaths.' . md5(__FILE__);
+    Civi::dispatcher()->addListener('hook_civicrm_config', function() use ($register) {
+      $dirs = [];
+      $event = \Civi\Core\Event\GenericHookEvent::create(['dirs' => &$dirs]);
+      Civi::dispatcher()->dispatch(Civi::$statics[__FILE__]['event'], $event);
+      $register($dirs);
+    });
+  }
+
+  Civi::dispatcher()->addListener(Civi::$statics[__FILE__]['event'], function($event) use ($mixInfo, $dir) {
+    if ($mixInfo->isActive()) {
+      array_unshift($event->dirs, $dir);
+    }
+  });
+
+};

proxy/config.dist.php

@@ -51,9 +51,8 @@ $target_url       = $target_civicrm . '/civicrm/mailing/url';
 $target_open      = $target_civicrm . '/civicrm/mailing/open';
 
 // CAUTION: use the following for CiviCRM < 5.27 or "Extern URL Style" = "Standalone Scripts" 
-#$target_url       = $target_civicrm . '/sites/all/modules/civicrm/extern/url.php';
+//$target_url       = $target_civicrm . '/sites/all/modules/civicrm/extern/url.php';
-#$target_open      = $target_civicrm . '/sites/all/modules/civicrm/extern/open.php';
+//$target_open      = $target_civicrm . '/sites/all/modules/civicrm/extern/open.php';
-
 
 /****************************************************************
  **                    GENERAL OPTIONS                         **
@@ -97,6 +96,23 @@ if (file_exists(dirname(__FILE__)."/secrets.php")) {
   require "secrets.php";
 }
 
+// Parameter whitelisting for open tracking and URL tracking
+// basic civicrm URL/open parameter are u, q and qid (as int)
+// If additional parameters are needed, best practise would be to whitelist each one as needed in
+// $valid_url_parameters and/or $valid_open_parameters.
+// Alternatively it is also possible to allow all parameters with the wildcard parameter '*' => 'string'
+$valid_url_parameters = [
+    'u'   => 'int',
+    'q'   => 'int',
+    'qid' => 'int',
+//    '*'   => 'string'     // whildcard, whitelist all url parameters
+];
+$valid_open_parameters = [
+    'u'   => 'int',
+    'q'   => 'int',
+    'qid' => 'int',
+//    '*'   => 'string'     // wildcard, whitelist *all* open parameters
+];
 // CiviCRM's API can authenticate with different flows
 // https://docs.civicrm.org/dev/en/latest/framework/authx/#flows
 // CiviProxy supports 'header', 'xheader', 'legacyrest', and 'param'.

proxy/libs/Cache/Lite.php

@@ -79,7 +79,7 @@ class Cache_Lite
     * @var string $_file
     */
     var $_file;
-    
+
     /**
     * File name (without path)
     *
@@ -128,7 +128,7 @@ class Cache_Lite
     * @var int $_pearErrorMode
     */
     var $_pearErrorMode = CACHE_LITE_ERROR_RETURN;
-    
+
     /**
     * Current cache id
     *
@@ -146,7 +146,7 @@ class Cache_Lite
     /**
     * Enable / Disable "Memory Caching"
     *
-    * NB : There is no lifetime for memory caching ! 
+    * NB : There is no lifetime for memory caching !
     *
     * @var boolean $_memoryCaching
     */
@@ -180,7 +180,7 @@ class Cache_Lite
     * @var int $memoryCachingLimit
     */
     var $_memoryCachingLimit = 1000;
-    
+
     /**
     * File Name protection
     *
@@ -192,17 +192,17 @@ class Cache_Lite
     * @var boolean $fileNameProtection
     */
     var $_fileNameProtection = true;
-    
+
     /**
     * Enable / disable automatic serialization
     *
     * it can be used to save directly datas which aren't strings
-    * (but it's slower)    
+    * (but it's slower)
     *
     * @var boolean $_serialize
     */
     var $_automaticSerialization = false;
-    
+
     /**
     * Disable / Tune the automatic cleaning process
     *
@@ -215,45 +215,45 @@ class Cache_Lite
     * @var int $_automaticCleaning
     */
     var $_automaticCleaningFactor = 0;
-    
+
     /**
     * Nested directory level
     *
-    * Set the hashed directory structure level. 0 means "no hashed directory 
+    * Set the hashed directory structure level. 0 means "no hashed directory
-    * structure", 1 means "one level of directory", 2 means "two levels"... 
+    * structure", 1 means "one level of directory", 2 means "two levels"...
-    * This option can speed up Cache_Lite only when you have many thousands of 
+    * This option can speed up Cache_Lite only when you have many thousands of
-    * cache file. Only specific benchs can help you to choose the perfect value 
+    * cache file. Only specific benchs can help you to choose the perfect value
     * for you. Maybe, 1 or 2 is a good start.
     *
     * @var int $_hashedDirectoryLevel
     */
     var $_hashedDirectoryLevel = 0;
-    
+
     /**
     * Umask for hashed directory structure
     *
     * @var int $_hashedDirectoryUmask
     */
     var $_hashedDirectoryUmask = 0700;
-    
+
     /**
      * API break for error handling in CACHE_LITE_ERROR_RETURN mode
-     * 
+     *
      * In CACHE_LITE_ERROR_RETURN mode, error handling was not good because
      * for example save() method always returned a boolean (a PEAR_Error object
      * would be better in CACHE_LITE_ERROR_RETURN mode). To correct this without
      * breaking the API, this option (false by default) can change this handling.
-     * 
+     *
      * @var boolean
      */
     var $_errorHandlingAPIBreak = false;
-	
+
 	var $_hashedDirectoryGroup = NULL;
-	
+
 	var $_cacheFileMode = NULL;
-	
+
 	var $_cacheFileGroup = NULL;
-    
+
     // --- Public methods ---
 
     /**
@@ -282,12 +282,12 @@ class Cache_Lite
 	*     'cacheFileMode' => filesystem mode of newly created cache files (int)
 	*     'cacheFileGroup' => group of newly created cache files (int | string) (see function chgrp)
     * );
-    * 
+    *
-    * If sys_get_temp_dir() is available and the 
+    * If sys_get_temp_dir() is available and the
-    * 'cacheDir' option is not provided in the 
+    * 'cacheDir' option is not provided in the
-    * constructor options array its output is used 
+    * constructor options array its output is used
     * to determine the suitable temporary directory.
-    * 
+    *
     * @see http://de.php.net/sys_get_temp_dir
     * @see http://pear.php.net/bugs/bug.php?id=18328
     *
@@ -313,7 +313,7 @@ class Cache_Lite
     {
         self::__construct($options);
     }
-    
+
     /**
     * Generic way to set a Cache_Lite option
     *
@@ -323,7 +323,7 @@ class Cache_Lite
     * @var mixed $value value of the option
     * @access public
     */
-    function setOption($name, $value) 
+    function setOption($name, $value)
     {
         $availableOptions = array('errorHandlingAPIBreak', 'hashedDirectoryUmask', 'hashedDirectoryLevel', 'automaticCleaningFactor', 'automaticSerialization', 'fileNameProtection', 'memoryCaching', 'onlyMemoryCaching', 'memoryCachingLimit', 'cacheDir', 'caching', 'lifeTime', 'fileLocking', 'writeControl', 'readControl', 'readControlType', 'pearErrorMode', 'hashedDirectoryGroup', 'cacheFileMode', 'cacheFileGroup');
         if (in_array($name, $availableOptions)) {
@@ -331,7 +331,7 @@ class Cache_Lite
             $this->$property = $value;
         }
     }
-    
+
     /**
     * Test if a cache is available and (if yes) return it
     *
@@ -359,7 +359,7 @@ class Cache_Lite
                 }
                 if ($this->_onlyMemoryCaching) {
                     return false;
-                }                
+                }
             }
             if (($doNotTestCacheValidity) || (is_null($this->_refreshTime))) {
                 if (file_exists($this->_file)) {
@@ -380,7 +380,7 @@ class Cache_Lite
         }
         return false;
     }
-    
+
     /**
     * Save some data in a cache file
     *
@@ -406,24 +406,24 @@ class Cache_Lite
                 }
             }
             if ($this->_automaticCleaningFactor>0 && ($this->_automaticCleaningFactor==1 || mt_rand(1, $this->_automaticCleaningFactor)==1)) {
-				$this->clean(false, 'old');			
+				$this->clean(false, 'old');
 			}
             if ($this->_writeControl) {
                 $res = $this->_writeAndControl($data);
                 if (is_bool($res)) {
                     if ($res) {
-                        return true;  
+                        return true;
                     }
                     // if $res if false, we need to invalidate the cache
                     @touch($this->_file, time() - 2*abs($this->_lifeTime));
                     return false;
-                }            
+                }
             } else {
                 $res = $this->_write($data);
             }
             if (is_object($res)) {
-                // $res is a PEAR_Error object 
+                // $res is a PEAR_Error object
-                if (!($this->_errorHandlingAPIBreak)) {   
+                if (!($this->_errorHandlingAPIBreak)) {
                     return false; // we return false (old API)
                 }
             }
@@ -466,7 +466,7 @@ class Cache_Lite
     * else only cache files of the specified group will be destroyed
     *
     * @param string $group name of the cache group
-    * @param string $mode flush cache mode : 'old', 'ingroup', 'notingroup', 
+    * @param string $mode flush cache mode : 'old', 'ingroup', 'notingroup',
     *                                        'callback_myFunction'
     * @return boolean true if no problem
     * @access public
@@ -475,12 +475,12 @@ class Cache_Lite
     {
         return $this->_cleanDir($this->_cacheDir, $group, $mode);
     }
-       
+
     /**
     * Set to debug mode
     *
     * When an error is found, the script will stop and the message will be displayed
-    * (in debug mode only). 
+    * (in debug mode only).
     *
     * @access public
     */
@@ -538,7 +538,7 @@ class Cache_Lite
             }
         }
     }
-    
+
     /**
     * Return the cache last modification time
     *
@@ -546,11 +546,11 @@ class Cache_Lite
     *
     * @return int last modification time
     */
-    function lastModified() 
+    function lastModified()
     {
         return @filemtime($this->_file);
     }
-    
+
     /**
     * Trigger a PEAR error
     *
@@ -564,29 +564,29 @@ class Cache_Lite
     */
     function raiseError($msg, $code)
     {
-        error_log("[code] $msg");
+        return PEAR::raiseError($msg, $code, $this->_pearErrorMode);
     }
-    
+
     /**
      * Extend the life of a valid cache file
-     * 
+     *
      * see http://pear.php.net/bugs/bug.php?id=6681
-     * 
+     *
      * @access public
      */
     function extendLife()
     {
         @touch($this->_file);
     }
-    
+
     // --- Private methods ---
-    
+
     /**
     * Compute & set the refresh time
     *
     * @access private
     */
-    function _setRefreshTime() 
+    function _setRefreshTime()
     {
         if (is_null($this->_lifeTime)) {
             $this->_refreshTime = null;
@@ -594,10 +594,10 @@ class Cache_Lite
             $this->_refreshTime = time() - $this->_lifeTime;
         }
     }
-    
+
     /**
     * Remove a file
-    * 
+    *
     * @param string $file complete file path and name
     * @return boolean true if no problem
     * @access private
@@ -607,7 +607,7 @@ class Cache_Lite
         if (!@unlink($file)) {
             return $this->raiseError('Cache_Lite : Unable to remove cache !', -3);
         }
-        return true;        
+        return true;
     }
 
     /**
@@ -620,7 +620,7 @@ class Cache_Lite
     * @return boolean true if no problem
     * @access private
     */
-    function _cleanDir($dir, $group = false, $mode = 'ingroup')     
+    function _cleanDir($dir, $group = false, $mode = 'ingroup')
     {
         if ($this->_fileNameProtection) {
             $motif = ($group) ? 'cache_'.md5($group).'_' : 'cache_';
@@ -638,7 +638,7 @@ class Cache_Lite
                 return true;
             }
         }
-        if (!($dh = opendir($dir))) {
+        if (!($dh = @opendir($dir))) {
             return $this->raiseError('Cache_Lite : Unable to open cache directory !', -4);
         }
         $result = true;
@@ -710,7 +710,7 @@ class Cache_Lite
             $key = key($this->_memoryCachingArray);
             next($this->_memoryCachingArray);
             unset($this->_memoryCachingArray[$key]);
-            
+
         } else {
             $this->_memoryCachingCounter = $this->_memoryCachingCounter + 1;
         }
@@ -725,7 +725,7 @@ class Cache_Lite
     */
     function _setFileName($id, $group)
     {
-        
+
         if ($this->_fileNameProtection) {
             $suffix = 'cache_'.md5($group).'_'.md5($id);
         } else {
@@ -736,12 +736,12 @@ class Cache_Lite
             $hash = md5($suffix);
             for ($i=0 ; $i<$this->_hashedDirectoryLevel ; $i++) {
                 $root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
-            }   
+            }
         }
         $this->_fileName = $suffix;
         $this->_file = $root.$suffix;
     }
-    
+
     /**
     * Read the cache file and return the content
     *
@@ -781,7 +781,7 @@ class Cache_Lite
                 $hashData = $this->_hash($data, $this->_readControlType);
                 if ($hashData != $hashControl) {
                     if (!(is_null($this->_lifeTime))) {
-                        @touch($this->_file, time() - 2*abs($this->_lifeTime)); 
+                        @touch($this->_file, time() - 2*abs($this->_lifeTime));
                     } else {
                         @unlink($this->_file);
                     }
@@ -790,9 +790,9 @@ class Cache_Lite
             }
             return $data;
         }
-        return $this->raiseError('Cache_Lite : Unable to read cache !', -2); 
+        return $this->raiseError('Cache_Lite : Unable to read cache !', -2);
     }
-    
+
     /**
     * Write the given data in the cache file
     *
@@ -819,7 +819,7 @@ class Cache_Lite
         }
 		// if both _cacheFileMode and _cacheFileGroup is null, then we don't need to call
 		// file_exists (see below: if ($is_newfile) ...)
-		$is_newfile = (! is_null($this->_cacheFileMode) || !is_null($this->_cacheFileGroup)) 
+		$is_newfile = (! is_null($this->_cacheFileMode) || !is_null($this->_cacheFileGroup))
 			&& ! @file_exists($this->_file);
         $fp = @fopen($this->_file, "wb");
         if ($fp) {
@@ -845,10 +845,10 @@ class Cache_Lite
             if ($this->_fileLocking) @flock($fp, LOCK_UN);
             @fclose($fp);
             return true;
-        }      
+        }
         return $this->raiseError('Cache_Lite : Unable to write cache file : '.$this->_file, -1);
     }
-       
+
     /**
     * Write the given data in the cache file and control it just after to avoir corrupted cache entries
     *
@@ -867,11 +867,11 @@ class Cache_Lite
             return $dataRead; # We return the PEAR_Error object
         }
         if ((is_bool($dataRead)) && (!$dataRead)) {
-            return false; 
+            return false;
         }
         return ($dataRead==$data);
     }
-    
+
     /**
     * Make a control key with the string containing datas
     *
@@ -893,5 +893,5 @@ class Cache_Lite
             return $this->raiseError('Unknown controlType ! (available values are only \'md5\', \'crc32\', \'strlen\')', -5);
         }
     }
-    
+
-} 
+}

proxy/mailing/confirm.php

@@ -19,7 +19,7 @@ civiproxy_security_check('mail-confirm');
 // basic restraints
 $valid_parameters = array(    'sid'          => 'int',
                               'cid'          => 'int', 
-                              'h'            => 'hex');
+                              'h'            => 'string');
 $parameters = civiproxy_get_parameters($valid_parameters);
 
 // check if parameters specified

proxy/mailing/resubscribe.php

@@ -19,7 +19,7 @@ civiproxy_security_check('mail-resubscribe');
 // basic restraints
 $valid_parameters = array(    'jid'          => 'int',
                               'qid'          => 'int', 
-                              'h'            => 'hex');
+                              'h'            => 'string');
 $parameters = civiproxy_get_parameters($valid_parameters);
 
 // check if parameters specified

proxy/mailing/unsubscribe.php

@@ -19,7 +19,7 @@ civiproxy_security_check('mail-unsubscribe');
 // basic restraints
 $valid_parameters = array(    'jid'          => 'int',
                               'qid'          => 'int', 
-                              'h'            => 'hex');
+                              'h'            => 'string');
 $parameters = civiproxy_get_parameters($valid_parameters);
 
 // check if parameters specified

proxy/open.php

@@ -16,11 +16,5 @@ if (!$target_open) civiproxy_http_error("Feature disabled", 405);
 // basic check
 civiproxy_security_check('open');
 
-// basic restraints
+$parameters = civiproxy_get_parameters($valid_open_parameters);
-$valid_parameters = [
-  'q'   => 'int',
-  'qid' => 'int',
-];
-
-$parameters = civiproxy_get_parameters($valid_parameters);
 civiproxy_redirect($target_open, $parameters);

proxy/proxy.php

@@ -8,7 +8,7 @@
 +---------------------------------------------------------*/
 
 require_once "config.php";
-$civiproxy_version = '0.7.0';
+$civiproxy_version = '1.0.0-beta';
 
 /**
  * this will redirect the request to another URL,

proxy/url.php

@@ -16,10 +16,5 @@ if (!$target_url) civiproxy_http_error("Feature disabled", 405);
 // basic check
 civiproxy_security_check('url');
 
-// basic restraints
+$parameters = civiproxy_get_parameters($valid_url_parameters);
-$valid_parameters = array(  'u'   => 'int',
-                            'q'   => 'int',
-                            'qid' => 'int');
-
-$parameters = civiproxy_get_parameters($valid_parameters);
 civiproxy_redirect($target_url, $parameters);

proxy/webhook2api.php

@@ -126,8 +126,8 @@ function webhook2api_processConfiguration($configuration, $post_input) {
     }
     if (!empty($result['values']['http_code'])) {
       $http_code = $result['values']['http_code'];
-    } else {
+    } elseif ($result['is_error'] != 0) {
-      $http_code = 403;
+        $http_code = 403;
     }
   }
   if ($http_code != '200') {