Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
424029e3 | 35 | * This class provides the common functionality for creating PDF letter for one or a group of contact ids. |
6a488035 TO |
36 | */ |
37 | class CRM_Contact_Form_Task_PDFLetterCommon { | |
38 | ||
39 | /** | |
fe482240 | 40 | * Build all the data structures needed to build the form. |
6a488035 | 41 | * |
c490a46a | 42 | * @param CRM_Core_Form $form |
6a488035 | 43 | */ |
00be9182 | 44 | public static function preProcess(&$form) { |
353ffa53 | 45 | $messageText = array(); |
6a488035 | 46 | $messageSubject = array(); |
353ffa53 | 47 | $dao = new CRM_Core_BAO_MessageTemplate(); |
6a488035 TO |
48 | $dao->is_active = 1; |
49 | $dao->find(); | |
50 | while ($dao->fetch()) { | |
51 | $messageText[$dao->id] = $dao->msg_text; | |
52 | $messageSubject[$dao->id] = $dao->msg_subject; | |
53 | } | |
54 | ||
55 | $form->assign('message', $messageText); | |
56 | $form->assign('messageSubject', $messageSubject); | |
6ce08914 | 57 | CRM_Utils_System::setTitle('Create Printable Letters (PDF)'); |
6a488035 TO |
58 | } |
59 | ||
86538308 | 60 | /** |
c490a46a | 61 | * @param CRM_Core_Form $form |
100fef9d | 62 | * @param int $cid |
86538308 | 63 | */ |
00be9182 | 64 | public static function preProcessSingle(&$form, $cid) { |
6a488035 TO |
65 | $form->_contactIds = array($cid); |
66 | // put contact display name in title for single contact mode | |
6ce08914 | 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')))); |
6a488035 TO |
68 | } |
69 | ||
70 | /** | |
fe482240 | 71 | * Build the form object. |
6a488035 | 72 | * |
cae80d9f | 73 | * @var CRM_Core_Form $form |
6a488035 | 74 | */ |
00be9182 | 75 | public static function buildQuickForm(&$form) { |
cae80d9f CW |
76 | // This form outputs a file so should never be submitted via ajax |
77 | $form->preventAjaxSubmit(); | |
78 | ||
4c71ccb4 RN |
79 | //Added for CRM-12682: Add activity subject and campaign fields |
80 | CRM_Campaign_BAO_Campaign::addCampaign($form); | |
81 | $form->add( | |
82 | 'text', | |
83 | 'subject', | |
84 | ts('Activity Subject'), | |
85 | array('size' => 45, 'maxlength' => 255), | |
86 | FALSE | |
87 | ); | |
88 | ||
a7916823 CW |
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', | |
96 | )); | |
ed106721 DL |
97 | $form->add( |
98 | 'select', | |
99 | 'paper_size', | |
100 | ts('Paper Size'), | |
101 | array(0 => ts('- default -')) + CRM_Core_BAO_PaperSize::getList(TRUE), | |
102 | FALSE, | |
6a488035 TO |
103 | array('onChange' => "selectPaper( this.value ); showUpdateFormatChkBox();") |
104 | ); | |
105 | $form->add('static', 'paper_dimensions', NULL, ts('Width x Height')); | |
ed106721 DL |
106 | $form->add( |
107 | 'select', | |
108 | 'orientation', | |
109 | ts('Orientation'), | |
110 | CRM_Core_BAO_PdfFormat::getPageOrientations(), | |
111 | FALSE, | |
6a488035 TO |
112 | array('onChange' => "updatePaperDimensions(); showUpdateFormatChkBox();") |
113 | ); | |
ed106721 DL |
114 | $form->add( |
115 | 'select', | |
116 | 'metric', | |
117 | ts('Unit of Measure'), | |
118 | CRM_Core_BAO_PdfFormat::getUnits(), | |
119 | FALSE, | |
6a488035 TO |
120 | array('onChange' => "selectMetric( this.value );") |
121 | ); | |
ed106721 DL |
122 | $form->add( |
123 | 'text', | |
124 | 'margin_left', | |
125 | ts('Left Margin'), | |
126 | array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"), | |
127 | TRUE | |
6a488035 | 128 | ); |
ed106721 DL |
129 | $form->add( |
130 | 'text', | |
131 | 'margin_right', | |
132 | ts('Right Margin'), | |
133 | array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"), | |
134 | TRUE | |
6a488035 | 135 | ); |
ed106721 DL |
136 | $form->add( |
137 | 'text', | |
138 | 'margin_top', | |
139 | ts('Top Margin'), | |
140 | array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"), | |
141 | TRUE | |
6a488035 | 142 | ); |
ed106721 DL |
143 | $form->add( |
144 | 'text', | |
145 | 'margin_bottom', | |
146 | ts('Bottom Margin'), | |
147 | array('size' => 8, 'maxlength' => 8, 'onkeyup' => "showUpdateFormatChkBox();"), | |
148 | TRUE | |
6a488035 | 149 | ); |
bdfa67c3 | 150 | |
151 | $config = CRM_Core_Config::singleton(); | |
828659cf | 152 | /** CRM-15883 Suppressing Stationery path field until we switch from DOMPDF to a library that supports it. |
ab8a593e | 153 | if ($config->wkhtmltopdfPath == FALSE) { |
828659cf DG |
154 | $form->add( |
155 | 'text', | |
156 | 'stationery', | |
157 | ts('Stationery (relative path to PDF you wish to use as the background)'), | |
158 | array('size' => 25, 'maxlength' => 900, 'onkeyup' => "showUpdateFormatChkBox();"), | |
159 | FALSE | |
160 | ); | |
bdfa67c3 | 161 | } |
828659cf | 162 | */ |
6a488035 TO |
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)')); | |
165 | ||
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)); | |
169 | ||
36d27c19 | 170 | CRM_Mailing_BAO_Mailing::commonCompose($form); |
6a488035 | 171 | |
fc942baa CW |
172 | $buttons = array(); |
173 | if ($form->get('action') != CRM_Core_Action::VIEW) { | |
a37ec997 DG |
174 | $buttons[] = array( |
175 | 'type' => 'submit', | |
188bad99 CW |
176 | 'name' => $form->_single ? ts('Make PDF') : ts('Make PDFs'), |
177 | 'isDefault' => TRUE, | |
a37ec997 | 178 | ); |
fc942baa CW |
179 | $buttons[] = array( |
180 | 'type' => 'submit', | |
188bad99 CW |
181 | 'name' => ts('Preview'), |
182 | 'subName' => 'preview', | |
0291a521 | 183 | 'icon' => 'fa-search', |
188bad99 | 184 | 'isDefault' => FALSE, |
6a488035 | 185 | ); |
6a488035 | 186 | } |
fc942baa CW |
187 | $buttons[] = array( |
188 | 'type' => 'cancel', | |
189 | 'name' => $form->get('action') == CRM_Core_Action::VIEW ? ts('Done') : ts('Cancel'), | |
190 | ); | |
191 | $form->addButtons($buttons); | |
6a488035 TO |
192 | |
193 | $form->addFormRule(array('CRM_Contact_Form_Task_PDFLetterCommon', 'formRule'), $form); | |
194 | } | |
195 | ||
196 | /** | |
fe482240 | 197 | * Set default values. |
6a488035 | 198 | */ |
00be9182 | 199 | public static function setDefaultValues() { |
6a488035 TO |
200 | $defaultFormat = CRM_Core_BAO_PdfFormat::getDefaultValues(); |
201 | $defaultFormat['format_id'] = $defaultFormat['id']; | |
202 | return $defaultFormat; | |
203 | } | |
204 | ||
205 | /** | |
fe482240 | 206 | * Form rule. |
6a488035 | 207 | * |
77c5b619 TO |
208 | * @param array $fields |
209 | * The input form values. | |
6a488035 | 210 | * @param array $dontCare |
77c5b619 TO |
211 | * @param array $self |
212 | * Additional values form 'this'. | |
6a488035 | 213 | * |
4eeb9a5b TO |
214 | * @return bool |
215 | * TRUE if no errors, else array of errors. | |
6a488035 | 216 | */ |
00be9182 | 217 | public static function formRule($fields, $dontCare, $self) { |
6a488035 TO |
218 | $errors = array(); |
219 | $template = CRM_Core_Smarty::singleton(); | |
220 | ||
221 | //Added for CRM-1393 | |
a7488080 | 222 | if (!empty($fields['saveTemplate']) && empty($fields['saveTemplateName'])) { |
6a488035 TO |
223 | $errors['saveTemplateName'] = ts("Enter name to save message template"); |
224 | } | |
225 | if (!is_numeric($fields['margin_left'])) { | |
226 | $errors['margin_left'] = 'Margin must be numeric'; | |
227 | } | |
228 | if (!is_numeric($fields['margin_right'])) { | |
229 | $errors['margin_right'] = 'Margin must be numeric'; | |
230 | } | |
231 | if (!is_numeric($fields['margin_top'])) { | |
232 | $errors['margin_top'] = 'Margin must be numeric'; | |
233 | } | |
234 | if (!is_numeric($fields['margin_bottom'])) { | |
235 | $errors['margin_bottom'] = 'Margin must be numeric'; | |
236 | } | |
237 | return empty($errors) ? TRUE : $errors; | |
238 | } | |
239 | ||
240 | /** | |
fe482240 | 241 | * Part of the post process which prepare and extract information from the template. |
6a488035 | 242 | * |
6a488035 | 243 | * |
c490a46a | 244 | * @param CRM_Core_Form $form |
dbddfb08 | 245 | * |
72b3a70c CW |
246 | * @return array |
247 | * [$categories, $html_message, $messageToken, $returnProperties] | |
6a488035 TO |
248 | */ |
249 | static protected function processMessageTemplate(&$form) { | |
250 | $formValues = $form->controller->exportValues($form->getName()); | |
251 | ||
252 | // process message template | |
8cc574cf | 253 | if (!empty($formValues['saveTemplate']) || !empty($formValues['updateTemplate'])) { |
6a488035 TO |
254 | $messageTemplate = array( |
255 | 'msg_text' => NULL, | |
256 | 'msg_html' => $formValues['html_message'], | |
257 | 'msg_subject' => NULL, | |
258 | 'is_active' => TRUE, | |
259 | ); | |
260 | ||
261 | $messageTemplate['pdf_format_id'] = 'null'; | |
a7916823 | 262 | if (!empty($formValues['bind_format']) && $formValues['format_id']) { |
6a488035 TO |
263 | $messageTemplate['pdf_format_id'] = $formValues['format_id']; |
264 | } | |
a7488080 | 265 | if (!empty($formValues['saveTemplate']) && $formValues['saveTemplate']) { |
6a488035 | 266 | $messageTemplate['msg_title'] = $formValues['saveTemplateName']; |
c6327d7d | 267 | CRM_Core_BAO_MessageTemplate::add($messageTemplate); |
6a488035 TO |
268 | } |
269 | ||
a7488080 | 270 | if (!empty($formValues['updateTemplate']) && $formValues['template'] && $formValues['updateTemplate']) { |
6a488035 TO |
271 | $messageTemplate['id'] = $formValues['template']; |
272 | ||
273 | unset($messageTemplate['msg_title']); | |
c6327d7d | 274 | CRM_Core_BAO_MessageTemplate::add($messageTemplate); |
6a488035 TO |
275 | } |
276 | } | |
277 | elseif (CRM_Utils_Array::value('template', $formValues) > 0) { | |
a7916823 | 278 | if (!empty($formValues['bind_format']) && $formValues['format_id']) { |
6a488035 TO |
279 | $query = "UPDATE civicrm_msg_template SET pdf_format_id = {$formValues['format_id']} WHERE id = {$formValues['template']}"; |
280 | } | |
281 | else { | |
282 | $query = "UPDATE civicrm_msg_template SET pdf_format_id = NULL WHERE id = {$formValues['template']}"; | |
283 | } | |
284 | CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); | |
285 | } | |
a7488080 | 286 | if (!empty($formValues['update_format'])) { |
6a488035 TO |
287 | $bao = new CRM_Core_BAO_PdfFormat(); |
288 | $bao->savePdfFormat($formValues, $formValues['format_id']); | |
289 | } | |
290 | ||
291 | $html = array(); | |
292 | ||
293 | $tokens = array(); | |
294 | CRM_Utils_Hook::tokens($tokens); | |
295 | $categories = array_keys($tokens); | |
296 | ||
297 | $html_message = $formValues['html_message']; | |
298 | ||
299 | //time being hack to strip ' ' | |
300 | //from particular letter line, CRM-6798 | |
301 | self::formatMessage($html_message); | |
302 | ||
303 | $messageToken = CRM_Utils_Token::getTokens($html_message); | |
304 | ||
305 | $returnProperties = array(); | |
306 | if (isset($messageToken['contact'])) { | |
307 | foreach ($messageToken['contact'] as $key => $value) { | |
308 | $returnProperties[$value] = 1; | |
309 | } | |
310 | } | |
311 | ||
312 | return array($formValues, $categories, $html_message, $messageToken, $returnProperties); | |
313 | } | |
314 | ||
315 | /** | |
fe482240 | 316 | * Process the form after the input has been submitted and validated. |
6a488035 | 317 | * |
c490a46a | 318 | * @param CRM_Core_Form $form |
6a488035 | 319 | */ |
00be9182 | 320 | public static function postProcess(&$form) { |
6a488035 | 321 | list($formValues, $categories, $html_message, $messageToken, $returnProperties) = self::processMessageTemplate($form); |
a37ec997 | 322 | $buttonName = $form->controller->getButtonName(); |
6a488035 TO |
323 | $skipOnHold = isset($form->skipOnHold) ? $form->skipOnHold : FALSE; |
324 | $skipDeceased = isset($form->skipDeceased) ? $form->skipDeceased : TRUE; | |
325 | ||
326 | foreach ($form->_contactIds as $item => $contactId) { | |
327 | $params = array('contact_id' => $contactId); | |
328 | ||
329 | list($contact) = CRM_Utils_Token::getTokenDetails($params, | |
330 | $returnProperties, | |
331 | $skipOnHold, | |
332 | $skipDeceased, | |
333 | NULL, | |
334 | $messageToken, | |
335 | 'CRM_Contact_Form_Task_PDFLetterCommon' | |
336 | ); | |
337 | if (civicrm_error($contact)) { | |
338 | $notSent[] = $contactId; | |
339 | continue; | |
340 | } | |
341 | ||
342 | $tokenHtml = CRM_Utils_Token::replaceContactTokens($html_message, $contact[$contactId], TRUE, $messageToken); | |
07945b3c CW |
343 | if (!empty($form->_caseId)) { |
344 | $tokenHtml = CRM_Utils_Token::replaceCaseTokens($form->_caseId, $html_message, $messageToken); | |
345 | } | |
6a488035 TO |
346 | $tokenHtml = CRM_Utils_Token::replaceHookTokens($tokenHtml, $contact[$contactId], $categories, TRUE); |
347 | ||
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"); | |
353 | } | |
354 | ||
355 | $html[] = $tokenHtml; | |
356 | } | |
357 | ||
a37ec997 DG |
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); | |
361 | } | |
6a488035 TO |
362 | |
363 | CRM_Utils_PDF_Utils::html2pdf($html, "CiviLetter.pdf", FALSE, $formValues); | |
364 | ||
365 | $form->postProcessHook(); | |
366 | ||
367 | CRM_Utils_System::civiExit(1); | |
368 | } | |
369 | ||
86538308 | 370 | /** |
c490a46a | 371 | * @param CRM_Core_Form $form |
86538308 EM |
372 | * @param $html_message |
373 | * @param $contactIds | |
374 | * | |
375 | * @throws CRM_Core_Exception | |
376 | */ | |
00be9182 | 377 | public static function createActivities($form, $html_message, $contactIds) { |
4c71ccb4 | 378 | //Added for CRM-12682: Add activity subject and campaign fields |
353ffa53 | 379 | $formValues = $form->controller->exportValues($form->getName()); |
6a488035 | 380 | |
353ffa53 TO |
381 | $session = CRM_Core_Session::singleton(); |
382 | $userID = $session->get('userID'); | |
1d85d241 DL |
383 | $activityTypeID = CRM_Core_OptionGroup::getValue( |
384 | 'activity_type', | |
6a488035 TO |
385 | 'Print PDF Letter', |
386 | 'name' | |
387 | ); | |
388 | $activityParams = array( | |
4c71ccb4 | 389 | 'subject' => $formValues['subject'], |
85d25c8f | 390 | 'campaign_id' => CRM_Utils_Array::value('campaign_id', $formValues), |
6a488035 TO |
391 | 'source_contact_id' => $userID, |
392 | 'activity_type_id' => $activityTypeID, | |
393 | 'activity_date_time' => date('YmdHis'), | |
394 | 'details' => $html_message, | |
395 | ); | |
396 | if (!empty($form->_activityId)) { | |
397 | $activityParams += array('id' => $form->_activityId); | |
398 | } | |
399 | if ($form->_cid) { | |
400 | $activity = CRM_Activity_BAO_Activity::create($activityParams); | |
623ba9d2 CW |
401 | if (!empty($form->_caseId)) { |
402 | $caseActivityParams = array('activity_id' => $activity->id, 'case_id' => $form->_caseId); | |
403 | CRM_Case_BAO_Case::processCaseActivity($caseActivityParams); | |
404 | } | |
6a488035 TO |
405 | } |
406 | else { | |
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; | |
412 | } | |
413 | } | |
414 | ||
e7e657f0 | 415 | $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name'); |
9e74e3ce | 416 | $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts); |
8ef12e64 | 417 | |
383c047b | 418 | //@todo why are we using $form->_contactIds here & contactIds above - need comment |
6a488035 TO |
419 | foreach ($form->_contactIds as $contactId) { |
420 | $activityTargetParams = array( | |
421 | 'activity_id' => empty($activity->id) ? $activityIds[$contactId] : $activity->id, | |
1d85d241 | 422 | 'contact_id' => $contactId, |
21dfd5f5 | 423 | 'record_type_id' => $targetID, |
6a488035 | 424 | ); |
1d85d241 | 425 | CRM_Activity_BAO_ActivityContact::create($activityTargetParams); |
6a488035 TO |
426 | } |
427 | } | |
428 | ||
86538308 EM |
429 | /** |
430 | * @param $message | |
431 | */ | |
00be9182 | 432 | public static function formatMessage(&$message) { |
6a488035 TO |
433 | $newLineOperators = array( |
434 | 'p' => array( | |
435 | 'oper' => '<p>', | |
436 | 'pattern' => '/<(\s+)?p(\s+)?>/m', | |
437 | ), | |
438 | 'br' => array( | |
439 | 'oper' => '<br />', | |
440 | 'pattern' => '/<(\s+)?br(\s+)?\/>/m', | |
441 | ), | |
442 | ); | |
443 | ||
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) { | |
448 | $msg = trim($msg); | |
449 | $matches = array(); | |
450 | if (preg_match('/^( )+/', $msg, $matches)) { | |
451 | $spaceLen = strlen($matches[0]) / 6; | |
353ffa53 TO |
452 | $trimMsg = ltrim($msg, ' '); |
453 | $charLen = strlen($trimMsg); | |
6a488035 TO |
454 | $totalLen = $charLen + $spaceLen; |
455 | if ($totalLen > 100) { | |
456 | $spacesCount = 10; | |
457 | if ($spaceLen > 50) { | |
458 | $spacesCount = 20; | |
459 | } | |
460 | if ($charLen > 100) { | |
461 | $spacesCount = 1; | |
462 | } | |
463 | $msg = str_repeat(' ', $spacesCount) . $trimMsg; | |
464 | } | |
465 | } | |
466 | } | |
467 | $m = implode($newLineOperators['br']['oper'], $messages); | |
468 | } | |
469 | $message = implode($newLineOperators['p']['oper'], $htmlMsg); | |
470 | } | |
96025800 | 471 | |
6a488035 | 472 | } |