Merge pull request #150 from yashodha/webtest-fixes
[civicrm-core.git] / CRM / Export / BAO / Export.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2013
32 * $Id$
33 *
34 */
35
36 /**
37 * This class contains the funtions for Component export
38 *
39 */
40 class CRM_Export_BAO_Export {
41 // increase this number a lot to avoid making too many queries
42 // LIMIT is not much faster than a no LIMIT query
43 // CRM-7675
44 CONST EXPORT_ROW_COUNT = 10000;
45
46 /**
47 * Function to get the list the export fields
48 *
49 * @param int $selectAll user preference while export
50 * @param array $ids contact ids
51 * @param array $params associated array of fields
52 * @param string $order order by clause
53 * @param array $fields associated array of fields
54 * @param array $moreReturnProperties additional return fields
55 * @param int $exportMode export mode
56 * @param string $componentClause component clause
57 * @param string $componentTable component table
58 * @param bool $mergeSameAddress merge records if they have same address
59 * @param bool $mergeSameHousehold merge records if they belong to the same household
60 *
61 * @static
62 * @access public
63 */
64 static function exportComponents($selectAll,
65 $ids,
66 $params,
67 $order = NULL,
68 $fields = NULL,
69 $moreReturnProperties = NULL,
70 $exportMode = CRM_Export_Form_Select::CONTACT_EXPORT,
71 $componentClause = NULL,
72 $componentTable = NULL,
73 $mergeSameAddress = FALSE,
74 $mergeSameHousehold = FALSE,
75 $exportParams = array(),
76 $queryOperator = 'AND'
77 ) {
78 $headerRows = $returnProperties = array();
79 $primary = $paymentFields = $selectedPaymentFields = FALSE;
80 $origFields = $fields;
81 $queryMode = $relationField = NULL;
82
83 $allCampaigns = array();
84 $exportCampaign = FALSE;
85
86 $phoneTypes = CRM_Core_PseudoConstant::phoneType();
87 $imProviders = CRM_Core_PseudoConstant::IMProvider();
88 $contactRelationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(
89 NULL,
90 NULL,
91 NULL,
92 NULL,
93 TRUE,
94 'label',
95 FALSE
96 );
97 $queryMode = CRM_Contact_BAO_Query::MODE_CONTACTS;
98
99 switch ($exportMode) {
100 case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
101 $queryMode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
102 break;
103
104 case CRM_Export_Form_Select::EVENT_EXPORT:
105 $queryMode = CRM_Contact_BAO_Query::MODE_EVENT;
106 break;
107
108 case CRM_Export_Form_Select::MEMBER_EXPORT:
109 $queryMode = CRM_Contact_BAO_Query::MODE_MEMBER;
110 break;
111
112 case CRM_Export_Form_Select::PLEDGE_EXPORT:
113 $queryMode = CRM_Contact_BAO_Query::MODE_PLEDGE;
114 break;
115
116 case CRM_Export_Form_Select::CASE_EXPORT:
117 $queryMode = CRM_Contact_BAO_Query::MODE_CASE;
118 break;
119
120 case CRM_Export_Form_Select::GRANT_EXPORT:
121 $queryMode = CRM_Contact_BAO_Query::MODE_GRANT;
122 break;
123
124 case CRM_Export_Form_Select::ACTIVITY_EXPORT:
125 $queryMode = CRM_Contact_BAO_Query::MODE_ACTIVITY;
126 break;
127 }
128 if ($fields) {
129 //construct return properties
130 $locationTypes = CRM_Core_PseudoConstant::locationType();
131 $locationTypeFields = array(
132 'street_address',
133 'supplemental_address_1',
134 'supplemental_address_2',
135 'city',
136 'postal_code',
137 'postal_code_suffix',
138 'geo_code_1',
139 'geo_code_2',
140 'state_province',
141 'country',
142 'phone',
143 'email',
144 'im',
145 );
146
147 foreach ($fields as $key => $value) {
148 $phoneTypeId = $imProviderId = NULL;
149 $relationshipTypes = $fieldName = CRM_Utils_Array::value(1, $value);
150 if (!$fieldName) {
151 continue;
152 }
153 // get phoneType id and IM service provider id seperately
154 if ($fieldName == 'phone') {
155 $phoneTypeId = CRM_Utils_Array::value(3, $value);
156 }
157 elseif ($fieldName == 'im') {
158 $imProviderId = CRM_Utils_Array::value(3, $value);
159 }
160 elseif (substr($fieldName, -8) == 'campaign') {
161 $exportCampaign = TRUE;
162 }
163
164 if (array_key_exists($relationshipTypes, $contactRelationshipTypes)) {
165 if (CRM_Utils_Array::value(2, $value)) {
166 $relationField = CRM_Utils_Array::value(2, $value);
167 if (trim(CRM_Utils_Array::value(3, $value))) {
168 $relLocTypeId = CRM_Utils_Array::value(3, $value);
169 }
170 else {
171 $relLocTypeId = 'Primary';
172 }
173
174 if ($relationField == 'phone') {
175 $relPhoneTypeId = CRM_Utils_Array::value(4, $value);
176 }
177 elseif ($relationField == 'im') {
178 $relIMProviderId = CRM_Utils_Array::value(4, $value);
179 }
180 }
181 elseif (CRM_Utils_Array::value(4, $value)) {
182 $relationField = CRM_Utils_Array::value(4, $value);
183 $relLocTypeId = CRM_Utils_Array::value(5, $value);
184 if ($relationField == 'phone') {
185 $relPhoneTypeId = CRM_Utils_Array::value(6, $value);
186 }
187 elseif ($relationField == 'im') {
188 $relIMProviderId = CRM_Utils_Array::value(6, $value);
189 }
190 }
191 }
192
193 $contactType = CRM_Utils_Array::value(0, $value);
194 $locTypeId = CRM_Utils_Array::value(2, $value);
195
196 if ($relationField) {
197 if (in_array($relationField, $locationTypeFields) && is_numeric($relLocTypeId)) {
198 if ($relPhoneTypeId) {
199 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['phone-' . $relPhoneTypeId] = 1;
200 }
201 elseif ($relIMProviderId) {
202 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['im-' . $relIMProviderId] = 1;
203 }
204 else {
205 $returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]][$relationField] = 1;
206 }
207 $relPhoneTypeId = $relIMProviderId = NULL;
208 }
209 else {
210 $returnProperties[$relationshipTypes][$relationField] = 1;
211 }
212 }
213 elseif (is_numeric($locTypeId)) {
214 if ($phoneTypeId) {
215 $returnProperties['location'][$locationTypes[$locTypeId]]['phone-' . $phoneTypeId] = 1;
216 }
217 elseif ($imProviderId) {
218 $returnProperties['location'][$locationTypes[$locTypeId]]['im-' . $imProviderId] = 1;
219 }
220 else {
221 $returnProperties['location'][$locationTypes[$locTypeId]][$fieldName] = 1;
222 }
223 }
224 else {
225 //hack to fix component fields
226 if ($fieldName == 'event_id') {
227 $returnProperties['event_title'] = 1;
228 }
229 else if (
230 $exportMode == CRM_Export_Form_Select::EVENT_EXPORT &&
231 array_key_exists( $fieldName, self::componentPaymentFields())
232 ) {
233 $selectedPaymentFields = true;
234 $paymentTableId = 'participant_id';
235 $returnProperties[$fieldName] = 1;
236 }
237 else {
238 $returnProperties[$fieldName] = 1;
239
240 //campaign field export.
241 if (substr($fieldName, -8) == 'campaign') {
242 $fldNames = explode('_', $fieldName);
243 $returnProperties["{$fldNames[0]}_campaign_id"] = 1;
244 }
245 }
246 }
247 }
248
249 // hack to add default returnproperty based on export mode
250 if ($exportMode == CRM_Export_Form_Select::CONTRIBUTE_EXPORT) {
251 $returnProperties['contribution_id'] = 1;
252 }
253 elseif ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
254 $returnProperties['participant_id'] = 1;
255 if (CRM_Utils_Array::value('participant_role', $returnProperties)) {
256 unset($returnProperties['participant_role']);
257 $returnProperties['participant_role_id'] = 1;
258 }
259 }
260 elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
261 $returnProperties['membership_id'] = 1;
262 }
263 elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
264 $returnProperties['pledge_id'] = 1;
265 }
266 elseif ($exportMode == CRM_Export_Form_Select::CASE_EXPORT) {
267 $returnProperties['case_id'] = 1;
268 }
269 elseif ($exportMode == CRM_Export_Form_Select::GRANT_EXPORT) {
270 $returnProperties['grant_id'] = 1;
271 }
272 elseif ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
273 $returnProperties['activity_id'] = 1;
274 }
275 }
276 else {
277 $primary = TRUE;
278 $fields = CRM_Contact_BAO_Contact::exportableFields('All', TRUE, TRUE);
279 foreach ($fields as $key => $var) {
280 if ($key && (substr($key, 0, 6) != 'custom')) {
281 //for CRM=952
282 $returnProperties[$key] = 1;
283 }
284 }
285
286 if ($primary) {
287 $returnProperties['location_type'] = 1;
288 $returnProperties['im_provider'] = 1;
289 $returnProperties['phone_type_id'] = 1;
290 $returnProperties['provider_id'] = 1;
291 $returnProperties['current_employer'] = 1;
292 }
293
294 $extraReturnProperties = array();
295 $paymentFields = FALSE;
296
297 switch ($queryMode) {
298 case CRM_Contact_BAO_Query::MODE_EVENT:
299 $paymentFields = TRUE;
300 $paymentTableId = 'participant_id';
301 break;
302
303 case CRM_Contact_BAO_Query::MODE_MEMBER:
304 $paymentFields = TRUE;
305 $paymentTableId = 'membership_id';
306 break;
307
308 case CRM_Contact_BAO_Query::MODE_PLEDGE:
309 $extraReturnProperties = CRM_Pledge_BAO_Query::extraReturnProperties($queryMode);
310 $paymentFields = TRUE;
311 $paymentTableId = 'pledge_payment_id';
312 break;
313
314 case CRM_Contact_BAO_Query::MODE_CASE:
315 $extraReturnProperties = CRM_Case_BAO_Query::extraReturnProperties($queryMode);
316 break;
317 }
318
319 if ($queryMode != CRM_Contact_BAO_Query::MODE_CONTACTS) {
320 $componentReturnProperties = CRM_Contact_BAO_Query::defaultReturnProperties($queryMode);
321
322 $campaignReturnProperties = array();;
323 foreach ($componentReturnProperties as $fld => $true) {
324 $campaignReturnProperties[$fld] = $true;
325 if (substr($fld, -11) == 'campaign_id') {
326 $exportCampaign = TRUE;
327 $campaignReturnProperties[substr($fld, 0, -3)] = 1;
328 }
329 }
330 $componentReturnProperties = $campaignReturnProperties;
331
332 $returnProperties = array_merge($returnProperties, $componentReturnProperties);
333
334 if (!empty($extraReturnProperties)) {
335 $returnProperties = array_merge($returnProperties, $extraReturnProperties);
336 }
337
338 // unset non exportable fields for components
339 $nonExpoFields = array(
340 'groups', 'tags', 'notes', 'contribution_status_id',
341 'pledge_status_id', 'pledge_payment_status_id',
342 );
343 foreach ($nonExpoFields as $value) {
344 unset($returnProperties[$value]);
345 }
346 }
347 }
348
349 if ($mergeSameAddress) {
350 //make sure the addressee fields are selected
351 //while using merge same address feature
352 $returnProperties['addressee'] = 1;
353 $returnProperties['postal_greeting'] = 1;
354 $returnProperties['email_greeting'] = 1;
355 $returnProperties['street_name'] = 1;
356 $returnProperties['household_name'] = 1;
357 $returnProperties['street_address'] = 1;
358 $returnProperties['city'] = 1;
359 $returnProperties['state_province'] = 1;
360
361 // some columns are required for assistance incase they are not already present
362 $exportParams['merge_same_address']['temp_columns'] = array();
363 $tempColumns = array('id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id');
364 foreach ($tempColumns as $column) {
365 if (!array_key_exists($column, $returnProperties)) {
366 $returnProperties[$column] = 1;
367 $column = $column == 'id' ? 'civicrm_primary_id' : $column;
368 $exportParams['merge_same_address']['temp_columns'][$column] = 1;
369 }
370 }
371 }
372
373 if ($componentTable &&
374 CRM_Utils_Array::value('additional_group', $exportParams)
375 ) {
376 // If an Additional Group is selected, then all contacts in that group are
377 // added to the export set (filtering out duplicates).
378 $query = "
379 INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_contact gc WHERE gc.group_id = {$exportParams['additional_group']} ON DUPLICATE KEY UPDATE {$componentTable}.contact_id = gc.contact_id";
380 CRM_Core_DAO::executeQuery($query);
381 }
382
383 if ($moreReturnProperties) {
384 // fix for CRM-7066
385 if (CRM_Utils_Array::value('group', $moreReturnProperties)) {
386 unset($moreReturnProperties['group']);
387 $moreReturnProperties['groups'] = 1;
388 }
389 $returnProperties = array_merge($returnProperties, $moreReturnProperties);
390 }
391
392 $exportParams['postal_mailing_export']['temp_columns'] = array();
393 if ($exportParams['exportOption'] == 2 &&
394 isset($exportParams['postal_mailing_export']) &&
395 CRM_Utils_Array::value('postal_mailing_export', $exportParams['postal_mailing_export']) == 1
396 ) {
397 $postalColumns = array('is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1');
398 foreach ($postalColumns as $column) {
399 if (!array_key_exists($column, $returnProperties)) {
400 $returnProperties[$column] = 1;
401 $exportParams['postal_mailing_export']['temp_columns'][$column] = 1;
402 }
403 }
404 }
405
406 $query = new CRM_Contact_BAO_Query(NULL, $returnProperties, NULL,
407 FALSE, FALSE, $queryMode,
408 FALSE, TRUE, TRUE, NULL, $queryOperator
409 );
410
411 list($select, $from, $where, $having) = $query->query();
412
413 if ($mergeSameHousehold == 1) {
414 if (!$returnProperties['id']) {
415 $returnProperties['id'] = 1;
416 }
417
418 //also merge Head of Household
419 $relationKeyMOH = CRM_Utils_Array::key('Household Member of', $contactRelationshipTypes);
420 $relationKeyHOH = CRM_Utils_Array::key('Head of Household for', $contactRelationshipTypes);
421
422 foreach ($returnProperties as $key => $value) {
423 if (!array_key_exists($key, $contactRelationshipTypes)) {
424 $returnProperties[$relationKeyMOH][$key] = $value;
425 $returnProperties[$relationKeyHOH][$key] = $value;
426 }
427 }
428
429 unset($returnProperties[$relationKeyMOH]['location_type']);
430 unset($returnProperties[$relationKeyMOH]['im_provider']);
431 unset($returnProperties[$relationKeyHOH]['location_type']);
432 unset($returnProperties[$relationKeyHOH]['im_provider']);
433 }
434
435 $allRelContactArray = $relationQuery = array();
436
437 foreach ($contactRelationshipTypes as $rel => $dnt) {
438 if ($relationReturnProperties = CRM_Utils_Array::value($rel, $returnProperties)) {
439 $allRelContactArray[$rel] = array();
440 // build Query for each relationship
441 $relationQuery[$rel] = new CRM_Contact_BAO_Query(NULL, $relationReturnProperties,
442 NULL, FALSE, FALSE, $queryMode
443 );
444 list($relationSelect, $relationFrom, $relationWhere, $relationHaving) = $relationQuery[$rel]->query();
445
446 list($id, $direction) = explode('_', $rel, 2);
447 // identify the relationship direction
448 $contactA = 'contact_id_a';
449 $contactB = 'contact_id_b';
450 if ($direction == 'b_a') {
451 $contactA = 'contact_id_b';
452 $contactB = 'contact_id_a';
453 }
454 if ($exportMode == CRM_Export_Form_Select::CONTACT_EXPORT) {
455 $relIDs = $ids;
456 }
457 elseif ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
458 $query = "SELECT source_contact_id FROM civicrm_activity
459 WHERE id IN ( " . implode(',', $ids) . ")";
460 $dao = CRM_Core_DAO::executeQuery($query);
461 while ($dao->fetch()) {
462 $relIDs[] = $dao->source_contact_id;
463 }
464 }
465 else {
466 switch ($exportMode) {
467 case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
468 $component = 'civicrm_contribution';
469 break;
470
471 case CRM_Export_Form_Select::EVENT_EXPORT:
472 $component = 'civicrm_participant';
473 break;
474
475 case CRM_Export_Form_Select::MEMBER_EXPORT:
476 $component = 'civicrm_membership';
477 break;
478
479 case CRM_Export_Form_Select::PLEDGE_EXPORT:
480 $component = 'civicrm_pledge';
481 break;
482
483 case CRM_Export_Form_Select::CASE_EXPORT:
484 $component = 'civicrm_case';
485 break;
486
487 case CRM_Export_Form_Select::GRANT_EXPORT:
488 $component = 'civicrm_grant';
489 break;
490 }
491 $relIDs = CRM_Core_DAO::getContactIDsFromComponent($ids, $component);
492 }
493
494 $relationshipJoin = $relationshipClause = '';
495 if ($componentTable) {
496 $relationshipJoin = " INNER JOIN $componentTable ctTable ON ctTable.contact_id = {$contactA}";
497 }
498 else {
499 $relID = implode(',', $relIDs);
500 $relationshipClause = " AND crel.{$contactA} IN ( {$relID} )";
501 }
502
503 $relationFrom = " {$relationFrom}
504 INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_a.id AND crel.relationship_type_id = {$id}
505 {$relationshipJoin} ";
506
507 //check for active relationship status only
508 $today = date('Ymd');
509 $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
510 $relationWhere = " WHERE contact_a.is_deleted = 0 {$relationshipClause} {$relationActive}";
511 $relationGroupBy = " GROUP BY crel.{$contactA}";
512 $relationSelect = "{$relationSelect}, {$contactA} as refContact ";
513 $relationQueryString = "$relationSelect $relationFrom $relationWhere $relationHaving $relationGroupBy";
514
515 $allRelContactDAO = CRM_Core_DAO::executeQuery($relationQueryString);
516 while ($allRelContactDAO->fetch()) {
517 //FIX Me: Migrate this to table rather than array
518 // build the array of all related contacts
519 $allRelContactArray[$rel][$allRelContactDAO->refContact] = clone($allRelContactDAO);
520 }
521 $allRelContactDAO->free();
522 }
523 }
524
525 // make sure the groups stuff is included only if specifically specified
526 // by the fields param (CRM-1969), else we limit the contacts outputted to only
527 // ones that are part of a group
528 if (CRM_Utils_Array::value('groups', $returnProperties)) {
529 $oldClause = "( contact_a.id = civicrm_group_contact.contact_id )";
530 $newClause = " ( $oldClause AND ( civicrm_group_contact.status = 'Added' OR civicrm_group_contact.status IS NULL ) )";
531 // total hack for export, CRM-3618
532 $from = str_replace($oldClause,
533 $newClause,
534 $from
535 );
536 }
537
538 if ($componentTable) {
539 $from .= " INNER JOIN $componentTable ctTable ON ctTable.contact_id = contact_a.id ";
540 }
541 elseif ($componentClause) {
542 if (empty($where)) {
543 $where = "WHERE $componentClause";
544 }
545 else {
546 $where .= " AND $componentClause";
547 }
548 }
549
550 $queryString = "$select $from $where $having";
551
552 $groupBy = "";
553 if (CRM_Utils_Array::value('tags', $returnProperties) ||
554 CRM_Utils_Array::value('groups', $returnProperties) ||
555 CRM_Utils_Array::value('notes', $returnProperties) ||
556 // CRM-9552
557 ($queryMode & CRM_Contact_BAO_Query::MODE_CONTACTS && $query->_useGroupBy)
558 ) {
559 $groupBy = " GROUP BY contact_a.id";
560 }
561
562 if ($queryMode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
563 $groupBy = " GROUP BY civicrm_activity.id ";
564 }
565 $queryString .= $groupBy;
566 if ($order) {
567 list($field, $dir) = explode(' ', $order, 2);
568 $field = trim($field);
569 if (CRM_Utils_Array::value($field, $returnProperties)) {
570 // $queryString .= " ORDER BY $order";
571 }
572 }
573
574 $multipleSelectFields = array('preferred_communication_method' => 1);
575
576 $addPaymentHeader = FALSE;
577
578 $paymentDetails = array();
579 if ($paymentFields || $selectedPaymentFields) {
580
581 // get payment related in for event and members
582 $paymentDetails = CRM_Contribute_BAO_Contribution::getContributionDetails($exportMode, $ids);
583 //get all payment headers.
584 if (!$selectedPaymentFields) {
585 $paymentHeaders = self::componentPaymentFields();
586 if (!empty($paymentDetails)) {
587 $addPaymentHeader = TRUE;
588 }
589 }
590 $nullContributionDetails = array_fill_keys(array_keys($paymentHeaders), NULL);
591 }
592
593 //get all campaigns.
594 if ($exportCampaign) {
595 $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
596 }
597
598 $componentDetails = $headerRows = $sqlColumns = array();
599 $setHeader = TRUE;
600
601 $rowCount = self::EXPORT_ROW_COUNT;
602 $offset = 0;
603 // we write to temp table often to avoid using too much memory
604 $tempRowCount = 100;
605
606 $count = -1;
607
608 // for CRM-3157 purposes
609 $i18n = CRM_Core_I18n::singleton();
610
611 while (1) {
612 $limitQuery = "{$queryString} LIMIT {$offset}, {$rowCount}";
613 $dao = CRM_Core_DAO::executeQuery($limitQuery);
614 if ($dao->N <= 0) {
615 break;
616 }
617
618 while ($dao->fetch()) {
619 $count++;
620 $row = array();
621
622 //first loop through returnproperties so that we return what is required, and in same order.
623 $relationshipField = 0;
624 foreach ($returnProperties as $field => $value) {
625 //we should set header only once
626 if ($setHeader) {
627 $sqlDone = FALSE;
628 if (isset($query->_fields[$field]['title'])) {
629 $headerRows[] = $query->_fields[$field]['title'];
630 }
631 elseif ($field == 'phone_type_id') {
632 $headerRows[] = ts('Phone Type');
633 }
634 elseif ($field == 'provider_id') {
635 $headerRows[] = ts('IM Service Provider');
636 }
637 elseif (is_array($value) && $field == 'location') {
638 // fix header for location type case
639 foreach ($value as $ltype => $val) {
640 foreach (array_keys($val) as $fld) {
641 $type = explode('-', $fld);
642 $hdr = "{$ltype}-" . $query->_fields[$type[0]]['title'];
643
644 if (CRM_Utils_Array::value(1, $type)) {
645 if (CRM_Utils_Array::value(0, $type) == 'phone') {
646 $hdr .= "-" . CRM_Utils_Array::value($type[1], $phoneTypes);
647 }
648 elseif (CRM_Utils_Array::value(0, $type) == 'im') {
649 $hdr .= "-" . CRM_Utils_Array::value($type[1], $imProviders);
650 }
651 }
652 $headerRows[] = $hdr;
653 self::sqlColumnDefn($query, $sqlColumns, $hdr);
654 }
655 $sqlDone = TRUE;
656 }
657 }
658 elseif (substr($field, 0, 5) == 'case_') {
659 if ($query->_fields['case'][$field]['title']) {
660 $headerRows[] = $query->_fields['case'][$field]['title'];
661 }
662 elseif ($query->_fields['activity'][$field]['title']) {
663 $headerRows[] = $query->_fields['activity'][$field]['title'];
664 }
665 }
666 elseif (array_key_exists($field, $contactRelationshipTypes)) {
667 $relName = $field;
668 foreach ($value as $relationField => $relationValue) {
669 // below block is same as primary block (duplicate)
670 if (isset($relationQuery[$field]->_fields[$relationField]['title'])) {
671 if ($relationQuery[$field]->_fields[$relationField]['name'] == 'name') {
672 $headerName = $field . '-' . $relationField;
673 }
674 else {
675 if ($relationField == 'current_employer') {
676 $headerName = $field . '-' . 'current_employer';
677 }
678 else {
679 $headerName = $field . '-' . $relationQuery[$field]->_fields[$relationField]['name'];
680 }
681 }
682
683 $headerRows[] = $headerName;
684
685 self::sqlColumnDefn($query, $sqlColumns, $headerName);
686 }
687 elseif ($relationField == 'phone_type_id') {
688 $headerName = $field . '-' . 'Phone Type';
689 $headerRows[] = $headerName;
690 self::sqlColumnDefn($query, $sqlColumns, $headerName);
691 }
692 elseif ($relationField == 'provider_id') {
693 $headerName = $field . '-' . 'Im Service Provider';
694 $headerRows[] = $headerName;
695 self::sqlColumnDefn($query, $sqlColumns, $headerName);
696 }
697 elseif ($relationField == 'state_province_id') {
698 $headerName = $field . '-' . 'state_province_id';
699 $headerRows[] = $headerName;
700 self::sqlColumnDefn($query, $sqlColumns, $headerName);
701 }
702 elseif (is_array($relationValue) && $relationField == 'location') {
703 // fix header for location type case
704 foreach ($relationValue as $ltype => $val) {
705 foreach (array_keys($val) as $fld) {
706 $type = explode('-', $fld);
707
708 $hdr = "{$ltype}-" . $relationQuery[$field]->_fields[$type[0]]['title'];
709
710 if (CRM_Utils_Array::value(1, $type)) {
711 if (CRM_Utils_Array::value(0, $type) == 'phone') {
712 $hdr .= "-" . CRM_Utils_Array::value($type[1], $phoneTypes);
713 }
714 elseif (CRM_Utils_Array::value(0, $type) == 'im') {
715 $hdr .= "-" . CRM_Utils_Array::value($type[1], $imProviders);
716 }
717 }
718 $headerName = $field . '-' . $hdr;
719 $headerRows[] = $headerName;
720 self::sqlColumnDefn($query, $sqlColumns, $headerName);
721 }
722 }
723 }
724 }
725 }
726 elseif ($selectedPaymentFields && array_key_exists($field, self::componentPaymentFields())) {
727 $headerRows[] = CRM_Utils_Array::value($field, self::componentPaymentFields());
728 }
729 else {
730 $headerRows[] = $field;
731 }
732
733 if (!$sqlDone) {
734 self::sqlColumnDefn($query, $sqlColumns, $field);
735 }
736 }
737
738 // add im_provider to $dao object
739 if ($field == 'im_provider' && property_exists($dao, 'provider_id')) {
740 $dao->im_provider = $dao->provider_id;
741 }
742
743 //build row values (data)
744 $fieldValue = NULL;
745 if (property_exists($dao, $field)) {
746 $fieldValue = $dao->$field;
747 // to get phone type from phone type id
748 if ($field == 'phone_type_id' && isset($phoneTypes[$fieldValue])) {
749 $fieldValue = $phoneTypes[$fieldValue];
750 }
751 elseif ($field == 'provider_id' || $field == 'im_provider') {
752 $fieldValue = CRM_Utils_Array::value($fieldValue, $imProviders);
753 }
754 elseif ($field == 'participant_role_id') {
755 $participantRoles = CRM_Event_PseudoConstant::participantRole();
756 $sep = CRM_Core_DAO::VALUE_SEPARATOR;
757 $viewRoles = array();
758 foreach (explode($sep, $dao->$field) as $k => $v) {
759 $viewRoles[] = $participantRoles[$v];
760 }
761 $fieldValue = implode(',', $viewRoles);
762 }
763 elseif ($field == 'master_id') {
764 $masterAddressId = NULL;
765 if (isset($dao->master_id)) {
766 $masterAddressId = $dao->master_id;
767 }
768 // get display name of contact that address is shared.
769 $fieldValue = CRM_Contact_BAO_Contact::getMasterDisplayName($masterAddressId, $dao->contact_id);
770 }
771 }
772
773 if ($field == 'id') {
774 $row[$field] = $dao->contact_id;
775 // special case for calculated field
776 }
777 elseif ($field == 'pledge_balance_amount') {
778 $row[$field] = $dao->pledge_amount - $dao->pledge_total_paid;
779 // special case for calculated field
780 }
781 elseif ($field == 'pledge_next_pay_amount') {
782 $row[$field] = $dao->pledge_next_pay_amount + $dao->pledge_outstanding_amount;
783 }
784 elseif (is_array($value) && $field == 'location') {
785 // fix header for location type case
786 foreach ($value as $ltype => $val) {
787 foreach (array_keys($val) as $fld) {
788 $type = explode('-', $fld);
789 $fldValue = "{$ltype}-" . $type[0];
790
791 if (CRM_Utils_Array::value(1, $type)) {
792 $fldValue .= "-" . $type[1];
793 }
794
795 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
796 switch ($fld) {
797 case 'country':
798 case 'world_region':
799 $row[$fldValue] = $i18n->crm_translate($dao->$fldValue, array('context' => 'country'));
800 break;
801
802 case 'state_province':
803 $row[$fldValue] = $i18n->crm_translate($dao->$fldValue, array('context' => 'province'));
804 break;
805
806 case 'im_provider':
807 $imFieldvalue = $fldValue . "-provider_id";
808 $row[$fldValue] = CRM_Utils_Array::value($dao->$imFieldvalue, $imProviders);
809 break;
810
811 default:
812 $row[$fldValue] = $dao->$fldValue;
813 break;
814 }
815 }
816 }
817 }
818 elseif (array_key_exists($field, $contactRelationshipTypes)) {
819 $relDAO = CRM_Utils_Array::value($dao->contact_id, $allRelContactArray[$field]);
820 foreach ($value as $relationField => $relationValue) {
821 if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
822 $fieldValue = $relDAO->$relationField;
823 if ($relationField == 'phone_type_id') {
824 $fieldValue = $phoneTypes[$relationValue];
825 }
826 elseif ($relationField == 'provider_id') {
827 $fieldValue = CRM_Utils_Array::value($relationValue, $imProviders);
828 }
829 }
830 else {
831 $fieldValue = '';
832 }
833 $field = $field . '_';
834 if (is_object($relDAO) && $relationField == 'id') {
835 $row[$field . $relationField] = $relDAO->contact_id;
836 } else if ( is_object( $relDAO ) && is_array( $relationValue ) && $relationField == 'location' ) {
837 foreach ($relationValue as $ltype => $val) {
838 foreach (array_keys($val) as $fld) {
839 $type = explode('-', $fld);
840 $fldValue = "{$ltype}-" . $type[0];
841 if (CRM_Utils_Array::value(1, $type)) {
842 $fldValue .= "-" . $type[1];
843 }
844 // CRM-3157: localise country, region (both have ‘country’ context)
845 // and state_province (‘province’ context)
846 switch (TRUE) {
847 case (!is_object($relDAO)):
848 $row[$field . '_' . $fldValue] = '';
849 break;
850
851 case in_array('country', $type):
852 case in_array('world_region', $type):
853 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
854 array('context' => 'country')
855 );
856 break;
857
858 case in_array('state_province', $type):
859 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
860 array('context' => 'province')
861 );
862 break;
863
864 default:
865 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
866 break;
867 }
868 }
869 }
870 }
871 elseif (isset($fieldValue) && $fieldValue != '') {
872 //check for custom data
873 if ($cfID = CRM_Core_BAO_CustomField::getKeyID($relationField)) {
874 $row[$field . $relationField] = CRM_Core_BAO_CustomField::getDisplayValue($fieldValue, $cfID,
875 $relationQuery[$field]->_options
876 );
877 }
878 elseif (in_array($relationField, array(
879 'email_greeting', 'postal_greeting', 'addressee'))) {
880 //special case for greeting replacement
881 $fldValue = "{$relationField}_display";
882 $row[$field . $relationField] = $relDAO->$fldValue;
883 }
884 else {
885 //normal relationship fields
886 // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
887 switch ($relationField) {
888 case 'country':
889 case 'world_region':
890 $row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
891 break;
892
893 case 'state_province':
894 $row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
895 break;
896
897 default:
898 $row[$field . $relationField] = $fieldValue;
899 break;
900 }
901 }
902 }
903 else {
904 // if relation field is empty or null
905 $row[$field . $relationField] = '';
906 }
907 }
908 }
909 elseif (isset($fieldValue) &&
910 $fieldValue != ''
911 ) {
912 //check for custom data
913 if ($cfID = CRM_Core_BAO_CustomField::getKeyID($field)) {
914 $row[$field] = CRM_Core_BAO_CustomField::getDisplayValue($fieldValue, $cfID, $query->_options);
915 }
916 elseif (array_key_exists($field, $multipleSelectFields)) {
917 //option group fixes
918 $paramsNew = array($field => $fieldValue);
919 if ($field == 'test_tutoring') {
920 $name = array($field => array('newName' => $field, 'groupName' => 'test'));
921 // for readers group
922 }
923 elseif (substr($field, 0, 4) == 'cmr_') {
924 $name = array($field => array('newName' => $field, 'groupName' => substr($field, 0, -3)));
925 }
926 else {
927 $name = array($field => array('newName' => $field, 'groupName' => $field));
928 }
929 CRM_Core_OptionGroup::lookupValues($paramsNew, $name, FALSE);
930 $row[$field] = $paramsNew[$field];
931 }
932 elseif (in_array($field, array(
933 'email_greeting', 'postal_greeting', 'addressee'))) {
934 //special case for greeting replacement
935 $fldValue = "{$field}_display";
936 $row[$field] = $dao->$fldValue;
937 }
938 else {
939 //normal fields with a touch of CRM-3157
940 switch ($field) {
941 case 'country':
942 case 'world_region':
943 $row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
944 break;
945
946 case 'state_province':
947 $row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
948 break;
949
950 case 'gender':
951 case 'preferred_communication_method':
952 case 'preferred_mail_format':
953 $row[$field] = $i18n->crm_translate($fieldValue);
954 break;
955
956 default:
957 $row[$field] = $fieldValue;
958 break;
959 }
960 }
961 }
962 elseif (substr($field, -8) == 'campaign') {
963 $campIdFld = "{$field}_id";
964 $row[$field] = CRM_Utils_Array::value($dao->$campIdFld, $allCampaigns, '');
965 }
966 elseif ($selectedPaymentFields && array_key_exists($field, self::componentPaymentFields())) {
967 $paymentData = CRM_Utils_Array::value($dao->$paymentTableId, $paymentDetails);
968 $payFieldMapper = array(
969 'componentPaymentField_total_amount' => 'total_amount',
970 'componentPaymentField_contribution_status' => 'contribution_status',
971 'componentPaymentField_payment_instrument' => 'pay_instru',
972 'componentPaymentField_transaction_id' => 'trxn_id',
973 'componentPaymentField_received_date' => 'receive_date',
974 );
975 $row[$field] = CRM_Utils_Array::value($payFieldMapper[$field], $paymentData, '');
976 }
977 else {
978 // if field is empty or null
979 $row[$field] = '';
980 }
981 }
982
983 // add payment headers if required
984 if ($addPaymentHeader && $paymentFields) {
985 $headerRows = array_merge($headerRows, $paymentHeaders);
986 foreach (array_keys($paymentHeaders) as $paymentHdr) {
987 self::sqlColumnDefn($query, $sqlColumns, $paymentHdr);
988 }
989 $addPaymentHeader = FALSE;
990 }
991
992 if ($setHeader) {
993 $exportTempTable = self::createTempTable($sqlColumns);
994 }
995
996 //build header only once
997 $setHeader = FALSE;
998
999 // If specific payment fields have been selected for export, payment
1000 // data will already be in $row. Otherwise, add payment related
1001 // information, if appropriate.
1002 if (!$selectedPaymentFields) {
1003 if ($paymentFields) {
1004 $paymentData = CRM_Utils_Array::value($row[$paymentTableId], $paymentDetails);
1005 if (!is_array($paymentData) || empty($paymentData)) {
1006 $paymentData = $nullContributionDetails;
1007 }
1008 $row = array_merge($row, $paymentData);
1009 }
1010 elseif (!empty($paymentDetails)) {
1011 $row = array_merge($row, $nullContributionDetails);
1012 }
1013 }
1014
1015 //remove organization name for individuals if it is set for current employer
1016 if (CRM_Utils_Array::value('contact_type', $row) &&
1017 $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)
1018 ) {
1019 $row['organization_name'] = '';
1020 }
1021
1022 // add component info
1023 // write the row to a file
1024 $componentDetails[] = $row;
1025
1026 // output every $tempRowCount rows
1027 if ($count % $tempRowCount == 0) {
1028 self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
1029 $componentDetails = array();
1030 }
1031 }
1032 $dao->free();
1033 $offset += $rowCount;
1034 }
1035
1036 if ($exportTempTable) {
1037 self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
1038
1039 // do merge same address and merge same household processing
1040 if ($mergeSameAddress) {
1041 self::mergeSameAddress($exportTempTable, $headerRows, $sqlColumns, $exportParams);
1042 }
1043
1044 // merge the records if they have corresponding households
1045 if ($mergeSameHousehold) {
1046 self::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyMOH);
1047 self::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyHOH);
1048 }
1049
1050 // fix the headers for rows with relationship type
1051 if (!empty($relName)) {
1052 self::manipulateHeaderRows($headerRows, $contactRelationshipTypes);
1053 }
1054
1055 // if postalMailing option is checked, exclude contacts who are deceased, have
1056 // "Do not mail" privacy setting, or have no street address
1057 if (isset($exportParams['postal_mailing_export']['postal_mailing_export']) &&
1058 $exportParams['postal_mailing_export']['postal_mailing_export'] == 1
1059 ) {
1060 self::postalMailingFormat($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1061 }
1062
1063 // call export hook
1064 CRM_Utils_Hook::export($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1065
1066 // now write the CSV file
1067 self::writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $exportMode);
1068
1069 // delete the export temp table and component table
1070 $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
1071 CRM_Core_DAO::executeQuery($sql);
1072
1073 CRM_Utils_System::civiExit();
1074 }
1075 else {
1076 CRM_Core_Error::fatal(ts('No records to export'));
1077 }
1078 }
1079
1080 /**
1081 * name of the export file based on mode
1082 *
1083 * @param string $output type of output
1084 * @param int $mode export mode
1085 *
1086 * @return string name of the file
1087 */
1088 function getExportFileName($output = 'csv', $mode = CRM_Export_Form_Select::CONTACT_EXPORT) {
1089 switch ($mode) {
1090 case CRM_Export_Form_Select::CONTACT_EXPORT:
1091 return ts('CiviCRM Contact Search');
1092
1093 case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
1094 return ts('CiviCRM Contribution Search');
1095
1096 case CRM_Export_Form_Select::MEMBER_EXPORT:
1097 return ts('CiviCRM Member Search');
1098
1099 case CRM_Export_Form_Select::EVENT_EXPORT:
1100 return ts('CiviCRM Participant Search');
1101
1102 case CRM_Export_Form_Select::PLEDGE_EXPORT:
1103 return ts('CiviCRM Pledge Search');
1104
1105 case CRM_Export_Form_Select::CASE_EXPORT:
1106 return ts('CiviCRM Case Search');
1107
1108 case CRM_Export_Form_Select::GRANT_EXPORT:
1109 return ts('CiviCRM Grant Search');
1110
1111 case CRM_Export_Form_Select::ACTIVITY_EXPORT:
1112 return ts('CiviCRM Activity Search');
1113 }
1114 }
1115
1116 /**
1117 * Function to handle import error file creation.
1118 *
1119 */
1120 function invoke() {
1121 $type = CRM_Utils_Request::retrieve('type', 'Positive', CRM_Core_DAO::$_nullObject);
1122 $parserName = CRM_Utils_Request::retrieve('parser', 'String', CRM_Core_DAO::$_nullObject);
1123 if (empty($parserName) || empty($type)) {
1124 return;
1125 }
1126
1127 // clean and ensure parserName is a valid string
1128 $parserName = CRM_Utils_String::munge($parserName);
1129 $parserClass = explode('_', $parserName);
1130
1131 // make sure parserClass is in the CRM namespace and
1132 // at least 3 levels deep
1133 if ($parserClass[0] == 'CRM' &&
1134 count($parserClass) >= 3
1135 ) {
1136 require_once (str_replace('_', DIRECTORY_SEPARATOR, $parserName) . ".php");
1137 // ensure the functions exists
1138 if (method_exists($parserName, 'errorFileName') &&
1139 method_exists($parserName, 'saveFileName')
1140 ) {
1141 $errorFileName = $parserName::errorFileName($type);
1142 $saveFileName = $parserName::saveFileName($type);
1143 if (!empty($errorFileName) && !empty($saveFileName)) {
1144 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
1145 header('Content-Description: File Transfer');
1146 header('Content-Type: text/csv');
1147 header('Content-Length: ' . filesize($errorFileName));
1148 header('Content-Disposition: attachment; filename=' . $saveFileName);
1149
1150 readfile($errorFileName);
1151 }
1152 }
1153 }
1154 CRM_Utils_System::civiExit();
1155 }
1156
1157 function exportCustom($customSearchClass, $formValues, $order) {
1158 $ext = CRM_Extension_System::singleton()->getMapper();
1159 if (!$ext->isExtensionClass($customSearchClass)) {
1160 require_once (str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php');
1161 }
1162 else {
1163 require_once ($ext->classToPath($customSearchClass));
1164 }
1165 $search = new $customSearchClass($formValues);
1166
1167 $includeContactIDs = FALSE;
1168 if ($formValues['radio_ts'] == 'ts_sel') {
1169 $includeContactIDs = TRUE;
1170 }
1171
1172 $sql = $search->all(0, 0, $order, $includeContactIDs);
1173
1174 $columns = $search->columns();
1175
1176 $header = array_keys($columns);
1177 $fields = array_values($columns);
1178
1179 $rows = array();
1180 $dao = CRM_Core_DAO::executeQuery($sql);
1181 $alterRow = FALSE;
1182 if (method_exists($search, 'alterRow')) {
1183 $alterRow = TRUE;
1184 }
1185 while ($dao->fetch()) {
1186 $row = array();
1187
1188 foreach ($fields as $field) {
1189 $row[$field] = $dao->$field;
1190 }
1191 if ($alterRow) {
1192 $search->alterRow($row);
1193 }
1194 $rows[] = $row;
1195 }
1196
1197 CRM_Core_Report_Excel::writeCSVFile(self::getExportFileName(), $header, $rows);
1198 CRM_Utils_System::civiExit();
1199 }
1200
1201 static function sqlColumnDefn(&$query, &$sqlColumns, $field) {
1202 if (substr($field, -4) == '_a_b' || substr($field, -4) == '_b_a') {
1203 return;
1204 }
1205
1206 $fieldName = CRM_Utils_String::munge(strtolower($field), '_', 64);
1207 if ($fieldName == 'id') {
1208 $fieldName = 'civicrm_primary_id';
1209 }
1210
1211 // early exit for master_id, CRM-12100
1212 // in the DB it is an ID, but in the export, we retrive the display_name of the master record
1213 if ($fieldName == 'master_id') {
1214 $sqlColumns[$fieldName] = "$fieldName varchar(128)";
1215 return;
1216 }
1217
1218 // set the sql columns
1219 if (isset($query->_fields[$field]['type'])) {
1220 switch ($query->_fields[$field]['type']) {
1221 case CRM_Utils_Type::T_INT:
1222 case CRM_Utils_Type::T_BOOL:
1223 case CRM_Utils_Type::T_BOOLEAN:
1224 $sqlColumns[$fieldName] = "$fieldName varchar(16)";
1225 break;
1226
1227 case CRM_Utils_Type::T_STRING:
1228 if (isset($query->_fields[$field]['maxlength'])) {
1229 $sqlColumns[$fieldName] = "$fieldName varchar({$query->_fields[$field]['maxlength']})";
1230 }
1231 else {
1232 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1233 }
1234 break;
1235
1236 case CRM_Utils_Type::T_TEXT:
1237 case CRM_Utils_Type::T_LONGTEXT:
1238 case CRM_Utils_Type::T_BLOB:
1239 case CRM_Utils_Type::T_MEDIUMBLOB:
1240 $sqlColumns[$fieldName] = "$fieldName longtext";
1241 break;
1242
1243 case CRM_Utils_Type::T_FLOAT:
1244 case CRM_Utils_Type::T_ENUM:
1245 case CRM_Utils_Type::T_DATE:
1246 case CRM_Utils_Type::T_TIME:
1247 case CRM_Utils_Type::T_TIMESTAMP:
1248 case CRM_Utils_Type::T_MONEY:
1249 case CRM_Utils_Type::T_EMAIL:
1250 case CRM_Utils_Type::T_URL:
1251 case CRM_Utils_Type::T_CCNUM:
1252 default:
1253 $sqlColumns[$fieldName] = "$fieldName varchar(32)";
1254 break;
1255 }
1256 }
1257 else {
1258 if (substr($fieldName, -3, 3) == '_id') {
1259 $sqlColumns[$fieldName] = "$fieldName varchar(16)";
1260 }
1261 else {
1262 $changeFields = array(
1263 'groups',
1264 'tags',
1265 'notes'
1266 );
1267
1268 if (in_array($fieldName, $changeFields)) {
1269 $sqlColumns[$fieldName] = "$fieldName text";
1270 }
1271 else {
1272 // set the sql columns for custom data
1273 if (isset($query->_fields[$field]['data_type'])) {
1274
1275 switch ($query->_fields[$field]['data_type']) {
1276 case 'Country':
1277 case 'StateProvince':
1278 case 'Link':
1279 case 'String':
1280 $sqlColumns[$fieldName] = "$fieldName varchar(255)";
1281 break;
1282
1283 case 'Memo':
1284 $sqlColumns[$fieldName] = "$fieldName text";
1285 break;
1286
1287 default:
1288 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1289 break;
1290 }
1291 }
1292 else {
1293 $sqlColumns[$fieldName] = "$fieldName varchar(64)";
1294 }
1295 }
1296 }
1297 }
1298 }
1299
1300 static function writeDetailsToTable($tableName, &$details, &$sqlColumns) {
1301 if (empty($details)) {
1302 return;
1303 }
1304
1305 $sql = "
1306 SELECT max(id)
1307 FROM $tableName
1308 ";
1309
1310 $id = CRM_Core_DAO::singleValueQuery($sql);
1311 if (!$id) {
1312 $id = 0;
1313 }
1314
1315 $sqlClause = array();
1316
1317 foreach ($details as $dontCare => $row) {
1318 $id++;
1319 $valueString = array($id);
1320 foreach ($row as $dontCare => $value) {
1321 if (empty($value)) {
1322 $valueString[] = "''";
1323 }
1324 else {
1325 $valueString[] = "'" . CRM_Core_DAO::escapeString($value) . "'";
1326 }
1327 }
1328 $sqlClause[] = '(' . implode(',', $valueString) . ')';
1329 }
1330
1331 $sqlColumnString = '(id, ' . implode(',', array_keys($sqlColumns)) . ')';
1332
1333 $sqlValueString = implode(",\n", $sqlClause);
1334
1335 $sql = "
1336 INSERT INTO $tableName $sqlColumnString
1337 VALUES $sqlValueString
1338 ";
1339
1340 CRM_Core_DAO::executeQuery($sql);
1341 }
1342
1343 static function createTempTable(&$sqlColumns) {
1344 //creating a temporary table for the search result that need be exported
1345 $exportTempTable = CRM_Core_DAO::createTempTableName('civicrm_export', TRUE);
1346
1347 // also create the sql table
1348 $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
1349 CRM_Core_DAO::executeQuery($sql);
1350
1351 $sql = "
1352 CREATE TABLE {$exportTempTable} (
1353 id int unsigned NOT NULL AUTO_INCREMENT,
1354 ";
1355 $sql .= implode(",\n", array_values($sqlColumns));
1356
1357 $sql .= ",
1358 PRIMARY KEY ( id )
1359 ";
1360 // add indexes for street_address and household_name if present
1361 $addIndices = array(
1362 'street_address',
1363 'household_name',
1364 'civicrm_primary_id',
1365 );
1366
1367 foreach ($addIndices as $index) {
1368 if (isset($sqlColumns[$index])) {
1369 $sql .= ",
1370 INDEX index_{$index}( $index )
1371 ";
1372 }
1373 }
1374
1375 $sql .= "
1376 ) ENGINE=MyISAM DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci
1377 ";
1378
1379 CRM_Core_DAO::executeQuery($sql);
1380 return $exportTempTable;
1381 }
1382
1383 static function mergeSameAddress($tableName, &$headerRows, &$sqlColumns, $exportParams) {
1384 // check if any records are present based on if they have used shared address feature,
1385 // and not based on if city / state .. matches.
1386 $sql = "
1387 SELECT r1.id as copy_id,
1388 r1.civicrm_primary_id as copy_contact_id,
1389 r1.addressee as copy_addressee,
1390 r1.addressee_id as copy_addressee_id,
1391 r1.postal_greeting as copy_postal_greeting,
1392 r1.postal_greeting_id as copy_postal_greeting_id,
1393 r2.id as master_id,
1394 r2.civicrm_primary_id as master_contact_id,
1395 r2.postal_greeting as master_postal_greeting,
1396 r2.postal_greeting_id as master_postal_greeting_id,
1397 r2.addressee as master_addressee,
1398 r2.addressee_id as master_addressee_id
1399 FROM $tableName r1
1400 INNER JOIN civicrm_address adr ON r1.master_id = adr.id
1401 INNER JOIN $tableName r2 ON adr.contact_id = r2.civicrm_primary_id
1402 ORDER BY r1.id";
1403 $linkedMerge = self::_buildMasterCopyArray($sql, $exportParams, TRUE);
1404
1405 // find all the records that have the same street address BUT not in a household
1406 // require match on city and state as well
1407 $sql = "
1408 SELECT r1.id as master_id,
1409 r1.civicrm_primary_id as master_contact_id,
1410 r1.postal_greeting as master_postal_greeting,
1411 r1.postal_greeting_id as master_postal_greeting_id,
1412 r1.addressee as master_addressee,
1413 r1.addressee_id as master_addressee_id,
1414 r2.id as copy_id,
1415 r2.civicrm_primary_id as copy_contact_id,
1416 r2.postal_greeting as copy_postal_greeting,
1417 r2.postal_greeting_id as copy_postal_greeting_id,
1418 r2.addressee as copy_addressee,
1419 r2.addressee_id as copy_addressee_id
1420 FROM $tableName r1
1421 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
1422 r1.city = r2.city AND
1423 r1.state_province_id = r2.state_province_id )
1424 WHERE ( r1.household_name IS NULL OR r1.household_name = '' )
1425 AND ( r2.household_name IS NULL OR r2.household_name = '' )
1426 AND ( r1.street_address != '' )
1427 AND r2.id > r1.id
1428 ORDER BY r1.id
1429 ";
1430 $merge = self::_buildMasterCopyArray($sql, $exportParams);
1431
1432 // unset ids from $merge already present in $linkedMerge
1433 foreach ($linkedMerge as $masterID => $values) {
1434 $keys = array($masterID);
1435 $keys = array_merge($keys, array_keys($values['copy']));
1436 foreach ($merge as $mid => $vals) {
1437 if (in_array($mid, $keys)) {
1438 unset($merge[$mid]);
1439 }
1440 else {
1441 foreach ($values['copy'] as $copyId) {
1442 if (in_array($copyId, $keys)) {
1443 unset($merge[$mid]['copy'][$copyId]);
1444 }
1445 }
1446 }
1447 }
1448 }
1449 $merge = $merge + $linkedMerge;
1450
1451 foreach ($merge as $masterID => $values) {
1452 $sql = "
1453 UPDATE $tableName
1454 SET addressee = %1, postal_greeting = %2, email_greeting = %3
1455 WHERE id = %4
1456 ";
1457 $params = array(1 => array($values['addressee'], 'String'),
1458 2 => array($values['postalGreeting'], 'String'),
1459 3 => array($values['emailGreeting'], 'String'),
1460 4 => array($masterID, 'Integer'),
1461 );
1462 CRM_Core_DAO::executeQuery($sql, $params);
1463
1464 // delete all copies
1465 $deleteIDs = array_keys($values['copy']);
1466 $deleteIDString = implode(',', $deleteIDs);
1467 $sql = "
1468 DELETE FROM $tableName
1469 WHERE id IN ( $deleteIDString )
1470 ";
1471 CRM_Core_DAO::executeQuery($sql);
1472 }
1473
1474 // unset temporary columns that were added for postal mailing format
1475 if (!empty($exportParams['merge_same_address']['temp_columns'])) {
1476 $unsetKeys = array_keys($sqlColumns);
1477 foreach ($unsetKeys as $headerKey => $sqlColKey) {
1478 if (array_key_exists($sqlColKey, $exportParams['merge_same_address']['temp_columns'])) {
1479 unset($sqlColumns[$sqlColKey], $headerRows[$headerKey]);
1480 }
1481 }
1482 }
1483 }
1484
1485 static function _replaceMergeTokens($contactId, $exportParams) {
1486 $greetings = array();
1487 $contact = NULL;
1488
1489 $greetingFields = array(
1490 'postal_greeting',
1491 'addressee',
1492 );
1493 foreach ($greetingFields as $greeting) {
1494 if (CRM_Utils_Array::value($greeting, $exportParams)) {
1495 $greetingLabel = $exportParams[$greeting];
1496 if (empty($contact)) {
1497 $values = array(
1498 'id' => $contactId,
1499 'version' => 3,
1500 );
1501 $contact = civicrm_api('contact', 'get', $values);
1502
1503 if (CRM_Utils_Array::value('is_error', $contact)) {
1504 return $greetings;
1505 }
1506 $contact = $contact['values'][$contact['id']];
1507 }
1508
1509 $tokens = array('contact' => $greetingLabel);
1510 $greetings[$greeting] = CRM_Utils_Token::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
1511 }
1512 }
1513 return $greetings;
1514 }
1515
1516 /**
1517 * The function unsets static part of the string, if token is the dynamic part.
1518 * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
1519 * i.e 'Hello Alan' => converted to => 'Alan'
1520 *
1521 */
1522 static function _trimNonTokens(&$parsedString, $defaultGreeting,
1523 $addressMergeGreetings, $greetingType = 'postal_greeting'
1524 ) {
1525 if (CRM_Utils_Array::value($greetingType, $addressMergeGreetings)) {
1526 $greetingLabel = $addressMergeGreetings[$greetingType];
1527 }
1528 $greetingLabel = empty($greetingLabel) ? $defaultGreeting : $greetingLabel;
1529
1530 $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
1531 $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
1532 foreach ($stringsToBeReplaced as $key => $string) {
1533 // to keep one space
1534 $stringsToBeReplaced[$key] = ltrim($string);
1535 }
1536 $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
1537
1538 return $parsedString;
1539 }
1540
1541 static function _buildMasterCopyArray($sql, $exportParams, $sharedAddress = FALSE) {
1542 static $contactGreetingTokens = array();
1543
1544 $addresseeOptions = CRM_Core_OptionGroup::values('addressee');
1545 $postalOptions = CRM_Core_OptionGroup::values('postal_greeting');
1546
1547 $merge = $parents = array();
1548 $dao = CRM_Core_DAO::executeQuery($sql);
1549
1550 while ($dao->fetch()) {
1551 $masterID = $dao->master_id;
1552 $copyID = $dao->copy_id;
1553 $masterPostalGreeting = $dao->master_postal_greeting;
1554 $masterAddressee = $dao->master_addressee;
1555 $copyAddressee = $dao->copy_addressee;
1556
1557 if (!$sharedAddress) {
1558 if (!isset($contactGreetingTokens[$dao->master_contact_id])) {
1559 $contactGreetingTokens[$dao->master_contact_id] = self::_replaceMergeTokens($dao->master_contact_id, $exportParams);
1560 }
1561 $masterPostalGreeting = CRM_Utils_Array::value('postal_greeting',
1562 $contactGreetingTokens[$dao->master_contact_id], $dao->master_postal_greeting
1563 );
1564 $masterAddressee = CRM_Utils_Array::value('addressee',
1565 $contactGreetingTokens[$dao->master_contact_id], $dao->master_addressee
1566 );
1567
1568 if (!isset($contactGreetingTokens[$dao->copy_contact_id])) {
1569 $contactGreetingTokens[$dao->copy_contact_id] = self::_replaceMergeTokens($dao->copy_contact_id, $exportParams);
1570 }
1571 $copyPostalGreeting = CRM_Utils_Array::value('postal_greeting',
1572 $contactGreetingTokens[$dao->copy_contact_id], $dao->copy_postal_greeting
1573 );
1574 $copyAddressee = CRM_Utils_Array::value('addressee',
1575 $contactGreetingTokens[$dao->copy_contact_id], $dao->copy_addressee
1576 );
1577 }
1578
1579 if (!isset($merge[$masterID])) {
1580 // check if this is an intermediate child
1581 // this happens if there are 3 or more matches a,b, c
1582 // the above query will return a, b / a, c / b, c
1583 // we might be doing a bit more work, but for now its ok, unless someone
1584 // knows how to fix the query above
1585 if (isset($parents[$masterID])) {
1586 $masterID = $parents[$masterID];
1587 }
1588 else {
1589 $merge[$masterID] = array(
1590 'addressee' => $masterAddressee,
1591 'copy' => array(),
1592 'postalGreeting' => $masterPostalGreeting,
1593 );
1594 $merge[$masterID]['emailGreeting'] = &$merge[$masterID]['postalGreeting'];
1595 }
1596 }
1597 $parents[$copyID] = $masterID;
1598
1599 if (!$sharedAddress && !array_key_exists($copyID, $merge[$masterID]['copy'])) {
1600
1601 if (CRM_Utils_Array::value('postal_greeting_other', $exportParams) &&
1602 count($merge[$masterID]['copy']) >= 1
1603 ) {
1604 // use static greetings specified if no of contacts > 2
1605 $merge[$masterID]['postalGreeting'] = $exportParams['postal_greeting_other'];
1606 }
1607 elseif ($copyPostalGreeting) {
1608 self::_trimNonTokens($copyPostalGreeting,
1609 $postalOptions[$dao->copy_postal_greeting_id],
1610 $exportParams
1611 );
1612 $merge[$masterID]['postalGreeting'] = "{$merge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
1613 // if there happens to be a duplicate, remove it
1614 $merge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $merge[$masterID]['postalGreeting']);
1615 }
1616
1617 if (CRM_Utils_Array::value('addressee_other', $exportParams) &&
1618 count($merge[$masterID]['copy']) >= 1
1619 ) {
1620 // use static greetings specified if no of contacts > 2
1621 $merge[$masterID]['addressee'] = $exportParams['addressee_other'];
1622 }
1623 elseif ($copyAddressee) {
1624 self::_trimNonTokens($copyAddressee,
1625 $addresseeOptions[$dao->copy_addressee_id],
1626 $exportParams, 'addressee'
1627 );
1628 $merge[$masterID]['addressee'] = "{$merge[$masterID]['addressee']}, " . trim($copyAddressee);
1629 }
1630 }
1631 $merge[$masterID]['copy'][$copyID] = $copyAddressee;
1632 }
1633
1634 return $merge;
1635 }
1636
1637 /**
1638 * Function to merge household record into the individual record
1639 * if exists
1640 *
1641 * @param string $exportTempTable temporary temp table that stores the records
1642 * @param array $headerRows array of headers for the export file
1643 * @param array $sqlColumns array of names of the table columns of the temp table
1644 * @param string $prefix name of the relationship type that is prefixed to the table columns
1645 */
1646 static function mergeSameHousehold($exportTempTable, &$headerRows, &$sqlColumns, $prefix) {
1647 $prefixColumn = $prefix . '_';
1648 $allKeys = array_keys($sqlColumns);
1649 $replaced = array();
1650 $headerRows = array_values($headerRows);
1651
1652 // name map of the non standard fields in header rows & sql columns
1653 $mappingFields = array(
1654 'civicrm_primary_id' => 'id',
1655 'contact_source' => 'source',
1656 'current_employer_id' => 'employer_id',
1657 'contact_is_deleted' => 'is_deleted',
1658 'name' => 'address_name',
1659 'provider_id' => 'im_service_provider',
1660 'phone_type_id' => 'phone_type'
1661 );
1662
1663 //figure out which columns are to be replaced by which ones
1664 foreach ($sqlColumns as $columnNames => $dontCare) {
1665 if ($rep = CRM_Utils_Array::value($columnNames, $mappingFields)) {
1666 $replaced[$columnNames] = CRM_Utils_String::munge($prefixColumn . $rep, '_', 64);
1667 }
1668 else {
1669 $householdColName = CRM_Utils_String::munge($prefixColumn . $columnNames, '_', 64);
1670
1671 if (CRM_Utils_Array::value($householdColName, $sqlColumns)) {
1672 $replaced[$columnNames] = $householdColName;
1673 }
1674 }
1675 }
1676 $query = "UPDATE $exportTempTable SET ";
1677
1678 $clause = array();
1679 foreach ($replaced as $from => $to) {
1680 $clause[] = "$from = $to ";
1681 unset($sqlColumns[$to]);
1682 if ($key = CRM_Utils_Array::key($to, $allKeys)) {
1683 unset($headerRows[$key]);
1684 }
1685 }
1686 $query .= implode(",\n", $clause);
1687 $query .= " WHERE {$replaced['civicrm_primary_id']} != ''";
1688
1689 CRM_Core_DAO::executeQuery($query);
1690
1691 //drop the table columns that store redundant household info
1692 $dropQuery = "ALTER TABLE $exportTempTable ";
1693 foreach ($replaced as $householdColumns) {
1694 $dropClause[] = " DROP $householdColumns ";
1695 }
1696 $dropQuery .= implode(",\n", $dropClause);
1697
1698 CRM_Core_DAO::executeQuery($dropQuery);
1699
1700 // also drop the temp table if exists
1701 $sql = "DROP TABLE IF EXISTS {$exportTempTable}_temp";
1702 CRM_Core_DAO::executeQuery($sql);
1703
1704 // clean up duplicate records
1705 $query = "
1706 CREATE TABLE {$exportTempTable}_temp SELECT *
1707 FROM {$exportTempTable}
1708 GROUP BY civicrm_primary_id ";
1709
1710 CRM_Core_DAO::executeQuery($query);
1711
1712 $query = "DROP TABLE $exportTempTable";
1713 CRM_Core_DAO::executeQuery($query);
1714
1715 $query = "ALTER TABLE {$exportTempTable}_temp RENAME TO {$exportTempTable}";
1716 CRM_Core_DAO::executeQuery($query);
1717 }
1718
1719 static function writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $exportMode, $saveFile = null, $batchItems = '') {
1720 $writeHeader = TRUE;
1721 $offset = 0;
1722 $limit = self::EXPORT_ROW_COUNT;
1723
1724 $query = "SELECT * FROM $exportTempTable";
1725
1726 while (1) {
1727 $limitQuery = $query . "
1728 LIMIT $offset, $limit
1729 ";
1730 $dao = CRM_Core_DAO::executeQuery($limitQuery);
1731
1732 if ($dao->N <= 0) {
1733 break;
1734 }
1735
1736 $componentDetails = array();
1737 while ($dao->fetch()) {
1738 $row = array();
1739
1740 foreach ($sqlColumns as $column => $dontCare) {
1741 $row[$column] = $dao->$column;
1742 }
1743 $componentDetails[] = $row;
1744 }
1745 if ( $exportMode == 'financial' ) {
1746 $getExportFileName = 'CiviCRM Contribution Search';
1747 }
1748 else {
1749 $getExportFileName =self::getExportFileName( 'csv', $exportMode );
1750 }
1751 $csvRows = CRM_Core_Report_Excel::writeCSVFile( $getExportFileName,
1752 $headerRows,
1753 $componentDetails,
1754 null,
1755 $writeHeader,
1756 $saveFile );
1757
1758 if ($saveFile && !empty($csvRows)) {
1759 $batchItems .= $csvRows;
1760 }
1761
1762 $writeHeader = false;
1763 $offset += $limit;
1764 }
1765 }
1766
1767 /**
1768 * Function to manipulate header rows for relationship fields
1769 *
1770 */
1771 function manipulateHeaderRows(&$headerRows, $contactRelationshipTypes) {
1772 foreach ($headerRows as & $header) {
1773 $split = explode('-', $header);
1774 if ($relationTypeName = CRM_Utils_Array::value($split[0], $contactRelationshipTypes)) {
1775 $split[0] = $relationTypeName;
1776 $header = implode('-', $split);
1777 }
1778 }
1779 }
1780
1781 /**
1782 * Function to exclude contacts who are deceased, have "Do not mail" privacy setting,
1783 * or have no street address
1784 *
1785 */
1786 function postalMailingFormat($exportTempTable, &$headerRows, &$sqlColumns, $exportParams) {
1787 $whereClause = array();
1788
1789 if (array_key_exists('is_deceased', $sqlColumns)) {
1790 $whereClause[] = 'is_deceased = 1';
1791 }
1792
1793 if (array_key_exists('do_not_mail', $sqlColumns)) {
1794 $whereClause[] = 'do_not_mail = 1';
1795 }
1796
1797 if (array_key_exists('street_address', $sqlColumns)) {
1798 $addressWhereClause = " ( (street_address IS NULL) OR (street_address = '') ) ";
1799
1800 // check for supplemental_address_1
1801 if (array_key_exists('supplemental_address_1', $sqlColumns)) {
1802 $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
1803 'address_options', TRUE, NULL, TRUE
1804 );
1805 if (CRM_Utils_Array::value('supplemental_address_1', $addressOptions)) {
1806 $addressWhereClause .= " AND ( (supplemental_address_1 IS NULL) OR (supplemental_address_1 = '') ) ";
1807 // enclose it again, since we are doing an AND in between a set of ORs
1808 $addressWhereClause = "( $addressWhereClause )";
1809 }
1810 }
1811
1812 $whereClause[] = $addressWhereClause;
1813 }
1814
1815 if (!empty($whereClause)) {
1816 $whereClause = implode(' OR ', $whereClause);
1817 $query = "
1818 DELETE
1819 FROM $exportTempTable
1820 WHERE {$whereClause}";
1821 CRM_Core_DAO::singleValueQuery($query);
1822 }
1823
1824 // unset temporary columns that were added for postal mailing format
1825 if (!empty($exportParams['postal_mailing_export']['temp_columns'])) {
1826 $unsetKeys = array_keys($sqlColumns);
1827 foreach ($unsetKeys as $headerKey => $sqlColKey) {
1828 if (array_key_exists($sqlColKey, $exportParams['postal_mailing_export']['temp_columns'])) {
1829 unset($sqlColumns[$sqlColKey], $headerRows[$headerKey]);
1830 }
1831 }
1832 }
1833 }
1834
1835 /**
1836 * Build componentPayment fields.
1837 */
1838 static function componentPaymentFields() {
1839 static $componentPaymentFields;
1840 if (!isset( $componentPaymentFields)) {
1841 $componentPaymentFields = array(
1842 'componentPaymentField_total_amount' => ts('Total Amount'),
1843 'componentPaymentField_contribution_status' => ts('Contribution Status'),
1844 'componentPaymentField_received_date' => ts('Received Date'),
1845 'componentPaymentField_payment_instrument' => ts('Payment Instrument'),
1846 'componentPaymentField_transaction_id' => ts('Transaction ID'),
1847 );
1848 }
1849 return $componentPaymentFields;
1850 }
1851 }
1852