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