Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Duplicate EmailCommon::buildQuickForm onto the trait #17052

Merged
merged 1 commit into from
Apr 10, 2020
Merged

Duplicate EmailCommon::buildQuickForm onto the trait #17052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CRM/Contact/Form/Task/EmailCommon.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ public static function preProcessFromAddress(&$form, $bounce = TRUE) {
* @throws \CRM_Core_Exception
*/
public static function buildQuickForm(&$form) {
CRM_Core_Error::deprecatedFunctionWarning('This code is no longer used in core and will be removed');
$toArray = $ccArray = $bccArray = [];
$suppressedEmails = 0;
//here we are getting logged in user id as array but we need target contact id. CRM-5988
Expand Down
244 changes: 243 additions & 1 deletion CRM/Contact/Form/Task/EmailTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,232 @@ public function buildQuickForm() {
$this->assign('suppressForm', FALSE);
$this->assign('emailTask', TRUE);

CRM_Contact_Form_Task_EmailCommon::buildQuickForm($this);
$toArray = $ccArray = $bccArray = [];
$suppressedEmails = 0;
//here we are getting logged in user id as array but we need target contact id. CRM-5988
$cid = $this->get('cid');
if ($cid) {
$this->_contactIds = explode(',', $cid);
}
if (count($this->_contactIds) > 1) {
$this->_single = FALSE;
}
CRM_Contact_Form_Task_EmailCommon::bounceIfSimpleMailLimitExceeded(count($this->_contactIds));

$emailAttributes = [
'class' => 'huge',
];
$to = $this->add('text', 'to', ts('To'), $emailAttributes, TRUE);
$cc = $this->add('text', 'cc_id', ts('CC'), $emailAttributes);
$bcc = $this->add('text', 'bcc_id', ts('BCC'), $emailAttributes);

if ($to->getValue()) {
$this->_toContactIds = $this->_contactIds = [];
}
$setDefaults = TRUE;
if (property_exists($this, '_context') && $this->_context === 'standalone') {
$setDefaults = FALSE;
}

$elements = ['to', 'cc', 'bcc'];
$this->_allContactIds = $this->_toContactIds = $this->_contactIds;
foreach ($elements as $element) {
if ($$element->getValue()) {

foreach ($this->getEmails($$element) as $value) {
$contactId = $value['contact_id'];
$email = $value['email'];
if ($contactId) {
switch ($element) {
case 'to':
$this->_contactIds[] = $this->_toContactIds[] = $contactId;
$this->_toContactEmails[] = $email;
break;

case 'cc':
$this->_ccContactIds[] = $contactId;
break;

case 'bcc':
$this->_bccContactIds[] = $contactId;
break;
}

$this->_allContactIds[] = $contactId;
}
}

$setDefaults = TRUE;
}
}

//get the group of contacts as per selected by user in case of Find Activities
if (!empty($this->_activityHolderIds)) {
$contact = $this->get('contacts');
$this->_allContactIds = $this->_contactIds = $contact;
}

// check if we need to setdefaults and check for valid contact emails / communication preferences
if (is_array($this->_allContactIds) && $setDefaults) {
$returnProperties = [
'sort_name' => 1,
'email' => 1,
'do_not_email' => 1,
'is_deceased' => 1,
'on_hold' => 1,
'display_name' => 1,
'preferred_mail_format' => 1,
];

// get the details for all selected contacts ( to, cc and bcc contacts )
list($this->_contactDetails) = CRM_Utils_Token::getTokenDetails($this->_allContactIds,
$returnProperties,
FALSE,
FALSE
);

// make a copy of all contact details
$this->_allContactDetails = $this->_contactDetails;

// perform all validations on unique contact Ids
foreach (array_unique($this->_allContactIds) as $key => $contactId) {
$value = $this->_contactDetails[$contactId];
if ($value['do_not_email'] || empty($value['email']) || !empty($value['is_deceased']) || $value['on_hold']) {
$suppressedEmails++;

// unset contact details for contacts that we won't be sending email. This is prevent extra computation
// during token evaluation etc.
unset($this->_contactDetails[$contactId]);
}
else {
$email = $value['email'];

// build array's which are used to setdefaults
if (in_array($contactId, $this->_toContactIds)) {
$this->_toContactDetails[$contactId] = $this->_contactDetails[$contactId];
// If a particular address has been specified as the default, use that instead of contact's primary email
if (!empty($this->_toEmail) && $this->_toEmail['contact_id'] == $contactId) {
$email = $this->_toEmail['email'];
}
$toArray[] = [
'text' => '"' . $value['sort_name'] . '" <' . $email . '>',
'id' => "$contactId::{$email}",
];
}
elseif (in_array($contactId, $this->_ccContactIds)) {
$ccArray[] = [
'text' => '"' . $value['sort_name'] . '" <' . $email . '>',
'id' => "$contactId::{$email}",
];
}
elseif (in_array($contactId, $this->_bccContactIds)) {
$bccArray[] = [
'text' => '"' . $value['sort_name'] . '" <' . $email . '>',
'id' => "$contactId::{$email}",
];
}
}
}

if (empty($toArray)) {
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.'));
}
}

$this->assign('toContact', json_encode($toArray));
$this->assign('ccContact', json_encode($ccArray));
$this->assign('bccContact', json_encode($bccArray));

$this->assign('suppressedEmails', $suppressedEmails);

$this->assign('totalSelectedContacts', count($this->_contactIds));

$this->add('text', 'subject', ts('Subject'), 'size=50 maxlength=254', TRUE);

$this->add('select', 'from_email_address', ts('From'), $this->_fromEmails, TRUE);

CRM_Mailing_BAO_Mailing::commonCompose($this);

// add attachments
CRM_Core_BAO_File::buildAttachment($this, NULL);

if ($this->_single) {
// also fix the user context stack
if ($this->_caseId) {
$ccid = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseContact', $this->_caseId,
'contact_id', 'case_id'
);
$url = CRM_Utils_System::url('civicrm/contact/view/case',
"&reset=1&action=view&cid={$ccid}&id={$this->_caseId}"
);
}
elseif ($this->_context) {
$url = CRM_Utils_System::url('civicrm/dashboard', 'reset=1');
}
else {
$url = CRM_Utils_System::url('civicrm/contact/view',
"&show=1&action=browse&cid={$this->_contactIds[0]}&selectedChild=activity"
);
}

$session = CRM_Core_Session::singleton();
$session->replaceUserContext($url);
$this->addDefaultButtons(ts('Send Email'), 'upload', 'cancel');
}
else {
$this->addDefaultButtons(ts('Send Email'), 'upload');
}

$fields = [
'followup_assignee_contact_id' => [
'type' => 'entityRef',
'label' => ts('Assigned to'),
'attributes' => [
'multiple' => TRUE,
'create' => TRUE,
'api' => ['params' => ['is_deceased' => 0]],
],
],
'followup_activity_type_id' => [
'type' => 'select',
'label' => ts('Followup Activity'),
'attributes' => ['' => '- ' . ts('select activity') . ' -'] + CRM_Core_PseudoConstant::ActivityType(FALSE),
'extra' => ['class' => 'crm-select2'],
],
'followup_activity_subject' => [
'type' => 'text',
'label' => ts('Subject'),
'attributes' => CRM_Core_DAO::getAttribute('CRM_Activity_DAO_Activity',
'subject'
),
],
];

//add followup date
$this->add('datepicker', 'followup_date', ts('in'));

foreach ($fields as $field => $values) {
if (!empty($fields[$field])) {
$attribute = $values['attributes'] ?? NULL;
$required = !empty($values['required']);

if ($values['type'] === 'select' && empty($attribute)) {
$this->addSelect($field, ['entity' => 'activity'], $required);
}
elseif ($values['type'] === 'entityRef') {
$this->addEntityRef($field, $values['label'], $attribute, $required);
}
else {
$this->add($values['type'], $field, $values['label'], $attribute, $required, CRM_Utils_Array::value('extra', $values));
}
}
}

//Added for CRM-15984: Add campaign field
CRM_Campaign_BAO_Campaign::addCampaign($this);

$this->addFormRule(['CRM_Contact_Form_Task_EmailCommon', 'formRule'], $this);
CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'templates/CRM/Contact/Form/Task/EmailCommon.js', 0, 'html-header');
}

/**
Expand All @@ -158,4 +383,21 @@ public function listTokens() {
return CRM_Core_SelectValues::contactTokens();
}

/**
* Get the emails from the added element.
*
* @param HTML_QuickForm_Element $element
*
* @return array
*/
protected function getEmails($element): array {
$allEmails = explode(',', $element->getValue());
$return = [];
foreach ($allEmails as $value) {
$values = explode('::', $value);
$return[] = ['contact_id' => $values[0], 'email' => $values[1]];
}
return $return;
}

}
2 changes: 1 addition & 1 deletion tests/phpunit/CRM/Contact/Form/Task/EmailCommonTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public function testPostProcessWithSignature() {
// so register it again. See packages/HTML/QuickForm/file.php.
$form->registerRule('maxfilesize', 'callback', '_ruleCheckMaxFileSize', 'HTML_QuickForm_file');
CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($form);
CRM_Contact_Form_Task_EmailCommon::buildQuickForm($form);
$form->buildQuickForm();
CRM_Contact_Form_Task_EmailCommon::submit($form, array_merge($form->_defaultValues, [
'from_email_address' => $loggedInEmail['id'],
'subject' => 'Really interesting stuff',
Expand Down