_mailingID = $this->get('mailing_id');
if (CRM_Core_Permission::check('administer CiviCRM')) {
$this->assign('isAdmin', 1);
}
//when user come from search context.
$ssID = $this->get('ssID');
$this->assign('ssid',$ssID);
$this->_searchBasedMailing = CRM_Contact_Form_Search::isSearchContext($this->get('context'));
if(CRM_Contact_Form_Search::isSearchContext($this->get('context')) && !$ssID){
$params = array();
$result = CRM_Core_BAO_PrevNextCache::getSelectedContacts();
$this->assign("value", $result);
}
}
/**
* Set default values for the form.
* the default values are retrieved from the database
*
* @access public
*
* @return void
*/
function setDefaultValues() {
$mailingID = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE, NULL);
//need to differentiate new/reuse mailing, CRM-2873
$reuseMailing = FALSE;
if ($mailingID) {
$reuseMailing = TRUE;
}
else {
$mailingID = $this->_mailingID;
}
$count = $this->get('count');
$this->assign('count', $count);
$this->set('skipTextFile', FALSE);
$this->set('skipHtmlFile', FALSE);
$defaults = array();
$htmlMessage = NULL;
if ($mailingID) {
$dao = new CRM_Mailing_DAO_Mailing();
$dao->id = $mailingID;
$dao->find(TRUE);
$dao->storeValues($dao, $defaults);
//we don't want to retrieve template details once it is
//set in session
$templateId = $this->get('template');
$this->assign('templateSelected', $templateId ? $templateId : 0);
if (isset($defaults['msg_template_id']) && !$templateId) {
$defaults['template'] = $defaults['msg_template_id'];
$messageTemplate = new CRM_Core_DAO_MessageTemplate();
$messageTemplate->id = $defaults['msg_template_id'];
$messageTemplate->selectAdd();
$messageTemplate->selectAdd('msg_text, msg_html');
$messageTemplate->find(TRUE);
$defaults['text_message'] = $messageTemplate->msg_text;
$htmlMessage = $messageTemplate->msg_html;
}
if (isset($defaults['body_text'])) {
$defaults['text_message'] = $defaults['body_text'];
$this->set('textFile', $defaults['body_text']);
$this->set('skipTextFile', TRUE);
}
if (isset($defaults['body_html'])) {
$htmlMessage = $defaults['body_html'];
$this->set('htmlFile', $defaults['body_html']);
$this->set('skipHtmlFile', TRUE);
}
//set default from email address.
if (!empty($defaults['from_name']) && !empty($defaults['from_email'])) {
$defaults['from_email_address'] = array_search('"' . $defaults['from_name'] . '" <' . $defaults['from_email'] . '>',
CRM_Core_OptionGroup::values('from_email_address')
);
}
else {
//get the default from email address.
$defaultAddress = CRM_Core_OptionGroup::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
foreach ($defaultAddress as $id => $value) {
$defaults['from_email_address'] = $id;
}
}
if (!empty($defaults['replyto_email'])) {
$replyToEmail = CRM_Core_OptionGroup::values('from_email_address');
foreach ($replyToEmail as $value) {
if (strstr($value, $defaults['replyto_email'])) {
$replyToEmailAddress = $value;
break;
}
}
$replyToEmailAddress = explode('<', $replyToEmailAddress);
if (count($replyToEmailAddress) > 1) {
$replyToEmailAddress = $replyToEmailAddress[0] . '<' . $replyToEmailAddress[1];
}
$defaults['reply_to_address'] = array_search($replyToEmailAddress, $replyToEmail);
}
}
//fix for CRM-2873
if (!$reuseMailing) {
$textFilePath = $this->get('textFilePath');
if ($textFilePath &&
file_exists($textFilePath)
) {
$defaults['text_message'] = file_get_contents($textFilePath);
if (strlen($defaults['text_message']) > 0) {
$this->set('skipTextFile', TRUE);
}
}
$htmlFilePath = $this->get('htmlFilePath');
if ($htmlFilePath &&
file_exists($htmlFilePath)
) {
$defaults['html_message'] = file_get_contents($htmlFilePath);
if (strlen($defaults['html_message']) > 0) {
$htmlMessage = $defaults['html_message'];
$this->set('skipHtmlFile', TRUE);
}
}
}
if ($this->get('html_message')) {
$htmlMessage = $this->get('html_message');
}
$htmlMessage = str_replace(array("\n", "\r"), ' ', $htmlMessage);
$htmlMessage = str_replace("'", "\'", $htmlMessage);
$this->assign('message_html', $htmlMessage);
$defaults['upload_type'] = 1;
if (isset($defaults['body_html'])) {
$defaults['html_message'] = $defaults['body_html'];
}
//CRM-4678 setdefault to default component when composing new mailing.
if (!$reuseMailing) {
$componentFields = array(
'header_id' => 'Header',
'footer_id' => 'Footer',
);
foreach ($componentFields as $componentVar => $componentType) {
$defaults[$componentVar] = CRM_Mailing_PseudoConstant::defaultComponent($componentType, '');
}
}
return $defaults;
}
/**
* Build the form object
*
* @return void
* @access public
*/
public function buildQuickForm() {
$session = CRM_Core_Session::singleton();
$config = CRM_Core_Config::singleton();
$options = array();
$tempVar = FALSE;
// this seems so hacky, not sure what we are doing here and why. Need to investigate and fix
$session->getVars($options,
"CRM_Mailing_Controller_Send_{$this->controller->_key}"
);
$fromEmailAddress = CRM_Core_OptionGroup::values('from_email_address');
if (empty($fromEmailAddress)) {
//redirect user to enter from email address.
$url = CRM_Utils_System::url('civicrm/admin/options/from_email_address', 'action=add&reset=1');
$status = ts("There is no valid from email address present. You can add here Add From Email Address.", array(1 => $url));
$session->setStatus($status, ts('Notice'));
}
else {
foreach ($fromEmailAddress as $key => $email) {
$fromEmailAddress[$key] = htmlspecialchars($fromEmailAddress[$key]);
}
}
$this->add('select', 'from_email_address',
ts('From Email Address'), array(
'' => '- select -') + $fromEmailAddress, TRUE
);
//Added code to add custom field as Reply-To on form when it is enabled from Mailer settings
if (isset($config->replyTo) && !empty($config->replyTo) && empty($options['override_verp'])) {
$this->add('select', 'reply_to_address', ts('Reply-To'),
array('' => '- select -') + $fromEmailAddress
);
}
elseif (!empty($options['override_verp'])) {
$trackReplies = TRUE;
$this->assign('trackReplies', $trackReplies);
}
$this->add('text', 'subject', ts('Mailing Subject'),
CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Mailing', 'subject'), TRUE
);
$attributes = array('onclick' => "showHideUpload();");
$options = array(ts('Upload Content'), ts('Compose On-screen'));
$this->addRadio('upload_type', ts('I want to'), $options, $attributes, " ");
CRM_Mailing_BAO_Mailing::commonCompose($this);
$this->addElement('file', 'textFile', ts('Upload TEXT Message'), 'size=30 maxlength=60');
$this->addUploadElement('textFile');
$this->setMaxFileSize(1024 * 1024);
$this->addRule('textFile', ts('File size should be less than 1 MByte'), 'maxfilesize', 1024 * 1024);
$this->addRule('textFile', ts('File must be in UTF-8 encoding'), 'utf8File');
$this->addElement('file', 'htmlFile', ts('Upload HTML Message'), 'size=30 maxlength=60');
$this->addUploadElement('htmlFile');
$this->setMaxFileSize(1024 * 1024);
$this->addRule('htmlFile',
ts('File size should be less than %1 MByte(s)',
array(1 => 1)
),
'maxfilesize',
1024 * 1024
);
$this->addRule('htmlFile', ts('File must be in UTF-8 encoding'), 'utf8File');
//fix upload files when context is search. CRM-3711
$ssID = $this->get('ssID');
if ($this->_searchBasedMailing && $ssID) {
$this->set('uploadNames', array('textFile', 'htmlFile'));
}
CRM_Core_BAO_File::buildAttachment($this,
'civicrm_mailing',
$this->_mailingID
);
$this->add('select', 'header_id', ts('Mailing Header'),
array('' => ts('- none -')) + CRM_Mailing_PseudoConstant::component('Header')
);
$this->add('select', 'footer_id', ts('Mailing Footer'),
array('' => ts('- none -')) + CRM_Mailing_PseudoConstant::component('Footer')
);
$this->addFormRule(array('CRM_Mailing_Form_Upload', 'formRule'), $this);
$buttons = array(
array('type' => 'back',
'name' => ts('<< Previous'),
),
array(
'type' => 'upload',
'name' => ts('Next >>'),
'spacing' => ' ',
'isDefault' => TRUE,
),
array(
'type' => 'upload',
'name' => ts('Save & Continue Later'),
'subName' => 'save',
),
array(
'type' => 'cancel',
'name' => ts('Cancel'),
),
);
$this->addButtons($buttons);
}
public function postProcess() {
$params = $ids = array();
$uploadParams = array('header_id', 'footer_id', 'subject', 'from_name', 'from_email');
$fileType = array('textFile', 'htmlFile');
$formValues = $this->controller->exportValues($this->_name);
foreach ($uploadParams as $key) {
if (!empty($formValues[$key]) ||
in_array($key, array('header_id', 'footer_id'))
) {
$params[$key] = $formValues[$key];
$this->set($key, $formValues[$key]);
}
}
if (!$formValues['upload_type']) {
foreach ($fileType as $key) {
$contents = NULL;
if (isset($formValues[$key]) &&
!empty($formValues[$key])
) {
$contents = file_get_contents($formValues[$key]['name']);
$this->set($key, $formValues[$key]['name']);
}
if ($contents) {
$params['body_' . substr($key, 0, 4)] = $contents;
}
else {
$params['body_' . substr($key, 0, 4)] = 'NULL';
}
}
}
else {
$text_message = $formValues['text_message'];
$params['body_text'] = $text_message;
$this->set('textFile', $params['body_text']);
$this->set('text_message', $params['body_text']);
$html_message = $formValues['html_message'];
// dojo editor does some html conversion when tokens are
// inserted as links. Hence token replacement fails.
// this is hack to revert html conversion for { to %7B and
// } to %7D by dojo editor
$html_message = str_replace('%7B', '{', str_replace('%7D', '}', $html_message));
$params['body_html'] = $html_message;
$this->set('htmlFile', $params['body_html']);
$this->set('html_message', $params['body_html']);
}
$params['name'] = $this->get('name');
$session = CRM_Core_Session::singleton();
$params['contact_id'] = $session->get('userID');
$composeFields = array(
'template', 'saveTemplate',
'updateTemplate', 'saveTemplateName',
);
$msgTemplate = NULL;
//mail template is composed
if ($formValues['upload_type']) {
$composeParams = array();
foreach ($composeFields as $key) {
if (!empty($formValues[$key])) {
$composeParams[$key] = $formValues[$key];
$this->set($key, $formValues[$key]);
}
}
if (!empty($composeParams['updateTemplate'])) {
$templateParams = array(
'msg_text' => $text_message,
'msg_html' => $html_message,
'msg_subject' => $params['subject'],
'is_active' => TRUE,
);
$templateParams['id'] = $formValues['template'];
$msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
}
if (!empty($composeParams['saveTemplate'])) {
$templateParams = array(
'msg_text' => $text_message,
'msg_html' => $html_message,
'msg_subject' => $params['subject'],
'is_active' => TRUE,
);
$templateParams['msg_title'] = $composeParams['saveTemplateName'];
$msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams);
}
if (isset($msgTemplate->id)) {
$params['msg_template_id'] = $msgTemplate->id;
}
else {
$params['msg_template_id'] = CRM_Utils_Array::value('template', $formValues);
}
$this->set('template', $params['msg_template_id']);
}
CRM_Core_BAO_File::formatAttachment($formValues,
$params,
'civicrm_mailing',
$this->_mailingID
);
$ids['mailing_id'] = $this->_mailingID;
//handle mailing from name & address.
$fromEmailAddress = CRM_Utils_Array::value($formValues['from_email_address'],
CRM_Core_OptionGroup::values('from_email_address')
);
//get the from email address
$params['from_email'] = CRM_Utils_Mail::pluckEmailFromHeader($fromEmailAddress);
//get the from Name
$params['from_name'] = CRM_Utils_Array::value(1, explode('"', $fromEmailAddress));
//Add Reply-To to headers
if (!empty($formValues['reply_to_address'])) {
$replyToEmail = CRM_Core_OptionGroup::values('from_email_address');
$params['replyto_email'] = CRM_Utils_Array::value($formValues['reply_to_address'], $replyToEmail);
}
/* Build the mailing object */
CRM_Mailing_BAO_Mailing::create($params, $ids);
if (isset($this->_submitValues['_qf_Upload_upload_save']) &&
$this->_submitValues['_qf_Upload_upload_save'] == 'Save & Continue Later'
) {
//when user perform mailing from search context
//redirect it to search result CRM-3711.
$ssID = $this->get('ssID');
if ($ssID && $this->_searchBasedMailing) {
if ($this->_action == CRM_Core_Action::BASIC) {
$fragment = 'search';
}
elseif ($this->_action == CRM_Core_Action::PROFILE) {
$fragment = 'search/builder';
}
elseif ($this->_action == CRM_Core_Action::ADVANCED) {
$fragment = 'search/advanced';
}
else {
$fragment = 'search/custom';
}
$context = $this->get('context');
if (!CRM_Contact_Form_Search::isSearchContext($context)) {
$context = 'search';
}
$urlParams = "force=1&reset=1&ssID={$ssID}&context={$context}";
$qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
if (CRM_Utils_Rule::qfKey($qfKey)) {
$urlParams .= "&qfKey=$qfKey";
}
$session = CRM_Core_Session::singleton();
$draftURL = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
$status = ts("You can continue later by clicking the 'Continue' action to resume working on it.
From Draft and Unscheduled Mailings.", array(1 => $draftURL));
CRM_Core_Session::setStatus($status, ts('Mailing Saved'), 'success');
// Redirect user to search.
$url = CRM_Utils_System::url('civicrm/contact/' . $fragment, $urlParams);
}
else {
$status = ts("Click the 'Continue' action to resume working on it.");
$url = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
}
CRM_Core_Session::setStatus($status, ts('Mailing Saved'), 'success');
return $this->controller->setDestination($url);
}
}
/**
* Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
* @param $files
* @param $self
*
* @return mixed true or array of errors
* @access public
* @static
*/
static function formRule($params, $files, $self) {
if (!empty($_POST['_qf_Import_refresh'])) {
return TRUE;
}
$errors = array();
$template = CRM_Core_Smarty::singleton();
if (isset($params['html_message'])) {
$htmlMessage = str_replace(array("\n", "\r"), ' ', $params['html_message']);
$htmlMessage = str_replace("'", "\'", $htmlMessage);
$template->assign('htmlContent', $htmlMessage);
}
$domain = CRM_Core_BAO_Domain::getDomain();
$mailing = new CRM_Mailing_BAO_Mailing();
$mailing->id = $self->_mailingID;
$mailing->find(TRUE);
$session = CRM_Core_Session::singleton();
$values = array('contact_id' => $session->get('userID'),
'version' => 3,
);
require_once 'api/api.php';
$contact = civicrm_api('contact', 'get', $values);
//CRM-4524
$contact = reset($contact['values']);
$verp = array_flip(array('optOut', 'reply', 'unsubscribe', 'resubscribe', 'owner'));
foreach ($verp as $key => $value) {
$verp[$key]++;
}
$urls = array_flip(array('forward', 'optOutUrl', 'unsubscribeUrl', 'resubscribeUrl'));
foreach ($urls as $key => $value) {
$urls[$key]++;
}
// set $header and $footer
foreach (array(
'header', 'footer') as $part) {
$$part = array();
if ($params["{$part}_id"]) {
//echo "found";
$component = new CRM_Mailing_BAO_Component();
$component->id = $params["{$part}_id"];
$component->find(TRUE);
${$part}['textFile'] = $component->body_text;
${$part}['htmlFile'] = $component->body_html;
$component->free();
}
else {
${$part}['htmlFile'] = ${$part}['textFile'] = '';
}
}
$skipTextFile = $self->get('skipTextFile');
$skipHtmlFile = $self->get('skipHtmlFile');
if (!$params['upload_type']) {
if ((!isset($files['textFile']) || !file_exists($files['textFile']['tmp_name'])) &&
(!isset($files['htmlFile']) || !file_exists($files['htmlFile']['tmp_name']))
) {
if (!($skipTextFile || $skipHtmlFile)) {
$errors['textFile'] = ts('Please provide either a Text or HTML formatted message - or both.');
}
}
}
else {
if (empty($params['text_message']) && empty($params['html_message'])) {
$errors['html_message'] = ts('Please provide either a Text or HTML formatted message - or both.');
}
if (!empty($params['saveTemplate']) && empty($params['saveTemplateName'])) {
$errors['saveTemplateName'] = ts('Please provide a Template Name.');
}
}
foreach (array(
'text', 'html') as $file) {
if (!$params['upload_type'] && !file_exists(CRM_Utils_Array::value('tmp_name', $files[$file . 'File']))) {
continue;
}
if ($params['upload_type'] && !$params[$file . '_message']) {
continue;
}
if (!$params['upload_type']) {
$str = file_get_contents($files[$file . 'File']['tmp_name']);
$name = $files[$file . 'File']['name'];
}
else {
$str = $params[$file . '_message'];
$str = ($file == 'html') ? str_replace('%7B', '{', str_replace('%7D', '}', $str)) : $str;
$name = $file . ' message';
}
/* append header/footer */
$str = $header[$file . 'File'] . $str . $footer[$file . 'File'];
$dataErrors = array();
/* First look for missing tokens */
if (!CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'disable_mandatory_tokens_check')) {
$err = CRM_Utils_Token::requiredTokens($str);
if ($err !== TRUE) {
foreach ($err as $token => $desc) {
$dataErrors[] = '
' . ts('This message is missing a required token - {%1}: %2',
array(1 => $token, 2 => $desc)
) . '';
}
}
}
/* Do a full token replacement on a dummy verp, the current
* contact and domain, and the first organization. */
// here we make a dummy mailing object so that we
// can retrieve the tokens that we need to replace
// so that we do get an invalid token error
// this is qute hacky and I hope that there might
// be a suggestion from someone on how to
// make it a bit more elegant
$dummy_mail = new CRM_Mailing_BAO_Mailing();
$mess = "body_{$file}";
$dummy_mail->$mess = $str;
$tokens = $dummy_mail->getTokens();
$str = CRM_Utils_Token::replaceSubscribeInviteTokens($str);
$str = CRM_Utils_Token::replaceDomainTokens($str, $domain, NULL, $tokens[$file]);
$str = CRM_Utils_Token::replaceMailingTokens($str, $mailing, NULL, $tokens[$file]);
$str = CRM_Utils_Token::replaceOrgTokens($str, $org);
$str = CRM_Utils_Token::replaceActionTokens($str, $verp, $urls, NULL, $tokens[$file]);
$str = CRM_Utils_Token::replaceContactTokens($str, $contact, NULL, $tokens[$file]);
$unmatched = CRM_Utils_Token::unmatchedTokens($str);
if (!empty($unmatched) && 0) {
foreach ($unmatched as $token) {
$dataErrors[] = '' . ts('Invalid token code') . ' {' . $token . '}';
}
}
if (!empty($dataErrors)) {
$errors[$file . 'File'] = ts('The following errors were detected in %1:', array(
1 => $name)) . ' ' . implode('', $dataErrors) . '
' . ts('More information on required tokens...') . '';
}
}
$templateName = CRM_Core_BAO_MessageTemplate::getMessageTemplates();
if (!empty($params['saveTemplate']) && in_array(CRM_Utils_Array::value('saveTemplateName', $params), $templateName)
) {
$errors['saveTemplate'] = ts('Duplicate Template Name.');
}
return empty($errors) ? TRUE : $errors;
}
/**
* Display Name of the form
*
* @access public
*
* @return string
*/
public function getTitle() {
return ts('Mailing Content');
}
}