CRM/ACL/BAO/Cache.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  *  Access Control Cache.
  20  */
  21 class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_ACLCache {
  22
  23   public static $_cache = NULL;
  24
  25   /**
  26    * Build an array of ACLs for a specific ACLed user
  27    * @param int $id - contact_id of the ACLed user
  28    *
  29    * @return mixed
  30    */
  31   public static function &build($id) {
  32     if (!self::$_cache) {
  33       self::$_cache = [];
  34     }
  35
  36     if (array_key_exists($id, self::$_cache)) {
  37       return self::$_cache[$id];
  38     }
  39
  40     // check if this entry exists in db
  41     // if so retrieve and return
  42     self::$_cache[$id] = self::retrieve($id);
  43     if (self::$_cache[$id]) {
  44       return self::$_cache[$id];
  45     }
  46
  47     self::$_cache[$id] = CRM_ACL_BAO_ACL::getAllByContact($id);
  48     self::store($id, self::$_cache[$id]);
  49     return self::$_cache[$id];
  50   }
  51
  52   /**
  53    * @param int $id
  54    *
  55    * @return array
  56    */
  57   public static function retrieve($id) {
  58     $query = "
  59 SELECT acl_id
  60   FROM civicrm_acl_cache
  61  WHERE contact_id = %1
  62 ";
  63     $params = [1 => [$id, 'Integer']];
  64
  65     if ($id == 0) {
  66       $query .= " OR contact_id IS NULL";
  67     }
  68
  69     $dao = CRM_Core_DAO::executeQuery($query, $params);
  70
  71     $cache = [];
  72     while ($dao->fetch()) {
  73       $cache[$dao->acl_id] = 1;
  74     }
  75     return $cache;
  76   }
  77
  78   /**
  79    * Store ACLs for a specific user in the `civicrm_acl_cache` table
  80    * @param int $id - contact_id of the ACLed user
  81    * @param array $cache - key civicrm_acl.id - values is the details of the ACL.
  82    *
  83    */
  84   public static function store($id, &$cache) {
  85     foreach ($cache as $aclID => $data) {
  86       $dao = new CRM_ACL_BAO_Cache();
  87       if ($id) {
  88         $dao->contact_id = $id;
  89       }
  90       $dao->acl_id = $aclID;
  91
  92       $cache[$aclID] = 1;
  93
  94       $dao->save();
  95     }
  96   }
  97
  98   /**
  99    * Remove entries from civicrm_acl_cache for a specified ACLed user
 100    * @param int $id - contact_id of the ACLed user
 101    *
 102    */
 103   public static function deleteEntry($id) {
 104     if (self::$_cache &&
 105       array_key_exists($id, self::$_cache)
 106     ) {
 107       unset(self::$_cache[$id]);
 108     }
 109
 110     $query = "
 111 DELETE FROM civicrm_acl_cache
 112 WHERE contact_id = %1
 113 ";
 114     $params = [1 => [$id, 'Integer']];
 115     CRM_Core_DAO::executeQuery($query, $params);
 116   }
 117
 118   /**
 119    * Do an opportunistic cache refresh if the site is configured for these.
 120    *
 121    * Sites that use acls and do not run the acl cache clearing cron job should
 122    * refresh the caches on demand. The user session will be forced to wait
 123    * and this is a common source of deadlocks, so it is less ideal.
 124    */
 125   public static function opportunisticCacheFlush(): void {
 126     if (Civi::settings()->get('acl_cache_refresh_mode') === 'opportunistic') {
 127       self::resetCache();
 128     }
 129   }
 130
 131   /**
 132    * Deletes all the cache entries.
 133    */
 134   public static function resetCache(): void {
 135     if (!CRM_Core_Config::isPermitCacheFlushMode()) {
 136       return;
 137     }
 138     // reset any static caching
 139     self::$_cache = NULL;
 140
 141     $query = "
 142 DELETE
 143 FROM   civicrm_acl_cache
 144 WHERE  modified_date IS NULL
 145    OR  (modified_date <= %1)
 146 ";
 147     $params = [
 148       1 => [
 149         CRM_Contact_BAO_GroupContactCache::getCacheInvalidDateTime(),
 150         'String',
 151       ],
 152     ];
 153     CRM_Core_DAO::singleValueQuery($query, $params);
 154
 155     // CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache"); // No, force-commits transaction
 156     // CRM_Core_DAO::singleValueQuery("DELETE FROM civicrm_acl_contact_cache"); // Transaction-safe
 157     if (CRM_Core_Transaction::isActive()) {
 158       CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_COMMIT, function () {
 159         CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache");
 160       });
 161     }
 162     else {
 163       CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache");
 164     }
 165   }
 166
 167   /**
 168    * Remove Entries from `civicrm_acl_contact_cache` for a specific ACLed user
 169    * @param int $userID - contact_id of the ACLed user
 170    *
 171    */
 172   public static function deleteContactCacheEntry($userID) {
 173     CRM_Core_DAO::executeQuery("DELETE FROM civicrm_acl_contact_cache WHERE user_id = %1", [1 => [$userID, 'Positive']]);
 174   }
 175
 176 }