CRM/Contribute/Form/Task/PDF.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  */
  33
  34 /**
  35  * This class provides the functionality to email a group of
  36  * contacts.
  37  */
  38 class CRM_Contribute_Form_Task_PDF extends CRM_Contribute_Form_Task {
  39
  40   /**
  41    * Are we operating in "single mode", i.e. updating the task of only
  42    * one specific contribution?
  43    *
  44    * @var boolean
  45    */
  46   public $_single = FALSE;
  47
  48   protected $_rows;
  49
  50   /**
  51    * Build all the data structures needed to build the form.
  52    */
  53   public function preProcess() {
  54     $id = CRM_Utils_Request::retrieve('id', 'Positive',
  55       $this, FALSE
  56     );
  57
  58     if ($id) {
  59       $this->_contributionIds = array($id);
  60       $this->_componentClause = " civicrm_contribution.id IN ( $id ) ";
  61       $this->_single = TRUE;
  62       $this->assign('totalSelectedContributions', 1);
  63     }
  64     else {
  65       parent::preProcess();
  66     }
  67
  68     // check that all the contribution ids have pending status
  69     $query = "
  70 SELECT count(*)
  71 FROM   civicrm_contribution
  72 WHERE  contribution_status_id != 1
  73 AND    {$this->_componentClause}";
  74     $count = CRM_Core_DAO::singleValueQuery($query);
  75     if ($count != 0) {
  76       CRM_Core_Error::statusBounce("Please select only online contributions with Completed status.");
  77     }
  78
  79     // we have all the contribution ids, so now we get the contact ids
  80     parent::setContactIDs();
  81     $this->assign('single', $this->_single);
  82
  83     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
  84     $urlParams = 'force=1';
  85     if (CRM_Utils_Rule::qfKey($qfKey)) {
  86       $urlParams .= "&qfKey=$qfKey";
  87     }
  88
  89     $url = CRM_Utils_System::url('civicrm/contribute/search', $urlParams);
  90     $breadCrumb = array(
  91       array(
  92         'url' => $url,
  93         'title' => ts('Search Results'),
  94       ),
  95     );
  96
  97     CRM_Utils_System::appendBreadCrumb($breadCrumb);
  98     CRM_Utils_System::setTitle(ts('Print Contribution Receipts'));
  99   }
 100
 101   /**
 102    * Build the form object.
 103    */
 104   public function buildQuickForm() {
 105
 106     $this->addElement('radio', 'output', NULL, ts('Email Receipts'), 'email_receipt',
 107       array('onClick' => "document.getElementById('selectPdfFormat').style.display = 'none';")
 108     );
 109     $this->addElement('radio', 'output', NULL, ts('PDF Receipts'), 'pdf_receipt',
 110       array('onClick' => "document.getElementById('selectPdfFormat').style.display = 'block';")
 111     );
 112     $this->addRule('output', ts('Selection required'), 'required');
 113
 114     $this->add('select', 'pdf_format_id', ts('Page Format'),
 115       array(0 => ts('- default -')) + CRM_Core_BAO_PdfFormat::getList(TRUE)
 116     );
 117     $this->add('checkbox', 'receipt_update', ts('Update receipt dates for these contributions'), FALSE);
 118     $this->add('checkbox', 'override_privacy', ts('Override privacy setting? (Do not email / Do not mail)'), FALSE);
 119
 120     $this->addButtons(array(
 121         array(
 122           'type' => 'next',
 123           'name' => ts('Process Receipt(s)'),
 124           'isDefault' => TRUE,
 125         ),
 126         array(
 127           'type' => 'back',
 128           'name' => ts('Cancel'),
 129         ),
 130       )
 131     );
 132   }
 133
 134   /**
 135    * Set default values.
 136    */
 137   public function setDefaultValues() {
 138     $defaultFormat = CRM_Core_BAO_PdfFormat::getDefaultValues();
 139     return array('pdf_format_id' => $defaultFormat['id'], 'receipt_update' => 1, 'override_privacy' => 0);
 140   }
 141
 142   /**
 143    * Process the form after the input has been submitted and validated.
 144    */
 145   public function postProcess() {
 146     // get all the details needed to generate a receipt
 147     $message = array();
 148     $template = CRM_Core_Smarty::singleton();
 149
 150     $params = $this->controller->exportValues($this->_name);
 151     $elements = self::getElements($this->_contributionIds, $params, $this->_contactIds);
 152
 153     foreach ($elements['details'] as $contribID => $detail) {
 154       $input = $ids = $objects = array();
 155
 156       if (in_array($detail['contact'], $elements['excludeContactIds'])) {
 157         continue;
 158       }
 159
 160       $input['component'] = $detail['component'];
 161
 162       $ids['contact'] = $detail['contact'];
 163       $ids['contribution'] = $contribID;
 164       $ids['contributionRecur'] = NULL;
 165       $ids['contributionPage'] = NULL;
 166       $ids['membership'] = CRM_Utils_Array::value('membership', $detail);
 167       $ids['participant'] = CRM_Utils_Array::value('participant', $detail);
 168       $ids['event'] = CRM_Utils_Array::value('event', $detail);
 169
 170       if (!$elements['baseIPN']->validateData($input, $ids, $objects, FALSE)) {
 171         CRM_Core_Error::fatal();
 172       }
 173
 174       $contribution = &$objects['contribution'];
 175
 176       // set some fake input values so we can reuse IPN code
 177       $input['amount'] = $contribution->total_amount;
 178       $input['is_test'] = $contribution->is_test;
 179       $input['fee_amount'] = $contribution->fee_amount;
 180       $input['net_amount'] = $contribution->net_amount;
 181       $input['trxn_id'] = $contribution->trxn_id;
 182       $input['trxn_date'] = isset($contribution->trxn_date) ? $contribution->trxn_date : NULL;
 183       $input['receipt_update'] = $params['receipt_update'];
 184       $input['contribution_status_id'] = $contribution->contribution_status_id;
 185
 186       // CRM_Contribute_BAO_Contribution::composeMessageArray expects mysql formatted date
 187       $objects['contribution']->receive_date = CRM_Utils_Date::isoToMysql($objects['contribution']->receive_date);
 188
 189       $values = array();
 190       $mail = CRM_Contribute_BAO_Contribution::sendMail($input, $ids, $objects['contribution']->id, $values, FALSE,
 191         $elements['createPdf']);
 192
 193       if ($mail['html']) {
 194         $message[] = $mail['html'];
 195       }
 196       else {
 197         $message[] = nl2br($mail['body']);
 198       }
 199
 200       // reset template values before processing next transactions
 201       $template->clearTemplateVars();
 202     }
 203
 204     if ($elements['createPdf']) {
 205       CRM_Utils_PDF_Utils::html2pdf($message,
 206         'civicrmContributionReceipt.pdf',
 207         FALSE,
 208         $elements['params']['pdf_format_id']
 209       );
 210       CRM_Utils_System::civiExit();
 211     }
 212     else {
 213       if ($elements['suppressedEmails']) {
 214         $status = ts('Email was NOT sent to %1 contacts (no email address on file, or communication preferences specify DO NOT EMAIL, or contact is deceased).', array(1 => $elements['suppressedEmails']));
 215         $msgTitle = ts('Email Error');
 216         $msgType = 'error';
 217       }
 218       else {
 219         $status = ts('Your mail has been sent.');
 220         $msgTitle = ts('Sent');
 221         $msgType = 'success';
 222       }
 223       CRM_Core_Session::setStatus($status, $msgTitle, $msgType);
 224     }
 225   }
 226
 227   /**
 228    * Declaration of common variables for Invoice and PDF.
 229    *
 230    *
 231    * @param array $contribIds
 232    *   Contribution Id.
 233    * @param array $params
 234    *   Parameter for pdf or email invoices.
 235    * @param array $contactIds
 236    *   Contact Id.
 237    *
 238    * @return array
 239    *   array of common elements
 240    *
 241    */
 242   static public function getElements($contribIds, $params, $contactIds) {
 243     $pdfElements = array();
 244
 245     $pdfElements['contribIDs'] = implode(',', $contribIds);
 246
 247     $pdfElements['details'] = CRM_Contribute_Form_Task_Status::getDetails($pdfElements['contribIDs']);
 248
 249     $pdfElements['baseIPN'] = new CRM_Core_Payment_BaseIPN();
 250
 251     $pdfElements['params'] = $params;
 252
 253     $pdfElements['createPdf'] = FALSE;
 254     if (!empty($pdfElements['params']['output']) &&
 255       ($pdfElements['params']['output'] == "pdf_invoice" || $pdfElements['params']['output'] == "pdf_receipt")
 256     ) {
 257       $pdfElements['createPdf'] = TRUE;
 258     }
 259
 260     $excludeContactIds = array();
 261     if (!$pdfElements['createPdf']) {
 262       $returnProperties = array(
 263         'email' => 1,
 264         'do_not_email' => 1,
 265         'is_deceased' => 1,
 266         'on_hold' => 1,
 267       );
 268
 269       list($contactDetails) = CRM_Utils_Token::getTokenDetails($contactIds, $returnProperties, FALSE, FALSE);
 270       $pdfElements['suppressedEmails'] = 0;
 271       $suppressedEmails = 0;
 272       foreach ($contactDetails as $id => $values) {
 273         if (empty($values['email']) ||
 274           (empty($params['override_privacy']) && !empty($values['do_not_email']))
 275           || CRM_Utils_Array::value('is_deceased', $values)
 276           || !empty($values['on_hold'])
 277         ) {
 278           $suppressedEmails++;
 279           $pdfElements['suppressedEmails'] = $suppressedEmails;
 280           $excludeContactIds[] = $values['contact_id'];
 281         }
 282       }
 283     }
 284     $pdfElements['excludeContactIds'] = $excludeContactIds;
 285
 286     return $pdfElements;
 287   }
 288
 289 }