CRM/Core/BAO/Email.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 use Civi\Api4\Email;
  19
  20 /**
  21  * This class contains functions for email handling.
  22  */
  23 class CRM_Core_BAO_Email extends CRM_Core_DAO_Email {
  24   use CRM_Contact_AccessTrait;
  25
  26   /**
  27    * Create email address.
  28    *
  29    * Note that the create function calls 'add' but  has more business logic.
  30    *
  31    * @param array $params
  32    *   Input parameters.
  33    *
  34    * @return object
  35    */
  36   public static function create($params) {
  37     CRM_Core_BAO_Block::handlePrimary($params, get_class());
  38
  39     $hook = empty($params['id']) ? 'create' : 'edit';
  40     CRM_Utils_Hook::pre($hook, 'Email', CRM_Utils_Array::value('id', $params), $params);
  41
  42     $email = new CRM_Core_DAO_Email();
  43     $email->copyValues($params);
  44     if (!empty($email->email)) {
  45       // lower case email field to optimize queries
  46       $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
  47       $email->email = $strtolower($email->email);
  48     }
  49
  50     //
  51     // Since we're setting bulkmail for 1 of this contact's emails, first reset
  52     // all their other emails to is_bulkmail false. We shouldn't set the current
  53     // email to false even though we are about to reset it to avoid
  54     // contaminating the changelog if logging is enabled.  (only 1 email
  55     // address can have is_bulkmail = true)
  56     //
  57     // Note setting a the is_bulkmail to '' in $params results in $email->is_bulkmail === 'null'.
  58     // @see https://lab.civicrm.org/dev/core/-/issues/2254
  59     //
  60     if ($email->is_bulkmail == 1 && !empty($params['contact_id']) && !self::isMultipleBulkMail()) {
  61       $sql = "
  62 UPDATE civicrm_email
  63 SET    is_bulkmail = 0
  64 WHERE  contact_id = {$params['contact_id']}
  65 ";
  66       if ($hook === 'edit') {
  67         $sql .= " AND id <> {$params['id']}";
  68       }
  69       CRM_Core_DAO::executeQuery($sql);
  70     }
  71
  72     // handle if email is on hold
  73     self::holdEmail($email);
  74
  75     $email->save();
  76
  77     $contactId = (int) ($email->contact_id ?? CRM_Core_DAO::getFieldValue(__CLASS__, $email->id, 'contact_id'));
  78     if ($contactId && $email->is_primary) {
  79       $address = $email->email ?? CRM_Core_DAO::getFieldValue(__CLASS__, $email->id, 'email');
  80       self::updateContactName($contactId, $address);
  81     }
  82
  83     if ($email->is_primary) {
  84       // update the UF user email if that has changed
  85       CRM_Core_BAO_UFMatch::updateUFName($email->contact_id);
  86     }
  87
  88     CRM_Utils_Hook::post($hook, 'Email', $email->id, $email);
  89     return $email;
  90   }
  91
  92   /**
  93    * Takes an associative array and adds email.
  94    *
  95    * @param array $params
  96    *   (reference ) an assoc array of name/value pairs.
  97    *
  98    * @return object
  99    *   CRM_Core_BAO_Email object on success, null otherwise
 100    */
 101   public static function add(&$params) {
 102     CRM_Core_Error::deprecatedFunctionWarning('apiv4 create');
 103     return self::create($params);
 104   }
 105
 106   /**
 107    * Given the list of params in the params array, fetch the object
 108    * and store the values in the values array
 109    *
 110    * @param array $entityBlock
 111    *   Input parameters to find object.
 112    *
 113    * @return array
 114    */
 115   public static function getValues($entityBlock) {
 116     return CRM_Core_BAO_Block::getValues('email', $entityBlock);
 117   }
 118
 119   /**
 120    * Get all the emails for a specified contact_id, with the primary email being first
 121    *
 122    * @param int $id
 123    *   The contact id.
 124    *
 125    * @param bool $updateBlankLocInfo
 126    *
 127    * @return array
 128    *   the array of email id's
 129    */
 130   public static function allEmails($id, $updateBlankLocInfo = FALSE) {
 131     if (!$id) {
 132       return NULL;
 133     }
 134
 135     $query = "
 136 SELECT    email,
 137           civicrm_location_type.name as locationType,
 138           civicrm_email.is_primary as is_primary,
 139           civicrm_email.on_hold as on_hold,
 140           civicrm_email.id as email_id,
 141           civicrm_email.location_type_id as locationTypeId
 142 FROM      civicrm_contact
 143 LEFT JOIN civicrm_email ON ( civicrm_email.contact_id = civicrm_contact.id )
 144 LEFT JOIN civicrm_location_type ON ( civicrm_email.location_type_id = civicrm_location_type.id )
 145 WHERE     civicrm_contact.id = %1
 146 ORDER BY  civicrm_email.is_primary DESC, email_id ASC ";
 147     $params = [
 148       1 => [
 149         $id,
 150         'Integer',
 151       ],
 152     ];
 153
 154     $emails = $values = [];
 155     $dao = CRM_Core_DAO::executeQuery($query, $params);
 156     $count = 1;
 157     while ($dao->fetch()) {
 158       $values = [
 159         'locationType' => $dao->locationType,
 160         'is_primary' => $dao->is_primary,
 161         'on_hold' => $dao->on_hold,
 162         'id' => $dao->email_id,
 163         'email' => $dao->email,
 164         'locationTypeId' => $dao->locationTypeId,
 165       ];
 166
 167       if ($updateBlankLocInfo) {
 168         $emails[$count++] = $values;
 169       }
 170       else {
 171         $emails[$dao->email_id] = $values;
 172       }
 173     }
 174     return $emails;
 175   }
 176
 177   /**
 178    * Get all the emails for a specified location_block id, with the primary email being first
 179    *
 180    * @param array $entityElements
 181    *   The array containing entity_id and.
 182    *   entity_table name
 183    *
 184    * @return array
 185    *   the array of email id's
 186    */
 187   public static function allEntityEmails(&$entityElements) {
 188     if (empty($entityElements)) {
 189       return NULL;
 190     }
 191
 192     $entityId = $entityElements['entity_id'];
 193     $entityTable = $entityElements['entity_table'];
 194
 195     $sql = " SELECT email, ltype.name as locationType, e.is_primary as is_primary, e.on_hold as on_hold,e.id as email_id, e.location_type_id as locationTypeId
 196 FROM civicrm_loc_block loc, civicrm_email e, civicrm_location_type ltype, {$entityTable} ev
 197 WHERE ev.id = %1
 198 AND   loc.id = ev.loc_block_id
 199 AND   e.id IN (loc.email_id, loc.email_2_id)
 200 AND   ltype.id = e.location_type_id
 201 ORDER BY e.is_primary DESC, email_id ASC ";
 202
 203     $params = [
 204       1 => [
 205         $entityId,
 206         'Integer',
 207       ],
 208     ];
 209
 210     $emails = [];
 211     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 212     while ($dao->fetch()) {
 213       $emails[$dao->email_id] = [
 214         'locationType' => $dao->locationType,
 215         'is_primary' => $dao->is_primary,
 216         'on_hold' => $dao->on_hold,
 217         'id' => $dao->email_id,
 218         'email' => $dao->email,
 219         'locationTypeId' => $dao->locationTypeId,
 220       ];
 221     }
 222
 223     return $emails;
 224   }
 225
 226   /**
 227    * Set / reset hold status for an email
 228    *
 229    * @param object $email
 230    *   Email object.
 231    */
 232   public static function holdEmail(&$email) {
 233     if ($email->id && $email->on_hold === NULL) {
 234       // email is being updated but no change to on_hold.
 235       return;
 236     }
 237     if ($email->on_hold === 'null' || $email->on_hold === NULL) {
 238       // legacy handling, deprecated.
 239       $email->on_hold = 0;
 240     }
 241     $email->on_hold = (int) $email->on_hold;
 242
 243     //check for update mode
 244     if ($email->id) {
 245       $params = [1 => [$email->id, 'Integer']];
 246       if ($email->on_hold) {
 247         $sql = "
 248 SELECT id
 249 FROM   civicrm_email
 250 WHERE  id = %1
 251 AND    hold_date IS NULL
 252 ";
 253         if (CRM_Core_DAO::singleValueQuery($sql, $params)) {
 254           $email->hold_date = date('YmdHis');
 255           $email->reset_date = 'null';
 256         }
 257       }
 258       elseif ($email->on_hold === 0) {
 259         // we do this lookup to see if reset_date should be changed.
 260         $sql = "
 261 SELECT id
 262 FROM   civicrm_email
 263 WHERE  id = %1
 264 AND    hold_date IS NOT NULL
 265 AND    reset_date IS NULL
 266 ";
 267         if (CRM_Core_DAO::singleValueQuery($sql, $params)) {
 268           //set reset date only if it is not set and if hold date is set
 269           $email->on_hold = FALSE;
 270           $email->hold_date = 'null';
 271           $email->reset_date = date('YmdHis');
 272         }
 273       }
 274     }
 275     else {
 276       if ($email->on_hold) {
 277         $email->hold_date = date('YmdHis');
 278       }
 279     }
 280   }
 281
 282   /**
 283    * Generate an array of Domain email addresses.
 284    * @return array $domainEmails;
 285    */
 286   public static function domainEmails() {
 287     $domainEmails = [];
 288     $domainFrom = (array) CRM_Core_OptionGroup::values('from_email_address');
 289     foreach (array_keys($domainFrom) as $k) {
 290       $domainEmail = $domainFrom[$k];
 291       $domainEmails[$domainEmail] = htmlspecialchars($domainEmail);
 292     }
 293     return $domainEmails;
 294   }
 295
 296   /**
 297    * Build From Email as the combination of all the email ids of the logged in user and
 298    * the domain email id
 299    *
 300    * @return array
 301    *   an array of email ids
 302    */
 303   public static function getFromEmail() {
 304     // add all configured FROM email addresses
 305     $fromEmailValues = self::domainEmails();
 306
 307     if (!Civi::settings()->get('allow_mail_from_logged_in_contact')) {
 308       return $fromEmailValues;
 309     }
 310
 311     $contactFromEmails = [];
 312     // add logged in user's active email ids
 313     $contactID = CRM_Core_Session::getLoggedInContactID();
 314     if ($contactID) {
 315       $contactEmails = self::allEmails($contactID);
 316       $fromDisplayName  = CRM_Core_Session::singleton()->getLoggedInContactDisplayName();
 317
 318       foreach ($contactEmails as $emailId => $emailVal) {
 319         $email = trim($emailVal['email']);
 320         if (!$email || $emailVal['on_hold']) {
 321           continue;
 322         }
 323         $fromEmail = "$fromDisplayName <$email>";
 324         $fromEmailHtml = htmlspecialchars($fromEmail) . ' ' . $emailVal['locationType'];
 325
 326         if (!empty($emailVal['is_primary'])) {
 327           $fromEmailHtml .= ' ' . ts('(preferred)');
 328         }
 329         $contactFromEmails[$emailId] = $fromEmailHtml;
 330       }
 331     }
 332     return CRM_Utils_Array::crmArrayMerge($contactFromEmails, $fromEmailValues);
 333   }
 334
 335   /**
 336    * @return object
 337    */
 338   public static function isMultipleBulkMail() {
 339     return Civi::settings()->get('civimail_multiple_bulk_emails');
 340   }
 341
 342   /**
 343    * Call common delete function.
 344    *
 345    * @param int $id
 346    *
 347    * @return bool
 348    */
 349   public static function del($id) {
 350     return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Email', $id);
 351   }
 352
 353   /**
 354    * Get filters for entity reference fields.
 355    *
 356    * @return array
 357    */
 358   public static function getEntityRefFilters() {
 359     $contactFields = CRM_Contact_BAO_Contact::getEntityRefFilters();
 360     foreach ($contactFields as $index => &$contactField) {
 361       if (!empty($contactField['entity'])) {
 362         // For now email_getlist can't parse state, country etc.
 363         unset($contactFields[$index]);
 364       }
 365       elseif ($contactField['key'] !== 'contact_id') {
 366         $contactField['entity'] = 'Contact';
 367         $contactField['key'] = 'contact_id.' . $contactField['key'];
 368       }
 369     }
 370     return $contactFields;
 371   }
 372
 373   /**
 374    *
 375    *
 376    * @param int $contactId
 377    * @param string $primaryEmail
 378    */
 379   public static function updateContactName($contactId, string $primaryEmail) {
 380     if (is_string($primaryEmail) && $primaryEmail !== '' &&
 381       !CRM_Contact_BAO_Contact::hasName(['id' => $contactId])
 382     ) {
 383       CRM_Core_DAO::setFieldValue('CRM_Contact_DAO_Contact', $contactId, 'display_name', $primaryEmail);
 384       CRM_Core_DAO::setFieldValue('CRM_Contact_DAO_Contact', $contactId, 'sort_name', $primaryEmail);
 385     }
 386   }
 387
 388   /**
 389    * Get default text for a message with the signature from the email sender populated.
 390    *
 391    * @param int $emailID
 392    *
 393    * @return array
 394    *
 395    * @throws \API_Exception
 396    * @throws \Civi\API\Exception\UnauthorizedException
 397    */
 398   public static function getEmailSignatureDefaults(int $emailID): array {
 399     // Add signature
 400     $defaultEmail = Email::get(FALSE)
 401       ->addSelect('signature_html', 'signature_text')
 402       ->addWhere('id', '=', $emailID)->execute()->first();
 403     return [
 404       'html_message' => empty($defaultEmail['signature_html']) ? '' : '<br/><br/>--' . $defaultEmail['signature_html'],
 405       'text_message' => empty($defaultEmail['signature_text']) ? '' : "\n\n--\n" . $defaultEmail['signature_text'],
 406     ];
 407   }
 408
 409 }