CRM/Export/BAO/Export.php

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