CIVICRM-1391 Update Smart Group form unsets the existing Group Types for the Group
[civicrm-core.git] / CRM / Contact / Form / Task / PDFLetterCommon.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
bc77d7c0 4 | Copyright CiviCRM LLC. All rights reserved. |
6a488035 5 | |
bc77d7c0
TO
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
6a488035 9 +--------------------------------------------------------------------+
d25dd0ee 10 */
6a488035
TO
11
12/**
13 *
14 * @package CRM
ca5cec67 15 * @copyright CiviCRM LLC https://civicrm.org/licensing
6a488035
TO
16 */
17
18/**
424029e3 19 * This class provides the common functionality for creating PDF letter for one or a group of contact ids.
6a488035 20 */
958060c1 21class CRM_Contact_Form_Task_PDFLetterCommon extends CRM_Core_Form_Task_PDFLetterCommon {
6a488035 22
2fe8b920 23 protected static $tokenCategories;
24
cc144465
TO
25 /**
26 * @return array
27 * Array(string $machineName => string $label).
28 */
29 public static function getLoggingOptions() {
be2fb01f 30 return [
cc144465
TO
31 'none' => ts('Do not record'),
32 'multiple' => ts('Multiple activities (one per contact)'),
33 'combined' => ts('One combined activity'),
34 'combined-attached' => ts('One combined activity plus one file attachment'),
35 // 'multiple-attached' <== not worth the work
be2fb01f 36 ];
cc144465
TO
37 }
38
6a488035 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) {
beac1417 45 CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($form);
be2fb01f
CW
46 $messageText = [];
47 $messageSubject = [];
353ffa53 48 $dao = new CRM_Core_BAO_MessageTemplate();
6a488035
TO
49 $dao->is_active = 1;
50 $dao->find();
51 while ($dao->fetch()) {
52 $messageText[$dao->id] = $dao->msg_text;
53 $messageSubject[$dao->id] = $dao->msg_subject;
54 }
55
56 $form->assign('message', $messageText);
57 $form->assign('messageSubject', $messageSubject);
958060c1 58 parent::preProcess($form);
6a488035
TO
59 }
60
86538308 61 /**
c490a46a 62 * @param CRM_Core_Form $form
100fef9d 63 * @param int $cid
86538308 64 */
00be9182 65 public static function preProcessSingle(&$form, $cid) {
fe61faf3 66 $form->_contactIds = explode(',', $cid);
6a488035 67 // put contact display name in title for single contact mode
fe61faf3 68 if (count($form->_contactIds) === 1) {
be2fb01f 69 CRM_Utils_System::setTitle(ts('Print/Merge Document for %1', [1 => CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name')]));
fe61faf3 70 }
6a488035
TO
71 }
72
6a488035 73 /**
fe482240 74 * Part of the post process which prepare and extract information from the template.
6a488035 75 *
6a488035 76 *
2bd6b6cf 77 * @param array $formValues
dbddfb08 78 *
72b3a70c
CW
79 * @return array
80 * [$categories, $html_message, $messageToken, $returnProperties]
6a488035 81 */
2bd6b6cf 82 public static function processMessageTemplate($formValues) {
958060c1 83 $html_message = self::processTemplate($formValues);
6a488035 84
2fe8b920 85 $categories = self::getTokenCategories();
6a488035 86
6a488035
TO
87 //time being hack to strip '&nbsp;'
88 //from particular letter line, CRM-6798
89 self::formatMessage($html_message);
90
91 $messageToken = CRM_Utils_Token::getTokens($html_message);
92
be2fb01f 93 $returnProperties = [];
6a488035
TO
94 if (isset($messageToken['contact'])) {
95 foreach ($messageToken['contact'] as $key => $value) {
96 $returnProperties[$value] = 1;
97 }
98 }
99
be2fb01f 100 return [$formValues, $categories, $html_message, $messageToken, $returnProperties];
6a488035
TO
101 }
102
103 /**
fe482240 104 * Process the form after the input has been submitted and validated.
6a488035 105 *
c490a46a 106 * @param CRM_Core_Form $form
2fe8b920 107 *
108 * @throws \CRM_Core_Exception
6a488035 109 */
00be9182 110 public static function postProcess(&$form) {
2bd6b6cf 111 $formValues = $form->controller->exportValues($form->getName());
112 list($formValues, $categories, $html_message, $messageToken, $returnProperties) = self::processMessageTemplate($formValues);
6a488035
TO
113 $skipOnHold = isset($form->skipOnHold) ? $form->skipOnHold : FALSE;
114 $skipDeceased = isset($form->skipDeceased) ? $form->skipDeceased : TRUE;
be2fb01f 115 $html = $activityIds = [];
ad7fdc34 116
117 // CRM-16725 Skip creation of activities if user is previewing their PDF letter(s)
752cee47 118 if (self::isLiveMode($form)) {
fe61faf3 119 $activityIds = self::createActivities($form, $html_message, $form->_contactIds, $formValues['subject'], CRM_Utils_Array::value('campaign_id', $formValues));
ad7fdc34 120 }
121
122 if (!empty($formValues['document_file_path'])) {
9eae09f1 123 list($html_message, $zip) = CRM_Utils_PDF_Document::unzipDoc($formValues['document_file_path'], $formValues['document_type']);
ad7fdc34 124 }
6a488035
TO
125
126 foreach ($form->_contactIds as $item => $contactId) {
8ffa3b7c 127 $caseId = NULL;
be2fb01f 128 $params = ['contact_id' => $contactId];
6a488035
TO
129
130 list($contact) = CRM_Utils_Token::getTokenDetails($params,
131 $returnProperties,
132 $skipOnHold,
133 $skipDeceased,
134 NULL,
135 $messageToken,
136 'CRM_Contact_Form_Task_PDFLetterCommon'
137 );
2c8a6e63 138
6a488035
TO
139 if (civicrm_error($contact)) {
140 $notSent[] = $contactId;
141 continue;
142 }
143
144 $tokenHtml = CRM_Utils_Token::replaceContactTokens($html_message, $contact[$contactId], TRUE, $messageToken);
07945b3c 145 if (!empty($form->_caseId)) {
8ffa3b7c 146 $caseId = $form->_caseId;
147 }
148 if (empty($caseId) && !empty($form->_caseIds[$item])) {
149 $caseId = $form->_caseIds[$item];
150 }
151 if ($caseId) {
152 $tokenHtml = CRM_Utils_Token::replaceCaseTokens($caseId, $tokenHtml, $messageToken);
07945b3c 153 }
6a488035
TO
154 $tokenHtml = CRM_Utils_Token::replaceHookTokens($tokenHtml, $contact[$contactId], $categories, TRUE);
155
156 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
157 $smarty = CRM_Core_Smarty::singleton();
158 // also add the contact tokens to the template
159 $smarty->assign_by_ref('contact', $contact);
160 $tokenHtml = $smarty->fetch("string:$tokenHtml");
161 }
162
163 $html[] = $tokenHtml;
164 }
165
38faa439 166 $tee = NULL;
dd8e53c4 167 if (self::isLiveMode($form) && Civi::settings()->get('recordGeneratedLetters') === 'combined-attached') {
bdac10d8
TO
168 if (count($activityIds) !== 1) {
169 throw new CRM_Core_Exception("When recordGeneratedLetters=combined-attached, there should only be one activity.");
170 }
38faa439 171 $tee = CRM_Utils_ConsoleTee::create()->start();
3c48a60c
TO
172 }
173
0aeb5a1e 174 $type = $formValues['document_type'];
3c48a60c 175 $mimeType = self::getMimeType($type);
3ed92c14 176 // ^^ Useful side-effect: consistently throws error for unrecognized types.
0aeb5a1e
CW
177
178 if ($type == 'pdf') {
3c48a60c
TO
179 $fileName = "CiviLetter.$type";
180 CRM_Utils_PDF_Utils::html2pdf($html, $fileName, FALSE, $formValues);
0aeb5a1e 181 }
ad7fdc34 182 elseif (!empty($formValues['document_file_path'])) {
63c8a9ba
TO
183 $fileName = pathinfo($formValues['document_file_path'], PATHINFO_FILENAME) . '.' . $type;
184 CRM_Utils_PDF_Document::printDocuments($html, $fileName, $type, $zip);
ad7fdc34 185 }
0aeb5a1e 186 else {
3c48a60c
TO
187 $fileName = "CiviLetter.$type";
188 CRM_Utils_PDF_Document::html2doc($html, $fileName, $formValues);
189 }
190
38faa439
TO
191 if ($tee) {
192 $tee->stop();
193 $content = file_get_contents($tee->getFileName(), NULL, NULL, NULL, 5);
3c48a60c
TO
194 if (empty($content)) {
195 throw new \CRM_Core_Exception("Failed to capture document content (type=$type)!");
196 }
197 foreach ($activityIds as $activityId) {
be2fb01f 198 civicrm_api3('Attachment', 'create', [
3c48a60c
TO
199 'entity_table' => 'civicrm_activity',
200 'entity_id' => $activityId,
201 'name' => $fileName,
202 'mime_type' => $mimeType,
be2fb01f 203 'options' => [
38faa439 204 'move-file' => $tee->getFileName(),
be2fb01f
CW
205 ],
206 ]);
3c48a60c 207 }
0aeb5a1e 208 }
6a488035
TO
209
210 $form->postProcessHook();
211
292c8687 212 CRM_Utils_System::civiExit();
6a488035
TO
213 }
214
86538308 215 /**
c490a46a 216 * @param CRM_Core_Form $form
818b4373
TO
217 * @param string $html_message
218 * @param array $contactIds
3280f327 219 * @param string $subject
220 * @param int $campaign_id
221 * @param array $perContactHtml
222 *
818b4373
TO
223 * @return array
224 * List of activity IDs.
225 * There may be 1 or more, depending on the system-settings
226 * and use-case.
86538308
EM
227 *
228 * @throws CRM_Core_Exception
229 */
be2fb01f 230 public static function createActivities($form, $html_message, $contactIds, $subject, $campaign_id, $perContactHtml = []) {
6a488035 231
be2fb01f 232 $activityParams = [
3280f327 233 'subject' => $subject,
234 'campaign_id' => $campaign_id,
235 'source_contact_id' => CRM_Core_Session::singleton()->getLoggedInContactID(),
236 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Print PDF Letter'),
6a488035
TO
237 'activity_date_time' => date('YmdHis'),
238 'details' => $html_message,
be2fb01f 239 ];
6a488035 240 if (!empty($form->_activityId)) {
be2fb01f 241 $activityParams += ['id' => $form->_activityId];
6a488035 242 }
818b4373 243
be2fb01f 244 $activityIds = [];
818b4373
TO
245 switch (Civi::settings()->get('recordGeneratedLetters')) {
246 case 'none':
be2fb01f 247 return [];
818b4373
TO
248
249 case 'multiple':
250 // One activity per contact.
fe61faf3 251 foreach ($contactIds as $i => $contactId) {
be2fb01f 252 $fullParams = [
6d3827cb 253 'target_contact_id' => $contactId,
be2fb01f 254 ] + $activityParams;
fe61faf3
CW
255 if (!empty($form->_caseId)) {
256 $fullParams['case_id'] = $form->_caseId;
257 }
258 elseif (!empty($form->_caseIds[$i])) {
259 $fullParams['case_id'] = $form->_caseIds[$i];
260 }
261
3280f327 262 if (isset($perContactHtml[$contactId])) {
263 $fullParams['details'] = implode('<hr>', $perContactHtml[$contactId]);
264 }
265 $activity = civicrm_api3('Activity', 'create', $fullParams);
266 $activityIds[$contactId] = $activity['id'];
818b4373
TO
267 }
268
269 break;
270
271 case 'combined':
272 case 'combined-attached':
273 // One activity with all contacts.
be2fb01f 274 $fullParams = [
6d3827cb 275 'target_contact_id' => $contactIds,
be2fb01f 276 ] + $activityParams;
fe61faf3
CW
277 if (!empty($form->_caseId)) {
278 $fullParams['case_id'] = $form->_caseId;
279 }
280 elseif (!empty($form->_caseIds)) {
281 $fullParams['case_id'] = $form->_caseIds;
282 }
283 $activity = civicrm_api3('Activity', 'create', $fullParams);
284 $activityIds[] = $activity['id'];
818b4373
TO
285 break;
286
287 default:
288 throw new CRM_Core_Exception("Unrecognized option in recordGeneratedLetters: " . Civi::settings()->get('recordGeneratedLetters'));
6a488035 289 }
818b4373 290
818b4373 291 return $activityIds;
6a488035
TO
292 }
293
86538308 294 /**
3c48a60c
TO
295 * Convert from a vague-type/file-extension to mime-type.
296 *
297 * @param string $type
298 * @return string
299 * @throws \CRM_Core_Exception
300 */
301 private static function getMimeType($type) {
be2fb01f 302 $mimeTypes = [
4b54b8bb 303 'pdf' => 'application/pdf',
3c48a60c
TO
304 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
305 'odt' => 'application/vnd.oasis.opendocument.text',
306 'html' => 'text/html',
be2fb01f 307 ];
3c48a60c
TO
308 if (isset($mimeTypes[$type])) {
309 return $mimeTypes[$type];
310 }
311 else {
312 throw new \CRM_Core_Exception("Cannot determine mime type");
313 }
314 }
315
2fe8b920 316 /**
317 * Get the categories required for rendering tokens.
318 *
319 * @return array
320 */
321 protected static function getTokenCategories() {
3280f327 322 if (!isset(Civi::$statics[__CLASS__]['token_categories'])) {
be2fb01f 323 $tokens = [];
2fe8b920 324 CRM_Utils_Hook::tokens($tokens);
3280f327 325 Civi::$statics[__CLASS__]['token_categories'] = array_keys($tokens);
2fe8b920 326 }
3280f327 327 return Civi::$statics[__CLASS__]['token_categories'];
2fe8b920 328 }
329
752cee47 330 /**
331 * Is the form in live mode (as opposed to being run as a preview).
332 *
333 * Returns true if the user has clicked the Download Document button on a
334 * Print/Merge Document (PDF Letter) search task form, or false if the Preview
335 * button was clicked.
336 *
337 * @param CRM_Core_Form $form
338 *
339 * @return bool
340 * TRUE if the Download Document button was clicked (also defaults to TRUE
341 * if the form controller does not exist), else FALSE
342 */
343 protected static function isLiveMode($form) {
344 // CRM-21255 - Hrm, CiviCase 4+5 seem to report buttons differently...
345 $buttonName = $form->controller->getButtonName();
346 $c = $form->controller->container();
347 $isLiveMode = ($buttonName == '_qf_PDF_upload') || isset($c['values']['PDF']['buttons']['_qf_PDF_upload']);
348 return $isLiveMode;
349 }
350
6a488035 351}