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     $whereClauses = ['trash_clause' => "contact_a.is_deleted != 1"];
 354     if (!$selectAll && $componentTable) {
 355       $from .= " INNER JOIN $componentTable ctTable ON ctTable.contact_id = contact_a.id ";
 356     }
 357     elseif ($componentClause) {
 358       $whereClauses[] = $componentClause;
 359     }
 360
 361     // CRM-13982 - check if is deleted
 362     foreach ($params as $value) {
 363       if ($value[0] == 'contact_is_deleted') {
 364         unset($whereClauses['trash_clause']);
 365       }
 366     }
 367
 368     if (empty($where)) {
 369       $where = "WHERE " . implode(' AND ', $whereClauses);
 370     }
 371     else {
 372       $where .= " AND " . implode(' AND ', $whereClauses);
 373     }
 374
 375     $queryString = "$select $from $where $having";
 376
 377     $groupBy = self::getGroupBy($processor, $returnProperties, $query);
 378
 379     $queryString .= $groupBy;
 380
 381     if ($order) {
 382       // always add contact_a.id to the ORDER clause
 383       // so the order is deterministic
 384       //CRM-15301
 385       if (strpos('contact_a.id', $order) === FALSE) {
 386         $order .= ", contact_a.id";
 387       }
 388
 389       list($field, $dir) = explode(' ', $order, 2);
 390       $field = trim($field);
 391       if (!empty($returnProperties[$field])) {
 392         //CRM-15301
 393         $queryString .= " ORDER BY $order";
 394       }
 395     }
 396
 397     $addPaymentHeader = FALSE;
 398
 399     list($outputColumns, $metadata) = self::getExportStructureArrays($returnProperties, $processor);
 400
 401     if (!empty($exportParams['merge_same_address']['temp_columns'])) {
 402       // @todo - this is a temp fix  - ideally later we don't set stuff only to unset it.
 403       // test exists covering this...
 404       foreach (array_keys($exportParams['merge_same_address']['temp_columns']) as $field) {
 405         $processor->setColumnAsCalculationOnly($field);
 406       }
 407     }
 408
 409     $paymentDetails = [];
 410     if ($processor->isExportPaymentFields()) {
 411       // get payment related in for event and members
 412       $paymentDetails = CRM_Contribute_BAO_Contribution::getContributionDetails($exportMode, $ids);
 413       //get all payment headers.
 414       // If we haven't selected specific payment fields, load in all the
 415       // payment headers.
 416       if (!$processor->isExportSpecifiedPaymentFields()) {
 417         if (!empty($paymentDetails)) {
 418           $addPaymentHeader = TRUE;
 419           foreach (array_keys($processor->getPaymentHeaders()) as $paymentField) {
 420             $processor->addOutputSpecification($paymentField);
 421           }
 422         }
 423       }
 424     }
 425
 426     $componentDetails = [];
 427
 428     $rowCount = self::EXPORT_ROW_COUNT;
 429     $offset = 0;
 430     // we write to temp table often to avoid using too much memory
 431     $tempRowCount = 100;
 432
 433     $count = -1;
 434
 435     $headerRows = $processor->getHeaderRows();
 436     $sqlColumns = $processor->getSQLColumns();
 437     $exportTempTable = self::createTempTable($sqlColumns);
 438     $limitReached = FALSE;
 439
 440     while (!$limitReached) {
 441       $limitQuery = "{$queryString} LIMIT {$offset}, {$rowCount}";
 442       CRM_Core_DAO::disableFullGroupByMode();
 443       $iterationDAO = CRM_Core_DAO::executeQuery($limitQuery);
 444       CRM_Core_DAO::reenableFullGroupByMode();
 445       // If this is less than our limit by the end of the iteration we do not need to run the query again to
 446       // check if some remain.
 447       $rowsThisIteration = 0;
 448
 449       while ($iterationDAO->fetch()) {
 450         $count++;
 451         $rowsThisIteration++;
 452         $row = $processor->buildRow($query, $iterationDAO, $outputColumns, $metadata, $paymentDetails, $addPaymentHeader, $paymentTableId);
 453         if ($row === FALSE) {
 454           continue;
 455         }
 456
 457         // add component info
 458         // write the row to a file
 459         $componentDetails[] = $row;
 460
 461         // output every $tempRowCount rows
 462         if ($count % $tempRowCount == 0) {
 463           self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
 464           $componentDetails = [];
 465         }
 466       }
 467       if ($rowsThisIteration < self::EXPORT_ROW_COUNT) {
 468         $limitReached = TRUE;
 469       }
 470       $offset += $rowCount;
 471     }
 472
 473     if ($exportTempTable) {
 474       self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
 475
 476       // do merge same address and merge same household processing
 477       if ($mergeSameAddress) {
 478         self::mergeSameAddress($exportTempTable, $sqlColumns, $exportParams);
 479       }
 480
 481       // call export hook
 482       CRM_Utils_Hook::export($exportTempTable, $headerRows, $sqlColumns, $exportMode, $componentTable, $ids);
 483
 484       // In order to be able to write a unit test against this function we need to suppress
 485       // the csv writing. In future hopefully the csv writing & the main processing will be in separate functions.
 486       if (empty($exportParams['suppress_csv_for_testing'])) {
 487         self::writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $processor);
 488       }
 489       else {
 490         // return tableName sqlColumns headerRows in test context
 491         return [$exportTempTable, $sqlColumns, $headerRows, $processor];
 492       }
 493
 494       // delete the export temp table and component table
 495       $sql = "DROP TABLE IF EXISTS {$exportTempTable}";
 496       CRM_Core_DAO::executeQuery($sql);
 497       CRM_Core_DAO::reenableFullGroupByMode();
 498       CRM_Utils_System::civiExit();
 499     }
 500     else {
 501       CRM_Core_DAO::reenableFullGroupByMode();
 502       throw new CRM_Core_Exception(ts('No records to export'));
 503     }
 504   }
 505
 506   /**
 507    * Handle import error file creation.
 508    */
 509   public static function invoke() {
 510     $type = CRM_Utils_Request::retrieve('type', 'Positive');
 511     $parserName = CRM_Utils_Request::retrieve('parser', 'String');
 512     if (empty($parserName) || empty($type)) {
 513       return;
 514     }
 515
 516     // clean and ensure parserName is a valid string
 517     $parserName = CRM_Utils_String::munge($parserName);
 518     $parserClass = explode('_', $parserName);
 519
 520     // make sure parserClass is in the CRM namespace and
 521     // at least 3 levels deep
 522     if ($parserClass[0] == 'CRM' &&
 523       count($parserClass) >= 3
 524     ) {
 525       require_once str_replace('_', DIRECTORY_SEPARATOR, $parserName) . ".php";
 526       // ensure the functions exists
 527       if (method_exists($parserName, 'errorFileName') &&
 528         method_exists($parserName, 'saveFileName')
 529       ) {
 530         $errorFileName = $parserName::errorFileName($type);
 531         $saveFileName = $parserName::saveFileName($type);
 532         if (!empty($errorFileName) && !empty($saveFileName)) {
 533           CRM_Utils_System::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
 534           CRM_Utils_System::setHttpHeader('Content-Description', 'File Transfer');
 535           CRM_Utils_System::setHttpHeader('Content-Type', 'text/csv');
 536           CRM_Utils_System::setHttpHeader('Content-Length', filesize($errorFileName));
 537           CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename=' . $saveFileName);
 538
 539           readfile($errorFileName);
 540         }
 541       }
 542     }
 543     CRM_Utils_System::civiExit();
 544   }
 545
 546   /**
 547    * @param $customSearchClass
 548    * @param $formValues
 549    * @param $order
 550    */
 551   public static function exportCustom($customSearchClass, $formValues, $order) {
 552     $ext = CRM_Extension_System::singleton()->getMapper();
 553     if (!$ext->isExtensionClass($customSearchClass)) {
 554       require_once str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php';
 555     }
 556     else {
 557       require_once $ext->classToPath($customSearchClass);
 558     }
 559     $search = new $customSearchClass($formValues);
 560
 561     $includeContactIDs = FALSE;
 562     if ($formValues['radio_ts'] == 'ts_sel') {
 563       $includeContactIDs = TRUE;
 564     }
 565
 566     $sql = $search->all(0, 0, $order, $includeContactIDs);
 567
 568     $columns = $search->columns();
 569
 570     $header = array_keys($columns);
 571     $fields = array_values($columns);
 572
 573     $rows = [];
 574     $dao = CRM_Core_DAO::executeQuery($sql);
 575     $alterRow = FALSE;
 576     if (method_exists($search, 'alterRow')) {
 577       $alterRow = TRUE;
 578     }
 579     while ($dao->fetch()) {
 580       $row = [];
 581
 582       foreach ($fields as $field) {
 583         $unqualified_field = CRM_Utils_Array::First(array_slice(explode('.', $field), -1));
 584         $row[$field] = $dao->$unqualified_field;
 585       }
 586       if ($alterRow) {
 587         $search->alterRow($row);
 588       }
 589       $rows[] = $row;
 590     }
 591
 592     CRM_Core_Report_Excel::writeCSVFile(ts('CiviCRM Contact Search'), $header, $rows);
 593     CRM_Utils_System::civiExit();
 594   }
 595
 596   /**
 597    * @param string $tableName
 598    * @param $details
 599    * @param $sqlColumns
 600    */
 601   public static function writeDetailsToTable($tableName, $details, $sqlColumns) {
 602     if (empty($details)) {
 603       return;
 604     }
 605
 606     $sql = "
 607 SELECT max(id)
 608 FROM   $tableName
 609 ";
 610
 611     $id = CRM_Core_DAO::singleValueQuery($sql);
 612     if (!$id) {
 613       $id = 0;
 614     }
 615
 616     $sqlClause = [];
 617
 618     foreach ($details as $row) {
 619       $id++;
 620       $valueString = [$id];
 621       foreach ($row as $value) {
 622         if (empty($value)) {
 623           $valueString[] = "''";
 624         }
 625         else {
 626           $valueString[] = "'" . CRM_Core_DAO::escapeString($value) . "'";
 627         }
 628       }
 629       $sqlClause[] = '(' . implode(',', $valueString) . ')';
 630     }
 631     $sqlColumns = array_merge(['id' => 1], $sqlColumns);
 632     $sqlColumnString = '(' . implode(',', array_keys($sqlColumns)) . ')';
 633
 634     $sqlValueString = implode(",\n", $sqlClause);
 635
 636     $sql = "
 637 INSERT INTO $tableName $sqlColumnString
 638 VALUES $sqlValueString
 639 ";
 640     CRM_Core_DAO::executeQuery($sql);
 641   }
 642
 643   /**
 644    * @param $sqlColumns
 645    *
 646    * @return string
 647    */
 648   public static function createTempTable($sqlColumns) {
 649     //creating a temporary table for the search result that need be exported
 650     $exportTempTable = CRM_Utils_SQL_TempTable::build()->setDurable()->setCategory('export');
 651
 652     // also create the sql table
 653     $exportTempTable->drop();
 654
 655     $sql = " id int unsigned NOT NULL AUTO_INCREMENT, ";
 656     if (!empty($sqlColumns)) {
 657       $sql .= implode(",\n", array_values($sqlColumns)) . ',';
 658     }
 659
 660     $sql .= "\n PRIMARY KEY ( id )";
 661
 662     // add indexes for street_address and household_name if present
 663     $addIndices = [
 664       'street_address',
 665       'household_name',
 666       'civicrm_primary_id',
 667     ];
 668
 669     foreach ($addIndices as $index) {
 670       if (isset($sqlColumns[$index])) {
 671         $sql .= ",
 672   INDEX index_{$index}( $index )
 673 ";
 674       }
 675     }
 676
 677     $exportTempTable->createWithColumns($sql);
 678     return $exportTempTable->getName();
 679   }
 680
 681   /**
 682    * @param string $tableName
 683    * @param $sqlColumns
 684    * @param array $exportParams
 685    */
 686   public static function mergeSameAddress($tableName, &$sqlColumns, $exportParams) {
 687     // check if any records are present based on if they have used shared address feature,
 688     // and not based on if city / state .. matches.
 689     $sql = "
 690 SELECT    r1.id                 as copy_id,
 691           r1.civicrm_primary_id as copy_contact_id,
 692           r1.addressee          as copy_addressee,
 693           r1.addressee_id       as copy_addressee_id,
 694           r1.postal_greeting    as copy_postal_greeting,
 695           r1.postal_greeting_id as copy_postal_greeting_id,
 696           r2.id                 as master_id,
 697           r2.civicrm_primary_id as master_contact_id,
 698           r2.postal_greeting    as master_postal_greeting,
 699           r2.postal_greeting_id as master_postal_greeting_id,
 700           r2.addressee          as master_addressee,
 701           r2.addressee_id       as master_addressee_id
 702 FROM      $tableName r1
 703 INNER JOIN civicrm_address adr ON r1.master_id   = adr.id
 704 INNER JOIN $tableName      r2  ON adr.contact_id = r2.civicrm_primary_id
 705 ORDER BY  r1.id";
 706     $linkedMerge = self::_buildMasterCopyArray($sql, $exportParams, TRUE);
 707
 708     // find all the records that have the same street address BUT not in a household
 709     // require match on city and state as well
 710     $sql = "
 711 SELECT    r1.id                 as master_id,
 712           r1.civicrm_primary_id as master_contact_id,
 713           r1.postal_greeting    as master_postal_greeting,
 714           r1.postal_greeting_id as master_postal_greeting_id,
 715           r1.addressee          as master_addressee,
 716           r1.addressee_id       as master_addressee_id,
 717           r2.id                 as copy_id,
 718           r2.civicrm_primary_id as copy_contact_id,
 719           r2.postal_greeting    as copy_postal_greeting,
 720           r2.postal_greeting_id as copy_postal_greeting_id,
 721           r2.addressee          as copy_addressee,
 722           r2.addressee_id       as copy_addressee_id
 723 FROM      $tableName r1
 724 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
 725                r1.city = r2.city AND
 726                r1.state_province_id = r2.state_province_id )
 727 WHERE     ( r1.household_name IS NULL OR r1.household_name = '' )
 728 AND       ( r2.household_name IS NULL OR r2.household_name = '' )
 729 AND       ( r1.street_address != '' )
 730 AND       r2.id > r1.id
 731 ORDER BY  r1.id
 732 ";
 733     $merge = self::_buildMasterCopyArray($sql, $exportParams);
 734
 735     // unset ids from $merge already present in $linkedMerge
 736     foreach ($linkedMerge as $masterID => $values) {
 737       $keys = [$masterID];
 738       $keys = array_merge($keys, array_keys($values['copy']));
 739       foreach ($merge as $mid => $vals) {
 740         if (in_array($mid, $keys)) {
 741           unset($merge[$mid]);
 742         }
 743         else {
 744           foreach ($values['copy'] as $copyId) {
 745             if (in_array($copyId, $keys)) {
 746               unset($merge[$mid]['copy'][$copyId]);
 747             }
 748           }
 749         }
 750       }
 751     }
 752     $merge = $merge + $linkedMerge;
 753
 754     foreach ($merge as $masterID => $values) {
 755       $sql = "
 756 UPDATE $tableName
 757 SET    addressee = %1, postal_greeting = %2, email_greeting = %3
 758 WHERE  id = %4
 759 ";
 760       $params = [
 761         1 => [$values['addressee'], 'String'],
 762         2 => [$values['postalGreeting'], 'String'],
 763         3 => [$values['emailGreeting'], 'String'],
 764         4 => [$masterID, 'Integer'],
 765       ];
 766       CRM_Core_DAO::executeQuery($sql, $params);
 767
 768       // delete all copies
 769       $deleteIDs = array_keys($values['copy']);
 770       $deleteIDString = implode(',', $deleteIDs);
 771       $sql = "
 772 DELETE FROM $tableName
 773 WHERE  id IN ( $deleteIDString )
 774 ";
 775       CRM_Core_DAO::executeQuery($sql);
 776     }
 777
 778     // unset temporary columns that were added for postal mailing format
 779     // @todo - this part is pretty close to ready to be removed....
 780     if (!empty($exportParams['merge_same_address']['temp_columns'])) {
 781       $unsetKeys = array_keys($sqlColumns);
 782       foreach ($unsetKeys as $headerKey => $sqlColKey) {
 783         if (array_key_exists($sqlColKey, $exportParams['merge_same_address']['temp_columns'])) {
 784           unset($sqlColumns[$sqlColKey]);
 785         }
 786       }
 787     }
 788   }
 789
 790   /**
 791    * @param int $contactId
 792    * @param array $exportParams
 793    *
 794    * @return array
 795    */
 796   public static function _replaceMergeTokens($contactId, $exportParams) {
 797     $greetings = [];
 798     $contact = NULL;
 799
 800     $greetingFields = [
 801       'postal_greeting',
 802       'addressee',
 803     ];
 804     foreach ($greetingFields as $greeting) {
 805       if (!empty($exportParams[$greeting])) {
 806         $greetingLabel = $exportParams[$greeting];
 807         if (empty($contact)) {
 808           $values = [
 809             'id' => $contactId,
 810             'version' => 3,
 811           ];
 812           $contact = civicrm_api('contact', 'get', $values);
 813
 814           if (!empty($contact['is_error'])) {
 815             return $greetings;
 816           }
 817           $contact = $contact['values'][$contact['id']];
 818         }
 819
 820         $tokens = ['contact' => $greetingLabel];
 821         $greetings[$greeting] = CRM_Utils_Token::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
 822       }
 823     }
 824     return $greetings;
 825   }
 826
 827   /**
 828    * The function unsets static part of the string, if token is the dynamic part.
 829    *
 830    * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
 831    * i.e 'Hello Alan' => converted to => 'Alan'
 832    *
 833    * @param string $parsedString
 834    * @param string $defaultGreeting
 835    * @param bool $addressMergeGreetings
 836    * @param string $greetingType
 837    *
 838    * @return mixed
 839    */
 840   public static function _trimNonTokens(
 841     &$parsedString, $defaultGreeting,
 842     $addressMergeGreetings, $greetingType = 'postal_greeting'
 843   ) {
 844     if (!empty($addressMergeGreetings[$greetingType])) {
 845       $greetingLabel = $addressMergeGreetings[$greetingType];
 846     }
 847     $greetingLabel = empty($greetingLabel) ? $defaultGreeting : $greetingLabel;
 848
 849     $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
 850     $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
 851     foreach ($stringsToBeReplaced as $key => $string) {
 852       // to keep one space
 853       $stringsToBeReplaced[$key] = ltrim($string);
 854     }
 855     $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
 856
 857     return $parsedString;
 858   }
 859
 860   /**
 861    * @param $sql
 862    * @param array $exportParams
 863    * @param bool $sharedAddress
 864    *
 865    * @return array
 866    */
 867   public static function _buildMasterCopyArray($sql, $exportParams, $sharedAddress = FALSE) {
 868     static $contactGreetingTokens = [];
 869
 870     $addresseeOptions = CRM_Core_OptionGroup::values('addressee');
 871     $postalOptions = CRM_Core_OptionGroup::values('postal_greeting');
 872
 873     $merge = $parents = [];
 874     $dao = CRM_Core_DAO::executeQuery($sql);
 875
 876     while ($dao->fetch()) {
 877       $masterID = $dao->master_id;
 878       $copyID = $dao->copy_id;
 879       $masterPostalGreeting = $dao->master_postal_greeting;
 880       $masterAddressee = $dao->master_addressee;
 881       $copyAddressee = $dao->copy_addressee;
 882
 883       if (!$sharedAddress) {
 884         if (!isset($contactGreetingTokens[$dao->master_contact_id])) {
 885           $contactGreetingTokens[$dao->master_contact_id] = self::_replaceMergeTokens($dao->master_contact_id, $exportParams);
 886         }
 887         $masterPostalGreeting = CRM_Utils_Array::value('postal_greeting',
 888           $contactGreetingTokens[$dao->master_contact_id], $dao->master_postal_greeting
 889         );
 890         $masterAddressee = CRM_Utils_Array::value('addressee',
 891           $contactGreetingTokens[$dao->master_contact_id], $dao->master_addressee
 892         );
 893
 894         if (!isset($contactGreetingTokens[$dao->copy_contact_id])) {
 895           $contactGreetingTokens[$dao->copy_contact_id] = self::_replaceMergeTokens($dao->copy_contact_id, $exportParams);
 896         }
 897         $copyPostalGreeting = CRM_Utils_Array::value('postal_greeting',
 898           $contactGreetingTokens[$dao->copy_contact_id], $dao->copy_postal_greeting
 899         );
 900         $copyAddressee = CRM_Utils_Array::value('addressee',
 901           $contactGreetingTokens[$dao->copy_contact_id], $dao->copy_addressee
 902         );
 903       }
 904
 905       if (!isset($merge[$masterID])) {
 906         // check if this is an intermediate child
 907         // this happens if there are 3 or more matches a,b, c
 908         // the above query will return a, b / a, c / b, c
 909         // we might be doing a bit more work, but for now its ok, unless someone
 910         // knows how to fix the query above
 911         if (isset($parents[$masterID])) {
 912           $masterID = $parents[$masterID];
 913         }
 914         else {
 915           $merge[$masterID] = [
 916             'addressee' => $masterAddressee,
 917             'copy' => [],
 918             'postalGreeting' => $masterPostalGreeting,
 919           ];
 920           $merge[$masterID]['emailGreeting'] = &$merge[$masterID]['postalGreeting'];
 921         }
 922       }
 923       $parents[$copyID] = $masterID;
 924
 925       if (!$sharedAddress && !array_key_exists($copyID, $merge[$masterID]['copy'])) {
 926
 927         if (!empty($exportParams['postal_greeting_other']) &&
 928           count($merge[$masterID]['copy']) >= 1
 929         ) {
 930           // use static greetings specified if no of contacts > 2
 931           $merge[$masterID]['postalGreeting'] = $exportParams['postal_greeting_other'];
 932         }
 933         elseif ($copyPostalGreeting) {
 934           self::_trimNonTokens($copyPostalGreeting,
 935             $postalOptions[$dao->copy_postal_greeting_id],
 936             $exportParams
 937           );
 938           $merge[$masterID]['postalGreeting'] = "{$merge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
 939           // if there happens to be a duplicate, remove it
 940           $merge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $merge[$masterID]['postalGreeting']);
 941         }
 942
 943         if (!empty($exportParams['addressee_other']) &&
 944           count($merge[$masterID]['copy']) >= 1
 945         ) {
 946           // use static greetings specified if no of contacts > 2
 947           $merge[$masterID]['addressee'] = $exportParams['addressee_other'];
 948         }
 949         elseif ($copyAddressee) {
 950           self::_trimNonTokens($copyAddressee,
 951             $addresseeOptions[$dao->copy_addressee_id],
 952             $exportParams, 'addressee'
 953           );
 954           $merge[$masterID]['addressee'] = "{$merge[$masterID]['addressee']}, " . trim($copyAddressee);
 955         }
 956       }
 957       $merge[$masterID]['copy'][$copyID] = $copyAddressee;
 958     }
 959
 960     return $merge;
 961   }
 962
 963   /**
 964    * @param $exportTempTable
 965    * @param $headerRows
 966    * @param $sqlColumns
 967    * @param \CRM_Export_BAO_ExportProcessor $processor
 968    */
 969   public static function writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $processor) {
 970     $exportMode = $processor->getExportMode();
 971     $writeHeader = TRUE;
 972     $offset = 0;
 973     $limit = self::EXPORT_ROW_COUNT;
 974
 975     $query = "SELECT * FROM $exportTempTable";
 976
 977     while (1) {
 978       $limitQuery = $query . "
 979 LIMIT $offset, $limit
 980 ";
 981       $dao = CRM_Core_DAO::executeQuery($limitQuery);
 982
 983       if ($dao->N <= 0) {
 984         break;
 985       }
 986
 987       $componentDetails = [];
 988       while ($dao->fetch()) {
 989         $row = [];
 990
 991         foreach ($sqlColumns as $column => $dontCare) {
 992           $row[$column] = $dao->$column;
 993         }
 994         $componentDetails[] = $row;
 995       }
 996       CRM_Core_Report_Excel::writeCSVFile($processor->getExportFileName(),
 997         $headerRows,
 998         $componentDetails,
 999         NULL,
1000         $writeHeader
1001       );
1002
1003       $writeHeader = FALSE;
1004       $offset += $limit;
1005     }
1006   }
1007
1008   /**
1009    * Build componentPayment fields.
1010    *
1011    * This is no longer used by export but BAO_Mapping still calls it & we
1012    * should find a generic way to handle this or move this to that class.
1013    *
1014    * @deprecated
1015    */
1016   public static function componentPaymentFields() {
1017     static $componentPaymentFields;
1018     if (!isset($componentPaymentFields)) {
1019       $componentPaymentFields = [
1020         'componentPaymentField_total_amount' => ts('Total Amount'),
1021         'componentPaymentField_contribution_status' => ts('Contribution Status'),
1022         'componentPaymentField_received_date' => ts('Date Received'),
1023         'componentPaymentField_payment_instrument' => ts('Payment Method'),
1024         'componentPaymentField_transaction_id' => ts('Transaction ID'),
1025       ];
1026     }
1027     return $componentPaymentFields;
1028   }
1029
1030   /**
1031    * Get the various arrays that we use to structure our output.
1032    *
1033    * The extraction of these has been moved to a separate function for clarity and so that
1034    * tests can be added - in particular on the $outputHeaders array.
1035    *
1036    * However it still feels a bit like something that I'm too polite to write down and this should be seen
1037    * as a step on the refactoring path rather than how it should be.
1038    *
1039    * @param array $returnProperties
1040    * @param \CRM_Export_BAO_ExportProcessor $processor
1041    *
1042    * @return array
1043    *   - outputColumns Array of columns to be exported. The values don't matter but the key must match the
1044    *   alias for the field generated by BAO_Query object.
1045    *   - headerRows Array of the column header strings to put in the csv header - non-associative.
1046    *   - sqlColumns Array of column names for the temp table. Not too sure why outputColumns can't be used here.
1047    *   - metadata Array of fields with specific parameters to pass to the translate function or another hacky nasty solution
1048    *    I'm too embarassed to discuss here.
1049    *    The keys need
1050    *    - to match the outputColumns keys (yes, the fact we ignore the output columns values & then pass another array with values
1051    *    we could use does suggest further refactors. However, you future improver, do remember that every check you do
1052    *    in the main DAO loop is done once per row & that coule be 100,000 times.)
1053    *    Finally a pop quiz: We need the translate context because we use a function other than ts() - is this because
1054    *    - a) the function used is more efficient or
1055    *    - b) this code is old & outdated. Submit your answers to circular bin or better
1056    *       yet find a way to comment them for posterity.
1057    */
1058   public static function getExportStructureArrays($returnProperties, $processor) {
1059     $outputColumns = $metadata = [];
1060     $queryFields = $processor->getQueryFields();
1061     foreach ($returnProperties as $key => $value) {
1062       if (($key != 'location' || !is_array($value)) && !$processor->isRelationshipTypeKey($key)) {
1063         $outputColumns[$key] = $value;
1064         $processor->addOutputSpecification($key);
1065       }
1066       elseif ($processor->isRelationshipTypeKey($key)) {
1067         $outputColumns[$key] = $value;
1068         foreach ($value as $relationField => $relationValue) {
1069           // below block is same as primary block (duplicate)
1070           if (isset($queryFields[$relationField]['title'])) {
1071             $processor->addOutputSpecification($relationField, $key);
1072           }
1073           elseif (is_array($relationValue) && $relationField == 'location') {
1074             // fix header for location type case
1075             foreach ($relationValue as $ltype => $val) {
1076               foreach (array_keys($val) as $fld) {
1077                 $type = explode('-', $fld);
1078                 $processor->addOutputSpecification($type[0], $key, $ltype, CRM_Utils_Array::value(1, $type));
1079               }
1080             }
1081           }
1082         }
1083       }
1084       else {
1085         foreach ($value as $locationType => $locationFields) {
1086           foreach (array_keys($locationFields) as $locationFieldName) {
1087             $type = explode('-', $locationFieldName);
1088
1089             $actualDBFieldName = $type[0];
1090             $daoFieldName = CRM_Utils_String::munge($locationType) . '-' . $actualDBFieldName;
1091
1092             if (!empty($type[1])) {
1093               $daoFieldName .= "-" . $type[1];
1094             }
1095             $processor->addOutputSpecification($actualDBFieldName, NULL, $locationType, CRM_Utils_Array::value(1, $type));
1096             $metadata[$daoFieldName] = $processor->getMetaDataForField($actualDBFieldName);
1097             $outputColumns[$daoFieldName] = TRUE;
1098           }
1099         }
1100       }
1101     }
1102     return [$outputColumns, $metadata];
1103   }
1104
1105   /**
1106    * Get the values of linked household contact.
1107    *
1108    * @param CRM_Core_DAO $relDAO
1109    * @param array $value
1110    * @param string $field
1111    * @param array $row
1112    */
1113   private static function fetchRelationshipDetails($relDAO, $value, $field, &$row) {
1114     $phoneTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
1115     $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
1116     $i18n = CRM_Core_I18n::singleton();
1117     $field = $field . '_';
1118
1119     foreach ($value as $relationField => $relationValue) {
1120       if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
1121         $fieldValue = $relDAO->$relationField;
1122         if ($relationField == 'phone_type_id') {
1123           $fieldValue = $phoneTypes[$relationValue];
1124         }
1125         elseif ($relationField == 'provider_id') {
1126           $fieldValue = CRM_Utils_Array::value($relationValue, $imProviders);
1127         }
1128         // CRM-13995
1129         elseif (is_object($relDAO) && in_array($relationField, [
1130           'email_greeting',
1131           'postal_greeting',
1132           'addressee',
1133         ])) {
1134           //special case for greeting replacement
1135           $fldValue = "{$relationField}_display";
1136           $fieldValue = $relDAO->$fldValue;
1137         }
1138       }
1139       elseif (is_object($relDAO) && $relationField == 'state_province') {
1140         $fieldValue = CRM_Core_PseudoConstant::stateProvince($relDAO->state_province_id);
1141       }
1142       elseif (is_object($relDAO) && $relationField == 'country') {
1143         $fieldValue = CRM_Core_PseudoConstant::country($relDAO->country_id);
1144       }
1145       else {
1146         $fieldValue = '';
1147       }
1148       $relPrefix = $field . $relationField;
1149
1150       if (is_object($relDAO) && $relationField == 'id') {
1151         $row[$relPrefix] = $relDAO->contact_id;
1152       }
1153       elseif (is_array($relationValue) && $relationField == 'location') {
1154         foreach ($relationValue as $ltype => $val) {
1155           // If the location name has a space in it the we need to handle that. This
1156           // is kinda hacky but specifically covered in the ExportTest so later efforts to
1157           // improve it should be secure in the knowled it will be caught.
1158           $ltype = str_replace(' ', '_', $ltype);
1159           foreach (array_keys($val) as $fld) {
1160             $type = explode('-', $fld);
1161             $fldValue = "{$ltype}-" . $type[0];
1162             if (!empty($type[1])) {
1163               $fldValue .= "-" . $type[1];
1164             }
1165             // CRM-3157: localise country, region (both have ‘country’ context)
1166             // and state_province (‘province’ context)
1167             switch (TRUE) {
1168               case (!is_object($relDAO)):
1169                 $row[$field . '_' . $fldValue] = '';
1170                 break;
1171
1172               case in_array('country', $type):
1173               case in_array('world_region', $type):
1174                 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
1175                   ['context' => 'country']
1176                 );
1177                 break;
1178
1179               case in_array('state_province', $type):
1180                 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
1181                   ['context' => 'province']
1182                 );
1183                 break;
1184
1185               default:
1186                 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
1187                 break;
1188             }
1189           }
1190         }
1191       }
1192       elseif (isset($fieldValue) && $fieldValue != '') {
1193         //check for custom data
1194         if ($cfID = CRM_Core_BAO_CustomField::getKeyID($relationField)) {
1195           $row[$relPrefix] = CRM_Core_BAO_CustomField::displayValue($fieldValue, $cfID);
1196         }
1197         else {
1198           //normal relationship fields
1199           // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
1200           switch ($relationField) {
1201             case 'country':
1202             case 'world_region':
1203               $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'country']);
1204               break;
1205
1206             case 'state_province':
1207               $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'province']);
1208               break;
1209
1210             default:
1211               $row[$relPrefix] = $fieldValue;
1212               break;
1213           }
1214         }
1215       }
1216       else {
1217         // if relation field is empty or null
1218         $row[$relPrefix] = '';
1219       }
1220     }
1221   }
1222
1223   /**
1224    * Get the ids that we want to get related contact details for.
1225    *
1226    * @param array $ids
1227    * @param int $exportMode
1228    *
1229    * @return array
1230    */
1231   protected static function getIDsForRelatedContact($ids, $exportMode) {
1232     if ($exportMode == CRM_Export_Form_Select::CONTACT_EXPORT) {
1233       return $ids;
1234     }
1235     if ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
1236       $relIDs = [];
1237       $sourceID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
1238       $dao = CRM_Core_DAO::executeQuery("
1239             SELECT contact_id FROM civicrm_activity_contact
1240             WHERE activity_id IN ( " . implode(',', $ids) . ") AND
1241             record_type_id = {$sourceID}
1242           ");
1243
1244       while ($dao->fetch()) {
1245         $relIDs[] = $dao->contact_id;
1246       }
1247       return $relIDs;
1248     }
1249     $component = self::exportComponent($exportMode);
1250
1251     if ($exportMode == CRM_Export_Form_Select::CASE_EXPORT) {
1252       return CRM_Case_BAO_Case::retrieveContactIdsByCaseId($ids);
1253     }
1254     else {
1255       return CRM_Core_DAO::getContactIDsFromComponent($ids, $component);
1256     }
1257   }
1258
1259   /**
1260    * @param $selectAll
1261    * @param $ids
1262    * @param \CRM_Export_BAO_ExportProcessor $processor
1263    * @param $componentTable
1264    */
1265   protected static function buildRelatedContactArray($selectAll, $ids, $processor, $componentTable) {
1266     $allRelContactArray = $relationQuery = [];
1267     $queryMode = $processor->getQueryMode();
1268     $exportMode = $processor->getExportMode();
1269
1270     foreach ($processor->getRelationshipReturnProperties() as $relationshipKey => $relationReturnProperties) {
1271       $allRelContactArray[$relationshipKey] = [];
1272       // build Query for each relationship
1273       $relationQuery = new CRM_Contact_BAO_Query(NULL, $relationReturnProperties,
1274         NULL, FALSE, FALSE, $queryMode
1275       );
1276       list($relationSelect, $relationFrom, $relationWhere, $relationHaving) = $relationQuery->query();
1277
1278       list($id, $direction) = explode('_', $relationshipKey, 2);
1279       // identify the relationship direction
1280       $contactA = 'contact_id_a';
1281       $contactB = 'contact_id_b';
1282       if ($direction == 'b_a') {
1283         $contactA = 'contact_id_b';
1284         $contactB = 'contact_id_a';
1285       }
1286       $relIDs = self::getIDsForRelatedContact($ids, $exportMode);
1287
1288       $relationshipJoin = $relationshipClause = '';
1289       if (!$selectAll && $componentTable) {
1290         $relationshipJoin = " INNER JOIN {$componentTable} ctTable ON ctTable.contact_id = {$contactA}";
1291       }
1292       elseif (!empty($relIDs)) {
1293         $relID = implode(',', $relIDs);
1294         $relationshipClause = " AND crel.{$contactA} IN ( {$relID} )";
1295       }
1296
1297       $relationFrom = " {$relationFrom}
1298               INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_a.id AND crel.relationship_type_id = {$id}
1299               {$relationshipJoin} ";
1300
1301       //check for active relationship status only
1302       $today = date('Ymd');
1303       $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
1304       $relationWhere = " WHERE contact_a.is_deleted = 0 {$relationshipClause} {$relationActive}";
1305       CRM_Core_DAO::disableFullGroupByMode();
1306       $relationSelect = "{$relationSelect}, {$contactA} as refContact ";
1307       $relationQueryString = "$relationSelect $relationFrom $relationWhere $relationHaving GROUP BY crel.{$contactA}";
1308
1309       $allRelContactDAO = CRM_Core_DAO::executeQuery($relationQueryString);
1310       CRM_Core_DAO::reenableFullGroupByMode();
1311
1312       while ($allRelContactDAO->fetch()) {
1313         $relationQuery->convertToPseudoNames($allRelContactDAO);
1314         $row = [];
1315         // @todo pass processor to fetchRelationshipDetails and set fields directly within it.
1316         self::fetchRelationshipDetails($allRelContactDAO, $relationReturnProperties, $relationshipKey, $row);
1317         foreach (array_keys($relationReturnProperties) as $property) {
1318           if ($property === 'location') {
1319             // @todo - simplify location in self::fetchRelationshipDetails - remove handling here. Or just call
1320             // $processor->setRelationshipValue from fetchRelationshipDetails
1321             foreach ($relationReturnProperties['location'] as $locationName => $locationValues) {
1322               foreach (array_keys($locationValues) as $locationValue) {
1323                 $key = str_replace(' ', '_', $locationName) . '-' . $locationValue;
1324                 $processor->setRelationshipValue($relationshipKey, $allRelContactDAO->refContact, $key, $row[$relationshipKey . '__' . $key]);
1325               }
1326             }
1327           }
1328           else {
1329             $processor->setRelationshipValue($relationshipKey, $allRelContactDAO->refContact, $property, $row[$relationshipKey . '_' . $property]);
1330           }
1331         }
1332       }
1333     }
1334   }
1335
1336 }