CRM/Export/BAO/Export.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * This class contains the functions for Component export
  36  *
  37  */
  38 class CRM_Export_BAO_Export {
  39   // increase this number a lot to avoid making too many queries
  40   // LIMIT is not much faster than a no LIMIT query
  41   // CRM-7675
  42   const EXPORT_ROW_COUNT = 100000;
  43
  44   /**
  45    * Get default return property for export based on mode
  46    *
  47    * @param int $exportMode
  48    *   Export mode.
  49    *
  50    * @return string
  51    *   Default Return property
  52    */
  53   public static function defaultReturnProperty($exportMode) {
  54     // hack to add default return property based on export mode
  55     $property = NULL;
  56     if ($exportMode == CRM_Export_Form_Select::CONTRIBUTE_EXPORT) {
  57       $property = 'contribution_id';
  58     }
  59     elseif ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
  60       $property = 'participant_id';
  61     }
  62     elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
  63       $property = 'membership_id';
  64     }
  65     elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
  66       $property = 'pledge_id';
  67     }
  68     elseif ($exportMode == CRM_Export_Form_Select::CASE_EXPORT) {
  69       $property = 'case_id';
  70     }
  71     elseif ($exportMode == CRM_Export_Form_Select::GRANT_EXPORT) {
  72       $property = 'grant_id';
  73     }
  74     elseif ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
  75       $property = 'activity_id';
  76     }
  77     return $property;
  78   }
  79
  80   /**
  81    * Get Export component
  82    *
  83    * @param int $exportMode
  84    *   Export mode.
  85    *
  86    * @return string
  87    *   CiviCRM Export Component
  88    */
  89   public static function exportComponent($exportMode) {
  90     switch ($exportMode) {
  91       case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
  92         $component = 'civicrm_contribution';
  93         break;
  94
  95       case CRM_Export_Form_Select::EVENT_EXPORT:
  96         $component = 'civicrm_participant';
  97         break;
  98
  99       case CRM_Export_Form_Select::MEMBER_EXPORT:
 100         $component = 'civicrm_membership';
 101         break;
 102
 103       case CRM_Export_Form_Select::PLEDGE_EXPORT:
 104         $component = 'civicrm_pledge';
 105         break;
 106
 107       case CRM_Export_Form_Select::GRANT_EXPORT:
 108         $component = 'civicrm_grant';
 109         break;
 110     }
 111     return $component;
 112   }
 113
 114   /**
 115    * Get Query Group By Clause
 116    * @param \CRM_Export_BAO_ExportProcessor $processor
 117    *   Export Mode
 118    * @param array $returnProperties
 119    *   Return Properties
 120    * @param object $query
 121    *   CRM_Contact_BAO_Query
 122    *
 123    * @return string
 124    *   Group By Clause
 125    */
 126   public static function getGroupBy($processor, $returnProperties, $query) {
 127     $groupBy = NULL;
 128     $exportMode = $processor->getExportMode();
 129     $queryMode = $processor->getQueryMode();
 130     if (!empty($returnProperties['tags']) || !empty($returnProperties['groups']) ||
 131       CRM_Utils_Array::value('notes', $returnProperties) ||
 132       // CRM-9552
 133       ($queryMode & CRM_Contact_BAO_Query::MODE_CONTACTS && $query->_useGroupBy)
 134     ) {
 135       $groupBy = "contact_a.id";
 136     }
 137
 138     switch ($exportMode) {
 139       case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
 140         $groupBy = 'civicrm_contribution.id';
 141         if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
 142           // especial group by  when soft credit columns are included
 143           $groupBy = ['contribution_search_scredit_combined.id', 'contribution_search_scredit_combined.scredit_id'];
 144         }
 145         break;
 146
 147       case CRM_Export_Form_Select::EVENT_EXPORT:
 148         $groupBy = 'civicrm_participant.id';
 149         break;
 150
 151       case CRM_Export_Form_Select::MEMBER_EXPORT:
 152         $groupBy = "civicrm_membership.id";
 153         break;
 154     }
 155
 156     if ($queryMode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
 157       $groupBy = "civicrm_activity.id ";
 158     }
 159
 160     return $groupBy ? ' GROUP BY ' . implode(', ', (array) $groupBy) : '';
 161   }
 162
 163   /**
 164    * Get the list the export fields.
 165    *
 166    * @param int $selectAll
 167    *   User preference while export.
 168    * @param array $ids
 169    *   Contact ids.
 170    * @param array $params
 171    *   Associated array of fields.
 172    * @param string $order
 173    *   Order by clause.
 174    * @param array $fields
 175    *   Associated array of fields.
 176    * @param array $moreReturnProperties
 177    *   Additional return fields.
 178    * @param int $exportMode
 179    *   Export mode.
 180    * @param string $componentClause
 181    *   Component clause.
 182    * @param string $componentTable
 183    *   Component table.
 184    * @param bool $mergeSameAddress
 185    *   Merge records if they have same address.
 186    * @param bool $mergeSameHousehold
 187    *   Merge records if they belong to the same household.
 188    *
 189    * @param array $exportParams
 190    * @param string $queryOperator
 191    *
 192    * @return array|null
 193    *   An array can be requested from within a unit test.
 194    *
 195    * @throws \CRM_Core_Exception
 196    */
 197   public static function exportComponents(
 198     $selectAll,
 199     $ids,
 200     $params,
 201     $order = NULL,
 202     $fields = NULL,
 203     $moreReturnProperties = NULL,
 204     $exportMode = CRM_Export_Form_Select::CONTACT_EXPORT,
 205     $componentClause = NULL,
 206     $componentTable = NULL,
 207     $mergeSameAddress = FALSE,
 208     $mergeSameHousehold = FALSE,
 209     $exportParams = [],
 210     $queryOperator = 'AND'
 211   ) {
 212
 213     $isPostalOnly = (
 214       isset($exportParams['postal_mailing_export']['postal_mailing_export']) &&
 215       $exportParams['postal_mailing_export']['postal_mailing_export'] == 1
 216     );
 217
 218     $processor = new CRM_Export_BAO_ExportProcessor($exportMode, $fields, $queryOperator, $mergeSameHousehold, $isPostalOnly);
 219     $returnProperties = [];
 220
 221     if ($fields) {
 222       foreach ($fields as $key => $value) {
 223         $fieldName = CRM_Utils_Array::value(1, $value);
 224         if (!$fieldName || $processor->isHouseholdMergeRelationshipTypeKey($fieldName)) {
 225           continue;
 226         }
 227
 228         if ($processor->isRelationshipTypeKey($fieldName) && (!empty($value[2]) || !empty($value[4]))) {
 229           $returnProperties[$fieldName] = $processor->setRelationshipReturnProperties($value, $fieldName);
 230         }
 231         elseif (is_numeric(CRM_Utils_Array::value(2, $value))) {
 232           $locationName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_Address', 'location_type_id', $value[2]);
 233           if ($fieldName == 'phone') {
 234             $returnProperties['location'][$locationName]['phone-' . CRM_Utils_Array::value(3, $value)] = 1;
 235           }
 236           elseif ($fieldName == 'im') {
 237             $returnProperties['location'][$locationName]['im-' . CRM_Utils_Array::value(3, $value)] = 1;
 238           }
 239           else {
 240             $returnProperties['location'][$locationName][$fieldName] = 1;
 241           }
 242         }
 243         else {
 244           //hack to fix component fields
 245           //revert mix of event_id and title
 246           if ($fieldName == 'event_id') {
 247             $returnProperties['event_id'] = 1;
 248           }
 249           else {
 250             $returnProperties[$fieldName] = 1;
 251           }
 252         }
 253       }
 254       $defaultExportMode = self::defaultReturnProperty($exportMode);
 255       if ($defaultExportMode) {
 256         $returnProperties[$defaultExportMode] = 1;
 257       }
 258     }
 259     else {
 260       $returnProperties = $processor->getDefaultReturnProperties();
 261     }
 262     // @todo - we are working towards this being entirely a property of the processor
 263     $processor->setReturnProperties($returnProperties);
 264     $paymentTableId = $processor->getPaymentTableID();
 265
 266     if ($mergeSameAddress) {
 267       //make sure the addressee fields are selected
 268       //while using merge same address feature
 269       $returnProperties['addressee'] = 1;
 270       $returnProperties['postal_greeting'] = 1;
 271       $returnProperties['email_greeting'] = 1;
 272       $returnProperties['street_name'] = 1;
 273       $returnProperties['household_name'] = 1;
 274       $returnProperties['street_address'] = 1;
 275       $returnProperties['city'] = 1;
 276       $returnProperties['state_province'] = 1;
 277
 278       // some columns are required for assistance incase they are not already present
 279       $exportParams['merge_same_address']['temp_columns'] = [];
 280       $tempColumns = ['id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id'];
 281       foreach ($tempColumns as $column) {
 282         if (!array_key_exists($column, $returnProperties)) {
 283           $returnProperties[$column] = 1;
 284           $column = $column == 'id' ? 'civicrm_primary_id' : $column;
 285           $exportParams['merge_same_address']['temp_columns'][$column] = 1;
 286         }
 287       }
 288     }
 289
 290     if (!$selectAll && $componentTable && !empty($exportParams['additional_group'])) {
 291       // If an Additional Group is selected, then all contacts in that group are
 292       // added to the export set (filtering out duplicates).
 293       $query = "
 294 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";
 295       CRM_Core_DAO::executeQuery($query);
 296     }
 297
 298     if ($moreReturnProperties) {
 299       // fix for CRM-7066
 300       if (!empty($moreReturnProperties['group'])) {
 301         unset($moreReturnProperties['group']);
 302         $moreReturnProperties['groups'] = 1;
 303       }
 304       $returnProperties = array_merge($returnProperties, $moreReturnProperties);
 305     }
 306
 307     $exportParams['postal_mailing_export']['temp_columns'] = [];
 308     if ($exportParams['exportOption'] == 2 &&
 309       isset($exportParams['postal_mailing_export']) &&
 310       CRM_Utils_Array::value('postal_mailing_export', $exportParams['postal_mailing_export']) == 1
 311     ) {
 312       $postalColumns = ['is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1'];
 313       foreach ($postalColumns as $column) {
 314         if (!array_key_exists($column, $returnProperties)) {
 315           $returnProperties[$column] = 1;
 316           $exportParams['postal_mailing_export']['temp_columns'][$column] = 1;
 317         }
 318       }
 319     }
 320
 321     // rectify params to what proximity search expects if there is a value for prox_distance
 322     // CRM-7021
 323     if (!empty($params)) {
 324       CRM_Contact_BAO_ProximityQuery::fixInputParams($params);
 325     }
 326
 327     list($query, $select, $from, $where, $having) = $processor->runQuery($params, $order, $returnProperties);
 328
 329     if ($mergeSameHousehold == 1) {
 330       if (empty($returnProperties['id'])) {
 331         $returnProperties['id'] = 1;
 332       }
 333
 334       $processor->setHouseholdMergeReturnProperties(array_diff_key($returnProperties, array_fill_keys(['location_type', 'im_provider'], 1)));
 335     }
 336
 337     // This perhaps only needs calling when $mergeSameHousehold == 1
 338     self::buildRelatedContactArray($selectAll, $ids, $processor, $componentTable);
 339
 340     // make sure the groups stuff is included only if specifically specified
 341     // by the fields param (CRM-1969), else we limit the contacts outputted to only
 342     // ones that are part of a group
 343     if (!empty($returnProperties['groups'])) {
 344       $oldClause = "( contact_a.id = civicrm_group_contact.contact_id )";
 345       $newClause = " ( $oldClause AND ( civicrm_group_contact.status = 'Added' OR civicrm_group_contact.status IS NULL ) )";
 346       // total hack for export, CRM-3618
 347       $from = str_replace($oldClause,
 348         $newClause,
 349         $from
 350       );
 351     }
 352
 353     if (!$selectAll && $componentTable) {
 354       $from .= " INNER JOIN $componentTable ctTable ON ctTable.contact_id = contact_a.id ";
 355     }
 356     elseif ($componentClause) {
 357       if (empty($where)) {
 358         $where = "WHERE $componentClause";
 359       }
 360       else {
 361         $where .= " AND $componentClause";
 362       }
 363     }
 364
 365     // CRM-13982 - check if is deleted
 366     $excludeTrashed = TRUE;
 367     foreach ($params as $value) {
 368       if ($value[0] == 'contact_is_deleted') {
 369         $excludeTrashed = FALSE;
 370       }
 371     }
 372     $trashClause = $excludeTrashed ? "contact_a.is_deleted != 1" : "( 1 )";
 373
 374     if (empty($where)) {
 375       $where = "WHERE $trashClause";
 376     }
 377     else {
 378       $where .= " AND $trashClause";
 379     }
 380
 381     $queryString = "$select $from $where $having";
 382
 383     $groupBy = self::getGroupBy($processor, $returnProperties, $query);
 384
 385     $queryString .= $groupBy;
 386
 387     if ($order) {
 388       // always add contact_a.id to the ORDER clause
 389       // so the order is deterministic
 390       //CRM-15301
 391       if (strpos('contact_a.id', $order) === FALSE) {
 392         $order .= ", contact_a.id";
 393       }
 394
 395       list($field, $dir) = explode(' ', $order, 2);
 396       $field = trim($field);
 397       if (!empty($returnProperties[$field])) {
 398         //CRM-15301
 399         $queryString .= " ORDER BY $order";
 400       }
 401     }
 402
 403     $addPaymentHeader = FALSE;
 404
 405     list($outputColumns, $metadata) = self::getExportStructureArrays($returnProperties, $processor);
 406
 407     if (!empty($exportParams['merge_same_address']['temp_columns'])) {
 408       // @todo - this is a temp fix  - ideally later we don't set stuff only to unset it.
 409       // test exists covering this...
 410       foreach (array_keys($exportParams['merge_same_address']['temp_columns']) as $field) {
 411         $processor->setColumnAsCalculationOnly($field);
 412       }
 413     }
 414
 415     $paymentDetails = [];
 416     if ($processor->isExportPaymentFields()) {
 417       // get payment related in for event and members
 418       $paymentDetails = CRM_Contribute_BAO_Contribution::getContributionDetails($exportMode, $ids);
 419       //get all payment headers.
 420       // If we haven't selected specific payment fields, load in all the
 421       // payment headers.
 422       if (!$processor->isExportSpecifiedPaymentFields()) {
 423         if (!empty($paymentDetails)) {
 424           $addPaymentHeader = TRUE;
 425           foreach (array_keys($processor->getPaymentHeaders()) as $paymentField) {
 426             $processor->addOutputSpecification($paymentField);
 427           }
 428         }
 429       }
 430     }
 431
 432     $componentDetails = [];
 433
 434     $rowCount = self::EXPORT_ROW_COUNT;
 435     $offset = 0;
 436     // we write to temp table often to avoid using too much memory
 437     $tempRowCount = 100;
 438
 439     $count = -1;
 440
 441     $headerRows = $processor->getHeaderRows();
 442     $sqlColumns = $processor->getSQLColumns();
 443     $exportTempTable = self::createTempTable($sqlColumns);
 444     $limitReached = FALSE;
 445
 446     while (!$limitReached) {
 447       $limitQuery = "{$queryString} LIMIT {$offset}, {$rowCount}";
 448       CRM_Core_DAO::disableFullGroupByMode();
 449       $iterationDAO = CRM_Core_DAO::executeQuery($limitQuery);
 450       CRM_Core_DAO::reenableFullGroupByMode();
 451       // If this is less than our limit by the end of the iteration we do not need to run the query again to
 452       // check if some remain.
 453       $rowsThisIteration = 0;
 454
 455       while ($iterationDAO->fetch()) {
 456         $count++;
 457         $rowsThisIteration++;
 458         $row = $processor->buildRow($query, $iterationDAO, $outputColumns, $metadata, $paymentDetails, $addPaymentHeader, $paymentTableId);
 459         if ($row === FALSE) {
 460           continue;
 461         }
 462
 463         // add component info
 464         // write the row to a file
 465         $componentDetails[] = $row;
 466
 467         // output every $tempRowCount rows
 468         if ($count % $tempRowCount == 0) {
 469           self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
 470           $componentDetails = [];
 471         }
 472       }
 473       if ($rowsThisIteration < self::EXPORT_ROW_COUNT) {
 474         $limitReached = TRUE;
 475       }
 476       $offset += $rowCount;
 477     }
 478
 479     if ($exportTempTable) {
 480       self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
 481
 482       // do merge same address and merge same household processing
 483       if ($mergeSameAddress) {
 484         self::mergeSameAddress($exportTempTable, $sqlColumns, $exportParams);
 485       }
 486
 487       // call export hook
 488       CRM_Utils_Hook::export($exportTempTable, $headerRows, $sqlColumns, $exportMode, $componentTable, $ids);
 489
 490       // In order to be able to write a unit test against this function we need to suppress
 491       // the csv writing. In future hopefully the csv writing & the main processing will be in separate functions.
 492       if (empty($exportParams['suppress_csv_for_testing'])) {
 493         self::writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $processor);
 494       }
 495       else {
 496         // return tableName sqlColumns headerRows in test context
 497         return [$exportTempTable, $sqlColumns, $headerRows, $processor];
 498       }
 499
 500       // delete the export temp table and component table
 501       $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
 502       CRM_Core_DAO::executeQuery($sql);
 503       CRM_Core_DAO::reenableFullGroupByMode();
 504       CRM_Utils_System::civiExit();
 505     }
 506     else {
 507       CRM_Core_DAO::reenableFullGroupByMode();
 508       throw new CRM_Core_Exception(ts('No records to export'));
 509     }
 510   }
 511
 512   /**
 513    * Handle import error file creation.
 514    */
 515   public static function invoke() {
 516     $type = CRM_Utils_Request::retrieve('type', 'Positive');
 517     $parserName = CRM_Utils_Request::retrieve('parser', 'String');
 518     if (empty($parserName) || empty($type)) {
 519       return;
 520     }
 521
 522     // clean and ensure parserName is a valid string
 523     $parserName = CRM_Utils_String::munge($parserName);
 524     $parserClass = explode('_', $parserName);
 525
 526     // make sure parserClass is in the CRM namespace and
 527     // at least 3 levels deep
 528     if ($parserClass[0] == 'CRM' &&
 529       count($parserClass) >= 3
 530     ) {
 531       require_once str_replace('_', DIRECTORY_SEPARATOR, $parserName) . ".php";
 532       // ensure the functions exists
 533       if (method_exists($parserName, 'errorFileName') &&
 534         method_exists($parserName, 'saveFileName')
 535       ) {
 536         $errorFileName = $parserName::errorFileName($type);
 537         $saveFileName = $parserName::saveFileName($type);
 538         if (!empty($errorFileName) && !empty($saveFileName)) {
 539           CRM_Utils_System::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
 540           CRM_Utils_System::setHttpHeader('Content-Description', 'File Transfer');
 541           CRM_Utils_System::setHttpHeader('Content-Type', 'text/csv');
 542           CRM_Utils_System::setHttpHeader('Content-Length', filesize($errorFileName));
 543           CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename=' . $saveFileName);
 544
 545           readfile($errorFileName);
 546         }
 547       }
 548     }
 549     CRM_Utils_System::civiExit();
 550   }
 551
 552   /**
 553    * @param $customSearchClass
 554    * @param $formValues
 555    * @param $order
 556    */
 557   public static function exportCustom($customSearchClass, $formValues, $order) {
 558     $ext = CRM_Extension_System::singleton()->getMapper();
 559     if (!$ext->isExtensionClass($customSearchClass)) {
 560       require_once str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php';
 561     }
 562     else {
 563       require_once $ext->classToPath($customSearchClass);
 564     }
 565     $search = new $customSearchClass($formValues);
 566
 567     $includeContactIDs = FALSE;
 568     if ($formValues['radio_ts'] == 'ts_sel') {
 569       $includeContactIDs = TRUE;
 570     }
 571
 572     $sql = $search->all(0, 0, $order, $includeContactIDs);
 573
 574     $columns = $search->columns();
 575
 576     $header = array_keys($columns);
 577     $fields = array_values($columns);
 578
 579     $rows = [];
 580     $dao = CRM_Core_DAO::executeQuery($sql);
 581     $alterRow = FALSE;
 582     if (method_exists($search, 'alterRow')) {
 583       $alterRow = TRUE;
 584     }
 585     while ($dao->fetch()) {
 586       $row = [];
 587
 588       foreach ($fields as $field) {
 589         $unqualified_field = CRM_Utils_Array::First(array_slice(explode('.', $field), -1));
 590         $row[$field] = $dao->$unqualified_field;
 591       }
 592       if ($alterRow) {
 593         $search->alterRow($row);
 594       }
 595       $rows[] = $row;
 596     }
 597
 598     CRM_Core_Report_Excel::writeCSVFile(ts('CiviCRM Contact Search'), $header, $rows);
 599     CRM_Utils_System::civiExit();
 600   }
 601
 602   /**
 603    * @param string $tableName
 604    * @param $details
 605    * @param $sqlColumns
 606    */
 607   public static function writeDetailsToTable($tableName, $details, $sqlColumns) {
 608     if (empty($details)) {
 609       return;
 610     }
 611
 612     $sql = "
 613 SELECT max(id)
 614 FROM   $tableName
 615 ";
 616
 617     $id = CRM_Core_DAO::singleValueQuery($sql);
 618     if (!$id) {
 619       $id = 0;
 620     }
 621
 622     $sqlClause = [];
 623
 624     foreach ($details as $row) {
 625       $id++;
 626       $valueString = [$id];
 627       foreach ($row as $value) {
 628         if (empty($value)) {
 629           $valueString[] = "''";
 630         }
 631         else {
 632           $valueString[] = "'" . CRM_Core_DAO::escapeString($value) . "'";
 633         }
 634       }
 635       $sqlClause[] = '(' . implode(',', $valueString) . ')';
 636     }
 637     $sqlColumns = array_merge(['id' => 1], $sqlColumns);
 638     $sqlColumnString = '(' . implode(',', array_keys($sqlColumns)) . ')';
 639
 640     $sqlValueString = implode(",\n", $sqlClause);
 641
 642     $sql = "
 643 INSERT INTO $tableName $sqlColumnString
 644 VALUES $sqlValueString
 645 ";
 646     CRM_Core_DAO::executeQuery($sql);
 647   }
 648
 649   /**
 650    * @param $sqlColumns
 651    *
 652    * @return string
 653    */
 654   public static function createTempTable($sqlColumns) {
 655     //creating a temporary table for the search result that need be exported
 656     $exportTempTable = CRM_Utils_SQL_TempTable::build()->setDurable()->setCategory('export');
 657
 658     // also create the sql table
 659     $exportTempTable->drop();
 660
 661     $sql = " id int unsigned NOT NULL AUTO_INCREMENT, ";
 662     if (!empty($sqlColumns)) {
 663       $sql .= implode(",\n", array_values($sqlColumns)) . ',';
 664     }
 665
 666     $sql .= "\n PRIMARY KEY ( id )";
 667
 668     // add indexes for street_address and household_name if present
 669     $addIndices = [
 670       'street_address',
 671       'household_name',
 672       'civicrm_primary_id',
 673     ];
 674
 675     foreach ($addIndices as $index) {
 676       if (isset($sqlColumns[$index])) {
 677         $sql .= ",
 678   INDEX index_{$index}( $index )
 679 ";
 680       }
 681     }
 682
 683     $exportTempTable->createWithColumns($sql);
 684     return $exportTempTable->getName();
 685   }
 686
 687   /**
 688    * @param string $tableName
 689    * @param $sqlColumns
 690    * @param array $exportParams
 691    */
 692   public static function mergeSameAddress($tableName, &$sqlColumns, $exportParams) {
 693     // check if any records are present based on if they have used shared address feature,
 694     // and not based on if city / state .. matches.
 695     $sql = "
 696 SELECT    r1.id                 as copy_id,
 697           r1.civicrm_primary_id as copy_contact_id,
 698           r1.addressee          as copy_addressee,
 699           r1.addressee_id       as copy_addressee_id,
 700           r1.postal_greeting    as copy_postal_greeting,
 701           r1.postal_greeting_id as copy_postal_greeting_id,
 702           r2.id                 as master_id,
 703           r2.civicrm_primary_id as master_contact_id,
 704           r2.postal_greeting    as master_postal_greeting,
 705           r2.postal_greeting_id as master_postal_greeting_id,
 706           r2.addressee          as master_addressee,
 707           r2.addressee_id       as master_addressee_id
 708 FROM      $tableName r1
 709 INNER JOIN civicrm_address adr ON r1.master_id   = adr.id
 710 INNER JOIN $tableName      r2  ON adr.contact_id = r2.civicrm_primary_id
 711 ORDER BY  r1.id";
 712     $linkedMerge = self::_buildMasterCopyArray($sql, $exportParams, TRUE);
 713
 714     // find all the records that have the same street address BUT not in a household
 715     // require match on city and state as well
 716     $sql = "
 717 SELECT    r1.id                 as master_id,
 718           r1.civicrm_primary_id as master_contact_id,
 719           r1.postal_greeting    as master_postal_greeting,
 720           r1.postal_greeting_id as master_postal_greeting_id,
 721           r1.addressee          as master_addressee,
 722           r1.addressee_id       as master_addressee_id,
 723           r2.id                 as copy_id,
 724           r2.civicrm_primary_id as copy_contact_id,
 725           r2.postal_greeting    as copy_postal_greeting,
 726           r2.postal_greeting_id as copy_postal_greeting_id,
 727           r2.addressee          as copy_addressee,
 728           r2.addressee_id       as copy_addressee_id
 729 FROM      $tableName r1
 730 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
 731                r1.city = r2.city AND
 732                r1.state_province_id = r2.state_province_id )
 733 WHERE     ( r1.household_name IS NULL OR r1.household_name = '' )
 734 AND       ( r2.household_name IS NULL OR r2.household_name = '' )
 735 AND       ( r1.street_address != '' )
 736 AND       r2.id > r1.id
 737 ORDER BY  r1.id
 738 ";
 739     $merge = self::_buildMasterCopyArray($sql, $exportParams);
 740
 741     // unset ids from $merge already present in $linkedMerge
 742     foreach ($linkedMerge as $masterID => $values) {
 743       $keys = [$masterID];
 744       $keys = array_merge($keys, array_keys($values['copy']));
 745       foreach ($merge as $mid => $vals) {
 746         if (in_array($mid, $keys)) {
 747           unset($merge[$mid]);
 748         }
 749         else {
 750           foreach ($values['copy'] as $copyId) {
 751             if (in_array($copyId, $keys)) {
 752               unset($merge[$mid]['copy'][$copyId]);
 753             }
 754           }
 755         }
 756       }
 757     }
 758     $merge = $merge + $linkedMerge;
 759
 760     foreach ($merge as $masterID => $values) {
 761       $sql = "
 762 UPDATE $tableName
 763 SET    addressee = %1, postal_greeting = %2, email_greeting = %3
 764 WHERE  id = %4
 765 ";
 766       $params = [
 767         1 => [$values['addressee'], 'String'],
 768         2 => [$values['postalGreeting'], 'String'],
 769         3 => [$values['emailGreeting'], 'String'],
 770         4 => [$masterID, 'Integer'],
 771       ];
 772       CRM_Core_DAO::executeQuery($sql, $params);
 773
 774       // delete all copies
 775       $deleteIDs = array_keys($values['copy']);
 776       $deleteIDString = implode(',', $deleteIDs);
 777       $sql = "
 778 DELETE FROM $tableName
 779 WHERE  id IN ( $deleteIDString )
 780 ";
 781       CRM_Core_DAO::executeQuery($sql);
 782     }
 783
 784     // unset temporary columns that were added for postal mailing format
 785     // @todo - this part is pretty close to ready to be removed....
 786     if (!empty($exportParams['merge_same_address']['temp_columns'])) {
 787       $unsetKeys = array_keys($sqlColumns);
 788       foreach ($unsetKeys as $headerKey => $sqlColKey) {
 789         if (array_key_exists($sqlColKey, $exportParams['merge_same_address']['temp_columns'])) {
 790           unset($sqlColumns[$sqlColKey]);
 791         }
 792       }
 793     }
 794   }
 795
 796   /**
 797    * @param int $contactId
 798    * @param array $exportParams
 799    *
 800    * @return array
 801    */
 802   public static function _replaceMergeTokens($contactId, $exportParams) {
 803     $greetings = [];
 804     $contact = NULL;
 805
 806     $greetingFields = [
 807       'postal_greeting',
 808       'addressee',
 809     ];
 810     foreach ($greetingFields as $greeting) {
 811       if (!empty($exportParams[$greeting])) {
 812         $greetingLabel = $exportParams[$greeting];
 813         if (empty($contact)) {
 814           $values = [
 815             'id' => $contactId,
 816             'version' => 3,
 817           ];
 818           $contact = civicrm_api('contact', 'get', $values);
 819
 820           if (!empty($contact['is_error'])) {
 821             return $greetings;
 822           }
 823           $contact = $contact['values'][$contact['id']];
 824         }
 825
 826         $tokens = ['contact' => $greetingLabel];
 827         $greetings[$greeting] = CRM_Utils_Token::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
 828       }
 829     }
 830     return $greetings;
 831   }
 832
 833   /**
 834    * The function unsets static part of the string, if token is the dynamic part.
 835    *
 836    * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
 837    * i.e 'Hello Alan' => converted to => 'Alan'
 838    *
 839    * @param string $parsedString
 840    * @param string $defaultGreeting
 841    * @param bool $addressMergeGreetings
 842    * @param string $greetingType
 843    *
 844    * @return mixed
 845    */
 846   public static function _trimNonTokens(
 847     &$parsedString, $defaultGreeting,
 848     $addressMergeGreetings, $greetingType = 'postal_greeting'
 849   ) {
 850     if (!empty($addressMergeGreetings[$greetingType])) {
 851       $greetingLabel = $addressMergeGreetings[$greetingType];
 852     }
 853     $greetingLabel = empty($greetingLabel) ? $defaultGreeting : $greetingLabel;
 854
 855     $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
 856     $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
 857     foreach ($stringsToBeReplaced as $key => $string) {
 858       // to keep one space
 859       $stringsToBeReplaced[$key] = ltrim($string);
 860     }
 861     $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
 862
 863     return $parsedString;
 864   }
 865
 866   /**
 867    * @param $sql
 868    * @param array $exportParams
 869    * @param bool $sharedAddress
 870    *
 871    * @return array
 872    */
 873   public static function _buildMasterCopyArray($sql, $exportParams, $sharedAddress = FALSE) {
 874     static $contactGreetingTokens = [];
 875
 876     $addresseeOptions = CRM_Core_OptionGroup::values('addressee');
 877     $postalOptions = CRM_Core_OptionGroup::values('postal_greeting');
 878
 879     $merge = $parents = [];
 880     $dao = CRM_Core_DAO::executeQuery($sql);
 881
 882     while ($dao->fetch()) {
 883       $masterID = $dao->master_id;
 884       $copyID = $dao->copy_id;
 885       $masterPostalGreeting = $dao->master_postal_greeting;
 886       $masterAddressee = $dao->master_addressee;
 887       $copyAddressee = $dao->copy_addressee;
 888
 889       if (!$sharedAddress) {
 890         if (!isset($contactGreetingTokens[$dao->master_contact_id])) {
 891           $contactGreetingTokens[$dao->master_contact_id] = self::_replaceMergeTokens($dao->master_contact_id, $exportParams);
 892         }
 893         $masterPostalGreeting = CRM_Utils_Array::value('postal_greeting',
 894           $contactGreetingTokens[$dao->master_contact_id], $dao->master_postal_greeting
 895         );
 896         $masterAddressee = CRM_Utils_Array::value('addressee',
 897           $contactGreetingTokens[$dao->master_contact_id], $dao->master_addressee
 898         );
 899
 900         if (!isset($contactGreetingTokens[$dao->copy_contact_id])) {
 901           $contactGreetingTokens[$dao->copy_contact_id] = self::_replaceMergeTokens($dao->copy_contact_id, $exportParams);
 902         }
 903         $copyPostalGreeting = CRM_Utils_Array::value('postal_greeting',
 904           $contactGreetingTokens[$dao->copy_contact_id], $dao->copy_postal_greeting
 905         );
 906         $copyAddressee = CRM_Utils_Array::value('addressee',
 907           $contactGreetingTokens[$dao->copy_contact_id], $dao->copy_addressee
 908         );
 909       }
 910
 911       if (!isset($merge[$masterID])) {
 912         // check if this is an intermediate child
 913         // this happens if there are 3 or more matches a,b, c
 914         // the above query will return a, b / a, c / b, c
 915         // we might be doing a bit more work, but for now its ok, unless someone
 916         // knows how to fix the query above
 917         if (isset($parents[$masterID])) {
 918           $masterID = $parents[$masterID];
 919         }
 920         else {
 921           $merge[$masterID] = [
 922             'addressee' => $masterAddressee,
 923             'copy' => [],
 924             'postalGreeting' => $masterPostalGreeting,
 925           ];
 926           $merge[$masterID]['emailGreeting'] = &$merge[$masterID]['postalGreeting'];
 927         }
 928       }
 929       $parents[$copyID] = $masterID;
 930
 931       if (!$sharedAddress && !array_key_exists($copyID, $merge[$masterID]['copy'])) {
 932
 933         if (!empty($exportParams['postal_greeting_other']) &&
 934           count($merge[$masterID]['copy']) >= 1
 935         ) {
 936           // use static greetings specified if no of contacts > 2
 937           $merge[$masterID]['postalGreeting'] = $exportParams['postal_greeting_other'];
 938         }
 939         elseif ($copyPostalGreeting) {
 940           self::_trimNonTokens($copyPostalGreeting,
 941             $postalOptions[$dao->copy_postal_greeting_id],
 942             $exportParams
 943           );
 944           $merge[$masterID]['postalGreeting'] = "{$merge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
 945           // if there happens to be a duplicate, remove it
 946           $merge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $merge[$masterID]['postalGreeting']);
 947         }
 948
 949         if (!empty($exportParams['addressee_other']) &&
 950           count($merge[$masterID]['copy']) >= 1
 951         ) {
 952           // use static greetings specified if no of contacts > 2
 953           $merge[$masterID]['addressee'] = $exportParams['addressee_other'];
 954         }
 955         elseif ($copyAddressee) {
 956           self::_trimNonTokens($copyAddressee,
 957             $addresseeOptions[$dao->copy_addressee_id],
 958             $exportParams, 'addressee'
 959           );
 960           $merge[$masterID]['addressee'] = "{$merge[$masterID]['addressee']}, " . trim($copyAddressee);
 961         }
 962       }
 963       $merge[$masterID]['copy'][$copyID] = $copyAddressee;
 964     }
 965
 966     return $merge;
 967   }
 968
 969   /**
 970    * @param $exportTempTable
 971    * @param $headerRows
 972    * @param $sqlColumns
 973    * @param \CRM_Export_BAO_ExportProcessor $processor
 974    */
 975   public static function writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $processor) {
 976     $exportMode = $processor->getExportMode();
 977     $writeHeader = TRUE;
 978     $offset = 0;
 979     $limit = self::EXPORT_ROW_COUNT;
 980
 981     $query = "SELECT * FROM $exportTempTable";
 982
 983     while (1) {
 984       $limitQuery = $query . "
 985 LIMIT $offset, $limit
 986 ";
 987       $dao = CRM_Core_DAO::executeQuery($limitQuery);
 988
 989       if ($dao->N <= 0) {
 990         break;
 991       }
 992
 993       $componentDetails = [];
 994       while ($dao->fetch()) {
 995         $row = [];
 996
 997         foreach ($sqlColumns as $column => $dontCare) {
 998           $row[$column] = $dao->$column;
 999         }
1000         $componentDetails[] = $row;
1001       }
1002       CRM_Core_Report_Excel::writeCSVFile($processor->getExportFileName(),
1003         $headerRows,
1004         $componentDetails,
1005         NULL,
1006         $writeHeader
1007       );
1008
1009       $writeHeader = FALSE;
1010       $offset += $limit;
1011     }
1012   }
1013
1014   /**
1015    * Build componentPayment fields.
1016    *
1017    * This is no longer used by export but BAO_Mapping still calls it & we
1018    * should find a generic way to handle this or move this to that class.
1019    *
1020    * @deprecated
1021    */
1022   public static function componentPaymentFields() {
1023     static $componentPaymentFields;
1024     if (!isset($componentPaymentFields)) {
1025       $componentPaymentFields = [
1026         'componentPaymentField_total_amount' => ts('Total Amount'),
1027         'componentPaymentField_contribution_status' => ts('Contribution Status'),
1028         'componentPaymentField_received_date' => ts('Date Received'),
1029         'componentPaymentField_payment_instrument' => ts('Payment Method'),
1030         'componentPaymentField_transaction_id' => ts('Transaction ID'),
1031       ];
1032     }
1033     return $componentPaymentFields;
1034   }
1035
1036   /**
1037    * Get the various arrays that we use to structure our output.
1038    *
1039    * The extraction of these has been moved to a separate function for clarity and so that
1040    * tests can be added - in particular on the $outputHeaders array.
1041    *
1042    * However it still feels a bit like something that I'm too polite to write down and this should be seen
1043    * as a step on the refactoring path rather than how it should be.
1044    *
1045    * @param array $returnProperties
1046    * @param \CRM_Export_BAO_ExportProcessor $processor
1047    *
1048    * @return array
1049    *   - outputColumns Array of columns to be exported. The values don't matter but the key must match the
1050    *   alias for the field generated by BAO_Query object.
1051    *   - headerRows Array of the column header strings to put in the csv header - non-associative.
1052    *   - sqlColumns Array of column names for the temp table. Not too sure why outputColumns can't be used here.
1053    *   - metadata Array of fields with specific parameters to pass to the translate function or another hacky nasty solution
1054    *    I'm too embarassed to discuss here.
1055    *    The keys need
1056    *    - to match the outputColumns keys (yes, the fact we ignore the output columns values & then pass another array with values
1057    *    we could use does suggest further refactors. However, you future improver, do remember that every check you do
1058    *    in the main DAO loop is done once per row & that coule be 100,000 times.)
1059    *    Finally a pop quiz: We need the translate context because we use a function other than ts() - is this because
1060    *    - a) the function used is more efficient or
1061    *    - b) this code is old & outdated. Submit your answers to circular bin or better
1062    *       yet find a way to comment them for posterity.
1063    */
1064   public static function getExportStructureArrays($returnProperties, $processor) {
1065     $outputColumns = $metadata = [];
1066     $queryFields = $processor->getQueryFields();
1067     foreach ($returnProperties as $key => $value) {
1068       if (($key != 'location' || !is_array($value)) && !$processor->isRelationshipTypeKey($key)) {
1069         $outputColumns[$key] = $value;
1070         $processor->addOutputSpecification($key);
1071       }
1072       elseif ($processor->isRelationshipTypeKey($key)) {
1073         $outputColumns[$key] = $value;
1074         foreach ($value as $relationField => $relationValue) {
1075           // below block is same as primary block (duplicate)
1076           if (isset($queryFields[$relationField]['title'])) {
1077             $processor->addOutputSpecification($relationField, $key);
1078           }
1079           elseif (is_array($relationValue) && $relationField == 'location') {
1080             // fix header for location type case
1081             foreach ($relationValue as $ltype => $val) {
1082               foreach (array_keys($val) as $fld) {
1083                 $type = explode('-', $fld);
1084                 $processor->addOutputSpecification($type[0], $key, $ltype, CRM_Utils_Array::value(1, $type));
1085               }
1086             }
1087           }
1088         }
1089       }
1090       else {
1091         foreach ($value as $locationType => $locationFields) {
1092           foreach (array_keys($locationFields) as $locationFieldName) {
1093             $type = explode('-', $locationFieldName);
1094
1095             $actualDBFieldName = $type[0];
1096             $daoFieldName = CRM_Utils_String::munge($locationType) . '-' . $actualDBFieldName;
1097
1098             if (!empty($type[1])) {
1099               $daoFieldName .= "-" . $type[1];
1100             }
1101             $processor->addOutputSpecification($actualDBFieldName, NULL, $locationType, CRM_Utils_Array::value(1, $type));
1102             $metadata[$daoFieldName] = $processor->getMetaDataForField($actualDBFieldName);
1103             $outputColumns[$daoFieldName] = TRUE;
1104           }
1105         }
1106       }
1107     }
1108     return [$outputColumns, $metadata];
1109   }
1110
1111   /**
1112    * Get the values of linked household contact.
1113    *
1114    * @param CRM_Core_DAO $relDAO
1115    * @param array $value
1116    * @param string $field
1117    * @param array $row
1118    */
1119   private static function fetchRelationshipDetails($relDAO, $value, $field, &$row) {
1120     $phoneTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
1121     $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
1122     $i18n = CRM_Core_I18n::singleton();
1123     $field = $field . '_';
1124
1125     foreach ($value as $relationField => $relationValue) {
1126       if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
1127         $fieldValue = $relDAO->$relationField;
1128         if ($relationField == 'phone_type_id') {
1129           $fieldValue = $phoneTypes[$relationValue];
1130         }
1131         elseif ($relationField == 'provider_id') {
1132           $fieldValue = CRM_Utils_Array::value($relationValue, $imProviders);
1133         }
1134         // CRM-13995
1135         elseif (is_object($relDAO) && in_array($relationField, [
1136           'email_greeting',
1137           'postal_greeting',
1138           'addressee',
1139         ])) {
1140           //special case for greeting replacement
1141           $fldValue = "{$relationField}_display";
1142           $fieldValue = $relDAO->$fldValue;
1143         }
1144       }
1145       elseif (is_object($relDAO) && $relationField == 'state_province') {
1146         $fieldValue = CRM_Core_PseudoConstant::stateProvince($relDAO->state_province_id);
1147       }
1148       elseif (is_object($relDAO) && $relationField == 'country') {
1149         $fieldValue = CRM_Core_PseudoConstant::country($relDAO->country_id);
1150       }
1151       else {
1152         $fieldValue = '';
1153       }
1154       $relPrefix = $field . $relationField;
1155
1156       if (is_object($relDAO) && $relationField == 'id') {
1157         $row[$relPrefix] = $relDAO->contact_id;
1158       }
1159       elseif (is_array($relationValue) && $relationField == 'location') {
1160         foreach ($relationValue as $ltype => $val) {
1161           // If the location name has a space in it the we need to handle that. This
1162           // is kinda hacky but specifically covered in the ExportTest so later efforts to
1163           // improve it should be secure in the knowled it will be caught.
1164           $ltype = str_replace(' ', '_', $ltype);
1165           foreach (array_keys($val) as $fld) {
1166             $type = explode('-', $fld);
1167             $fldValue = "{$ltype}-" . $type[0];
1168             if (!empty($type[1])) {
1169               $fldValue .= "-" . $type[1];
1170             }
1171             // CRM-3157: localise country, region (both have ‘country’ context)
1172             // and state_province (‘province’ context)
1173             switch (TRUE) {
1174               case (!is_object($relDAO)):
1175                 $row[$field . '_' . $fldValue] = '';
1176                 break;
1177
1178               case in_array('country', $type):
1179               case in_array('world_region', $type):
1180                 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
1181                   ['context' => 'country']
1182                 );
1183                 break;
1184
1185               case in_array('state_province', $type):
1186                 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
1187                   ['context' => 'province']
1188                 );
1189                 break;
1190
1191               default:
1192                 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
1193                 break;
1194             }
1195           }
1196         }
1197       }
1198       elseif (isset($fieldValue) && $fieldValue != '') {
1199         //check for custom data
1200         if ($cfID = CRM_Core_BAO_CustomField::getKeyID($relationField)) {
1201           $row[$relPrefix] = CRM_Core_BAO_CustomField::displayValue($fieldValue, $cfID);
1202         }
1203         else {
1204           //normal relationship fields
1205           // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
1206           switch ($relationField) {
1207             case 'country':
1208             case 'world_region':
1209               $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'country']);
1210               break;
1211
1212             case 'state_province':
1213               $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'province']);
1214               break;
1215
1216             default:
1217               $row[$relPrefix] = $fieldValue;
1218               break;
1219           }
1220         }
1221       }
1222       else {
1223         // if relation field is empty or null
1224         $row[$relPrefix] = '';
1225       }
1226     }
1227   }
1228
1229   /**
1230    * Get the ids that we want to get related contact details for.
1231    *
1232    * @param array $ids
1233    * @param int $exportMode
1234    *
1235    * @return array
1236    */
1237   protected static function getIDsForRelatedContact($ids, $exportMode) {
1238     if ($exportMode == CRM_Export_Form_Select::CONTACT_EXPORT) {
1239       return $ids;
1240     }
1241     if ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
1242       $relIDs = [];
1243       $sourceID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
1244       $dao = CRM_Core_DAO::executeQuery("
1245             SELECT contact_id FROM civicrm_activity_contact
1246             WHERE activity_id IN ( " . implode(',', $ids) . ") AND
1247             record_type_id = {$sourceID}
1248           ");
1249
1250       while ($dao->fetch()) {
1251         $relIDs[] = $dao->contact_id;
1252       }
1253       return $relIDs;
1254     }
1255     $component = self::exportComponent($exportMode);
1256
1257     if ($exportMode == CRM_Export_Form_Select::CASE_EXPORT) {
1258       return CRM_Case_BAO_Case::retrieveContactIdsByCaseId($ids);
1259     }
1260     else {
1261       return CRM_Core_DAO::getContactIDsFromComponent($ids, $component);
1262     }
1263   }
1264
1265   /**
1266    * @param $selectAll
1267    * @param $ids
1268    * @param \CRM_Export_BAO_ExportProcessor $processor
1269    * @param $componentTable
1270    */
1271   protected static function buildRelatedContactArray($selectAll, $ids, $processor, $componentTable) {
1272     $allRelContactArray = $relationQuery = [];
1273     $queryMode = $processor->getQueryMode();
1274     $exportMode = $processor->getExportMode();
1275
1276     foreach ($processor->getRelationshipReturnProperties() as $relationshipKey => $relationReturnProperties) {
1277       $allRelContactArray[$relationshipKey] = [];
1278       // build Query for each relationship
1279       $relationQuery = new CRM_Contact_BAO_Query(NULL, $relationReturnProperties,
1280         NULL, FALSE, FALSE, $queryMode
1281       );
1282       list($relationSelect, $relationFrom, $relationWhere, $relationHaving) = $relationQuery->query();
1283
1284       list($id, $direction) = explode('_', $relationshipKey, 2);
1285       // identify the relationship direction
1286       $contactA = 'contact_id_a';
1287       $contactB = 'contact_id_b';
1288       if ($direction == 'b_a') {
1289         $contactA = 'contact_id_b';
1290         $contactB = 'contact_id_a';
1291       }
1292       $relIDs = self::getIDsForRelatedContact($ids, $exportMode);
1293
1294       $relationshipJoin = $relationshipClause = '';
1295       if (!$selectAll && $componentTable) {
1296         $relationshipJoin = " INNER JOIN {$componentTable} ctTable ON ctTable.contact_id = {$contactA}";
1297       }
1298       elseif (!empty($relIDs)) {
1299         $relID = implode(',', $relIDs);
1300         $relationshipClause = " AND crel.{$contactA} IN ( {$relID} )";
1301       }
1302
1303       $relationFrom = " {$relationFrom}
1304               INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_a.id AND crel.relationship_type_id = {$id}
1305               {$relationshipJoin} ";
1306
1307       //check for active relationship status only
1308       $today = date('Ymd');
1309       $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
1310       $relationWhere = " WHERE contact_a.is_deleted = 0 {$relationshipClause} {$relationActive}";
1311       CRM_Core_DAO::disableFullGroupByMode();
1312       $relationSelect = "{$relationSelect}, {$contactA} as refContact ";
1313       $relationQueryString = "$relationSelect $relationFrom $relationWhere $relationHaving GROUP BY crel.{$contactA}";
1314
1315       $allRelContactDAO = CRM_Core_DAO::executeQuery($relationQueryString);
1316       CRM_Core_DAO::reenableFullGroupByMode();
1317
1318       while ($allRelContactDAO->fetch()) {
1319         $relationQuery->convertToPseudoNames($allRelContactDAO);
1320         $row = [];
1321         // @todo pass processor to fetchRelationshipDetails and set fields directly within it.
1322         self::fetchRelationshipDetails($allRelContactDAO, $relationReturnProperties, $relationshipKey, $row);
1323         foreach (array_keys($relationReturnProperties) as $property) {
1324           if ($property === 'location') {
1325             // @todo - simplify location in self::fetchRelationshipDetails - remove handling here. Or just call
1326             // $processor->setRelationshipValue from fetchRelationshipDetails
1327             foreach ($relationReturnProperties['location'] as $locationName => $locationValues) {
1328               foreach (array_keys($locationValues) as $locationValue) {
1329                 $key = str_replace(' ', '_', $locationName) . '-' . $locationValue;
1330                 $processor->setRelationshipValue($relationshipKey, $allRelContactDAO->refContact, $key, $row[$relationshipKey . '__' . $key]);
1331               }
1332             }
1333           }
1334           else {
1335             $processor->setRelationshipValue($relationshipKey, $allRelContactDAO->refContact, $property, $row[$relationshipKey . '_' . $property]);
1336           }
1337         }
1338       }
1339     }
1340   }
1341
1342 }