CRM/Core/BAO/Block.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  * Add static functions to include some common functionality used across location sub object BAO classes.
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  */
  18 class CRM_Core_BAO_Block {
  19
  20   /**
  21    * Fields that are required for a valid block.
  22    * @var array
  23    */
  24   public static $requiredBlockFields = [
  25     'email' => ['email'],
  26     'phone' => ['phone'],
  27     'im' => ['name'],
  28     'openid' => ['openid'],
  29   ];
  30
  31   /**
  32    * Given the list of params in the params array, fetch the object
  33    * and store the values in the values array
  34    *
  35    * @param string $blockName
  36    *   Name of the above object.
  37    * @param array $params
  38    *   Input parameters to find object.
  39    *
  40    * @return array
  41    *   Array of $block objects.
  42    * @throws CRM_Core_Exception
  43    */
  44   public static function &getValues($blockName, $params) {
  45     if (empty($params)) {
  46       return NULL;
  47     }
  48     $BAOString = 'CRM_Core_BAO_' . $blockName;
  49     $block = new $BAOString();
  50
  51     $blocks = [];
  52     if (!isset($params['entity_table'])) {
  53       $block->contact_id = $params['contact_id'];
  54       if (!$block->contact_id) {
  55         throw new CRM_Core_Exception('Invalid Contact ID parameter passed');
  56       }
  57       $blocks = self::retrieveBlock($block, $blockName);
  58     }
  59     else {
  60       $blockIds = self::getBlockIds($blockName, NULL, $params);
  61
  62       if (empty($blockIds)) {
  63         return $blocks;
  64       }
  65
  66       $count = 1;
  67       foreach ($blockIds as $blockId) {
  68         $block = new $BAOString();
  69         $block->id = $blockId['id'];
  70         $getBlocks = self::retrieveBlock($block, $blockName);
  71         $blocks[$count++] = array_pop($getBlocks);
  72       }
  73     }
  74
  75     return $blocks;
  76   }
  77
  78   /**
  79    * Given the list of params in the params array, fetch the object
  80    * and store the values in the values array
  81    *
  82    * @param Object $block
  83    *   Typically a Phone|Email|IM|OpenID object.
  84    * @param string $blockName
  85    *   Name of the above object.
  86    *
  87    * @return array
  88    *   Array of $block objects.
  89    */
  90   public static function retrieveBlock(&$block, $blockName) {
  91     // we first get the primary location due to the order by clause
  92     $block->orderBy('is_primary desc, id');
  93     $block->find();
  94
  95     $count = 1;
  96     $blocks = [];
  97     while ($block->fetch()) {
  98       CRM_Core_DAO::storeValues($block, $blocks[$count]);
  99       //unset is_primary after first block. Due to some bug in earlier version
 100       //there might be more than one primary blocks, hence unset is_primary other than first
 101       if ($count > 1) {
 102         unset($blocks[$count]['is_primary']);
 103       }
 104       $count++;
 105     }
 106
 107     return $blocks;
 108   }
 109
 110   /**
 111    * Check if the current block object has any valid data.
 112    *
 113    * @param array $blockFields
 114    *   Array of fields that are of interest for this object.
 115    * @param array $params
 116    *   Associated array of submitted fields.
 117    *
 118    * @return bool
 119    *   true if the block has data, otherwise false
 120    */
 121   public static function dataExists($blockFields, &$params) {
 122     foreach ($blockFields as $field) {
 123       if (CRM_Utils_System::isNull(CRM_Utils_Array::value($field, $params))) {
 124         return FALSE;
 125       }
 126     }
 127     return TRUE;
 128   }
 129
 130   /**
 131    * Check if the current block exits.
 132    *
 133    * @param string $blockName
 134    *   Block name.
 135    * @param array $params
 136    *   Array of submitted fields.
 137    *
 138    * @return bool
 139    *   true if the block is in the params and is an array
 140    */
 141   public static function blockExists($blockName, $params) {
 142     return !empty($params[$blockName]) && is_array($params[$blockName]);
 143   }
 144
 145   /**
 146    * Get all block ids for a contact.
 147    *
 148    * @param string $blockName
 149    *   Block name.
 150    * @param int $contactId
 151    *   Contact id.
 152    *
 153    * @param null $entityElements
 154    * @param bool $updateBlankLocInfo
 155    *
 156    * @return array
 157    *   formatted array of block ids
 158    *
 159    */
 160   public static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) {
 161     $allBlocks = [];
 162
 163     $name = ucfirst($blockName);
 164     if ($blockName == 'im') {
 165       $name = 'IM';
 166     }
 167     elseif ($blockName == 'openid') {
 168       $name = 'OpenID';
 169     }
 170
 171     $baoString = 'CRM_Core_BAO_' . $name;
 172     if ($contactId) {
 173       //@todo a cleverer way to do this would be to use the same fn name on each
 174       // BAO rather than constructing the fn
 175       // it would also be easier to grep for
 176       // e.g $bao = new $baoString;
 177       // $bao->getAllBlocks()
 178       $baoFunction = 'all' . $name . 's';
 179       $allBlocks = $baoString::$baoFunction($contactId, $updateBlankLocInfo);
 180     }
 181     elseif (!empty($entityElements) && $blockName != 'openid') {
 182       $baoFunction = 'allEntity' . $name . 's';
 183       $allBlocks = $baoString::$baoFunction($entityElements);
 184     }
 185
 186     return $allBlocks;
 187   }
 188
 189   /**
 190    * Takes an associative array and creates a block.
 191    *
 192    * @param string $blockName
 193    *   Block name.
 194    * @param array $params
 195    *   Array of name/value pairs.
 196    *
 197    * @return array|null
 198    *   Array of created location entities or NULL if none to create.
 199    */
 200   public static function create($blockName, $params) {
 201     if (!self::blockExists($blockName, $params)) {
 202       return NULL;
 203     }
 204
 205     $name = ucfirst($blockName);
 206     $isPrimary = $isBilling = TRUE;
 207     $entityElements = $blocks = [];
 208     $resetPrimaryId = NULL;
 209     $primaryId = FALSE;
 210
 211     $contactId = $params['contact_id'];
 212
 213     $updateBlankLocInfo = CRM_Utils_Array::value('updateBlankLocInfo', $params, FALSE);
 214     $isIdSet = CRM_Utils_Array::value('isIdSet', $params[$blockName], FALSE);
 215
 216     //get existing block ids.
 217     $blockIds = self::getBlockIds($blockName, $contactId, $entityElements);
 218     foreach ($params[$blockName] as $count => $value) {
 219       $blockId = $value['id'] ?? NULL;
 220       if ($blockId) {
 221         if (is_array($blockIds) && array_key_exists($blockId, $blockIds)) {
 222           unset($blockIds[$blockId]);
 223         }
 224         else {
 225           unset($value['id']);
 226         }
 227       }
 228     }
 229     $baoString = 'CRM_Core_BAO_' . $name;
 230     foreach ($params[$blockName] as $count => $value) {
 231       if (!is_array($value)) {
 232         continue;
 233       }
 234       // if in some cases (eg. email used in Online Conribution Page, Profiles, etc.) id is not set
 235       // lets try to add using the previous method to avoid any false creation of existing data.
 236       foreach ($blockIds as $blockId => $blockValue) {
 237         if (empty($value['id']) && $blockValue['locationTypeId'] == CRM_Utils_Array::value('location_type_id', $value) && !$isIdSet) {
 238           $valueId = FALSE;
 239           if ($blockName == 'phone') {
 240             $phoneTypeBlockValue = $blockValue['phoneTypeId'] ?? NULL;
 241             if ($phoneTypeBlockValue == CRM_Utils_Array::value('phone_type_id', $value)) {
 242               $valueId = TRUE;
 243             }
 244           }
 245           elseif ($blockName == 'im') {
 246             $providerBlockValue = $blockValue['providerId'] ?? NULL;
 247             if (!empty($value['provider_id']) && $providerBlockValue == $value['provider_id']) {
 248               $valueId = TRUE;
 249             }
 250           }
 251           else {
 252             $valueId = TRUE;
 253           }
 254           if ($valueId) {
 255             $value['id'] = $blockValue['id'];
 256             if (!$primaryId && !empty($blockValue['is_primary'])) {
 257               $value['is_primary'] = $blockValue['is_primary'];
 258             }
 259             break;
 260           }
 261         }
 262       }
 263       $dataExists = self::dataExists(self::$requiredBlockFields[$blockName], $value);
 264       // Note there could be cases when block info already exist ($value[id] is set) for a contact/entity
 265       // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
 266       // $updateBlankLocInfo will help take appropriate decision. CRM-5969
 267       if (!empty($value['id']) && !$dataExists && $updateBlankLocInfo) {
 268         //delete the existing record
 269         $baoString::del($value['id']);
 270         continue;
 271       }
 272       elseif (!$dataExists) {
 273         continue;
 274       }
 275       $contactFields = [
 276         'contact_id' => $contactId,
 277         'location_type_id' => $value['location_type_id'] ?? NULL,
 278       ];
 279
 280       $contactFields['is_billing'] = 0;
 281       if ($isBilling && !empty($value['is_billing'])) {
 282         $contactFields['is_billing'] = $value['is_billing'];
 283         $isBilling = FALSE;
 284       }
 285
 286       $blockFields = array_merge($value, $contactFields);
 287       $blocks[] = $baoString::create($blockFields);
 288     }
 289
 290     return $blocks;
 291   }
 292
 293   /**
 294    * Delete block.
 295    * @deprecated - just call the BAO / api directly.
 296    *
 297    * @param string $blockName
 298    *   Block name.
 299    * @param int $params
 300    *   Associates array.
 301    */
 302   public static function blockDelete($blockName, $params) {
 303     $name = ucfirst($blockName);
 304     if ($blockName == 'im') {
 305       $name = 'IM';
 306     }
 307     elseif ($blockName == 'openid') {
 308       $name = 'OpenID';
 309     }
 310
 311     $baoString = 'CRM_Core_BAO_' . $name;
 312     $baoString::del($params['id']);
 313   }
 314
 315   /**
 316    * Handling for is_primary.
 317    * $params is_primary could be
 318    *  #  1 - find other entries with is_primary = 1 &  reset them to 0
 319    *  #  0 - make sure at least one entry is set to 1
 320    *            - if no other entry is 1 change to 1
 321    *            - if one other entry exists change that to 1
 322    *            - if more than one other entry exists change first one to 1
 323    * @fixme - perhaps should choose by location_type
 324    *  #  empty - same as 0 as once we have checked first step
 325    *             we know if it should be 1 or 0
 326    *
 327    *  if $params['id'] is set $params['contact_id'] may need to be retrieved
 328    *
 329    * @param array $params
 330    * @param $class
 331    *
 332    * @throws API_Exception
 333    */
 334   public static function handlePrimary(&$params, $class) {
 335     if (isset($params['id']) && CRM_Utils_System::isNull($params['is_primary'] ?? NULL)) {
 336       // if id is set & is_primary isn't we can assume no change)
 337       return;
 338     }
 339     $table = CRM_Core_DAO_AllCoreTables::getTableForClass($class);
 340     if (!$table) {
 341       throw new API_Exception("Failed to locate table for class [$class]");
 342     }
 343
 344     // contact_id in params might be empty or the string 'null' so cast to integer
 345     $contactId = (int) ($params['contact_id'] ?? 0);
 346     // If id is set & we haven't been passed a contact_id, retrieve it
 347     if (!empty($params['id']) && !isset($params['contact_id'])) {
 348       $entity = new $class();
 349       $entity->id = $params['id'];
 350       $entity->find(TRUE);
 351       $contactId = $entity->contact_id;
 352     }
 353     // If entity is not associated with contact, concept of is_primary not relevant
 354     if (!$contactId) {
 355       return;
 356     }
 357
 358     // if params is_primary then set all others to not be primary & exit out
 359     // if is_primary = 1
 360     if (!empty($params['is_primary'])) {
 361       $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
 362       $sqlParams = [1 => [$contactId, 'Integer']];
 363       // we don't want to create unnecessary entries in the log_ tables so exclude the one we are working on
 364       if (!empty($params['id'])) {
 365         $sql .= " AND id <> %2";
 366         $sqlParams[2] = [$params['id'], 'Integer'];
 367       }
 368       CRM_Core_DAO::executeQuery($sql, $sqlParams);
 369       return;
 370     }
 371
 372     //Check what other emails exist for the contact
 373     $existingEntities = new $class();
 374     $existingEntities->contact_id = $contactId;
 375     $existingEntities->orderBy('is_primary DESC');
 376     if (!$existingEntities->find(TRUE) || (!empty($params['id']) && $existingEntities->id == $params['id'])) {
 377       // ie. if  no others is set to be primary then this has to be primary set to 1 so change
 378       $params['is_primary'] = 1;
 379       return;
 380     }
 381     else {
 382       /*
 383        * If the only existing email is the one we are editing then we must set
 384        * is_primary to 1
 385        * @see https://issues.civicrm.org/jira/browse/CRM-10451
 386        */
 387       if ($existingEntities->N == 1 && $existingEntities->id == CRM_Utils_Array::value('id', $params)) {
 388         $params['is_primary'] = 1;
 389         return;
 390       }
 391
 392       if ($existingEntities->is_primary == 1) {
 393         return;
 394       }
 395       // so at this point we are only dealing with ones explicity setting is_primary to 0
 396       // since we have reverse sorted by email we can either set the first one to
 397       // primary or return if is already is
 398       $existingEntities->is_primary = 1;
 399       $existingEntities->save();
 400     }
 401   }
 402
 403   /**
 404    * Sort location array so primary element is first.
 405    *
 406    * @param array $locations
 407    */
 408   public static function sortPrimaryFirst(&$locations) {
 409     uasort($locations, 'self::primaryComparison');
 410   }
 411
 412   /**
 413    * compare 2 locations to see which should go first based on is_primary
 414    * (sort function for sortPrimaryFirst)
 415    * @param array $location1
 416    * @param array $location2
 417    * @return int
 418    */
 419   public static function primaryComparison($location1, $location2) {
 420     $l1 = $location1['is_primary'] ?? NULL;
 421     $l2 = $location2['is_primary'] ?? NULL;
 422     if ($l1 == $l2) {
 423       return 0;
 424     }
 425     return ($l1 < $l2) ? -1 : 1;
 426   }
 427
 428 }