CRM/Mailing/Form/Test.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Form to send test mail
  38  */
  39 class CRM_Mailing_Form_Test extends CRM_Core_Form {
  40
  41   /**
  42    * Set variables up before form is built
  43    *
  44    * @return void
  45    */
  46   public function preProcess() {
  47     //when user come from search context.
  48     $ssID = $this->get('ssID');
  49     $this->assign('ssid', $ssID);
  50     $this->_searchBasedMailing = CRM_Contact_Form_Search::isSearchContext($this->get('context'));
  51     if (CRM_Contact_Form_Search::isSearchContext($this->get('context')) && !$ssID) {
  52       $params = array();
  53       $result = CRM_Core_BAO_PrevNextCache::getSelectedContacts();
  54       $this->assign("value", $result);
  55     }
  56   }
  57
  58   /**
  59    * Set default values for the form.
  60    *
  61    *
  62    * @return void
  63    */
  64   public function setDefaultValues() {
  65     $count = $this->get('count');
  66     $this->assign('count', $count);
  67   }
  68
  69   public function buildQuickForm() {
  70     $session = CRM_Core_Session::singleton();
  71     $this->add('text', 'test_email', ts('Send to This Address'));
  72     $defaults['test_email'] = $session->get('ufUniqID');
  73     $qfKey = $this->get('qfKey');
  74
  75     $this->add('select',
  76       'test_group',
  77       ts('Send to This Group'),
  78       array('' => ts('- none -')) + CRM_Core_PseudoConstant::group('Mailing')
  79     );
  80     $this->setDefaults($defaults);
  81
  82     $this->add('submit', 'sendtest', ts('Send a Test Mailing'));
  83     $name = ts('Next');
  84     if (CRM_Mailing_Info::workflowEnabled()) {
  85       if (!CRM_Core_Permission::check('schedule mailings') &&
  86         CRM_Core_Permission::check('create mailings')
  87       ) {
  88         $name = ts('Inform Scheduler');
  89       }
  90     }
  91
  92     $buttons = array(
  93       array(
  94         'type' => 'back',
  95         'name' => ts('Previous'),
  96       ),
  97       array(
  98         'type' => 'next',
  99         'name' => $name,
 100         'spacing' => '&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;',
 101         'isDefault' => TRUE,
 102       ),
 103       array(
 104         'type' => 'submit',
 105         'name' => ts('Save & Continue Later'),
 106       ),
 107       array(
 108         'type' => 'cancel',
 109         'name' => ts('Cancel'),
 110       ),
 111     );
 112
 113     $this->addButtons($buttons);
 114
 115     $mailingID = $this->get('mailing_id');
 116     $textFile  = $this->get('textFile');
 117     $htmlFile  = $this->get('htmlFile');
 118
 119     $this->addFormRule(array('CRM_Mailing_Form_Test', 'testMail'), $this);
 120     $preview = array();
 121     if ($textFile) {
 122       $preview['text_link'] = CRM_Utils_System::url('civicrm/mailing/preview', "type=text&qfKey=$qfKey");
 123     }
 124     if ($htmlFile) {
 125       $preview['html_link'] = CRM_Utils_System::url('civicrm/mailing/preview', "type=html&qfKey=$qfKey");
 126     }
 127
 128     $preview['attachment'] = CRM_Core_BAO_File::attachmentInfo('civicrm_mailing', $mailingID);
 129     $this->assign('preview', $preview);
 130     //Token Replacement of Subject in preview mailing
 131     $options = array();
 132     $prefix = "CRM_Mailing_Controller_Send_$qfKey";
 133     if ($this->_searchBasedMailing) {
 134       $prefix = "CRM_Contact_Controller_Search_$qfKey";
 135     }
 136     $session->getVars($options, $prefix);
 137
 138     $mailing = new CRM_Mailing_BAO_Mailing();
 139     $mailing->id = $options['mailing_id'];
 140     $mailing->find(TRUE);
 141     $fromEmail = $mailing->from_email;
 142     $replyToEmail = $mailing->replyto_email;
 143
 144     $attachments = CRM_Core_BAO_File::getEntityFile('civicrm_mailing',
 145       $mailing->id
 146     );
 147
 148     $returnProperties = $mailing->getReturnProperties();
 149     $userID           = $session->get('userID');
 150     $params           = array('contact_id' => $userID);
 151
 152     $details = CRM_Utils_Token::getTokenDetails($params,
 153       $returnProperties,
 154       TRUE, TRUE, NULL,
 155       $mailing->getFlattenedTokens(),
 156       get_class($this)
 157     );
 158
 159     $allDetails = &$mailing->compose(NULL, NULL, NULL,
 160       $userID,
 161       $fromEmail,
 162       $fromEmail,
 163       TRUE,
 164       $details[0][$userID],
 165       $attachments
 166     );
 167
 168     $this->assign('subject', $allDetails->_headers['Subject']);
 169   }
 170
 171   /**
 172    * Form rule to send out a test mailing.
 173    *
 174    * @param aray $testParams
 175    * @param array $files
 176    *   Any files posted to the form.
 177    * @param array $self
 178    *   An current this object.
 179    *
 180    * @return boolean          true on successful SMTP handoff
 181    */
 182   public static function testMail($testParams, $files, $self) {
 183     $error = NULL;
 184
 185     $urlString = 'civicrm/mailing/send';
 186     $urlParams = "_qf_Test_display=true&qfKey={$testParams['qfKey']}";
 187
 188     $ssID = $self->get('ssID');
 189     if ($ssID && $self->_searchBasedMailing) {
 190       if ($self->_action == CRM_Core_Action::BASIC) {
 191         $fragment = 'search';
 192       }
 193       elseif ($self->_action == CRM_Core_Action::PROFILE) {
 194         $fragment = 'search/builder';
 195       }
 196       elseif ($self->_action == CRM_Core_Action::ADVANCED) {
 197         $fragment = 'search/advanced';
 198       }
 199       else {
 200         $fragment = 'search/custom';
 201       }
 202       $urlString = 'civicrm/contact/' . $fragment;
 203     }
 204     $emails = NULL;
 205     if (!empty($testParams['sendtest'])) {
 206       if (!($testParams['test_group'] || $testParams['test_email'])) {
 207         CRM_Core_Session::setStatus(ts('You did not provide an email address or select a group.'), ts('Test not sent.'), 'error');
 208         $error = TRUE;
 209       }
 210
 211       if ($testParams['test_email']) {
 212         $emailAdd = explode(',', $testParams['test_email']);
 213         foreach ($emailAdd as $key => $value) {
 214           $email = trim($value);
 215           $testParams['emails'][] = $email;
 216           $emails .= $emails ? ",'$email'" : "'$email'";
 217           if (!CRM_Utils_Rule::email($email)) {
 218             CRM_Core_Session::setStatus(ts('Please enter a valid email address.'), ts('Test not sent.'), 'error');
 219             $error = TRUE;
 220           }
 221         }
 222       }
 223
 224       if ($error) {
 225         $url = CRM_Utils_System::url($urlString, $urlParams);
 226         CRM_Utils_System::redirect($url);
 227         return $error;
 228       }
 229     }
 230
 231     if (!empty($testParams['_qf_Test_submit'])) {
 232       //when user perform mailing from search context
 233       //redirect it to search result CRM-3711.
 234       if ($ssID && $self->_searchBasedMailing) {
 235         $draftURL = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
 236         $status = ts("You can continue later by clicking the 'Continue' action to resume working on it.<br />From <a href='%1'>Draft and Unscheduled Mailings</a>.", array(1 => $draftURL));
 237
 238         //replace user context to search.
 239         $context = $self->get('context');
 240         if (!CRM_Contact_Form_Search::isSearchContext($context)) {
 241           $context = 'search';
 242         }
 243         $urlParams = "force=1&reset=1&ssID={$ssID}&context={$context}&qfKey={$testParams['qfKey']}";
 244         $url = CRM_Utils_System::url($urlString, $urlParams);
 245       }
 246       else {
 247         $status = ts("Click the 'Continue' action to resume working on it.");
 248         $url = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
 249       }
 250       CRM_Core_Session::setStatus($status, ts('Mailing Saved'), 'success');
 251       CRM_Utils_System::redirect($url);
 252     }
 253
 254     if (CRM_Mailing_Info::workflowEnabled()) {
 255       if (!CRM_Core_Permission::check('schedule mailings') &&
 256         CRM_Core_Permission::check('create mailings')
 257       ) {
 258         $url = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
 259         CRM_Utils_System::redirect($url);
 260       }
 261     }
 262
 263     if (!empty($testParams['_qf_Test_next']) &&
 264       $self->get('count') <= 0) {
 265       return array(
 266         '_qf_default' =>
 267         ts("You can not schedule or send this mailing because there are currently no recipients selected. Click 'Previous' to return to the Select Recipients step, OR click 'Save & Continue Later'."),
 268       );
 269     }
 270
 271     if (!empty($_POST['_qf_Import_refresh']) || !empty($testParams['_qf_Test_next']) || empty($testParams['sendtest'])) {
 272       $error = TRUE;
 273       return $error;
 274     }
 275
 276     $job             = new CRM_Mailing_BAO_MailingJob();
 277     $job->mailing_id = $self->get('mailing_id');
 278     $job->is_test    = TRUE;
 279     $job->save();
 280     $newEmails = NULL;
 281     $session = CRM_Core_Session::singleton();
 282     if (!empty($testParams['emails'])) {
 283       $query = "
 284 SELECT     e.id, e.contact_id, e.email
 285 FROM       civicrm_email e
 286 INNER JOIN civicrm_contact c ON e.contact_id = c.id
 287 WHERE      e.email IN ($emails)
 288 AND        e.on_hold = 0
 289 AND        c.is_opt_out = 0
 290 AND        c.do_not_email = 0
 291 AND        c.is_deleted = 0
 292 AND        c.is_deceased = 0
 293 GROUP BY   e.id
 294 ORDER BY   e.is_bulkmail DESC, e.is_primary DESC
 295 ";
 296
 297       $dao = CRM_Core_DAO::executeQuery($query);
 298       $emailDetail = array();
 299       // fetch contact_id and email id for all existing emails
 300       while ($dao->fetch()) {
 301         $emailDetail[$dao->email] = array(
 302           'contact_id' => $dao->contact_id,
 303           'email_id' => $dao->id,
 304         );
 305       }
 306
 307       $dao->free();
 308       foreach ($testParams['emails'] as $key => $email) {
 309         // Email addresses are forced to lower case when saved, so ensure
 310         // we have the same case when comparing.
 311         $email = trim(strtolower($email));
 312         $contactId = $emailId = NULL;
 313         if (array_key_exists($email, $emailDetail)) {
 314           $emailId = $emailDetail[$email]['email_id'];
 315           $contactId = $emailDetail[$email]['contact_id'];
 316         }
 317
 318         if (!$contactId) {
 319           //create new contact.
 320           $params = array(
 321             'contact_type' => 'Individual',
 322             'email' => array(
 323               1 => array(
 324           'email' => $email,
 325                 'is_primary' => 1,
 326                 'location_type_id' => 1,
 327               )),
 328           );
 329           $contact   = CRM_Contact_BAO_Contact::create($params);
 330           $emailId   = $contact->email[0]->id;
 331           $contactId = $contact->id;
 332           $contact->free();
 333         }
 334         $params = array(
 335           'job_id' => $job->id,
 336           'email_id' => $emailId,
 337           'contact_id' => $contactId,
 338         );
 339         CRM_Mailing_Event_BAO_Queue::create($params);
 340       }
 341     }
 342
 343     $testParams['job_id'] = $job->id;
 344     $isComplete = FALSE;
 345     while (!$isComplete) {
 346       $isComplete = CRM_Mailing_BAO_MailingJob::runJobs($testParams);
 347     }
 348
 349     if (!empty($testParams['sendtest'])) {
 350       $status = NULL;
 351       if (CRM_Mailing_Info::workflowEnabled()) {
 352         if ((
 353             CRM_Core_Permission::check('schedule mailings') &&
 354             CRM_Core_Permission::check('create mailings')
 355           ) ||
 356           CRM_Core_Permission::check('access CiviMail')
 357         ) {
 358           $status = ts("Click 'Next' when you are ready to Schedule or Send your live mailing (you will still have a chance to confirm or cancel sending this mailing on the next page).");
 359         }
 360       }
 361       else {
 362         $status = ts("Click 'Next' when you are ready to Schedule or Send your live mailing (you will still have a chance to confirm or cancel sending this mailing on the next page).");
 363       }
 364
 365       if ($status) {
 366         CRM_Core_Session::setStatus($status, ts('Test message sent'), 'success');
 367       }
 368       $url = CRM_Utils_System::url($urlString, $urlParams);
 369       CRM_Utils_System::redirect($url);
 370     }
 371     $error = TRUE;
 372     return $error;
 373   }
 374
 375   /**
 376    * Display Name of the form
 377    *
 378    *
 379    * @return string
 380    */
 381   public function getTitle() {
 382     return ts('Test');
 383   }
 384
 385   public function postProcess() {
 386   }
 387
 388 }