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