3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class provides the common functionality for creating PDF letter for
38 * one or a group of contact ids.
40 class CRM_Contact_Form_Task_PDFLetterCommon
{
43 * Build all the data structures needed to build the form
45 * @param CRM_Core_Form $form
49 public static function preProcess(&$form) {
50 $messageText = array();
51 $messageSubject = array();
52 $dao = new CRM_Core_BAO_MessageTemplate();
55 while ($dao->fetch()) {
56 $messageText[$dao->id
] = $dao->msg_text
;
57 $messageSubject[$dao->id
] = $dao->msg_subject
;
60 $form->assign('message', $messageText);
61 $form->assign('messageSubject', $messageSubject);
62 CRM_Utils_System
::setTitle('Create Printable Letters (PDF)');
66 * @param CRM_Core_Form $form
69 public static function preProcessSingle(&$form, $cid) {
70 $form->_contactIds
= array($cid);
71 // put contact display name in title for single contact mode
72 CRM_Utils_System
::setTitle(ts('Create Printable Letter (PDF) for %1', array(1 => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name'))));
76 * Build the form object
78 * @var CRM_Core_Form $form
82 public static function buildQuickForm(&$form) {
83 // This form outputs a file so should never be submitted via ajax
84 $form->preventAjaxSubmit();
86 //Added for CRM-12682: Add activity subject and campaign fields
87 CRM_Campaign_BAO_Campaign
::addCampaign($form);
91 ts('Activity Subject'),
92 array('size' => 45, 'maxlength' => 255),
96 $form->add('static', 'pdf_format_header', NULL, ts('Page Format: %1', array(1 => '<span class="pdf-format-header-label"></span>')));
97 $form->addSelect('format_id', array(
98 'label' => ts('Select Format'),
99 'placeholder' => ts('Default'),
100 'entity' => 'message_template',
101 'field' => 'pdf_format_id',
102 'option_url' => 'civicrm/admin/pdfFormats',
108 array(0 => ts('- default -')) + CRM_Core_BAO_PaperSize
::getList(TRUE),
110 array('onChange' => "selectPaper( this.value ); showUpdateFormatChkBox();")
112 $form->add('static', 'paper_dimensions', NULL, ts('Width x Height'));
117 CRM_Core_BAO_PdfFormat
::getPageOrientations(),
119 array('onChange' => "updatePaperDimensions(); showUpdateFormatChkBox();")
124 ts('Unit of Measure'),
125 CRM_Core_BAO_PdfFormat
::getUnits(),
127 array('onChange' => "selectMetric( this.value );")
133 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
140 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
147 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
154 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
158 $config = CRM_Core_Config
::singleton();
159 if ($config->wkhtmltopdfPath
== FALSE) {
163 ts('Stationery (relative path to PDF you wish to use as the background)'),
164 array('size' => 25, 'maxlength' => 900, 'onkeyup' => "showUpdateFormatChkBox();"),
168 $form->add('checkbox', 'bind_format', ts('Always use this Page Format with the selected Template'));
169 $form->add('checkbox', 'update_format', ts('Update Page Format (this will affect all templates that use this format)'));
171 $form->assign('useThisPageFormat', ts('Always use this Page Format with the new template?'));
172 $form->assign('useSelectedPageFormat', ts('Should the new template always use the selected Page Format?'));
173 $form->assign('totalSelectedContacts', count($form->_contactIds
));
175 CRM_Mailing_BAO_Mailing
::commonLetterCompose($form);
178 if ($form->get('action') != CRM_Core_Action
::VIEW
) {
181 'name' => $form->_single ?
ts('Make PDF') : ts('Make PDFs'),
187 'name' => $form->get('action') == CRM_Core_Action
::VIEW ?
ts('Done') : ts('Cancel'),
189 $form->addButtons($buttons);
191 $form->addFormRule(array('CRM_Contact_Form_Task_PDFLetterCommon', 'formRule'), $form);
197 public static function setDefaultValues() {
198 $defaultFormat = CRM_Core_BAO_PdfFormat
::getDefaultValues();
199 $defaultFormat['format_id'] = $defaultFormat['id'];
200 return $defaultFormat;
206 * @param array $fields
207 * The input form values.
208 * @param array $dontCare
210 * Additional values form 'this'.
213 * TRUE if no errors, else array of errors.
216 public static function formRule($fields, $dontCare, $self) {
218 $template = CRM_Core_Smarty
::singleton();
221 if (!empty($fields['saveTemplate']) && empty($fields['saveTemplateName'])) {
222 $errors['saveTemplateName'] = ts("Enter name to save message template");
224 if (!is_numeric($fields['margin_left'])) {
225 $errors['margin_left'] = 'Margin must be numeric';
227 if (!is_numeric($fields['margin_right'])) {
228 $errors['margin_right'] = 'Margin must be numeric';
230 if (!is_numeric($fields['margin_top'])) {
231 $errors['margin_top'] = 'Margin must be numeric';
233 if (!is_numeric($fields['margin_bottom'])) {
234 $errors['margin_bottom'] = 'Margin must be numeric';
236 return empty($errors) ?
TRUE : $errors;
240 * Part of the post process which prepare and extract information from the template
243 * @param CRM_Core_Form $form
245 * @return array( $categories, $html_message, $messageToken, $returnProperties )
247 static protected function processMessageTemplate(&$form) {
248 $formValues = $form->controller
->exportValues($form->getName());
250 // process message template
251 if (!empty($formValues['saveTemplate']) ||
!empty($formValues['updateTemplate'])) {
252 $messageTemplate = array(
254 'msg_html' => $formValues['html_message'],
255 'msg_subject' => NULL,
259 $messageTemplate['pdf_format_id'] = 'null';
260 if (!empty($formValues['bind_format']) && $formValues['format_id']) {
261 $messageTemplate['pdf_format_id'] = $formValues['format_id'];
263 if (!empty($formValues['saveTemplate']) && $formValues['saveTemplate']) {
264 $messageTemplate['msg_title'] = $formValues['saveTemplateName'];
265 CRM_Core_BAO_MessageTemplate
::add($messageTemplate);
268 if (!empty($formValues['updateTemplate']) && $formValues['template'] && $formValues['updateTemplate']) {
269 $messageTemplate['id'] = $formValues['template'];
271 unset($messageTemplate['msg_title']);
272 CRM_Core_BAO_MessageTemplate
::add($messageTemplate);
275 elseif (CRM_Utils_Array
::value('template', $formValues) > 0) {
276 if (!empty($formValues['bind_format']) && $formValues['format_id']) {
277 $query = "UPDATE civicrm_msg_template SET pdf_format_id = {$formValues['format_id']} WHERE id = {$formValues['template']}";
280 $query = "UPDATE civicrm_msg_template SET pdf_format_id = NULL WHERE id = {$formValues['template']}";
282 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
284 if (!empty($formValues['update_format'])) {
285 $bao = new CRM_Core_BAO_PdfFormat();
286 $bao->savePdfFormat($formValues, $formValues['format_id']);
292 CRM_Utils_Hook
::tokens($tokens);
293 $categories = array_keys($tokens);
295 $html_message = $formValues['html_message'];
297 //time being hack to strip ' '
298 //from particular letter line, CRM-6798
299 self
::formatMessage($html_message);
301 $messageToken = CRM_Utils_Token
::getTokens($html_message);
303 $returnProperties = array();
304 if (isset($messageToken['contact'])) {
305 foreach ($messageToken['contact'] as $key => $value) {
306 $returnProperties[$value] = 1;
310 return array($formValues, $categories, $html_message, $messageToken, $returnProperties);
314 * Process the form after the input has been submitted and validated
317 * @param CRM_Core_Form $form
321 public static function postProcess(&$form) {
322 list($formValues, $categories, $html_message, $messageToken, $returnProperties) = self
::processMessageTemplate($form);
324 $skipOnHold = isset($form->skipOnHold
) ?
$form->skipOnHold
: FALSE;
325 $skipDeceased = isset($form->skipDeceased
) ?
$form->skipDeceased
: TRUE;
327 foreach ($form->_contactIds
as $item => $contactId) {
328 $params = array('contact_id' => $contactId);
330 list($contact) = CRM_Utils_Token
::getTokenDetails($params,
336 'CRM_Contact_Form_Task_PDFLetterCommon'
338 if (civicrm_error($contact)) {
339 $notSent[] = $contactId;
343 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html_message, $contact[$contactId], TRUE, $messageToken);
344 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $contact[$contactId], $categories, TRUE);
346 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
347 $smarty = CRM_Core_Smarty
::singleton();
348 // also add the contact tokens to the template
349 $smarty->assign_by_ref('contact', $contact);
350 $tokenHtml = $smarty->fetch("string:$tokenHtml");
353 $html[] = $tokenHtml;
356 self
::createActivities($form, $html_message, $form->_contactIds
);
358 CRM_Utils_PDF_Utils
::html2pdf($html, "CiviLetter.pdf", FALSE, $formValues);
360 $form->postProcessHook();
362 CRM_Utils_System
::civiExit(1);
366 * @param CRM_Core_Form $form
367 * @param $html_message
370 * @throws CRM_Core_Exception
372 public static function createActivities($form, $html_message, $contactIds) {
373 //Added for CRM-12682: Add activity subject and campaign fields
374 $formValues = $form->controller
->exportValues($form->getName());
376 $session = CRM_Core_Session
::singleton();
377 $userID = $session->get('userID');
378 $activityTypeID = CRM_Core_OptionGroup
::getValue(
383 $activityParams = array(
384 'subject' => $formValues['subject'],
385 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $formValues),
386 'source_contact_id' => $userID,
387 'activity_type_id' => $activityTypeID,
388 'activity_date_time' => date('YmdHis'),
389 'details' => $html_message,
391 if (!empty($form->_activityId
)) {
392 $activityParams +
= array('id' => $form->_activityId
);
395 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
398 // create Print PDF activity for each selected contact. CRM-6886
399 $activityIds = array();
400 foreach ($contactIds as $contactId) {
401 $activityID = CRM_Activity_BAO_Activity
::create($activityParams);
402 $activityIds[$contactId] = $activityID->id
;
406 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
407 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
409 //@todo why are we using $form->_contactIds here & contactIds above - need comment
410 foreach ($form->_contactIds
as $contactId) {
411 $activityTargetParams = array(
412 'activity_id' => empty($activity->id
) ?
$activityIds[$contactId] : $activity->id
,
413 'contact_id' => $contactId,
414 'record_type_id' => $targetID,
416 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
423 public static function formatMessage(&$message) {
424 $newLineOperators = array(
427 'pattern' => '/<(\s+)?p(\s+)?>/m',
431 'pattern' => '/<(\s+)?br(\s+)?\/>/m',
435 $htmlMsg = preg_split($newLineOperators['p']['pattern'], $message);
436 foreach ($htmlMsg as $k => & $m) {
437 $messages = preg_split($newLineOperators['br']['pattern'], $m);
438 foreach ($messages as $key => & $msg) {
441 if (preg_match('/^( )+/', $msg, $matches)) {
442 $spaceLen = strlen($matches[0]) / 6;
443 $trimMsg = ltrim($msg, ' ');
444 $charLen = strlen($trimMsg);
445 $totalLen = $charLen +
$spaceLen;
446 if ($totalLen > 100) {
448 if ($spaceLen > 50) {
451 if ($charLen > 100) {
454 $msg = str_repeat(' ', $spacesCount) . $trimMsg;
458 $m = implode($newLineOperators['br']['oper'], $messages);
460 $message = implode($newLineOperators['p']['oper'], $htmlMsg);