Commit | Line | Data |
---|---|---|
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 | /** | |
00252851 | 19 | * This class helps to print the labels for contacts. |
6a488035 TO |
20 | */ |
21 | class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { | |
22 | ||
23 | /** | |
fe482240 | 24 | * Build all the data structures needed to build the form. |
6a488035 | 25 | */ |
00be9182 | 26 | public function preProcess() { |
6a488035 TO |
27 | $this->set('contactIds', $this->_contactIds); |
28 | parent::preProcess(); | |
29 | } | |
30 | ||
31 | /** | |
fe482240 | 32 | * Build the form object. |
6a488035 | 33 | */ |
00be9182 | 34 | public function buildQuickForm() { |
14396107 | 35 | self::buildLabelForm($this); |
36 | } | |
37 | ||
38 | /** | |
39 | * Common Function to build Mailing Label Form. | |
bf48aa29 | 40 | * |
41 | * @param CRM_Core_Form $form | |
14396107 | 42 | */ |
43 | public static function buildLabelForm($form) { | |
6a488035 TO |
44 | CRM_Utils_System::setTitle(ts('Make Mailing Labels')); |
45 | ||
46 | //add select for label | |
47 | $label = CRM_Core_BAO_LabelFormat::getList(TRUE); | |
48 | ||
be2fb01f | 49 | $form->add('select', 'label_name', ts('Select Label'), ['' => ts('- select label -')] + $label, TRUE); |
6a488035 | 50 | |
6a488035 | 51 | // add select for Location Type |
14396107 | 52 | $form->addElement('select', 'location_type_id', ts('Select Location'), |
be2fb01f | 53 | [ |
af9b09df | 54 | '' => ts('Primary'), |
be2fb01f | 55 | ] + CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'), TRUE |
6a488035 TO |
56 | ); |
57 | ||
58 | // checkbox for SKIP contacts with Do Not Mail privacy option | |
14396107 | 59 | $form->addElement('checkbox', 'do_not_mail', ts('Do not print labels for contacts with "Do Not Mail" privacy option checked')); |
6a488035 | 60 | |
14396107 | 61 | $form->add('checkbox', 'merge_same_address', ts('Merge labels for contacts with the same address'), NULL); |
62 | $form->add('checkbox', 'merge_same_household', ts('Merge labels for contacts belonging to the same household'), NULL); | |
6a488035 | 63 | |
be2fb01f CW |
64 | $form->addButtons([ |
65 | [ | |
85d25c8f DG |
66 | 'type' => 'submit', |
67 | 'name' => ts('Make Mailing Labels'), | |
68 | 'isDefault' => TRUE, | |
be2fb01f CW |
69 | ], |
70 | [ | |
85d25c8f DG |
71 | 'type' => 'cancel', |
72 | 'name' => ts('Done'), | |
be2fb01f CW |
73 | ], |
74 | ]); | |
6a488035 TO |
75 | } |
76 | ||
77 | /** | |
c490a46a | 78 | * Set default values for the form. |
6a488035 | 79 | * |
a6c01b45 CW |
80 | * @return array |
81 | * array of default values | |
6a488035 | 82 | */ |
00be9182 | 83 | public function setDefaultValues() { |
be2fb01f | 84 | $defaults = []; |
6a488035 | 85 | $format = CRM_Core_BAO_LabelFormat::getDefaultValues(); |
9c1bc317 | 86 | $defaults['label_name'] = $format['name'] ?? NULL; |
6a488035 TO |
87 | $defaults['do_not_mail'] = 1; |
88 | ||
89 | return $defaults; | |
90 | } | |
91 | ||
92 | /** | |
fe482240 | 93 | * Process the form after the input has been submitted and validated. |
2582af2a MD |
94 | * |
95 | * @param array|NULL $params | |
6a488035 | 96 | */ |
2582af2a MD |
97 | public function postProcess($params = NULL) { |
98 | $fv = $params ?: $this->controller->exportValues($this->_name); | |
353ffa53 | 99 | $config = CRM_Core_Config::singleton(); |
6a488035 TO |
100 | $locName = NULL; |
101 | //get the address format sequence from the config file | |
aaffa79f | 102 | $mailingFormat = Civi::settings()->get('mailing_format'); |
6a488035 TO |
103 | |
104 | $sequence = CRM_Utils_Address::sequence($mailingFormat); | |
105 | ||
106 | foreach ($sequence as $v) { | |
107 | $address[$v] = 1; | |
108 | } | |
109 | ||
110 | if (array_key_exists('postal_code', $address)) { | |
111 | $address['postal_code_suffix'] = 1; | |
112 | } | |
113 | ||
114 | //build the returnproperties | |
be2fb01f | 115 | $returnProperties = ['display_name' => 1, 'contact_type' => 1, 'prefix_id' => 1]; |
aaffa79f | 116 | $mailingFormat = Civi::settings()->get('mailing_format'); |
6a488035 | 117 | |
be2fb01f | 118 | $mailingFormatProperties = []; |
6a488035 | 119 | if ($mailingFormat) { |
bdd49e38 | 120 | $mailingFormatProperties = CRM_Utils_Token::getReturnProperties($mailingFormat); |
6a488035 TO |
121 | $returnProperties = array_merge($returnProperties, $mailingFormatProperties); |
122 | } | |
123 | //we should not consider addressee for data exists, CRM-6025 | |
124 | if (array_key_exists('addressee', $mailingFormatProperties)) { | |
125 | unset($mailingFormatProperties['addressee']); | |
126 | } | |
127 | ||
be2fb01f | 128 | $customFormatProperties = []; |
6a488035 TO |
129 | if (stristr($mailingFormat, 'custom_')) { |
130 | foreach ($mailingFormatProperties as $token => $true) { | |
131 | if (substr($token, 0, 7) == 'custom_') { | |
a7488080 | 132 | if (empty($customFormatProperties[$token])) { |
6a488035 TO |
133 | $customFormatProperties[$token] = $mailingFormatProperties[$token]; |
134 | } | |
135 | } | |
136 | } | |
137 | } | |
138 | ||
139 | if (!empty($customFormatProperties)) { | |
140 | $returnProperties = array_merge($returnProperties, $customFormatProperties); | |
141 | } | |
142 | ||
143 | if (isset($fv['merge_same_address'])) { | |
144 | // we need first name/last name for summarising to avoid spillage | |
145 | $returnProperties['first_name'] = 1; | |
146 | $returnProperties['last_name'] = 1; | |
147 | } | |
148 | ||
57884c26 DJ |
149 | $individualFormat = FALSE; |
150 | ||
151 | /* | |
152 | * CRM-8338: replace ids of household members with the id of their household | |
153 | * so we can merge labels by household. | |
154 | */ | |
155 | if (isset($fv['merge_same_household'])) { | |
156 | $this->mergeContactIdsByHousehold(); | |
157 | $individualFormat = TRUE; | |
158 | } | |
159 | ||
6a488035 | 160 | //get the contacts information |
be2fb01f | 161 | $params = []; |
a7488080 | 162 | if (!empty($fv['location_type_id'])) { |
353ffa53 TO |
163 | $locType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
164 | $locName = $locType[$fv['location_type_id']]; | |
be2fb01f | 165 | $location = ['location' => ["{$locName}" => $address]]; |
6a488035 | 166 | $returnProperties = array_merge($returnProperties, $location); |
be2fb01f | 167 | $params[] = ['location_type', '=', [1 => $fv['location_type_id']], 0, 0]; |
d068e84b | 168 | $primaryLocationOnly = FALSE; |
6a488035 TO |
169 | } |
170 | else { | |
171 | $returnProperties = array_merge($returnProperties, $address); | |
d068e84b | 172 | $primaryLocationOnly = TRUE; |
6a488035 TO |
173 | } |
174 | ||
be2fb01f | 175 | $rows = []; |
6a488035 | 176 | foreach ($this->_contactIds as $key => $contactID) { |
be2fb01f | 177 | $params[] = [ |
6a488035 | 178 | CRM_Core_Form::CB_PREFIX . $contactID, |
353ffa53 TO |
179 | '=', |
180 | 1, | |
181 | 0, | |
182 | 0, | |
be2fb01f | 183 | ]; |
6a488035 TO |
184 | } |
185 | ||
186 | // fix for CRM-2651 | |
a7488080 | 187 | if (!empty($fv['do_not_mail'])) { |
be2fb01f | 188 | $params[] = ['do_not_mail', '=', 0, 0, 0]; |
6a488035 TO |
189 | } |
190 | // fix for CRM-2613 | |
be2fb01f | 191 | $params[] = ['is_deceased', '=', 0, 0, 0]; |
6a488035 | 192 | |
be2fb01f | 193 | $custom = []; |
6a488035 TO |
194 | foreach ($returnProperties as $name => $dontCare) { |
195 | $cfID = CRM_Core_BAO_CustomField::getKeyID($name); | |
196 | if ($cfID) { | |
197 | $custom[] = $cfID; | |
198 | } | |
199 | } | |
200 | ||
201 | //get the total number of contacts to fetch from database. | |
202 | $numberofContacts = count($this->_contactIds); | |
353ffa53 | 203 | $query = new CRM_Contact_BAO_Query($params, $returnProperties); |
d068e84b | 204 | $details = $query->apiQuery($params, $returnProperties, NULL, NULL, 0, $numberofContacts, TRUE, FALSE, TRUE, CRM_Contact_BAO_Query::MODE_CONTACTS, NULL, $primaryLocationOnly); |
6a488035 TO |
205 | $messageToken = CRM_Utils_Token::getTokens($mailingFormat); |
206 | ||
590111ef | 207 | // $details[0] is an array of [ contactID => contactDetails ] |
6a488035 TO |
208 | // also get all token values |
209 | CRM_Utils_Hook::tokenValues($details[0], | |
210 | $this->_contactIds, | |
211 | NULL, | |
212 | $messageToken, | |
213 | 'CRM_Contact_Form_Task_Label' | |
214 | ); | |
215 | ||
be2fb01f | 216 | $tokens = []; |
6a488035 | 217 | CRM_Utils_Hook::tokens($tokens); |
be2fb01f | 218 | $tokenFields = []; |
6a488035 TO |
219 | foreach ($tokens as $category => $catTokens) { |
220 | foreach ($catTokens as $token => $tokenName) { | |
221 | $tokenFields[] = $token; | |
222 | } | |
223 | } | |
224 | ||
225 | foreach ($this->_contactIds as $value) { | |
226 | foreach ($custom as $cfID) { | |
227 | if (isset($details[0][$value]["custom_{$cfID}"])) { | |
8cee0c70 | 228 | $details[0][$value]["custom_{$cfID}"] = CRM_Core_BAO_CustomField::displayValue($details[0][$value]["custom_{$cfID}"], $cfID); |
6a488035 TO |
229 | } |
230 | } | |
9c1bc317 | 231 | $contact = $details['0'][$value] ?? NULL; |
6a488035 TO |
232 | |
233 | if (is_a($contact, 'CRM_Core_Error')) { | |
234 | return NULL; | |
235 | } | |
236 | ||
237 | // we need to remove all the "_id" | |
238 | unset($contact['contact_id']); | |
239 | ||
8cc574cf | 240 | if ($locName && !empty($contact[$locName])) { |
6a488035 TO |
241 | // If location type is not primary, $contact contains |
242 | // one more array as "$contact[$locName] = array( values... )" | |
243 | ||
8bdfc216 | 244 | if (!self::tokenIsFound($contact, $mailingFormatProperties, $tokenFields)) { |
6a488035 TO |
245 | continue; |
246 | } | |
247 | ||
ceebbde9 | 248 | $contact = array_merge($contact, $contact[$locName]); |
6a488035 TO |
249 | unset($contact[$locName]); |
250 | ||
a7488080 | 251 | if (!empty($contact['county_id'])) { |
6a488035 TO |
252 | unset($contact['county_id']); |
253 | } | |
254 | ||
255 | foreach ($contact as $field => $fieldValue) { | |
256 | $rows[$value][$field] = $fieldValue; | |
257 | } | |
258 | ||
be2fb01f CW |
259 | $valuesothers = []; |
260 | $paramsothers = ['contact_id' => $value]; | |
6a488035 | 261 | $valuesothers = CRM_Core_BAO_Location::getValues($paramsothers, $valuesothers); |
a7488080 | 262 | if (!empty($fv['location_type_id'])) { |
6a488035 | 263 | foreach ($valuesothers as $vals) { |
353ffa53 TO |
264 | if (CRM_Utils_Array::value('location_type_id', $vals) == |
265 | CRM_Utils_Array::value('location_type_id', $fv) | |
266 | ) { | |
6a488035 | 267 | foreach ($vals as $k => $v) { |
be2fb01f | 268 | if (in_array($k, [ |
353ffa53 TO |
269 | 'email', |
270 | 'phone', | |
271 | 'im', | |
af9b09df | 272 | 'openid', |
be2fb01f | 273 | ])) { |
6a488035 TO |
274 | if ($k == 'im') { |
275 | $rows[$value][$k] = $v['1']['name']; | |
276 | } | |
277 | else { | |
278 | $rows[$value][$k] = $v['1'][$k]; | |
279 | } | |
280 | $rows[$value][$k . '_id'] = $v['1']['id']; | |
281 | } | |
282 | } | |
283 | } | |
284 | } | |
285 | } | |
286 | } | |
287 | else { | |
8bdfc216 | 288 | if (!self::tokenIsFound($contact, $mailingFormatProperties, $tokenFields)) { |
6a488035 TO |
289 | continue; |
290 | } | |
291 | ||
a7488080 | 292 | if (!empty($contact['addressee_display'])) { |
6a488035 TO |
293 | $contact['addressee_display'] = trim($contact['addressee_display']); |
294 | } | |
a7488080 | 295 | if (!empty($contact['addressee'])) { |
6a488035 TO |
296 | $contact['addressee'] = $contact['addressee_display']; |
297 | } | |
298 | ||
299 | // now create the rows for generating mailing labels | |
300 | foreach ($contact as $field => $fieldValue) { | |
301 | $rows[$value][$field] = $fieldValue; | |
302 | } | |
303 | } | |
304 | } | |
305 | ||
6a488035 | 306 | if (isset($fv['merge_same_address'])) { |
8bdfc216 | 307 | CRM_Core_BAO_Address::mergeSameAddress($rows); |
6a488035 TO |
308 | $individualFormat = TRUE; |
309 | } | |
6a488035 TO |
310 | |
311 | // format the addresses according to CIVICRM_ADDRESS_FORMAT (CRM-1327) | |
312 | foreach ($rows as $id => $row) { | |
313 | if ($commMethods = CRM_Utils_Array::value('preferred_communication_method', $row)) { | |
353ffa53 | 314 | $val = array_filter(explode(CRM_Core_DAO::VALUE_SEPARATOR, $commMethods)); |
e7e657f0 | 315 | $comm = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method'); |
be2fb01f | 316 | $temp = []; |
6a488035 TO |
317 | foreach ($val as $vals) { |
318 | $temp[] = $comm[$vals]; | |
319 | } | |
320 | $row['preferred_communication_method'] = implode(', ', $temp); | |
321 | } | |
322 | $row['id'] = $id; | |
4c49535e | 323 | $formatted = CRM_Utils_Address::format($row, 'mailing_format', FALSE, TRUE, $tokenFields); |
6a488035 TO |
324 | |
325 | // CRM-2211: UFPDF doesn't have bidi support; use the PECL fribidi package to fix it. | |
326 | // On Ubuntu (possibly Debian?) be aware of http://pecl.php.net/bugs/bug.php?id=12366 | |
327 | // Due to FriBidi peculiarities, this can't be called on | |
328 | // a multi-line string, hence the explode+implode approach. | |
329 | if (function_exists('fribidi_log2vis')) { | |
330 | $lines = explode("\n", $formatted); | |
331 | foreach ($lines as $i => $line) { | |
332 | $lines[$i] = fribidi_log2vis($line, FRIBIDI_AUTO, FRIBIDI_CHARSET_UTF8); | |
333 | } | |
334 | $formatted = implode("\n", $lines); | |
335 | } | |
be2fb01f | 336 | $rows[$id] = [$formatted]; |
6a488035 TO |
337 | } |
338 | ||
2582af2a MD |
339 | if (!empty($fv['is_unit_testing'])) { |
340 | return $rows; | |
341 | } | |
342 | ||
6a488035 TO |
343 | //call function to create labels |
344 | self::createLabel($rows, $fv['label_name']); | |
292c8687 | 345 | CRM_Utils_System::civiExit(); |
6a488035 TO |
346 | } |
347 | ||
c91c5542 | 348 | /** |
fe482240 | 349 | * Check for presence of tokens to be swapped out. |
77b97be7 | 350 | * |
c91c5542 | 351 | * @param array $contact |
352 | * @param array $mailingFormatProperties | |
353 | * @param array $tokenFields | |
77b97be7 EM |
354 | * |
355 | * @return bool | |
c91c5542 | 356 | */ |
8bdfc216 | 357 | public static function tokenIsFound($contact, $mailingFormatProperties, $tokenFields) { |
c91c5542 | 358 | foreach (array_merge($mailingFormatProperties, array_fill_keys($tokenFields, 1)) as $key => $dontCare) { |
8bdfc216 | 359 | //we should not consider addressee for data exists, CRM-6025 |
353ffa53 | 360 | if ($key != 'addressee' && !empty($contact[$key])) { |
c91c5542 | 361 | return TRUE; |
362 | } | |
363 | } | |
364 | return FALSE; | |
365 | } | |
353ffa53 | 366 | |
6a488035 | 367 | /** |
00252851 | 368 | * Create labels (pdf). |
6a488035 | 369 | * |
77c5b619 | 370 | * @param array $contactRows |
00252851 | 371 | * Associated array of contact data. |
77c5b619 TO |
372 | * @param string $format |
373 | * Format in which labels needs to be printed. | |
374 | * @param string $fileName | |
375 | * The name of the file to save the label in. | |
6a488035 | 376 | */ |
00be9182 | 377 | public function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') { |
6a488035 TO |
378 | $pdf = new CRM_Utils_PDF_Label($format, 'mm'); |
379 | $pdf->Open(); | |
380 | $pdf->AddPage(); | |
381 | ||
382 | //build contact string that needs to be printed | |
383 | $val = NULL; | |
384 | foreach ($contactRows as $row => $value) { | |
385 | foreach ($value as $k => $v) { | |
386 | $val .= "$v\n"; | |
387 | } | |
388 | ||
389 | $pdf->AddPdfLabel($val); | |
390 | $val = ''; | |
391 | } | |
392 | $pdf->Output($fileName, 'D'); | |
393 | } | |
394 | ||
6a488035 | 395 | } |