CRM/Dedupe/MergeHandler.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  * This class exists primarily for the purposes of supporting code clean up in the Merger class.
  14  *
  15  * It is expected to be fast-moving and calling it outside the refactoring work is not advised.
  16  *
  17  * @package CRM
  18  * @copyright CiviCRM LLC https://civicrm.org/licensing
  19  */
  20 class CRM_Dedupe_MergeHandler {
  21
  22   /**
  23    * ID of contact to be kept.
  24    *
  25    * @var int
  26    */
  27   protected $toKeepID;
  28
  29   /**
  30    * ID of contact to be merged and deleted.
  31    *
  32    * @var int
  33    */
  34   protected $toRemoveID;
  35
  36   /**
  37    * Migration info array.
  38    *
  39    * This is a nasty bunch of data used in mysterious ways. We want to work to make it more
  40    * sensible but for now we store it.
  41    *
  42    * @var array
  43    */
  44   protected $migrationInfo = [];
  45
  46   /**
  47    * @return array
  48    */
  49   public function getMigrationInfo(): array {
  50     return $this->migrationInfo;
  51   }
  52
  53   /**
  54    * @param array $migrationInfo
  55    */
  56   public function setMigrationInfo(array $migrationInfo) {
  57     $this->migrationInfo = $migrationInfo;
  58   }
  59
  60   /**
  61    * @return mixed
  62    */
  63   public function getToKeepID() {
  64     return $this->toKeepID;
  65   }
  66
  67   /**
  68    * @param mixed $toKeepID
  69    */
  70   public function setToKeepID($toKeepID) {
  71     $this->toKeepID = $toKeepID;
  72   }
  73
  74   /**
  75    * @return mixed
  76    */
  77   public function getToRemoveID() {
  78     return $this->toRemoveID;
  79   }
  80
  81   /**
  82    * @param mixed $toRemoveID
  83    */
  84   public function setToRemoveID($toRemoveID) {
  85     $this->toRemoveID = $toRemoveID;
  86   }
  87
  88   /**
  89    * CRM_Dedupe_MergeHandler constructor.
  90    *
  91    * @param int $toKeepID
  92    *   ID of contact to be kept.
  93    * @param int $toRemoveID
  94    *   ID of contact to be removed.
  95    */
  96   public function __construct(int $toKeepID, int $toRemoveID) {
  97     $this->setToKeepID($toKeepID);
  98     $this->setToRemoveID($toRemoveID);
  99   }
 100
 101   /**
 102    * Get an array of tables that relate to the contact entity and will need consideration in a merge.
 103    *
 104    * The list of potential tables is filtered by tables which have data for the relevant contacts.
 105    */
 106   public function getTablesRelatedToTheMergePair() {
 107     $relTables = CRM_Dedupe_Merger::relTables();
 108     $activeRelTables = CRM_Dedupe_Merger::getActiveRelTables($this->toRemoveID);
 109     $activeMainRelTables = CRM_Dedupe_Merger::getActiveRelTables($this->toKeepID);
 110     foreach ($relTables as $name => $null) {
 111       if (!in_array($name, $activeRelTables, TRUE) &&
 112         !(($name === 'rel_table_users') && in_array($name, $activeMainRelTables, TRUE))
 113       ) {
 114         unset($relTables[$name]);
 115       }
 116     }
 117     return $relTables;
 118   }
 119
 120   /**
 121    * Get an array of tables that have a dynamic reference to the contact table.
 122    *
 123    * This would be the case when the table uses entity_table + entity_id rather than an FK.
 124    *
 125    * There are a number of tables that 'could' but don't have contact related data so we
 126    * do a cached check for this, ensuring the query is only done once per batch run.
 127    *
 128    * @return array
 129    */
 130   public function getTablesDynamicallyRelatedToContactTable() {
 131     if (!isset(\Civi::$statics[__CLASS__]['dynamic'])) {
 132       \Civi::$statics[__CLASS__]['dynamic'] = [];
 133       foreach (CRM_Core_DAO::getDynamicReferencesToTable('civicrm_contact') as $tableName => $fields) {
 134         if ($tableName === 'civicrm_financial_item') {
 135           // It turns out that civicrm_financial_item does not have an index on entity_table (only as the latter
 136           // part of a entity_id/entity_table index which probably is not adding any value over & above entity_id
 137           // only. This means this is a slow query. The correct fix is probably to add a whitelist to
 138           // values for entity_table in the schema.
 139           continue;
 140         }
 141         foreach ($fields as $field) {
 142           $sql[] = "(SELECT '$tableName' as civicrm_table, '{$field[0]}' as field_name FROM $tableName WHERE {$field[1]} = 'civicrm_contact' LIMIT 1)";
 143         }
 144       }
 145       $sqlString = implode(' UNION ', $sql);
 146       if ($sqlString) {
 147         $result = CRM_Core_DAO::executeQuery($sqlString);
 148         while ($result->fetch()) {
 149           \Civi::$statics[__CLASS__]['dynamic'][$result->civicrm_table] = $result->field_name;
 150         }
 151       }
 152     }
 153     return \Civi::$statics[__CLASS__]['dynamic'];
 154   }
 155
 156   /**
 157    * Get the location blocks designated to be moved during the merge.
 158    *
 159    * Note this is a refactoring step and future refactors should develop a more coherent array
 160    *
 161    * @return array
 162    *   The format is ['address' => [0 => ['is_replace' => TRUE]], 'email' => [0...],[1....]
 163    *   where the entity is address, the internal indexing for the addresses on both contact is 1
 164    *   and the intent to replace the existing address is TRUE.
 165    */
 166   public function getLocationBlocksToMerge(): array {
 167     $locBlocks = [];
 168     foreach ($this->getMigrationInfo() as $key => $value) {
 169       $isLocationField = (substr($key, 0, 14) === 'move_location_' and $value != NULL);
 170       if (!$isLocationField) {
 171         continue;
 172       }
 173       $locField = explode('_', $key);
 174       $fieldName = $locField[2];
 175       $fieldCount = $locField[3];
 176
 177       // Set up the operation type (add/overwrite)
 178       // Ignore operation for websites
 179       // @todo Tidy this up
 180       $operation = 0;
 181       if ($fieldName !== 'website') {
 182         $operation = $this->getMigrationInfo()['location_blocks'][$fieldName][$fieldCount]['operation'] ?? NULL;
 183       }
 184       // default operation is overwrite.
 185       if (!$operation) {
 186         $operation = 2;
 187       }
 188       $locBlocks[$fieldName][$fieldCount]['is_replace'] = $operation === 2;
 189     }
 190     return $locBlocks;
 191   }
 192
 193   /**
 194    * Copy the data to be moved to a new DAO object.
 195    *
 196    * This is intended as a refactoring step - not the long term function. Do not
 197    * call from any function other than the one it is taken from (Merger::mergeLocations).
 198    *
 199    * @param int $otherBlockId
 200    * @param string $name
 201    * @param int $blkCount
 202    *
 203    * @return CRM_Core_DAO_Address|CRM_Core_DAO_Email|CRM_Core_DAO_IM|CRM_Core_DAO_Phone|CRM_Core_DAO_Website
 204    *
 205    * @throws \CRM_Core_Exception
 206    */
 207   public function copyDataToNewBlockDAO($otherBlockId, $name, $blkCount) {
 208     // For the block which belongs to other-contact, link the location block to main-contact
 209     $otherBlockDAO = $this->getDAOForLocationEntity($name, $this->getSelectedLocationType($name, $blkCount), $this->getSelectedType($name, $blkCount));
 210     $otherBlockDAO->contact_id = $this->getToKeepID();
 211     // Get the ID of this block on the 'other' contact, otherwise skip
 212     $otherBlockDAO->id = $otherBlockId;
 213     return $otherBlockDAO;
 214   }
 215
 216   /**
 217    * Get the DAO object appropriate to the location entity.
 218    *
 219    * @param string $entity
 220    *
 221    * @param int|null $locationTypeID
 222    * @param int|null $typeID
 223    *
 224    * @return CRM_Core_DAO_Address|CRM_Core_DAO_Email|CRM_Core_DAO_IM|CRM_Core_DAO_Phone|CRM_Core_DAO_Website
 225    * @throws \CRM_Core_Exception
 226    */
 227   public function getDAOForLocationEntity($entity, $locationTypeID = NULL, $typeID = NULL) {
 228     switch ($entity) {
 229       case 'email':
 230         $dao = new CRM_Core_DAO_Email();
 231         $dao->location_type_id = $locationTypeID;
 232         return $dao;
 233
 234       case 'address':
 235         $dao = new CRM_Core_DAO_Address();
 236         $dao->location_type_id = $locationTypeID;
 237         return $dao;
 238
 239       case 'phone':
 240         $dao = new CRM_Core_DAO_Phone();
 241         $dao->location_type_id = $locationTypeID;
 242         $dao->phone_type_id = $typeID;
 243         return $dao;
 244
 245       case 'website':
 246         $dao = new CRM_Core_DAO_Website();
 247         $dao->website_type_id = $typeID;
 248         return $dao;
 249
 250       case 'im':
 251         $dao = new CRM_Core_DAO_IM();
 252         $dao->location_type_id = $locationTypeID;
 253         return $dao;
 254
 255       default:
 256         // Mostly here, along with the switch over a more concise format, to help IDEs understand the possibilities.
 257         throw new CRM_Core_Exception('Unsupported entity');
 258     }
 259   }
 260
 261   /**
 262    * Get the selected location type for the given location block.
 263    *
 264    * This will retrieve any user selection if they specified which location to move a block to.
 265    *
 266    * @param string $entity
 267    * @param int $blockIndex
 268    *
 269    * @return int|null
 270    */
 271   protected function getSelectedLocationType($entity, $blockIndex) {
 272     return $this->getMigrationInfo()['location_blocks'][$entity][$blockIndex]['locTypeId'] ?? NULL;
 273   }
 274
 275   /**
 276    * Get the selected type for the given location block.
 277    *
 278    * This will retrieve any user selection if they specified which type to move a block to (e.g 'Mobile' for phone).
 279    *
 280    * @param string $entity
 281    * @param int $blockIndex
 282    *
 283    * @return int|null
 284    */
 285   protected function getSelectedType($entity, $blockIndex) {
 286     return $this->getMigrationInfo()['location_blocks'][$entity][$blockIndex]['typeTypeId'] ?? NULL;
 287   }
 288
 289 }