CRM/Contact/Form/Task/EmailCommon.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the common functionality for sending email to
  38  * one or a group of contact ids. This class is reused by all the search
  39  * components in CiviCRM (since they all have send email as a task)
  40  */
  41 class CRM_Contact_Form_Task_EmailCommon {
  42   const MAX_EMAILS_KILL_SWITCH = 50;
  43
  44   public $_contactDetails = array();
  45   public $_allContactDetails = array();
  46   public $_toContactEmails = array();
  47
  48   /**
  49    * @param CRM_Core_Form $form
  50    */
  51   public static function preProcessFromAddress(&$form) {
  52     $form->_single = FALSE;
  53     $className = CRM_Utils_System::getClassName($form);
  54     if (property_exists($form, '_context') &&
  55       $form->_context != 'search' &&
  56       $className == 'CRM_Contact_Form_Task_Email'
  57     ) {
  58       $form->_single = TRUE;
  59     }
  60
  61     $form->_emails = $emails = array();
  62
  63     $session = CRM_Core_Session::singleton();
  64     $contactID = $session->get('userID');
  65
  66     $form->_contactIds = array($contactID);
  67     $contactEmails = CRM_Core_BAO_Email::allEmails($contactID);
  68
  69     $form->_onHold = array();
  70
  71     $fromDisplayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
  72       $contactID, 'display_name'
  73     );
  74
  75     foreach ($contactEmails as $emailId => $item) {
  76       $email = $item['email'];
  77       if (!$email && (count($emails) < 1)) {
  78         // set it if no emails are present at all
  79         $form->_noEmails = TRUE;
  80       }
  81       else {
  82         if ($email) {
  83           if (in_array($email, $emails)) {
  84             // CRM-3624
  85             continue;
  86           }
  87
  88           $emails[$emailId] = '"' . $fromDisplayName . '" <' . $email . '> ';
  89           $form->_onHold[$emailId] = $item['on_hold'];
  90           $form->_noEmails = FALSE;
  91         }
  92       }
  93
  94       $form->_emails[$emailId] = $emails[$emailId];
  95       $emails[$emailId] .= $item['locationType'];
  96
  97       if ($item['is_primary']) {
  98         $emails[$emailId] .= ' ' . ts('(preferred)');
  99       }
 100       $emails[$emailId] = htmlspecialchars($emails[$emailId]);
 101     }
 102
 103     $form->assign('noEmails', $form->_noEmails);
 104
 105     if ($form->_noEmails) {
 106       CRM_Core_Error::statusBounce(ts('Your user record does not have a valid email address'));
 107     }
 108
 109     // now add domain from addresses
 110     $domainEmails = array();
 111     $domainFrom = CRM_Core_OptionGroup::values('from_email_address');
 112     foreach (array_keys($domainFrom) as $k) {
 113       $domainEmail = $domainFrom[$k];
 114       $domainEmails[$domainEmail] = htmlspecialchars($domainEmail);
 115       $form->_emails[$domainEmail] = $domainEmail;
 116     }
 117
 118     $form->_fromEmails = CRM_Utils_Array::crmArrayMerge($emails, $domainEmails);
 119
 120     // Add signature
 121     $defaultEmail = civicrm_api3('email', 'getsingle', array('id' => key($form->_fromEmails)));
 122     $defaults = array();
 123     if (!empty($defaultEmail['signature_html'])) {
 124       $defaults['html_message'] = '<br/><br/>--' . $defaultEmail['signature_html'];
 125     }
 126     if (!empty($defaultEmail['signature_text'])) {
 127       $defaults['text_message'] = "\n\n--\n" . $defaultEmail['signature_text'];
 128     }
 129     $form->setDefaults($defaults);
 130   }
 131
 132   /**
 133    * Build the form object.
 134    *
 135    *
 136    * @param CRM_Core_Form $form
 137    *
 138    * @return void
 139    */
 140   public static function buildQuickForm(&$form) {
 141     $toArray = $ccArray = $bccArray = array();
 142     $suppressedEmails = 0;
 143     //here we are getting logged in user id as array but we need target contact id. CRM-5988
 144     $cid = $form->get('cid');
 145     if ($cid) {
 146       $form->_contactIds = explode(',', $cid);
 147     }
 148     if (count($form->_contactIds) > 1) {
 149       $form->_single = FALSE;
 150     }
 151
 152     $emailAttributes = array(
 153       'class' => 'huge',
 154     );
 155     $to = $form->add('text', 'to', ts('To'), $emailAttributes, TRUE);
 156     $cc = $form->add('text', 'cc_id', ts('CC'), $emailAttributes);
 157     $bcc = $form->add('text', 'bcc_id', ts('BCC'), $emailAttributes);
 158
 159     $setDefaults = TRUE;
 160     if (property_exists($form, '_context') && $form->_context == 'standalone') {
 161       $setDefaults = FALSE;
 162     }
 163
 164     $elements = array('to', 'cc', 'bcc');
 165     $form->_allContactIds = $form->_toContactIds = $form->_contactIds;
 166     foreach ($elements as $element) {
 167       if ($$element->getValue()) {
 168         $allEmails = explode(',', $$element->getValue());
 169         if ($element == 'to') {
 170           $form->_toContactIds = $form->_contactIds = array();
 171         }
 172
 173         foreach ($allEmails as $value) {
 174           list($contactId, $email) = explode('::', $value);
 175           if ($contactId) {
 176             switch ($element) {
 177               case 'to':
 178                 $form->_contactIds[] = $form->_toContactIds[] = $contactId;
 179                 $form->_toContactEmails[] = $email;
 180                 break;
 181
 182               case 'cc':
 183                 $form->_ccContactIds[] = $contactId;
 184                 break;
 185
 186               case 'bcc':
 187                 $form->_bccContactIds[] = $contactId;
 188                 break;
 189             }
 190
 191             $form->_allContactIds[] = $contactId;
 192           }
 193         }
 194
 195         $setDefaults = TRUE;
 196       }
 197     }
 198
 199     //get the group of contacts as per selected by user in case of Find Activities
 200     if (!empty($form->_activityHolderIds)) {
 201       $contact = $form->get('contacts');
 202       $form->_allContactIds = $form->_contactIds = $contact;
 203     }
 204
 205     // check if we need to setdefaults and check for valid contact emails / communication preferences
 206     if (is_array($form->_allContactIds) && $setDefaults) {
 207       $returnProperties = array(
 208         'sort_name' => 1,
 209         'email' => 1,
 210         'do_not_email' => 1,
 211         'is_deceased' => 1,
 212         'on_hold' => 1,
 213         'display_name' => 1,
 214         'preferred_mail_format' => 1,
 215       );
 216
 217       // get the details for all selected contacts ( to, cc and bcc contacts )
 218       list($form->_contactDetails) = CRM_Utils_Token::getTokenDetails($form->_allContactIds,
 219         $returnProperties,
 220         FALSE,
 221         FALSE
 222       );
 223
 224       // make a copy of all contact details
 225       $form->_allContactDetails = $form->_contactDetails;
 226
 227       // perform all validations
 228       foreach ($form->_allContactIds as $key => $contactId) {
 229         $value = $form->_contactDetails[$contactId];
 230         if ($value['do_not_email'] || empty($value['email']) || !empty($value['is_deceased']) || $value['on_hold']) {
 231           $suppressedEmails++;
 232
 233           // unset contact details for contacts that we won't be sending email. This is prevent extra computation
 234           // during token evaluation etc.
 235           unset($form->_contactDetails[$contactId]);
 236         }
 237         else {
 238           $email = $value['email'];
 239
 240           // build array's which are used to setdefaults
 241           if (in_array($contactId, $form->_toContactIds)) {
 242             $form->_toContactDetails[$contactId] = $form->_contactDetails[$contactId];
 243             // If a particular address has been specified as the default, use that instead of contact's primary email
 244             if (!empty($form->_toEmail) && $form->_toEmail['contact_id'] == $contactId) {
 245               $email = $form->_toEmail['email'];
 246             }
 247             $toArray[] = array(
 248               'text' => '"' . $value['sort_name'] . '" <' . $email . '>',
 249               'id' => "$contactId::{$email}",
 250             );
 251           }
 252           elseif (in_array($contactId, $form->_ccContactIds)) {
 253             $ccArray[] = array(
 254               'text' => '"' . $value['sort_name'] . '" <' . $email . '>',
 255               'id' => "$contactId::{$email}",
 256             );
 257           }
 258           elseif (in_array($contactId, $form->_bccContactIds)) {
 259             $bccArray[] = array(
 260               'text' => '"' . $value['sort_name'] . '" <' . $email . '>',
 261               'id' => "$contactId::{$email}",
 262             );
 263           }
 264         }
 265       }
 266
 267       if (empty($toArray)) {
 268         CRM_Core_Error::statusBounce(ts('Selected contact(s) do not have a valid email address, or communication preferences specify DO NOT EMAIL, or they are deceased or Primary email address is On Hold.'));
 269       }
 270     }
 271
 272     $form->assign('toContact', json_encode($toArray));
 273     $form->assign('ccContact', json_encode($ccArray));
 274     $form->assign('bccContact', json_encode($bccArray));
 275
 276     $form->assign('suppressedEmails', $suppressedEmails);
 277
 278     $form->assign('totalSelectedContacts', count($form->_contactIds));
 279
 280     $form->add('text', 'subject', ts('Subject'), 'size=50 maxlength=254', TRUE);
 281
 282     $form->add('select', 'fromEmailAddress', ts('From'), $form->_fromEmails, TRUE, array('class' => 'crm-select2 huge'));
 283
 284     CRM_Mailing_BAO_Mailing::commonCompose($form);
 285
 286     // add attachments
 287     CRM_Core_BAO_File::buildAttachment($form, NULL);
 288
 289     if ($form->_single) {
 290       // also fix the user context stack
 291       if ($form->_caseId) {
 292         $ccid = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseContact', $form->_caseId,
 293           'contact_id', 'case_id'
 294         );
 295         $url = CRM_Utils_System::url('civicrm/contact/view/case',
 296           "&reset=1&action=view&cid={$ccid}&id={$form->_caseId}"
 297         );
 298       }
 299       elseif ($form->_context) {
 300         $url = CRM_Utils_System::url('civicrm/dashboard', 'reset=1');
 301       }
 302       else {
 303         $url = CRM_Utils_System::url('civicrm/contact/view',
 304           "&show=1&action=browse&cid={$form->_contactIds[0]}&selectedChild=activity"
 305         );
 306       }
 307
 308       $session = CRM_Core_Session::singleton();
 309       $session->replaceUserContext($url);
 310       $form->addDefaultButtons(ts('Send Email'), 'upload', 'cancel');
 311     }
 312     else {
 313       $form->addDefaultButtons(ts('Send Email'), 'upload');
 314     }
 315
 316     $form->addFormRule(array('CRM_Contact_Form_Task_EmailCommon', 'formRule'), $form);
 317     CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'templates/CRM/Contact/Form/Task/EmailCommon.js', 0, 'html-header');
 318   }
 319
 320   /**
 321    * Form rule.
 322    *
 323    * @param array $fields
 324    *   The input form values.
 325    * @param array $dontCare
 326    * @param array $self
 327    *   Additional values form 'this'.
 328    *
 329    * @return bool|array
 330    *   true if no errors, else array of errors
 331    */
 332   public static function formRule($fields, $dontCare, $self) {
 333     $errors = array();
 334     $template = CRM_Core_Smarty::singleton();
 335
 336     if (isset($fields['html_message'])) {
 337       $htmlMessage = str_replace(array("\n", "\r"), ' ', $fields['html_message']);
 338       $htmlMessage = str_replace('"', '\"', $htmlMessage);
 339       $template->assign('htmlContent', $htmlMessage);
 340     }
 341
 342     //Added for CRM-1393
 343     if (!empty($fields['saveTemplate']) && empty($fields['saveTemplateName'])) {
 344       $errors['saveTemplateName'] = ts("Enter name to save message template");
 345     }
 346
 347     return empty($errors) ? TRUE : $errors;
 348   }
 349
 350   /**
 351    * Process the form after the input has been submitted and validated.
 352    *
 353    *
 354    * @param CRM_Core_Form $form
 355    *
 356    * @return void
 357    */
 358   public static function postProcess(&$form) {
 359     if (count($form->_contactIds) > self::MAX_EMAILS_KILL_SWITCH) {
 360       CRM_Core_Error::fatal(ts('Please do not use this task to send a lot of emails (greater than %1). We recommend using CiviMail instead.',
 361         array(1 => self::MAX_EMAILS_KILL_SWITCH)
 362       ));
 363     }
 364
 365     // check and ensure that
 366     $formValues = $form->controller->exportValues($form->getName());
 367
 368     $fromEmail = $formValues['fromEmailAddress'];
 369     $from = CRM_Utils_Array::value($fromEmail, $form->_emails);
 370     $subject = $formValues['subject'];
 371
 372     // CRM-13378: Append CC and BCC information at the end of Activity Details and format cc and bcc fields
 373     $elements = array('cc_id', 'bcc_id');
 374     $additionalDetails = NULL;
 375     $ccValues = $bccValues = array();
 376     foreach ($elements as $element) {
 377       if (!empty($formValues[$element])) {
 378         $allEmails = explode(',', $formValues[$element]);
 379         foreach ($allEmails as $value) {
 380           list($contactId, $email) = explode('::', $value);
 381           $contactURL = CRM_Utils_System::url('civicrm/contact/view', "reset=1&force=1&cid={$contactId}", TRUE);
 382           switch ($element) {
 383             case 'cc_id':
 384               $ccValues['email'][] = '"' . $form->_contactDetails[$contactId]['sort_name'] . '" <' . $email . '>';
 385               $ccValues['details'][] = "<a href='{$contactURL}'>" . $form->_contactDetails[$contactId]['display_name'] . "</a>";
 386               break;
 387
 388             case 'bcc_id':
 389               $bccValues['email'][] = '"' . $form->_contactDetails[$contactId]['sort_name'] . '" <' . $email . '>';
 390               $bccValues['details'][] = "<a href='{$contactURL}'>" . $form->_contactDetails[$contactId]['display_name'] . "</a>";
 391               break;
 392           }
 393         }
 394       }
 395     }
 396
 397     $cc = $bcc = '';
 398     if (!empty($ccValues)) {
 399       $cc = implode(',', $ccValues['email']);
 400       $additionalDetails .= "\ncc : " . implode(", ", $ccValues['details']);
 401     }
 402     if (!empty($bccValues)) {
 403       $bcc = implode(',', $bccValues['email']);
 404       $additionalDetails .= "\nbcc : " . implode(", ", $bccValues['details']);
 405     }
 406
 407     // CRM-5916: prepend case id hash to CiviCase-originating emails’ subjects
 408     if (isset($form->_caseId) && is_numeric($form->_caseId)) {
 409       $hash = substr(sha1(CIVICRM_SITE_KEY . $form->_caseId), 0, 7);
 410       $subject = "[case #$hash] $subject";
 411     }
 412
 413     // process message template
 414     if (!empty($formValues['saveTemplate']) || !empty($formValues['updateTemplate'])) {
 415       $messageTemplate = array(
 416         'msg_text' => $formValues['text_message'],
 417         'msg_html' => $formValues['html_message'],
 418         'msg_subject' => $formValues['subject'],
 419         'is_active' => TRUE,
 420       );
 421
 422       if (!empty($formValues['saveTemplate'])) {
 423         $messageTemplate['msg_title'] = $formValues['saveTemplateName'];
 424         CRM_Core_BAO_MessageTemplate::add($messageTemplate);
 425       }
 426
 427       if (!empty($formValues['template']) && !empty($formValues['updateTemplate'])) {
 428         $messageTemplate['id'] = $formValues['template'];
 429         unset($messageTemplate['msg_title']);
 430         CRM_Core_BAO_MessageTemplate::add($messageTemplate);
 431       }
 432     }
 433
 434     $attachments = array();
 435     CRM_Core_BAO_File::formatAttachment($formValues,
 436       $attachments,
 437       NULL, NULL
 438     );
 439
 440     // format contact details array to handle multiple emails from same contact
 441     $formattedContactDetails = array();
 442     $tempEmails = array();
 443
 444     foreach ($form->_contactIds as $key => $contactId) {
 445       // if we dont have details on this contactID, we should ignore
 446       // potentially this is due to the contact not wanting to receive email
 447       if (!isset($form->_contactDetails[$contactId])) {
 448         continue;
 449       }
 450       $email = $form->_toContactEmails[$key];
 451       // prevent duplicate emails if same email address is selected CRM-4067
 452       // we should allow same emails for different contacts
 453       $emailKey = "{$contactId}::{$email}";
 454       if (!in_array($emailKey, $tempEmails)) {
 455         $tempEmails[] = $emailKey;
 456         $details = $form->_contactDetails[$contactId];
 457         $details['email'] = $email;
 458         unset($details['email_id']);
 459         $formattedContactDetails[] = $details;
 460       }
 461     }
 462
 463     // send the mail
 464     list($sent, $activityId) = CRM_Activity_BAO_Activity::sendEmail(
 465       $formattedContactDetails,
 466       $subject,
 467       $formValues['text_message'],
 468       $formValues['html_message'],
 469       NULL,
 470       NULL,
 471       $from,
 472       $attachments,
 473       $cc,
 474       $bcc,
 475       array_keys($form->_toContactDetails),
 476       $additionalDetails
 477     );
 478
 479     if ($sent) {
 480       $count_success = count($form->_toContactDetails);
 481       CRM_Core_Session::setStatus(ts('One message was sent successfully.', array(
 482             'plural' => '%count messages were sent successfully.',
 483             'count' => $count_success,
 484           )), ts('Message Sent', array('plural' => 'Messages Sent', 'count' => $count_success)), 'success');
 485     }
 486
 487     // Display the name and number of contacts for those email is not sent.
 488     // php 5.4 throws out a notice since the values of these below arrays are arrays.
 489     // the behavior is not documented in the php manual, but it does the right thing
 490     // suppressing the notices to get things in good shape going forward
 491     $emailsNotSent = @array_diff_assoc($form->_allContactDetails, $form->_contactDetails);
 492
 493     if ($emailsNotSent) {
 494       $not_sent = array();
 495       foreach ($emailsNotSent as $contactId => $values) {
 496         $displayName = $values['display_name'];
 497         $email = $values['email'];
 498         $contactViewUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid=$contactId");
 499         $not_sent[] = "<a href='$contactViewUrl' title='$email'>$displayName</a>" . ($values['on_hold'] ? '(' . ts('on hold') . ')' : '');
 500       }
 501       $status = '(' . ts('because no email address on file or communication preferences specify DO NOT EMAIL or Contact is deceased or Primary email address is On Hold') . ')<ul><li>' . implode('</li><li>', $not_sent) . '</li></ul>';
 502       CRM_Core_Session::setStatus($status, ts('One Message Not Sent', array(
 503             'count' => count($emailsNotSent),
 504             'plural' => '%count Messages Not Sent',
 505           )), 'info');
 506     }
 507
 508     if (isset($form->_caseId)) {
 509       // if case-id is found in the url, create case activity record
 510       $cases = explode(',', $form->_caseId);
 511       foreach ($cases as $key => $val) {
 512         if (is_numeric($val)) {
 513           $caseParams = array(
 514             'activity_id' => $activityId,
 515             'case_id' => $val,
 516           );
 517           CRM_Case_BAO_Case::processCaseActivity($caseParams);
 518         }
 519       }
 520     }
 521   }
 522
 523 }