3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
35 * This class provides the common functionality for creating PDF letter for one or a group of contact ids.
37 class CRM_Contact_Form_Task_PDFLetterCommon
{
40 * Build all the data structures needed to build the form.
42 * @param CRM_Core_Form $form
44 public static function preProcess(&$form) {
45 $messageText = array();
46 $messageSubject = array();
47 $dao = new CRM_Core_BAO_MessageTemplate();
50 while ($dao->fetch()) {
51 $messageText[$dao->id
] = $dao->msg_text
;
52 $messageSubject[$dao->id
] = $dao->msg_subject
;
55 $form->assign('message', $messageText);
56 $form->assign('messageSubject', $messageSubject);
57 CRM_Utils_System
::setTitle('Create Printable Letters (PDF)');
61 * @param CRM_Core_Form $form
64 public static function preProcessSingle(&$form, $cid) {
65 $form->_contactIds
= array($cid);
66 // put contact display name in title for single contact mode
67 CRM_Utils_System
::setTitle(ts('Create Printable Letter (PDF) for %1', array(1 => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name'))));
71 * Build the form object.
73 * @var CRM_Core_Form $form
75 public static function buildQuickForm(&$form) {
76 // This form outputs a file so should never be submitted via ajax
77 $form->preventAjaxSubmit();
79 //Added for CRM-12682: Add activity subject and campaign fields
80 CRM_Campaign_BAO_Campaign
::addCampaign($form);
84 ts('Activity Subject'),
85 array('size' => 45, 'maxlength' => 255),
89 $form->add('static', 'pdf_format_header', NULL, ts('Page Format: %1', array(1 => '<span class="pdf-format-header-label"></span>')));
90 $form->addSelect('format_id', array(
91 'label' => ts('Select Format'),
92 'placeholder' => ts('Default'),
93 'entity' => 'message_template',
94 'field' => 'pdf_format_id',
95 'option_url' => 'civicrm/admin/pdfFormats',
101 array(0 => ts('- default -')) + CRM_Core_BAO_PaperSize
::getList(TRUE),
103 array('onChange' => "selectPaper( this.value ); showUpdateFormatChkBox();")
105 $form->add('static', 'paper_dimensions', NULL, ts('Width x Height'));
110 CRM_Core_BAO_PdfFormat
::getPageOrientations(),
112 array('onChange' => "updatePaperDimensions(); showUpdateFormatChkBox();")
117 ts('Unit of Measure'),
118 CRM_Core_BAO_PdfFormat
::getUnits(),
120 array('onChange' => "selectMetric( this.value );")
126 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
133 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
140 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
147 array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"),
151 $config = CRM_Core_Config
::singleton();
152 /** CRM-15883 Suppressing Stationery path field until we switch from DOMPDF to a library that supports it.
153 if ($config->wkhtmltopdfPath == FALSE) {
157 ts('Stationery (relative path to PDF you wish to use as the background)'),
158 array('size' => 25, 'maxlength' => 900, 'onkeyup' => "showUpdateFormatChkBox();"),
163 $form->add('checkbox', 'bind_format', ts('Always use this Page Format with the selected Template'));
164 $form->add('checkbox', 'update_format', ts('Update Page Format (this will affect all templates that use this format)'));
166 $form->assign('useThisPageFormat', ts('Always use this Page Format with the new template?'));
167 $form->assign('useSelectedPageFormat', ts('Should the new template always use the selected Page Format?'));
168 $form->assign('totalSelectedContacts', count($form->_contactIds
));
170 CRM_Mailing_BAO_Mailing
::commonCompose($form);
173 if ($form->get('action') != CRM_Core_Action
::VIEW
) {
176 'name' => $form->_single ?
ts('Make PDF') : ts('Make PDFs'),
181 'name' => ts('Preview'),
182 'subName' => 'preview',
183 'icon' => 'fa-search',
184 'isDefault' => FALSE,
189 'name' => $form->get('action') == CRM_Core_Action
::VIEW ?
ts('Done') : ts('Cancel'),
191 $form->addButtons($buttons);
193 $form->addFormRule(array('CRM_Contact_Form_Task_PDFLetterCommon', 'formRule'), $form);
197 * Set default values.
199 public static function setDefaultValues() {
200 $defaultFormat = CRM_Core_BAO_PdfFormat
::getDefaultValues();
201 $defaultFormat['format_id'] = $defaultFormat['id'];
202 return $defaultFormat;
208 * @param array $fields
209 * The input form values.
210 * @param array $dontCare
212 * Additional values form 'this'.
215 * TRUE if no errors, else array of errors.
217 public static function formRule($fields, $dontCare, $self) {
219 $template = CRM_Core_Smarty
::singleton();
222 if (!empty($fields['saveTemplate']) && empty($fields['saveTemplateName'])) {
223 $errors['saveTemplateName'] = ts("Enter name to save message template");
225 if (!is_numeric($fields['margin_left'])) {
226 $errors['margin_left'] = 'Margin must be numeric';
228 if (!is_numeric($fields['margin_right'])) {
229 $errors['margin_right'] = 'Margin must be numeric';
231 if (!is_numeric($fields['margin_top'])) {
232 $errors['margin_top'] = 'Margin must be numeric';
234 if (!is_numeric($fields['margin_bottom'])) {
235 $errors['margin_bottom'] = 'Margin must be numeric';
237 return empty($errors) ?
TRUE : $errors;
241 * Part of the post process which prepare and extract information from the template.
244 * @param CRM_Core_Form $form
247 * [$categories, $html_message, $messageToken, $returnProperties]
249 static protected function processMessageTemplate(&$form) {
250 $formValues = $form->controller
->exportValues($form->getName());
252 // process message template
253 if (!empty($formValues['saveTemplate']) ||
!empty($formValues['updateTemplate'])) {
254 $messageTemplate = array(
256 'msg_html' => $formValues['html_message'],
257 'msg_subject' => NULL,
261 $messageTemplate['pdf_format_id'] = 'null';
262 if (!empty($formValues['bind_format']) && $formValues['format_id']) {
263 $messageTemplate['pdf_format_id'] = $formValues['format_id'];
265 if (!empty($formValues['saveTemplate']) && $formValues['saveTemplate']) {
266 $messageTemplate['msg_title'] = $formValues['saveTemplateName'];
267 CRM_Core_BAO_MessageTemplate
::add($messageTemplate);
270 if (!empty($formValues['updateTemplate']) && $formValues['template'] && $formValues['updateTemplate']) {
271 $messageTemplate['id'] = $formValues['template'];
273 unset($messageTemplate['msg_title']);
274 CRM_Core_BAO_MessageTemplate
::add($messageTemplate);
277 elseif (CRM_Utils_Array
::value('template', $formValues) > 0) {
278 if (!empty($formValues['bind_format']) && $formValues['format_id']) {
279 $query = "UPDATE civicrm_msg_template SET pdf_format_id = {$formValues['format_id']} WHERE id = {$formValues['template']}";
282 $query = "UPDATE civicrm_msg_template SET pdf_format_id = NULL WHERE id = {$formValues['template']}";
284 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
286 if (!empty($formValues['update_format'])) {
287 $bao = new CRM_Core_BAO_PdfFormat();
288 $bao->savePdfFormat($formValues, $formValues['format_id']);
294 CRM_Utils_Hook
::tokens($tokens);
295 $categories = array_keys($tokens);
297 $html_message = $formValues['html_message'];
299 //time being hack to strip ' '
300 //from particular letter line, CRM-6798
301 self
::formatMessage($html_message);
303 $messageToken = CRM_Utils_Token
::getTokens($html_message);
305 $returnProperties = array();
306 if (isset($messageToken['contact'])) {
307 foreach ($messageToken['contact'] as $key => $value) {
308 $returnProperties[$value] = 1;
312 return array($formValues, $categories, $html_message, $messageToken, $returnProperties);
316 * Process the form after the input has been submitted and validated.
318 * @param CRM_Core_Form $form
320 public static function postProcess(&$form) {
321 list($formValues, $categories, $html_message, $messageToken, $returnProperties) = self
::processMessageTemplate($form);
322 $buttonName = $form->controller
->getButtonName();
323 $skipOnHold = isset($form->skipOnHold
) ?
$form->skipOnHold
: FALSE;
324 $skipDeceased = isset($form->skipDeceased
) ?
$form->skipDeceased
: TRUE;
326 foreach ($form->_contactIds
as $item => $contactId) {
327 $params = array('contact_id' => $contactId);
329 list($contact) = CRM_Utils_Token
::getTokenDetails($params,
335 'CRM_Contact_Form_Task_PDFLetterCommon'
337 if (civicrm_error($contact)) {
338 $notSent[] = $contactId;
342 $tokenHtml = CRM_Utils_Token
::replaceContactTokens($html_message, $contact[$contactId], TRUE, $messageToken);
343 if (!empty($form->_caseId
)) {
344 $tokenHtml = CRM_Utils_Token
::replaceCaseTokens($form->_caseId
, $html_message, $messageToken);
346 $tokenHtml = CRM_Utils_Token
::replaceHookTokens($tokenHtml, $contact[$contactId], $categories, TRUE);
348 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
349 $smarty = CRM_Core_Smarty
::singleton();
350 // also add the contact tokens to the template
351 $smarty->assign_by_ref('contact', $contact);
352 $tokenHtml = $smarty->fetch("string:$tokenHtml");
355 $html[] = $tokenHtml;
358 // CRM-16725 Skip creation of activities if user is previewing their PDF letter(s)
359 if ($buttonName == '_qf_PDF_submit') {
360 self
::createActivities($form, $html_message, $form->_contactIds
);
363 CRM_Utils_PDF_Utils
::html2pdf($html, "CiviLetter.pdf", FALSE, $formValues);
365 $form->postProcessHook();
367 CRM_Utils_System
::civiExit(1);
371 * @param CRM_Core_Form $form
372 * @param $html_message
375 * @throws CRM_Core_Exception
377 public static function createActivities($form, $html_message, $contactIds) {
378 //Added for CRM-12682: Add activity subject and campaign fields
379 $formValues = $form->controller
->exportValues($form->getName());
381 $session = CRM_Core_Session
::singleton();
382 $userID = $session->get('userID');
383 $activityTypeID = CRM_Core_OptionGroup
::getValue(
388 $activityParams = array(
389 'subject' => $formValues['subject'],
390 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $formValues),
391 'source_contact_id' => $userID,
392 'activity_type_id' => $activityTypeID,
393 'activity_date_time' => date('YmdHis'),
394 'details' => $html_message,
396 if (!empty($form->_activityId
)) {
397 $activityParams +
= array('id' => $form->_activityId
);
400 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
401 if (!empty($form->_caseId
)) {
402 $caseActivityParams = array('activity_id' => $activity->id
, 'case_id' => $form->_caseId
);
403 CRM_Case_BAO_Case
::processCaseActivity($caseActivityParams);
407 // create Print PDF activity for each selected contact. CRM-6886
408 $activityIds = array();
409 foreach ($contactIds as $contactId) {
410 $activityID = CRM_Activity_BAO_Activity
::create($activityParams);
411 $activityIds[$contactId] = $activityID->id
;
415 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
416 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
418 //@todo why are we using $form->_contactIds here & contactIds above - need comment
419 foreach ($form->_contactIds
as $contactId) {
420 $activityTargetParams = array(
421 'activity_id' => empty($activity->id
) ?
$activityIds[$contactId] : $activity->id
,
422 'contact_id' => $contactId,
423 'record_type_id' => $targetID,
425 CRM_Activity_BAO_ActivityContact
::create($activityTargetParams);
432 public static function formatMessage(&$message) {
433 $newLineOperators = array(
436 'pattern' => '/<(\s+)?p(\s+)?>/m',
440 'pattern' => '/<(\s+)?br(\s+)?\/>/m',
444 $htmlMsg = preg_split($newLineOperators['p']['pattern'], $message);
445 foreach ($htmlMsg as $k => & $m) {
446 $messages = preg_split($newLineOperators['br']['pattern'], $m);
447 foreach ($messages as $key => & $msg) {
450 if (preg_match('/^( )+/', $msg, $matches)) {
451 $spaceLen = strlen($matches[0]) / 6;
452 $trimMsg = ltrim($msg, ' ');
453 $charLen = strlen($trimMsg);
454 $totalLen = $charLen +
$spaceLen;
455 if ($totalLen > 100) {
457 if ($spaceLen > 50) {
460 if ($charLen > 100) {
463 $msg = str_repeat(' ', $spacesCount) . $trimMsg;
467 $m = implode($newLineOperators['br']['oper'], $messages);
469 $message = implode($newLineOperators['p']['oper'], $htmlMsg);