CRM/Export/BAO/ExportProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Class CRM_Export_BAO_ExportProcessor
  20  *
  21  * Class to handle logic of export.
  22  */
  23 class CRM_Export_BAO_ExportProcessor {
  24
  25   /**
  26    * @var int
  27    */
  28   protected $queryMode;
  29
  30   /**
  31    * @var int
  32    */
  33   protected $exportMode;
  34
  35   /**
  36    * Array of fields in the main query.
  37    *
  38    * @var array
  39    */
  40   protected $queryFields = [];
  41
  42   /**
  43    * Either AND or OR.
  44    *
  45    * @var string
  46    */
  47   protected $queryOperator;
  48
  49   /**
  50    * Requested output fields.
  51    *
  52    * If set to NULL then it is 'primary fields only'
  53    * which actually means pretty close to all fields!
  54    *
  55    * @var array|null
  56    */
  57   protected $requestedFields;
  58
  59   /**
  60    * Is the contact being merged into a single household.
  61    *
  62    * @var bool
  63    */
  64   protected $isMergeSameHousehold;
  65
  66   /**
  67    * Should contacts with the same address be merged.
  68    *
  69    * @var bool
  70    */
  71   protected $isMergeSameAddress = FALSE;
  72
  73   /**
  74    * Fields that need to be retrieved for address merge purposes but should not be in output.
  75    *
  76    * @var array
  77    */
  78   protected $additionalFieldsForSameAddressMerge = [];
  79
  80   /**
  81    * Fields used for merging same contacts.
  82    *
  83    * @var array
  84    */
  85   protected $contactGreetingFields = [];
  86
  87   /**
  88    * An array of primary IDs of the entity being exported.
  89    *
  90    * @var array
  91    */
  92   protected $ids = [];
  93
  94   /**
  95    * Greeting options mapping to various greeting ids.
  96    *
  97    * This stores the option values for the addressee, postal_greeting & email_greeting
  98    * option groups.
  99    *
 100    * @var array
 101    */
 102   protected $greetingOptions = [];
 103
 104   /**
 105    * Get additional non-visible fields for address merge purposes.
 106    *
 107    * @return array
 108    */
 109   public function getAdditionalFieldsForSameAddressMerge(): array {
 110     return $this->additionalFieldsForSameAddressMerge;
 111   }
 112
 113   /**
 114    * Set additional non-visible fields for address merge purposes.
 115    */
 116   public function setAdditionalFieldsForSameAddressMerge() {
 117     if ($this->isMergeSameAddress) {
 118       $fields = ['id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id'];
 119       foreach ($fields as $index => $field) {
 120         if (!empty($this->getReturnProperties()[$field])) {
 121           unset($fields[$index]);
 122         }
 123       }
 124       $this->additionalFieldsForSameAddressMerge = array_fill_keys($fields, 1);
 125     }
 126   }
 127
 128   /**
 129    * Should contacts with the same address be merged.
 130    *
 131    * @return bool
 132    */
 133   public function isMergeSameAddress(): bool {
 134     return $this->isMergeSameAddress;
 135   }
 136
 137   /**
 138    * Set same address is to be merged.
 139    *
 140    * @param bool $isMergeSameAddress
 141    */
 142   public function setIsMergeSameAddress(bool $isMergeSameAddress) {
 143     $this->isMergeSameAddress = $isMergeSameAddress;
 144   }
 145
 146   /**
 147    * Additional fields required to export postal fields.
 148    *
 149    * @var array
 150    */
 151   protected $additionalFieldsForPostalExport = [];
 152
 153   /**
 154    * Get additional fields required to do a postal export.
 155    *
 156    * @return array
 157    */
 158   public function getAdditionalFieldsForPostalExport() {
 159     return $this->additionalFieldsForPostalExport;
 160   }
 161
 162   /**
 163    * Set additional fields required for a postal export.
 164    */
 165   public function setAdditionalFieldsForPostalExport() {
 166     if ($this->getRequestedFields() && $this->isPostalableOnly()) {
 167       $fields = ['is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1'];
 168       foreach ($fields as $index => $field) {
 169         if (!empty($this->getReturnProperties()[$field])) {
 170           unset($fields[$index]);
 171         }
 172       }
 173       $this->additionalFieldsForPostalExport = array_fill_keys($fields, 1);
 174     }
 175   }
 176
 177   /**
 178    * Only export contacts that can receive postal mail.
 179    *
 180    * Includes being alive, having an address & not having do_not_mail.
 181    *
 182    * @var bool
 183    */
 184   protected $isPostalableOnly;
 185
 186   /**
 187    * Key representing the head of household in the relationship array.
 188    *
 189    * e.g. ['8_b_a' => 'Household Member Is', '8_a_b = 'Household Member Of'.....]
 190    *
 191    * @var array
 192    */
 193   protected $relationshipTypes = [];
 194
 195   /**
 196    * Array of properties to retrieve for relationships.
 197    *
 198    * @var array
 199    */
 200   protected $relationshipReturnProperties = [];
 201
 202   /**
 203    * IDs of households that have already been exported.
 204    *
 205    * @var array
 206    */
 207   protected $exportedHouseholds = [];
 208
 209   /**
 210    * Contacts to be merged by virtue of their shared address.
 211    *
 212    * @var array
 213    */
 214   protected $contactsToMerge = [];
 215
 216   /**
 217    * Households to skip during export as they will be exported via their relationships anyway.
 218    *
 219    * @var array
 220    */
 221   protected $householdsToSkip = [];
 222
 223   /**
 224    * Additional fields to return.
 225    *
 226    * This doesn't make much sense when we have a fields set but search build add it's own onto
 227    * the 'Primary fields' (all) option.
 228    *
 229    * @var array
 230    */
 231   protected $additionalRequestedReturnProperties = [];
 232
 233   /**
 234    * Get additional return properties.
 235    *
 236    * @return array
 237    */
 238   public function getAdditionalRequestedReturnProperties() {
 239     return $this->additionalRequestedReturnProperties;
 240   }
 241
 242   /**
 243    * Set additional return properties.
 244    *
 245    * @param array $value
 246    */
 247   public function setAdditionalRequestedReturnProperties($value) {
 248     // fix for CRM-7066
 249     if (!empty($value['group'])) {
 250       unset($value['group']);
 251       $value['groups'] = 1;
 252     }
 253     $this->additionalRequestedReturnProperties = $value;
 254   }
 255
 256   /**
 257    * Get return properties by relationship.
 258    * @return array
 259    */
 260   public function getRelationshipReturnProperties() {
 261     return $this->relationshipReturnProperties;
 262   }
 263
 264   /**
 265    * Export values for related contacts.
 266    *
 267    * @var array
 268    */
 269   protected $relatedContactValues = [];
 270
 271   /**
 272    * @var array
 273    */
 274   protected $returnProperties = [];
 275
 276   /**
 277    * @var array
 278    */
 279   protected $outputSpecification = [];
 280
 281   /**
 282    * @var string
 283    */
 284   protected $componentTable = '';
 285
 286   /**
 287    * @return string
 288    */
 289   public function getComponentTable() {
 290     return $this->componentTable;
 291   }
 292
 293   /**
 294    * Set the component table (if any).
 295    *
 296    * @param string $componentTable
 297    */
 298   public function setComponentTable($componentTable) {
 299     $this->componentTable = $componentTable;
 300   }
 301
 302   /**
 303    * Clause from component search.
 304    *
 305    * @var string
 306    */
 307   protected $componentClause = '';
 308
 309   /**
 310    * @return string
 311    */
 312   public function getComponentClause() {
 313     return $this->componentClause;
 314   }
 315
 316   /**
 317    * @param string $componentClause
 318    */
 319   public function setComponentClause($componentClause) {
 320     $this->componentClause = $componentClause;
 321   }
 322
 323   /**
 324    * Name of a temporary table created to hold the results.
 325    *
 326    * Current decision making on when to create a temp table is kinda bad so this might change
 327    * a bit as it is reviewed but basically we need a temp table or similar to calculate merging
 328    * addresses. Merging households is handled in php. We create a temp table even when we don't need them.
 329    *
 330    * @var string
 331    */
 332   protected $temporaryTable;
 333
 334   /**
 335    * @return string
 336    */
 337   public function getTemporaryTable(): string {
 338     return $this->temporaryTable;
 339   }
 340
 341   /**
 342    * @param string $temporaryTable
 343    */
 344   public function setTemporaryTable(string $temporaryTable) {
 345     $this->temporaryTable = $temporaryTable;
 346   }
 347
 348   protected $postalGreetingTemplate;
 349
 350   /**
 351    * @return mixed
 352    */
 353   public function getPostalGreetingTemplate() {
 354     return $this->postalGreetingTemplate;
 355   }
 356
 357   /**
 358    * @param mixed $postalGreetingTemplate
 359    */
 360   public function setPostalGreetingTemplate($postalGreetingTemplate) {
 361     $this->postalGreetingTemplate = $postalGreetingTemplate;
 362   }
 363
 364   /**
 365    * @return mixed
 366    */
 367   public function getAddresseeGreetingTemplate() {
 368     return $this->addresseeGreetingTemplate;
 369   }
 370
 371   /**
 372    * @param mixed $addresseeGreetingTemplate
 373    */
 374   public function setAddresseeGreetingTemplate($addresseeGreetingTemplate) {
 375     $this->addresseeGreetingTemplate = $addresseeGreetingTemplate;
 376   }
 377
 378   protected $addresseeGreetingTemplate;
 379
 380   /**
 381    * CRM_Export_BAO_ExportProcessor constructor.
 382    *
 383    * @param int $exportMode
 384    * @param array|null $requestedFields
 385    * @param string $queryOperator
 386    * @param bool $isMergeSameHousehold
 387    * @param bool $isPostalableOnly
 388    * @param bool $isMergeSameAddress
 389    * @param array $formValues
 390    *   Values from the export options form on contact export. We currently support these keys
 391    *   - postal_greeting
 392    *   - postal_other
 393    *   - addresee_greeting
 394    *   - addressee_other
 395    */
 396   public function __construct($exportMode, $requestedFields, $queryOperator, $isMergeSameHousehold = FALSE, $isPostalableOnly = FALSE, $isMergeSameAddress = FALSE, $formValues = []) {
 397     $this->setExportMode($exportMode);
 398     $this->setQueryMode();
 399     $this->setQueryOperator($queryOperator);
 400     $this->setRequestedFields($requestedFields);
 401     $this->setRelationshipTypes();
 402     $this->setIsMergeSameHousehold($isMergeSameHousehold || $isMergeSameAddress);
 403     $this->setIsPostalableOnly($isPostalableOnly);
 404     $this->setIsMergeSameAddress($isMergeSameAddress);
 405     $this->setReturnProperties($this->determineReturnProperties());
 406     $this->setAdditionalFieldsForSameAddressMerge();
 407     $this->setAdditionalFieldsForPostalExport();
 408     $this->setHouseholdMergeReturnProperties();
 409     $this->setGreetingStringsForSameAddressMerge($formValues);
 410     $this->setGreetingOptions();
 411   }
 412
 413   /**
 414    * Set the greeting options, if relevant.
 415    */
 416   public function setGreetingOptions() {
 417     if ($this->isMergeSameAddress()) {
 418       $this->greetingOptions['addressee'] = CRM_Core_OptionGroup::values('addressee');
 419       $this->greetingOptions['postal_greeting'] = CRM_Core_OptionGroup::values('postal_greeting');
 420     }
 421   }
 422
 423   /**
 424    * @return bool
 425    */
 426   public function isPostalableOnly() {
 427     return $this->isPostalableOnly;
 428   }
 429
 430   /**
 431    * @param bool $isPostalableOnly
 432    */
 433   public function setIsPostalableOnly($isPostalableOnly) {
 434     $this->isPostalableOnly = $isPostalableOnly;
 435   }
 436
 437   /**
 438    * @return array|null
 439    */
 440   public function getRequestedFields() {
 441     return empty($this->requestedFields) ? NULL : $this->requestedFields;
 442   }
 443
 444   /**
 445    * @param array|null $requestedFields
 446    */
 447   public function setRequestedFields($requestedFields) {
 448     $this->requestedFields = $requestedFields;
 449   }
 450
 451   /**
 452    * @return array
 453    */
 454   public function getReturnProperties() {
 455     return array_merge($this->returnProperties, $this->getAdditionalRequestedReturnProperties(), $this->getAdditionalFieldsForSameAddressMerge(), $this->getAdditionalFieldsForPostalExport());
 456   }
 457
 458   /**
 459    * @param array $returnProperties
 460    */
 461   public function setReturnProperties($returnProperties) {
 462     $this->returnProperties = $returnProperties;
 463   }
 464
 465   /**
 466    * @return array
 467    */
 468   public function getRelationshipTypes() {
 469     return $this->relationshipTypes;
 470   }
 471
 472   /**
 473    */
 474   public function setRelationshipTypes() {
 475     $this->relationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(
 476       NULL,
 477       NULL,
 478       NULL,
 479       NULL,
 480       TRUE,
 481       'name',
 482       FALSE
 483     );
 484   }
 485
 486   /**
 487    * Set the value for a relationship type field.
 488    *
 489    * In this case we are building up an array of properties for a related contact.
 490    *
 491    * These may be used for direct exporting or for merge to household depending on the
 492    * options selected.
 493    *
 494    * @param string $relationshipType
 495    * @param int $contactID
 496    * @param string $field
 497    * @param string $value
 498    */
 499   public function setRelationshipValue($relationshipType, $contactID, $field, $value) {
 500     $this->relatedContactValues[$relationshipType][$contactID][$field] = $value;
 501     if ($field === 'id' && $this->isHouseholdMergeRelationshipTypeKey($relationshipType)) {
 502       $this->householdsToSkip[] = $value;
 503     }
 504   }
 505
 506   /**
 507    * Get the value for a relationship type field.
 508    *
 509    * In this case we are building up an array of properties for a related contact.
 510    *
 511    * These may be used for direct exporting or for merge to household depending on the
 512    * options selected.
 513    *
 514    * @param string $relationshipType
 515    * @param int $contactID
 516    * @param string $field
 517    *
 518    * @return string
 519    */
 520   public function getRelationshipValue($relationshipType, $contactID, $field) {
 521     return $this->relatedContactValues[$relationshipType][$contactID][$field] ?? '';
 522   }
 523
 524   /**
 525    * Get the id of the related household.
 526    *
 527    * @param int $contactID
 528    * @param string $relationshipType
 529    *
 530    * @return int
 531    */
 532   public function getRelatedHouseholdID($contactID, $relationshipType) {
 533     return $this->relatedContactValues[$relationshipType][$contactID]['id'];
 534   }
 535
 536   /**
 537    * Has the household already been exported.
 538    *
 539    * @param int $housholdContactID
 540    *
 541    * @return bool
 542    */
 543   public function isHouseholdExported($housholdContactID) {
 544     return isset($this->exportedHouseholds[$housholdContactID]);
 545
 546   }
 547
 548   /**
 549    * @return bool
 550    */
 551   public function isMergeSameHousehold() {
 552     return $this->isMergeSameHousehold;
 553   }
 554
 555   /**
 556    * @param bool $isMergeSameHousehold
 557    */
 558   public function setIsMergeSameHousehold($isMergeSameHousehold) {
 559     $this->isMergeSameHousehold = $isMergeSameHousehold;
 560   }
 561
 562   /**
 563    * Return relationship types for household merge.
 564    *
 565    * @return mixed
 566    */
 567   public function getHouseholdRelationshipTypes() {
 568     if (!$this->isMergeSameHousehold()) {
 569       return [];
 570     }
 571     return [
 572       CRM_Utils_Array::key('Household Member of', $this->getRelationshipTypes()),
 573       CRM_Utils_Array::key('Head of Household for', $this->getRelationshipTypes()),
 574     ];
 575   }
 576
 577   /**
 578    * @param $fieldName
 579    * @return bool
 580    */
 581   public function isRelationshipTypeKey($fieldName) {
 582     return array_key_exists($fieldName, $this->relationshipTypes);
 583   }
 584
 585   /**
 586    * @param $fieldName
 587    * @return bool
 588    */
 589   public function isHouseholdMergeRelationshipTypeKey($fieldName) {
 590     return in_array($fieldName, $this->getHouseholdRelationshipTypes());
 591   }
 592
 593   /**
 594    * @return string
 595    */
 596   public function getQueryOperator() {
 597     return $this->queryOperator;
 598   }
 599
 600   /**
 601    * @param string $queryOperator
 602    */
 603   public function setQueryOperator($queryOperator) {
 604     $this->queryOperator = $queryOperator;
 605   }
 606
 607   /**
 608    * @return array
 609    */
 610   public function getIds() {
 611     return $this->ids;
 612   }
 613
 614   /**
 615    * @param array $ids
 616    */
 617   public function setIds($ids) {
 618     $this->ids = $ids;
 619   }
 620
 621   /**
 622    * @return array
 623    */
 624   public function getQueryFields() {
 625     return array_merge(
 626       $this->queryFields,
 627       $this->getComponentPaymentFields()
 628     );
 629   }
 630
 631   /**
 632    * @param array $queryFields
 633    */
 634   public function setQueryFields($queryFields) {
 635     // legacy hacks - we add these to queryFields because this
 636     // pseudometadata is currently required.
 637     $queryFields['im_provider']['pseudoconstant']['var'] = 'imProviders';
 638     $queryFields['country']['context'] = 'country';
 639     $queryFields['world_region']['context'] = 'country';
 640     $queryFields['state_province']['context'] = 'province';
 641     $queryFields['contact_id'] = ['title' => ts('Contact ID'), 'type' => CRM_Utils_Type::T_INT];
 642     $this->queryFields = $queryFields;
 643   }
 644
 645   /**
 646    * @return int
 647    */
 648   public function getQueryMode() {
 649     return $this->queryMode;
 650   }
 651
 652   /**
 653    * Set the query mode based on the export mode.
 654    */
 655   public function setQueryMode() {
 656
 657     switch ($this->getExportMode()) {
 658       case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
 659         $this->queryMode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
 660         break;
 661
 662       case CRM_Export_Form_Select::EVENT_EXPORT:
 663         $this->queryMode = CRM_Contact_BAO_Query::MODE_EVENT;
 664         break;
 665
 666       case CRM_Export_Form_Select::MEMBER_EXPORT:
 667         $this->queryMode = CRM_Contact_BAO_Query::MODE_MEMBER;
 668         break;
 669
 670       case CRM_Export_Form_Select::PLEDGE_EXPORT:
 671         $this->queryMode = CRM_Contact_BAO_Query::MODE_PLEDGE;
 672         break;
 673
 674       case CRM_Export_Form_Select::CASE_EXPORT:
 675         $this->queryMode = CRM_Contact_BAO_Query::MODE_CASE;
 676         break;
 677
 678       case CRM_Export_Form_Select::GRANT_EXPORT:
 679         $this->queryMode = CRM_Contact_BAO_Query::MODE_GRANT;
 680         break;
 681
 682       case CRM_Export_Form_Select::ACTIVITY_EXPORT:
 683         $this->queryMode = CRM_Contact_BAO_Query::MODE_ACTIVITY;
 684         break;
 685
 686       default:
 687         $this->queryMode = CRM_Contact_BAO_Query::MODE_CONTACTS;
 688     }
 689   }
 690
 691   /**
 692    * @return int
 693    */
 694   public function getExportMode() {
 695     return $this->exportMode;
 696   }
 697
 698   /**
 699    * @param int $exportMode
 700    */
 701   public function setExportMode($exportMode) {
 702     $this->exportMode = $exportMode;
 703   }
 704
 705   /**
 706    * Get the name for the export file.
 707    *
 708    * @return string
 709    */
 710   public function getExportFileName() {
 711     switch ($this->getExportMode()) {
 712       case CRM_Export_Form_Select::CONTACT_EXPORT:
 713         return ts('CiviCRM Contact Search');
 714
 715       case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
 716         return ts('CiviCRM Contribution Search');
 717
 718       case CRM_Export_Form_Select::MEMBER_EXPORT:
 719         return ts('CiviCRM Member Search');
 720
 721       case CRM_Export_Form_Select::EVENT_EXPORT:
 722         return ts('CiviCRM Participant Search');
 723
 724       case CRM_Export_Form_Select::PLEDGE_EXPORT:
 725         return ts('CiviCRM Pledge Search');
 726
 727       case CRM_Export_Form_Select::CASE_EXPORT:
 728         return ts('CiviCRM Case Search');
 729
 730       case CRM_Export_Form_Select::GRANT_EXPORT:
 731         return ts('CiviCRM Grant Search');
 732
 733       case CRM_Export_Form_Select::ACTIVITY_EXPORT:
 734         return ts('CiviCRM Activity Search');
 735
 736       default:
 737         // Legacy code suggests the value could be 'financial' - ie. something
 738         // other than what should be accepted. However, I suspect that this line is
 739         // never hit.
 740         return ts('CiviCRM Search');
 741     }
 742   }
 743
 744   /**
 745    * Get the label for the header row based on the field to output.
 746    *
 747    * @param string $field
 748    *
 749    * @return string
 750    */
 751   public function getHeaderForRow($field) {
 752     if (substr($field, -11) === 'campaign_id') {
 753       // @todo - set this correctly in the xml rather than here.
 754       // This will require a generalised handling cleanup
 755       return ts('Campaign ID');
 756     }
 757     if ($this->isMergeSameHousehold() && !$this->isMergeSameAddress() && $field === 'id') {
 758       // This is weird - even if we are merging households not every contact in the export is a household so this would not be accurate.
 759       return ts('Household ID');
 760     }
 761     elseif (isset($this->getQueryFields()[$field]['title'])) {
 762       return $this->getQueryFields()[$field]['title'];
 763     }
 764     elseif ($this->isExportPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
 765       return CRM_Utils_Array::value($field, $this->getcomponentPaymentFields())['title'];
 766     }
 767     else {
 768       return $field;
 769     }
 770   }
 771
 772   /**
 773    * @param $params
 774    * @param $order
 775    *
 776    * @return array
 777    */
 778   public function runQuery($params, $order) {
 779     $returnProperties = $this->getReturnProperties();
 780     $params = array_merge($params, $this->getWhereParams());
 781
 782     $query = new CRM_Contact_BAO_Query($params, $returnProperties, NULL,
 783       FALSE, FALSE, $this->getQueryMode(),
 784       FALSE, TRUE, TRUE, NULL, $this->getQueryOperator(),
 785       NULL, TRUE
 786     );
 787
 788     //sort by state
 789     //CRM-15301
 790     $query->_sort = $order;
 791     list($select, $from, $where, $having) = $query->query();
 792     $this->setQueryFields($query->_fields);
 793     $whereClauses = ['trash_clause' => "contact_a.is_deleted != 1"];
 794     if ($this->getRequestedFields() && ($this->getComponentTable())) {
 795       $from .= " INNER JOIN " . $this->getComponentTable() . " ctTable ON ctTable.contact_id = contact_a.id ";
 796     }
 797     elseif ($this->getComponentClause()) {
 798       $whereClauses[] = $this->getComponentClause();
 799     }
 800
 801     // CRM-13982 - check if is deleted
 802     foreach ($params as $value) {
 803       if ($value[0] == 'contact_is_deleted') {
 804         unset($whereClauses['trash_clause']);
 805       }
 806     }
 807
 808     if ($this->isPostalableOnly) {
 809       if (array_key_exists('street_address', $returnProperties)) {
 810         $addressWhere = " civicrm_address.street_address <> ''";
 811         if (array_key_exists('supplemental_address_1', $returnProperties)) {
 812           // We need this to be an OR rather than AND on the street_address so, hack it in.
 813           $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 814             'address_options', TRUE, NULL, TRUE
 815           );
 816           if (!empty($addressOptions['supplemental_address_1'])) {
 817             $addressWhere .= " OR civicrm_address.supplemental_address_1 <> ''";
 818           }
 819         }
 820         $whereClauses['address'] = '(' . $addressWhere . ')';
 821       }
 822     }
 823
 824     if (empty($where)) {
 825       $where = "WHERE " . implode(' AND ', $whereClauses);
 826     }
 827     else {
 828       $where .= " AND " . implode(' AND ', $whereClauses);
 829     }
 830
 831     $groupBy = $this->getGroupBy($query);
 832     $queryString = "$select $from $where $having $groupBy";
 833     if ($order) {
 834       // always add contact_a.id to the ORDER clause
 835       // so the order is deterministic
 836       //CRM-15301
 837       if (strpos('contact_a.id', $order) === FALSE) {
 838         $order .= ", contact_a.id";
 839       }
 840
 841       list($field, $dir) = explode(' ', $order, 2);
 842       $field = trim($field);
 843       if (!empty($this->getReturnProperties()[$field])) {
 844         //CRM-15301
 845         $queryString .= " ORDER BY $order";
 846       }
 847     }
 848     return [$query, $queryString];
 849   }
 850
 851   /**
 852    * Add a row to the specification for how to output data.
 853    *
 854    * @param string $key
 855    * @param string $relationshipType
 856    * @param string $locationType
 857    * @param int $entityTypeID phone_type_id or provider_id for phone or im fields.
 858    */
 859   public function addOutputSpecification($key, $relationshipType = NULL, $locationType = NULL, $entityTypeID = NULL) {
 860     $entityLabel = '';
 861     if ($entityTypeID) {
 862       if ($key === 'phone') {
 863         $entityLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_Phone', 'phone_type_id', $entityTypeID);
 864       }
 865       if ($key === 'im') {
 866         $entityLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_IM', 'provider_id', $entityTypeID);
 867       }
 868     }
 869
 870     // These oddly constructed keys are for legacy reasons. Altering them will affect test success
 871     // but in time it may be good to rationalise them.
 872     $label = $this->getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel);
 873     $index = $this->getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityTypeID);
 874     $fieldKey = $this->getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityTypeID);
 875
 876     $this->outputSpecification[$index]['header'] = $label;
 877     $this->outputSpecification[$index]['sql_columns'] = $this->getSqlColumnDefinition($fieldKey, $key);
 878
 879     if ($relationshipType && $this->isHouseholdMergeRelationshipTypeKey($relationshipType)) {
 880       $this->setColumnAsCalculationOnly($index);
 881     }
 882     $this->outputSpecification[$index]['metadata'] = $this->getMetaDataForField($key);
 883   }
 884
 885   /**
 886    * Get the metadata for the given field.
 887    *
 888    * @param $key
 889    *
 890    * @return array
 891    */
 892   public function getMetaDataForField($key) {
 893     $mappings = ['contact_id' => 'id'];
 894     if (isset($this->getQueryFields()[$key])) {
 895       return $this->getQueryFields()[$key];
 896     }
 897     if (isset($mappings[$key])) {
 898       return $this->getQueryFields()[$mappings[$key]];
 899     }
 900     return [];
 901   }
 902
 903   /**
 904    * @param $key
 905    */
 906   public function setSqlColumnDefn($key) {
 907     $this->outputSpecification[$this->getMungedFieldName($key)]['sql_columns'] = $this->getSqlColumnDefinition($key, $this->getMungedFieldName($key));
 908   }
 909
 910   /**
 911    * Mark a column as only required for calculations.
 912    *
 913    * Do not include the row with headers.
 914    *
 915    * @param string $column
 916    */
 917   public function setColumnAsCalculationOnly($column) {
 918     $this->outputSpecification[$column]['do_not_output_to_csv'] = TRUE;
 919   }
 920
 921   /**
 922    * @return array
 923    */
 924   public function getHeaderRows() {
 925     $headerRows = [];
 926     foreach ($this->outputSpecification as $key => $spec) {
 927       if (empty($spec['do_not_output_to_csv'])) {
 928         $headerRows[] = $spec['header'];
 929       }
 930     }
 931     return $headerRows;
 932   }
 933
 934   /**
 935    * @return array
 936    */
 937   public function getSQLColumns() {
 938     $sqlColumns = [];
 939     foreach ($this->outputSpecification as $key => $spec) {
 940       if (empty($spec['do_not_output_to_sql'])) {
 941         $sqlColumns[$key] = $spec['sql_columns'];
 942       }
 943     }
 944     return $sqlColumns;
 945   }
 946
 947   /**
 948    * @return array
 949    */
 950   public function getMetadata() {
 951     $metadata = [];
 952     foreach ($this->outputSpecification as $key => $spec) {
 953       $metadata[$key] = $spec['metadata'];
 954     }
 955     return $metadata;
 956   }
 957
 958   /**
 959    * Build the row for output.
 960    *
 961    * @param \CRM_Contact_BAO_Query $query
 962    * @param CRM_Core_DAO $iterationDAO
 963    * @param array $outputColumns
 964    * @param $paymentDetails
 965    * @param $addPaymentHeader
 966    *
 967    * @return array|bool
 968    */
 969   public function buildRow($query, $iterationDAO, $outputColumns, $paymentDetails, $addPaymentHeader) {
 970     $paymentTableId = $this->getPaymentTableID();
 971     if ($this->isHouseholdToSkip($iterationDAO->contact_id)) {
 972       return FALSE;
 973     }
 974     $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
 975
 976     $row = [];
 977     $householdMergeRelationshipType = $this->getHouseholdMergeTypeForRow($iterationDAO->contact_id);
 978     if ($householdMergeRelationshipType) {
 979       $householdID = $this->getRelatedHouseholdID($iterationDAO->contact_id, $householdMergeRelationshipType);
 980       if ($this->isHouseholdExported($householdID)) {
 981         return FALSE;
 982       }
 983       foreach (array_keys($outputColumns) as $column) {
 984         $row[$column] = $this->getRelationshipValue($householdMergeRelationshipType, $iterationDAO->contact_id, $column);
 985       }
 986       $this->markHouseholdExported($householdID);
 987       return $row;
 988     }
 989
 990     $query->convertToPseudoNames($iterationDAO);
 991
 992     //first loop through output columns so that we return what is required, and in same order.
 993     foreach ($outputColumns as $field => $value) {
 994       // add im_provider to $dao object
 995       if ($field == 'im_provider' && property_exists($iterationDAO, 'provider_id')) {
 996         $iterationDAO->im_provider = $iterationDAO->provider_id;
 997       }
 998
 999       //build row values (data)
1000       $fieldValue = NULL;
1001       if (property_exists($iterationDAO, $field)) {
1002         $fieldValue = $iterationDAO->$field;
1003         // to get phone type from phone type id
1004         if ($field == 'provider_id' || $field == 'im_provider') {
1005           $fieldValue = $imProviders[$fieldValue] ?? NULL;
1006         }
1007         elseif (strstr($field, 'master_id')) {
1008           // @todo - why not just $field === 'master_id'  - what else would it be?
1009           $masterAddressId = $iterationDAO->$field ?? NULL;
1010           // get display name of contact that address is shared.
1011           $fieldValue = CRM_Contact_BAO_Contact::getMasterDisplayName($masterAddressId);
1012         }
1013       }
1014
1015       if ($this->isRelationshipTypeKey($field)) {
1016         $this->buildRelationshipFieldsForRow($row, $iterationDAO->contact_id, $value, $field);
1017       }
1018       else {
1019         $row[$field] = $this->getTransformedFieldValue($field, $iterationDAO, $fieldValue, $paymentDetails);
1020       }
1021     }
1022
1023     // If specific payment fields have been selected for export, payment
1024     // data will already be in $row. Otherwise, add payment related
1025     // information, if appropriate.
1026     if ($addPaymentHeader) {
1027       if (!$this->isExportSpecifiedPaymentFields()) {
1028         $nullContributionDetails = array_fill_keys(array_keys($this->getPaymentHeaders()), NULL);
1029         if ($this->isExportPaymentFields()) {
1030           $paymentData = $paymentDetails[$row[$paymentTableId]] ?? NULL;
1031           if (!is_array($paymentData) || empty($paymentData)) {
1032             $paymentData = $nullContributionDetails;
1033           }
1034           $row = array_merge($row, $paymentData);
1035         }
1036         elseif (!empty($paymentDetails)) {
1037           $row = array_merge($row, $nullContributionDetails);
1038         }
1039       }
1040     }
1041     //remove organization name for individuals if it is set for current employer
1042     if (!empty($row['contact_type']) &&
1043       $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)
1044     ) {
1045       $row['organization_name'] = '';
1046     }
1047     return $row;
1048   }
1049
1050   /**
1051    * If this row has a household whose details we should use get the relationship type key.
1052    *
1053    * @param $contactID
1054    *
1055    * @return bool
1056    */
1057   public function getHouseholdMergeTypeForRow($contactID) {
1058     if (!$this->isMergeSameHousehold()) {
1059       return FALSE;
1060     }
1061     foreach ($this->getHouseholdRelationshipTypes() as $relationshipType) {
1062       if (isset($this->relatedContactValues[$relationshipType][$contactID])) {
1063         return $relationshipType;
1064       }
1065     }
1066   }
1067
1068   /**
1069    * Mark the given household as already exported.
1070    *
1071    * @param $householdID
1072    */
1073   public function markHouseholdExported($householdID) {
1074     $this->exportedHouseholds[$householdID] = $householdID;
1075   }
1076
1077   /**
1078    * @param $field
1079    * @param $iterationDAO
1080    * @param $fieldValue
1081    * @param $paymentDetails
1082    *
1083    * @return string
1084    * @throws \CRM_Core_Exception
1085    * @throws \CiviCRM_API3_Exception
1086    */
1087   public function getTransformedFieldValue($field, $iterationDAO, $fieldValue, $paymentDetails) {
1088
1089     $i18n = CRM_Core_I18n::singleton();
1090     if ($field == 'id') {
1091       return $iterationDAO->contact_id;
1092       // special case for calculated field
1093     }
1094     elseif ($field == 'source_contact_id') {
1095       return $iterationDAO->contact_id;
1096     }
1097     elseif ($field == 'pledge_balance_amount') {
1098       return $iterationDAO->pledge_amount - $iterationDAO->pledge_total_paid;
1099       // special case for calculated field
1100     }
1101     elseif ($field == 'pledge_next_pay_amount') {
1102       return $iterationDAO->pledge_next_pay_amount + $iterationDAO->pledge_outstanding_amount;
1103     }
1104     elseif (isset($fieldValue) &&
1105       $fieldValue != ''
1106     ) {
1107       //check for custom data
1108       if ($cfID = CRM_Core_BAO_CustomField::getKeyID($field)) {
1109         $html_type = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $cfID, 'html_type');
1110
1111         //need to calculate the link to the file for file custom data
1112         if ($html_type === 'File' && $fieldValue) {
1113           $result = civicrm_api3('attachment', 'get', ['return' => ['url'], 'id' => $fieldValue]);
1114           return $result['values'][$result['id']]['url'];
1115         }
1116
1117         return CRM_Core_BAO_CustomField::displayValue($fieldValue, $cfID);
1118       }
1119       elseif (in_array($field, [
1120         'email_greeting',
1121         'postal_greeting',
1122         'addressee',
1123       ])) {
1124         //special case for greeting replacement
1125         $fldValue = "{$field}_display";
1126         return $iterationDAO->$fldValue;
1127       }
1128       else {
1129         //normal fields with a touch of CRM-3157
1130         switch ($field) {
1131           case 'country':
1132           case 'world_region':
1133             return $i18n->crm_translate($fieldValue, ['context' => 'country']);
1134
1135           case 'state_province':
1136             return $i18n->crm_translate($fieldValue, ['context' => 'province']);
1137
1138           case 'gender':
1139           case 'preferred_communication_method':
1140           case 'preferred_mail_format':
1141           case 'communication_style':
1142             return $i18n->crm_translate($fieldValue);
1143
1144           default:
1145             $fieldSpec = $this->outputSpecification[$this->getMungedFieldName($field)]['metadata'];
1146             // No I don't know why we do it this way & whether we could
1147             // make better use of pseudoConstants.
1148             if (!empty($fieldSpec['context'])) {
1149               return $i18n->crm_translate($fieldValue, $fieldSpec);
1150             }
1151             if (!empty($fieldSpec['pseudoconstant']) && !empty($fieldSpec['hasLocationType']) && $fieldSpec['name'] !== 'phone_type_id') {
1152               if (!empty($fieldSpec['bao'])) {
1153                 $transformedValue = CRM_Core_PseudoConstant::getLabel($fieldSpec['bao'], $fieldSpec['name'], $fieldValue);
1154                 if ($transformedValue) {
1155                   return $transformedValue;
1156                 }
1157                 return $fieldValue;
1158               }
1159               // Yes - definitely feeling hatred for this bit of code - I know you will beat me up over it's awfulness
1160               // but I have to reach a stable point....
1161               $varName = $fieldSpec['pseudoconstant']['var'];
1162               if ($varName === 'imProviders') {
1163                 return CRM_Core_PseudoConstant::getLabel('CRM_Core_DAO_IM', 'provider_id', $fieldValue);
1164               }
1165             }
1166             return $fieldValue;
1167         }
1168       }
1169     }
1170     elseif ($this->isExportSpecifiedPaymentFields() && array_key_exists($field, $this->getcomponentPaymentFields())) {
1171       $paymentTableId = $this->getPaymentTableID();
1172       $paymentData = $paymentDetails[$iterationDAO->$paymentTableId] ?? NULL;
1173       $payFieldMapper = [
1174         'componentPaymentField_total_amount' => 'total_amount',
1175         'componentPaymentField_contribution_status' => 'contribution_status',
1176         'componentPaymentField_payment_instrument' => 'pay_instru',
1177         'componentPaymentField_transaction_id' => 'trxn_id',
1178         'componentPaymentField_received_date' => 'receive_date',
1179       ];
1180       return CRM_Utils_Array::value($payFieldMapper[$field], $paymentData, '');
1181     }
1182     else {
1183       // if field is empty or null
1184       return '';
1185     }
1186   }
1187
1188   /**
1189    * Get array of fields to return, over & above those defined in the main contact exportable fields.
1190    *
1191    * These include export mode specific fields & some fields apparently required as 'exportableFields'
1192    * but not returned by the function of the same name.
1193    *
1194    * @return array
1195    *   Array of fields to return in the format ['field_name' => 1,...]
1196    */
1197   public function getAdditionalReturnProperties() {
1198     if ($this->getQueryMode() === CRM_Contact_BAO_Query::MODE_CONTACTS) {
1199       $componentSpecificFields = [];
1200     }
1201     else {
1202       $componentSpecificFields = CRM_Contact_BAO_Query::defaultReturnProperties($this->getQueryMode());
1203     }
1204     if ($this->getQueryMode() === CRM_Contact_BAO_Query::MODE_PLEDGE) {
1205       $componentSpecificFields = array_merge($componentSpecificFields, CRM_Pledge_BAO_Query::extraReturnProperties($this->getQueryMode()));
1206       unset($componentSpecificFields['contribution_status_id']);
1207       unset($componentSpecificFields['pledge_status_id']);
1208       unset($componentSpecificFields['pledge_payment_status_id']);
1209     }
1210     if ($this->getQueryMode() === CRM_Contact_BAO_Query::MODE_CASE) {
1211       $componentSpecificFields = array_merge($componentSpecificFields, CRM_Case_BAO_Query::extraReturnProperties($this->getQueryMode()));
1212     }
1213     if ($this->getQueryMode() === CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
1214       $componentSpecificFields = array_merge($componentSpecificFields, CRM_Contribute_BAO_Query::softCreditReturnProperties(TRUE));
1215       unset($componentSpecificFields['contribution_status_id']);
1216     }
1217     return $componentSpecificFields;
1218   }
1219
1220   /**
1221    * Should payment fields be appended to the export.
1222    *
1223    * (This is pretty hacky so hopefully this function won't last long - notice
1224    * how obviously it should be part of the above function!).
1225    */
1226   public function isExportPaymentFields() {
1227     if ($this->getRequestedFields() === NULL
1228       &&  in_array($this->getQueryMode(), [
1229         CRM_Contact_BAO_Query::MODE_EVENT,
1230         CRM_Contact_BAO_Query::MODE_MEMBER,
1231         CRM_Contact_BAO_Query::MODE_PLEDGE,
1232       ])) {
1233       return TRUE;
1234     }
1235     elseif ($this->isExportSpecifiedPaymentFields()) {
1236       return TRUE;
1237     }
1238     return FALSE;
1239   }
1240
1241   /**
1242    * Has specific payment fields been requested (as opposed to via all fields).
1243    *
1244    * If specific fields have been requested then they get added at various points.
1245    *
1246    * @return bool
1247    */
1248   public function isExportSpecifiedPaymentFields() {
1249     if ($this->getRequestedFields() !== NULL && $this->hasRequestedComponentPaymentFields()) {
1250       return TRUE;
1251     }
1252   }
1253
1254   /**
1255    * Get the name of the id field in the table that connects contributions to the export entity.
1256    */
1257   public function getPaymentTableID() {
1258     if ($this->getRequestedFields() === NULL) {
1259       $mapping = [
1260         CRM_Contact_BAO_Query::MODE_EVENT => 'participant_id',
1261         CRM_Contact_BAO_Query::MODE_MEMBER => 'membership_id',
1262         CRM_Contact_BAO_Query::MODE_PLEDGE => 'pledge_payment_id',
1263       ];
1264       return isset($mapping[$this->getQueryMode()]) ? $mapping[$this->getQueryMode()] : '';
1265     }
1266     elseif ($this->hasRequestedComponentPaymentFields()) {
1267       return 'participant_id';
1268     }
1269     return FALSE;
1270   }
1271
1272   /**
1273    * Have component payment fields been requested.
1274    *
1275    * @return bool
1276    */
1277   protected function hasRequestedComponentPaymentFields() {
1278     if ($this->getQueryMode() === CRM_Contact_BAO_Query::MODE_EVENT) {
1279       $participantPaymentFields = array_intersect_key($this->getComponentPaymentFields(), $this->getReturnProperties());
1280       if (!empty($participantPaymentFields)) {
1281         return TRUE;
1282       }
1283     }
1284     return FALSE;
1285   }
1286
1287   /**
1288    * Get fields that indicate payment fields have been requested for a component.
1289    *
1290    * Ideally this should be protected but making it temporarily public helps refactoring..
1291    *
1292    * @return array
1293    */
1294   public function getComponentPaymentFields() {
1295     return [
1296       'componentPaymentField_total_amount' => ['title' => ts('Total Amount'), 'type' => CRM_Utils_Type::T_MONEY],
1297       'componentPaymentField_contribution_status' => ['title' => ts('Contribution Status'), 'type' => CRM_Utils_Type::T_STRING],
1298       'componentPaymentField_received_date' => ['title' => ts('Date Received'), 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME],
1299       'componentPaymentField_payment_instrument' => ['title' => ts('Payment Method'), 'type' => CRM_Utils_Type::T_STRING],
1300       'componentPaymentField_transaction_id' => ['title' => ts('Transaction ID'), 'type' => CRM_Utils_Type::T_STRING],
1301     ];
1302   }
1303
1304   /**
1305    * Get headers for payment fields.
1306    *
1307    * Returns an array of contribution fields when the entity supports payment fields and specific fields
1308    * are not specified. This is a transitional function for refactoring legacy code.
1309    */
1310   public function getPaymentHeaders() {
1311     if ($this->isExportPaymentFields() && !$this->isExportSpecifiedPaymentFields()) {
1312       return CRM_Utils_Array::collect('title', $this->getcomponentPaymentFields());
1313     }
1314     return [];
1315   }
1316
1317   /**
1318    * Get the default properties when not specified.
1319    *
1320    * In the UI this appears as 'Primary fields only' but in practice it's
1321    * most of the kitchen sink and the hallway closet thrown in.
1322    *
1323    * Since CRM-952 custom fields are excluded, but no other form of mercy is shown.
1324    *
1325    * @return array
1326    */
1327   public function getDefaultReturnProperties() {
1328     $returnProperties = [];
1329     $fields = CRM_Contact_BAO_Contact::exportableFields('All', TRUE, TRUE);
1330     $skippedFields = ($this->getQueryMode() === CRM_Contact_BAO_Query::MODE_CONTACTS) ? [] : [
1331       'groups',
1332       'tags',
1333       'notes',
1334     ];
1335
1336     foreach ($fields as $key => $var) {
1337       if ($key && (substr($key, 0, 6) != 'custom') && !in_array($key, $skippedFields)) {
1338         $returnProperties[$key] = 1;
1339       }
1340     }
1341     $returnProperties = array_merge($returnProperties, $this->getAdditionalReturnProperties());
1342     return $returnProperties;
1343   }
1344
1345   /**
1346    * Add the field to relationship return properties & return it.
1347    *
1348    * This function is doing both setting & getting which is yuck but it is an interim
1349    * refactor.
1350    *
1351    * @param array $value
1352    * @param string $relationshipKey
1353    *
1354    * @return array
1355    */
1356   public function setRelationshipReturnProperties($value, $relationshipKey) {
1357     $relationField = $value['name'];
1358     $relIMProviderId = NULL;
1359     $relLocTypeId = $value['location_type_id'] ?? NULL;
1360     $locationName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_Address', 'location_type_id', $relLocTypeId);
1361     $relPhoneTypeId = CRM_Utils_Array::value('phone_type_id', $value, ($locationName ? 'Primary' : NULL));
1362     $relIMProviderId = CRM_Utils_Array::value('im_provider_id', $value, ($locationName ? 'Primary' : NULL));
1363     if (in_array($relationField, $this->getValidLocationFields()) && $locationName) {
1364       if ($relationField === 'phone') {
1365         $this->relationshipReturnProperties[$relationshipKey]['location'][$locationName]['phone-' . $relPhoneTypeId] = 1;
1366       }
1367       elseif ($relationField === 'im') {
1368         $this->relationshipReturnProperties[$relationshipKey]['location'][$locationName]['im-' . $relIMProviderId] = 1;
1369       }
1370       else {
1371         $this->relationshipReturnProperties[$relationshipKey]['location'][$locationName][$relationField] = 1;
1372       }
1373     }
1374     else {
1375       $this->relationshipReturnProperties[$relationshipKey][$relationField] = 1;
1376     }
1377     return $this->relationshipReturnProperties[$relationshipKey];
1378   }
1379
1380   /**
1381    * Add the main return properties to the household merge properties if needed for merging.
1382    *
1383    * If we are using household merge we need to add these to the relationship properties to
1384    * be retrieved.
1385    */
1386   public function setHouseholdMergeReturnProperties() {
1387     if ($this->isMergeSameHousehold()) {
1388       $returnProperties = $this->getReturnProperties();
1389       $returnProperties = array_diff_key($returnProperties, array_fill_keys(['location_type', 'im_provider'], 1));
1390       foreach ($this->getHouseholdRelationshipTypes() as $householdRelationshipType) {
1391         $this->relationshipReturnProperties[$householdRelationshipType] = $returnProperties;
1392       }
1393     }
1394   }
1395
1396   /**
1397    * Get the default location fields to request.
1398    *
1399    * @return array
1400    */
1401   public function getValidLocationFields() {
1402     return [
1403       'street_address',
1404       'supplemental_address_1',
1405       'supplemental_address_2',
1406       'supplemental_address_3',
1407       'city',
1408       'postal_code',
1409       'postal_code_suffix',
1410       'geo_code_1',
1411       'geo_code_2',
1412       'state_province',
1413       'country',
1414       'phone',
1415       'email',
1416       'im',
1417     ];
1418   }
1419
1420   /**
1421    * Get the sql column definition for the given field.
1422    *
1423    * @param string $fieldName
1424    * @param string $columnName
1425    *
1426    * @return mixed
1427    */
1428   public function getSqlColumnDefinition($fieldName, $columnName) {
1429
1430     // early exit for master_id, CRM-12100
1431     // in the DB it is an ID, but in the export, we retrive the display_name of the master record
1432     // also for current_employer, CRM-16939
1433     if ($columnName == 'master_id' || $columnName == 'current_employer') {
1434       return "`$fieldName` varchar(128)";
1435     }
1436
1437     $queryFields = $this->getQueryFields();
1438     // @todo remove the enotice avoidance here, ensure all columns are declared.
1439     // tests will fail on the enotices until they all are & then all the 'else'
1440     // below can go.
1441     $fieldSpec = $queryFields[$columnName] ?? [];
1442
1443     // set the sql columns
1444     if (isset($fieldSpec['type'])) {
1445       switch ($fieldSpec['type']) {
1446         case CRM_Utils_Type::T_INT:
1447         case CRM_Utils_Type::T_BOOLEAN:
1448           if (in_array(CRM_Utils_Array::value('data_type', $fieldSpec), ['Country', 'StateProvince', 'ContactReference'])) {
1449             return "`$fieldName` varchar(255)";
1450           }
1451           return "`$fieldName` varchar(16)";
1452
1453         case CRM_Utils_Type::T_STRING:
1454           if (isset($queryFields[$columnName]['maxlength'])) {
1455             return "`$fieldName` varchar({$queryFields[$columnName]['maxlength']})";
1456           }
1457           else {
1458             return "`$fieldName` varchar(255)";
1459           }
1460
1461         case CRM_Utils_Type::T_TEXT:
1462         case CRM_Utils_Type::T_LONGTEXT:
1463         case CRM_Utils_Type::T_BLOB:
1464         case CRM_Utils_Type::T_MEDIUMBLOB:
1465           return "`$fieldName` longtext";
1466
1467         case CRM_Utils_Type::T_FLOAT:
1468         case CRM_Utils_Type::T_ENUM:
1469         case CRM_Utils_Type::T_DATE:
1470         case CRM_Utils_Type::T_TIME:
1471         case CRM_Utils_Type::T_TIMESTAMP:
1472         case CRM_Utils_Type::T_MONEY:
1473         case CRM_Utils_Type::T_EMAIL:
1474         case CRM_Utils_Type::T_URL:
1475         case CRM_Utils_Type::T_CCNUM:
1476         default:
1477           return "`$fieldName` varchar(32)";
1478       }
1479     }
1480     else {
1481       if (substr($fieldName, -3, 3) == '_id') {
1482         return "`$fieldName` varchar(255)";
1483       }
1484       elseif (substr($fieldName, -5, 5) == '_note') {
1485         return "`$fieldName` text";
1486       }
1487       else {
1488         $changeFields = [
1489           'groups',
1490           'tags',
1491           'notes',
1492         ];
1493
1494         if (in_array($fieldName, $changeFields)) {
1495           return "`$fieldName` text";
1496         }
1497         else {
1498           // set the sql columns for custom data
1499           if (isset($queryFields[$columnName]['data_type'])) {
1500
1501             switch ($queryFields[$columnName]['data_type']) {
1502               case 'String':
1503                 // May be option labels, which could be up to 512 characters
1504                 $length = max(512, CRM_Utils_Array::value('text_length', $queryFields[$columnName]));
1505                 return "`$fieldName` varchar($length)";
1506
1507               case 'Link':
1508                 return "`$fieldName` varchar(255)";
1509
1510               case 'Memo':
1511                 return "`$fieldName` text";
1512
1513               default:
1514                 return "`$fieldName` varchar(255)";
1515             }
1516           }
1517           else {
1518             return "`$fieldName` text";
1519           }
1520         }
1521       }
1522     }
1523   }
1524
1525   /**
1526    * Get the munged field name.
1527    *
1528    * @param string $field
1529    * @return string
1530    */
1531   public function getMungedFieldName($field) {
1532     $fieldName = CRM_Utils_String::munge(strtolower($field), '_', 64);
1533     if ($fieldName == 'id') {
1534       $fieldName = 'civicrm_primary_id';
1535     }
1536     return $fieldName;
1537   }
1538
1539   /**
1540    * In order to respect the history of this class we need to index kinda illogically.
1541    *
1542    * On the bright side - this stuff is tested within a nano-byte of it's life.
1543    *
1544    * e.g '2-a-b_Home-City'
1545    *
1546    * @param string $key
1547    * @param string $relationshipType
1548    * @param string $locationType
1549    * @param $entityLabel
1550    *
1551    * @return string
1552    */
1553   protected function getOutputSpecificationIndex($key, $relationshipType, $locationType, $entityLabel) {
1554     if (!$relationshipType || $key !== 'id') {
1555       $key = $this->getMungedFieldName($key);
1556     }
1557     return $this->getMungedFieldName(
1558       ($relationshipType ? ($relationshipType . '_') : '')
1559       . ($locationType ? ($locationType . '_') : '')
1560       . $key
1561       . ($entityLabel ? ('_' . $entityLabel) : '')
1562     );
1563   }
1564
1565   /**
1566    * Get the compiled label for the column.
1567    *
1568    * e.g 'Gender', 'Employee Of-Home-city'
1569    *
1570    * @param string $key
1571    * @param string $relationshipType
1572    * @param string $locationType
1573    * @param string $entityLabel
1574    *
1575    * @return string
1576    */
1577   protected function getOutputSpecificationLabel($key, $relationshipType, $locationType, $entityLabel) {
1578     return ($relationshipType ? $this->getRelationshipTypes()[$relationshipType] . '-' : '')
1579       . ($locationType ? $locationType . '-' : '')
1580       . $this->getHeaderForRow($key)
1581       . ($entityLabel ? '-' . $entityLabel : '');
1582   }
1583
1584   /**
1585    * Get the mysql field name key.
1586    *
1587    * This key is locked in by tests but the reasons for the specific conventions -
1588    * ie. headings are used for keying fields in some cases, are likely
1589    * accidental rather than deliberate.
1590    *
1591    * This key is used for the output sql array.
1592    *
1593    * @param string $key
1594    * @param $relationshipType
1595    * @param $locationType
1596    * @param $entityLabel
1597    *
1598    * @return string
1599    */
1600   protected function getOutputSpecificationFieldKey($key, $relationshipType, $locationType, $entityLabel) {
1601     if (!$relationshipType || $key !== 'id') {
1602       $key = $this->getMungedFieldName($key);
1603     }
1604     $fieldKey = $this->getMungedFieldName(
1605       ($relationshipType ? ($relationshipType . '_') : '')
1606       . ($locationType ? ($locationType . '_') : '')
1607       . $key
1608       . ($entityLabel ? ('_' . $entityLabel) : '')
1609     );
1610     return $fieldKey;
1611   }
1612
1613   /**
1614    * Get params for the where criteria.
1615    *
1616    * @return mixed
1617    */
1618   public function getWhereParams() {
1619     if (!$this->isPostalableOnly()) {
1620       return [];
1621     }
1622     $params['is_deceased'] = ['is_deceased', '=', 0, CRM_Contact_BAO_Query::MODE_CONTACTS];
1623     $params['do_not_mail'] = ['do_not_mail', '=', 0, CRM_Contact_BAO_Query::MODE_CONTACTS];
1624     return $params;
1625   }
1626
1627   /**
1628    * @param $row
1629    * @param $contactID
1630    * @param $value
1631    * @param $field
1632    */
1633   protected function buildRelationshipFieldsForRow(&$row, $contactID, $value, $field) {
1634     foreach (array_keys($value) as $property) {
1635       if ($property === 'location') {
1636         // @todo just undo all this nasty location wrangling!
1637         foreach ($value['location'] as $locationKey => $locationFields) {
1638           foreach (array_keys($locationFields) as $locationField) {
1639             $fieldKey = str_replace(' ', '_', $locationKey . '-' . $locationField);
1640             $row[$field . '_' . $fieldKey] = $this->getRelationshipValue($field, $contactID, $fieldKey);
1641           }
1642         }
1643       }
1644       else {
1645         $row[$field . '_' . $property] = $this->getRelationshipValue($field, $contactID, $property);
1646       }
1647     }
1648   }
1649
1650   /**
1651    * Is this contact a household that is already set to be exported by virtue of it's household members.
1652    *
1653    * @param int $contactID
1654    *
1655    * @return bool
1656    */
1657   protected function isHouseholdToSkip($contactID) {
1658     return in_array($contactID, $this->householdsToSkip);
1659   }
1660
1661   /**
1662    * Get the various arrays that we use to structure our output.
1663    *
1664    * The extraction of these has been moved to a separate function for clarity and so that
1665    * tests can be added - in particular on the $outputHeaders array.
1666    *
1667    * However it still feels a bit like something that I'm too polite to write down and this should be seen
1668    * as a step on the refactoring path rather than how it should be.
1669    *
1670    * @return array
1671    *   - outputColumns Array of columns to be exported. The values don't matter but the key must match the
1672    *   alias for the field generated by BAO_Query object.
1673    *   - headerRows Array of the column header strings to put in the csv header - non-associative.
1674    *   - sqlColumns Array of column names for the temp table. Not too sure why outputColumns can't be used here.
1675    *   - metadata Array of fields with specific parameters to pass to the translate function or another hacky nasty solution
1676    *    I'm too embarassed to discuss here.
1677    *    The keys need
1678    *    - to match the outputColumns keys (yes, the fact we ignore the output columns values & then pass another array with values
1679    *    we could use does suggest further refactors. However, you future improver, do remember that every check you do
1680    *    in the main DAO loop is done once per row & that coule be 100,000 times.)
1681    *    Finally a pop quiz: We need the translate context because we use a function other than ts() - is this because
1682    *    - a) the function used is more efficient or
1683    *    - b) this code is old & outdated. Submit your answers to circular bin or better
1684    *       yet find a way to comment them for posterity.
1685    */
1686   public function getExportStructureArrays() {
1687     $outputColumns = [];
1688     $queryFields = $this->getQueryFields();
1689     foreach ($this->getReturnProperties() as $key => $value) {
1690       if (($key != 'location' || !is_array($value)) && !$this->isRelationshipTypeKey($key)) {
1691         $outputColumns[$key] = $value;
1692         $this->addOutputSpecification($key);
1693       }
1694       elseif ($this->isRelationshipTypeKey($key)) {
1695         $outputColumns[$key] = $value;
1696         foreach ($value as $relationField => $relationValue) {
1697           // below block is same as primary block (duplicate)
1698           if (isset($queryFields[$relationField]['title'])) {
1699             $this->addOutputSpecification($relationField, $key);
1700           }
1701           elseif (is_array($relationValue) && $relationField == 'location') {
1702             // fix header for location type case
1703             foreach ($relationValue as $ltype => $val) {
1704               foreach (array_keys($val) as $fld) {
1705                 $type = explode('-', $fld);
1706                 $this->addOutputSpecification($type[0], $key, $ltype, CRM_Utils_Array::value(1, $type));
1707               }
1708             }
1709           }
1710         }
1711       }
1712       else {
1713         foreach ($value as $locationType => $locationFields) {
1714           foreach (array_keys($locationFields) as $locationFieldName) {
1715             $type = explode('-', $locationFieldName);
1716
1717             $actualDBFieldName = $type[0];
1718             $daoFieldName = CRM_Utils_String::munge($locationType) . '-' . $actualDBFieldName;
1719
1720             if (!empty($type[1])) {
1721               $daoFieldName .= "-" . $type[1];
1722             }
1723             $this->addOutputSpecification($actualDBFieldName, NULL, $locationType, CRM_Utils_Array::value(1, $type));
1724             $outputColumns[$daoFieldName] = TRUE;
1725           }
1726         }
1727       }
1728     }
1729     return [$outputColumns];
1730   }
1731
1732   /**
1733    * Get default return property for export based on mode
1734    *
1735    * @return string
1736    *   Default Return property
1737    */
1738   public function defaultReturnProperty() {
1739     // hack to add default return property based on export mode
1740     $property = NULL;
1741     $exportMode = $this->getExportMode();
1742     if ($exportMode == CRM_Export_Form_Select::CONTRIBUTE_EXPORT) {
1743       $property = 'contribution_id';
1744     }
1745     elseif ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
1746       $property = 'participant_id';
1747     }
1748     elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
1749       $property = 'membership_id';
1750     }
1751     elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
1752       $property = 'pledge_id';
1753     }
1754     elseif ($exportMode == CRM_Export_Form_Select::CASE_EXPORT) {
1755       $property = 'case_id';
1756     }
1757     elseif ($exportMode == CRM_Export_Form_Select::GRANT_EXPORT) {
1758       $property = 'grant_id';
1759     }
1760     elseif ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
1761       $property = 'activity_id';
1762     }
1763     return $property;
1764   }
1765
1766   /**
1767    * Determine the required return properties from the input parameters.
1768    *
1769    * @return array
1770    */
1771   public function determineReturnProperties() {
1772     if ($this->getRequestedFields()) {
1773       $returnProperties = [];
1774       foreach ($this->getRequestedFields() as $key => $value) {
1775         $fieldName = $value['name'];
1776         $locationName = !empty($value['location_type_id']) ? CRM_Core_PseudoConstant::getName('CRM_Core_BAO_Address', 'location_type_id', $value['location_type_id']) : NULL;
1777         $relationshipTypeKey = !empty($value['relationship_type_id']) ? $value['relationship_type_id'] . '_' . $value['relationship_direction'] : NULL;
1778         if (!$fieldName || $this->isHouseholdMergeRelationshipTypeKey($relationshipTypeKey)) {
1779           continue;
1780         }
1781
1782         if ($this->isRelationshipTypeKey($relationshipTypeKey)) {
1783           $returnProperties[$relationshipTypeKey] = $this->setRelationshipReturnProperties($value, $relationshipTypeKey);
1784         }
1785         elseif ($locationName) {
1786           if ($fieldName === 'phone') {
1787             $returnProperties['location'][$locationName]['phone-' . $value['phone_type_id'] ?? NULL] = 1;
1788           }
1789           elseif ($fieldName === 'im') {
1790             $returnProperties['location'][$locationName]['im-' . $value['im_provider_id'] ?? NULL] = 1;
1791           }
1792           else {
1793             $returnProperties['location'][$locationName][$fieldName] = 1;
1794           }
1795         }
1796         else {
1797           //hack to fix component fields
1798           //revert mix of event_id and title
1799           if ($fieldName == 'event_id') {
1800             $returnProperties['event_id'] = 1;
1801           }
1802           else {
1803             $returnProperties[$fieldName] = 1;
1804           }
1805         }
1806       }
1807       $defaultExportMode = $this->defaultReturnProperty();
1808       if ($defaultExportMode) {
1809         $returnProperties[$defaultExportMode] = 1;
1810       }
1811     }
1812     else {
1813       $returnProperties = $this->getDefaultReturnProperties();
1814     }
1815     if ($this->isMergeSameHousehold()) {
1816       $returnProperties['id'] = 1;
1817     }
1818     if ($this->isMergeSameAddress()) {
1819       $returnProperties['addressee'] = 1;
1820       $returnProperties['postal_greeting'] = 1;
1821       $returnProperties['email_greeting'] = 1;
1822       $returnProperties['street_name'] = 1;
1823       $returnProperties['household_name'] = 1;
1824       $returnProperties['street_address'] = 1;
1825       $returnProperties['city'] = 1;
1826       $returnProperties['state_province'] = 1;
1827
1828     }
1829     return $returnProperties;
1830   }
1831
1832   /**
1833    * @param object $query
1834    *   CRM_Contact_BAO_Query
1835    *
1836    * @return string
1837    *   Group By Clause
1838    */
1839   public function getGroupBy($query) {
1840     $groupBy = NULL;
1841     $returnProperties = $this->getReturnProperties();
1842     $exportMode = $this->getExportMode();
1843     $queryMode = $this->getQueryMode();
1844     if (!empty($returnProperties['tags']) || !empty($returnProperties['groups']) ||
1845       CRM_Utils_Array::value('notes', $returnProperties) ||
1846       // CRM-9552
1847       ($queryMode & CRM_Contact_BAO_Query::MODE_CONTACTS && $query->_useGroupBy)
1848     ) {
1849       $groupBy = "contact_a.id";
1850     }
1851
1852     switch ($exportMode) {
1853       case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
1854         $groupBy = 'civicrm_contribution.id';
1855         if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
1856           // especial group by  when soft credit columns are included
1857           $groupBy = ['contribution_search_scredit_combined.id', 'contribution_search_scredit_combined.scredit_id'];
1858         }
1859         break;
1860
1861       case CRM_Export_Form_Select::EVENT_EXPORT:
1862         $groupBy = 'civicrm_participant.id';
1863         break;
1864
1865       case CRM_Export_Form_Select::MEMBER_EXPORT:
1866         $groupBy = "civicrm_membership.id";
1867         break;
1868     }
1869
1870     if ($queryMode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
1871       $groupBy = "civicrm_activity.id ";
1872     }
1873
1874     return $groupBy ? ' GROUP BY ' . implode(', ', (array) $groupBy) : '';
1875   }
1876
1877   /**
1878    * @param int $contactId
1879    *
1880    * @return array
1881    */
1882   public function replaceMergeTokens($contactId) {
1883     $greetings = [];
1884     $contact = NULL;
1885
1886     $greetingFields = [
1887       'postal_greeting' => $this->getPostalGreetingTemplate(),
1888       'addressee' => $this->getAddresseeGreetingTemplate(),
1889     ];
1890     foreach ($greetingFields as $greeting => $greetingLabel) {
1891       $tokens = CRM_Utils_Token::getTokens($greetingLabel);
1892       if (!empty($tokens)) {
1893         if (empty($contact)) {
1894           $values = [
1895             'id' => $contactId,
1896             'version' => 3,
1897           ];
1898           $contact = civicrm_api('contact', 'get', $values);
1899
1900           if (!empty($contact['is_error'])) {
1901             return $greetings;
1902           }
1903           $contact = $contact['values'][$contact['id']];
1904         }
1905
1906         $tokens = ['contact' => $greetingLabel];
1907         $greetings[$greeting] = CRM_Utils_Token::replaceContactTokens($greetingLabel, $contact, NULL, $tokens);
1908       }
1909     }
1910     return $greetings;
1911   }
1912
1913   /**
1914    * Build array for merging same addresses.
1915    *
1916    * @param string $sql
1917    */
1918   public function buildMasterCopyArray($sql) {
1919
1920     $parents = [];
1921     $dao = CRM_Core_DAO::executeQuery($sql);
1922
1923     while ($dao->fetch()) {
1924       $masterID = $dao->master_id;
1925       $copyID = $dao->copy_id;
1926
1927       $this->cacheContactGreetings((int) $dao->master_contact_id);
1928       $this->cacheContactGreetings((int) $dao->copy_contact_id);
1929
1930       if (!isset($this->contactsToMerge[$masterID])) {
1931         // check if this is an intermediate child
1932         // this happens if there are 3 or more matches a,b, c
1933         // the above query will return a, b / a, c / b, c
1934         // we might be doing a bit more work, but for now its ok, unless someone
1935         // knows how to fix the query above
1936         if (isset($parents[$masterID])) {
1937           $masterID = $parents[$masterID];
1938         }
1939         else {
1940           $this->contactsToMerge[$masterID] = [
1941             'addressee' => $this->getContactGreeting((int) $dao->master_contact_id, 'addressee', $dao->master_addressee),
1942             'copy' => [],
1943             'postalGreeting' => $this->getContactGreeting((int) $dao->master_contact_id, 'postal_greeting', $dao->master_postal_greeting),
1944           ];
1945           $this->contactsToMerge[$masterID]['emailGreeting'] = &$this->contactsToMerge[$masterID]['postalGreeting'];
1946         }
1947       }
1948       $parents[$copyID] = $masterID;
1949
1950       if (!array_key_exists($copyID, $this->contactsToMerge[$masterID]['copy'])) {
1951         $copyPostalGreeting = $this->getContactPortionOfGreeting((int) $dao->copy_contact_id, (int) $dao->copy_postal_greeting_id, 'postal_greeting', $dao->copy_postal_greeting);
1952         if ($copyPostalGreeting) {
1953           $this->contactsToMerge[$masterID]['postalGreeting'] = "{$this->contactsToMerge[$masterID]['postalGreeting']}, {$copyPostalGreeting}";
1954           // if there happens to be a duplicate, remove it
1955           $this->contactsToMerge[$masterID]['postalGreeting'] = str_replace(" {$copyPostalGreeting},", "", $this->contactsToMerge[$masterID]['postalGreeting']);
1956         }
1957
1958         $copyAddressee = $this->getContactPortionOfGreeting((int) $dao->copy_contact_id, (int) $dao->copy_addressee_id, 'addressee', $dao->copy_addressee);
1959         if ($copyAddressee) {
1960           $this->contactsToMerge[$masterID]['addressee'] = "{$this->contactsToMerge[$masterID]['addressee']}, " . trim($copyAddressee);
1961         }
1962       }
1963       if (!isset($this->contactsToMerge[$masterID]['copy'][$copyID])) {
1964         // If it was set in the first run through - share routine, don't subsequently clobber.
1965         $this->contactsToMerge[$masterID]['copy'][$copyID] = $copyAddressee ?? $dao->copy_addressee;
1966       }
1967     }
1968   }
1969
1970   /**
1971    * Merge contacts with the same address.
1972    */
1973   public function mergeSameAddress() {
1974
1975     $tableName = $this->getTemporaryTable();
1976
1977     // find all the records that have the same street address BUT not in a household
1978     // require match on city and state as well
1979     $sql = "
1980 SELECT    r1.id                 as master_id,
1981           r1.civicrm_primary_id as master_contact_id,
1982           r1.postal_greeting    as master_postal_greeting,
1983           r1.postal_greeting_id as master_postal_greeting_id,
1984           r1.addressee          as master_addressee,
1985           r1.addressee_id       as master_addressee_id,
1986           r2.id                 as copy_id,
1987           r2.civicrm_primary_id as copy_contact_id,
1988           r2.postal_greeting    as copy_postal_greeting,
1989           r2.postal_greeting_id as copy_postal_greeting_id,
1990           r2.addressee          as copy_addressee,
1991           r2.addressee_id       as copy_addressee_id
1992 FROM      $tableName r1
1993 LEFT JOIN $tableName r2 ON ( r1.street_address = r2.street_address AND
1994           r1.city = r2.city AND
1995           r1.state_province_id = r2.state_province_id )
1996 WHERE ( r1.street_address != '' )
1997 AND       r2.id > r1.id
1998 ORDER BY  r1.id
1999 ";
2000     $this->buildMasterCopyArray($sql);
2001
2002     foreach ($this->contactsToMerge as $masterID => $values) {
2003       $sql = "
2004 UPDATE $tableName
2005 SET    addressee = %1, postal_greeting = %2, email_greeting = %3
2006 WHERE  id = %4
2007 ";
2008       $params = [
2009         1 => [$values['addressee'], 'String'],
2010         2 => [$values['postalGreeting'], 'String'],
2011         3 => [$values['emailGreeting'], 'String'],
2012         4 => [$masterID, 'Integer'],
2013       ];
2014       CRM_Core_DAO::executeQuery($sql, $params);
2015
2016       // delete all copies
2017       $deleteIDs = array_keys($values['copy']);
2018       $deleteIDString = implode(',', $deleteIDs);
2019       $sql = "
2020 DELETE FROM $tableName
2021 WHERE  id IN ( $deleteIDString )
2022 ";
2023       CRM_Core_DAO::executeQuery($sql);
2024     }
2025   }
2026
2027   /**
2028    * The function unsets static part of the string, if token is the dynamic part.
2029    *
2030    * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
2031    * i.e 'Hello Alan' => converted to => 'Alan'
2032    *
2033    * @param string $parsedString
2034    * @param string $defaultGreeting
2035    * @param string $greetingLabel
2036    *
2037    * @return mixed
2038    */
2039   public function trimNonTokensFromAddressString(
2040     &$parsedString, $defaultGreeting,
2041     $greetingLabel
2042   ) {
2043     $greetingLabel = empty($greetingLabel) ? $defaultGreeting : $greetingLabel;
2044
2045     $stringsToBeReplaced = preg_replace('/(\{[a-zA-Z._ ]+\})/', ';;', $greetingLabel);
2046     $stringsToBeReplaced = explode(';;', $stringsToBeReplaced);
2047     foreach ($stringsToBeReplaced as $key => $string) {
2048       // to keep one space
2049       $stringsToBeReplaced[$key] = ltrim($string);
2050     }
2051     $parsedString = str_replace($stringsToBeReplaced, "", $parsedString);
2052
2053     return $parsedString;
2054   }
2055
2056   /**
2057    * Preview export output.
2058    *
2059    * @param int $limit
2060    * @return array
2061    */
2062   public function getPreview($limit) {
2063     $rows = [];
2064     list($outputColumns) = $this->getExportStructureArrays();
2065     $query = $this->runQuery([], '');
2066     CRM_Core_DAO::disableFullGroupByMode();
2067     $result = CRM_Core_DAO::executeQuery($query[1] . ' LIMIT ' . (int) $limit);
2068     CRM_Core_DAO::reenableFullGroupByMode();
2069     while ($result->fetch()) {
2070       $rows[] = $this->buildRow($query[0], $result, $outputColumns, [], []);
2071     }
2072     return $rows;
2073   }
2074
2075   /**
2076    * Set the template strings to be used when merging two contacts with the same address.
2077    *
2078    * @param array $formValues
2079    *   Values from first form. In this case we care about the keys
2080    *   - postal_greeting
2081    *   - postal_other
2082    *   - address_greeting
2083    *   - addressee_other
2084    *
2085    * @return mixed
2086    */
2087   protected function setGreetingStringsForSameAddressMerge($formValues) {
2088     $greetingOptions = CRM_Export_Form_Select::getGreetingOptions();
2089
2090     if (!empty($greetingOptions)) {
2091       // Greeting options is keyed by 'postal_greeting' or 'addressee'.
2092       foreach ($greetingOptions as $key => $value) {
2093         $option = $formValues[$key] ?? NULL;
2094         if ($option) {
2095           if ($greetingOptions[$key][$option] == ts('Other')) {
2096             $formValues[$key] = $formValues["{$key}_other"];
2097           }
2098           elseif ($greetingOptions[$key][$option] == ts('List of names')) {
2099             $formValues[$key] = '';
2100           }
2101           else {
2102             $formValues[$key] = $greetingOptions[$key][$option];
2103           }
2104         }
2105       }
2106     }
2107     if (!empty($formValues['postal_greeting'])) {
2108       $this->setPostalGreetingTemplate($formValues['postal_greeting']);
2109     }
2110     if (!empty($formValues['addressee'])) {
2111       $this->setAddresseeGreetingTemplate($formValues['addressee']);
2112     }
2113   }
2114
2115   /**
2116    * Create the temporary table for output.
2117    */
2118   public function createTempTable() {
2119     //creating a temporary table for the search result that need be exported
2120     $exportTempTable = CRM_Utils_SQL_TempTable::build()->setDurable()->setCategory('export');
2121     $sqlColumns = $this->getSQLColumns();
2122     // also create the sql table
2123     $exportTempTable->drop();
2124
2125     $sql = " id int unsigned NOT NULL AUTO_INCREMENT, ";
2126     if (!empty($sqlColumns)) {
2127       $sql .= implode(",\n", array_values($sqlColumns)) . ',';
2128     }
2129
2130     $sql .= "\n PRIMARY KEY ( id )";
2131
2132     // add indexes for street_address and household_name if present
2133     $addIndices = [
2134       'street_address',
2135       'household_name',
2136       'civicrm_primary_id',
2137     ];
2138
2139     foreach ($addIndices as $index) {
2140       if (isset($sqlColumns[$index])) {
2141         $sql .= ",
2142   INDEX index_{$index}( $index )
2143 ";
2144       }
2145     }
2146
2147     $exportTempTable->createWithColumns($sql);
2148     $this->setTemporaryTable($exportTempTable->getName());
2149   }
2150
2151   /**
2152    * Get the values of linked household contact.
2153    *
2154    * @param CRM_Core_DAO $relDAO
2155    * @param array $value
2156    * @param string $field
2157    * @param array $row
2158    *
2159    * @throws \Exception
2160    */
2161   public function fetchRelationshipDetails($relDAO, $value, $field, &$row) {
2162     $phoneTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
2163     $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
2164     $i18n = CRM_Core_I18n::singleton();
2165     $field = $field . '_';
2166
2167     foreach ($value as $relationField => $relationValue) {
2168       if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
2169         $fieldValue = $relDAO->$relationField;
2170         if ($relationField == 'provider_id') {
2171           $fieldValue = $imProviders[$relationValue] ?? NULL;
2172         }
2173         // CRM-13995
2174         elseif (is_object($relDAO) && in_array($relationField, [
2175           'email_greeting',
2176           'postal_greeting',
2177           'addressee',
2178         ])) {
2179           //special case for greeting replacement
2180           $fldValue = "{$relationField}_display";
2181           $fieldValue = $relDAO->$fldValue;
2182         }
2183       }
2184       elseif (is_object($relDAO) && $relationField == 'state_province') {
2185         $fieldValue = CRM_Core_PseudoConstant::stateProvince($relDAO->state_province_id);
2186       }
2187       elseif (is_object($relDAO) && $relationField == 'country') {
2188         $fieldValue = CRM_Core_PseudoConstant::country($relDAO->country_id);
2189       }
2190       else {
2191         $fieldValue = '';
2192       }
2193       $relPrefix = $field . $relationField;
2194
2195       if (is_object($relDAO) && $relationField == 'id') {
2196         $row[$relPrefix] = $relDAO->contact_id;
2197       }
2198       elseif (is_array($relationValue) && $relationField == 'location') {
2199         foreach ($relationValue as $ltype => $val) {
2200           // If the location name has a space in it the we need to handle that. This
2201           // is kinda hacky but specifically covered in the ExportTest so later efforts to
2202           // improve it should be secure in the knowled it will be caught.
2203           $ltype = str_replace(' ', '_', $ltype);
2204           foreach (array_keys($val) as $fld) {
2205             $type = explode('-', $fld);
2206             $fldValue = "{$ltype}-" . $type[0];
2207             if (!empty($type[1])) {
2208               $fldValue .= "-" . $type[1];
2209             }
2210             // CRM-3157: localise country, region (both have ‘country’ context)
2211             // and state_province (‘province’ context)
2212             switch (TRUE) {
2213               case (!is_object($relDAO)):
2214                 $row[$field . '_' . $fldValue] = '';
2215                 break;
2216
2217               case in_array('country', $type):
2218               case in_array('world_region', $type):
2219                 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2220                   ['context' => 'country']
2221                 );
2222                 break;
2223
2224               case in_array('state_province', $type):
2225                 $row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->$fldValue,
2226                   ['context' => 'province']
2227                 );
2228                 break;
2229
2230               default:
2231                 $row[$field . '_' . $fldValue] = $relDAO->$fldValue;
2232                 break;
2233             }
2234           }
2235         }
2236       }
2237       elseif (isset($fieldValue) && $fieldValue != '') {
2238         //check for custom data
2239         if ($cfID = CRM_Core_BAO_CustomField::getKeyID($relationField)) {
2240           $row[$relPrefix] = CRM_Core_BAO_CustomField::displayValue($fieldValue, $cfID);
2241         }
2242         else {
2243           //normal relationship fields
2244           // CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
2245           switch ($relationField) {
2246             case 'country':
2247             case 'world_region':
2248               $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'country']);
2249               break;
2250
2251             case 'state_province':
2252               $row[$relPrefix] = $i18n->crm_translate($fieldValue, ['context' => 'province']);
2253               break;
2254
2255             default:
2256               $row[$relPrefix] = $fieldValue;
2257               break;
2258           }
2259         }
2260       }
2261       else {
2262         // if relation field is empty or null
2263         $row[$relPrefix] = '';
2264       }
2265     }
2266   }
2267
2268   /**
2269    * Write to the csv from the temp table.
2270    */
2271   public function writeCSVFromTable() {
2272     // call export hook
2273     $headerRows = $this->getHeaderRows();
2274     $exportTempTable = $this->getTemporaryTable();
2275     $exportMode = $this->getExportMode();
2276     $sqlColumns = $this->getSQLColumns();
2277     $componentTable = $this->getComponentTable();
2278     $ids = $this->getIds();
2279     CRM_Utils_Hook::export($exportTempTable, $headerRows, $sqlColumns, $exportMode, $componentTable, $ids);
2280     if ($exportMode !== $this->getExportMode() || $componentTable !== $this->getComponentTable()) {
2281       CRM_Core_Error::deprecatedFunctionWarning('altering the export mode and/or component table in the hook is no longer supported.');
2282     }
2283     if ($ids !== $this->getIds()) {
2284       CRM_Core_Error::deprecatedFunctionWarning('altering the ids in the hook is no longer supported.');
2285     }
2286     if ($exportTempTable !== $this->getTemporaryTable()) {
2287       CRM_Core_Error::deprecatedFunctionWarning('altering the export table in the hook is deprecated (in some flows the table itself will be)');
2288       $this->setTemporaryTable($exportTempTable);
2289     }
2290     $exportTempTable = $this->getTemporaryTable();
2291     $writeHeader = TRUE;
2292     $offset = 0;
2293     // increase this number a lot to avoid making too many queries
2294     // LIMIT is not much faster than a no LIMIT query
2295     // CRM-7675
2296     $limit = 100000;
2297
2298     $query = "SELECT * FROM $exportTempTable";
2299
2300     $this->instantiateTempTable($headerRows);
2301     while (1) {
2302       $limitQuery = $query . "
2303 LIMIT $offset, $limit
2304 ";
2305       $dao = CRM_Core_DAO::executeQuery($limitQuery);
2306
2307       if ($dao->N <= 0) {
2308         break;
2309       }
2310
2311       $componentDetails = [];
2312       while ($dao->fetch()) {
2313         $row = [];
2314
2315         foreach (array_keys($sqlColumns) as $column) {
2316           $row[$column] = $dao->$column;
2317         }
2318         $componentDetails[] = $row;
2319       }
2320       $this->writeRows($headerRows, $componentDetails);
2321
2322       $offset += $limit;
2323     }
2324   }
2325
2326   /**
2327    * Set up the temp table.
2328    *
2329    * @param array $headerRows
2330    */
2331   protected function instantiateTempTable(array $headerRows) {
2332     CRM_Utils_System::download(CRM_Utils_String::munge($this->getExportFileName()),
2333       'text/x-csv',
2334       CRM_Core_DAO::$_nullObject,
2335       'csv',
2336       FALSE
2337     );
2338     // Output UTF BOM so that MS Excel copes with diacritics. This is recommended as
2339     // the Windows variant but is tested with MS Excel for Mac (Office 365 v 16.31)
2340     // and it continues to work on Libre Office, Numbers, Notes etc.
2341     echo "\xEF\xBB\xBF";
2342     CRM_Core_Report_Excel::makeCSVTable($headerRows, [], TRUE);
2343   }
2344
2345   /**
2346    * Write rows to the csv.
2347    *
2348    * @param array $headerRows
2349    * @param array $rows
2350    */
2351   protected function writeRows(array $headerRows, array $rows) {
2352     if (!empty($rows)) {
2353       CRM_Core_Report_Excel::makeCSVTable($headerRows, $rows, FALSE);
2354     }
2355   }
2356
2357   /**
2358    * Cache the greeting fields for the given contact.
2359    *
2360    * @param int $contactID
2361    */
2362   protected function cacheContactGreetings(int $contactID) {
2363     if (!isset($this->contactGreetingFields[$contactID])) {
2364       $this->contactGreetingFields[$contactID] = $this->replaceMergeTokens($contactID);
2365     }
2366   }
2367
2368   /**
2369    * Get the greeting value for the given contact.
2370    *
2371    * The values have already been cached so we are grabbing the value at this point.
2372    *
2373    * @param int $contactID
2374    * @param string $type
2375    *   postal_greeting|addressee|email_greeting
2376    * @param string $default
2377    *
2378    * @return string
2379    */
2380   protected function getContactGreeting(int $contactID, string $type, string $default) {
2381     return CRM_Utils_Array::value($type,
2382       $this->contactGreetingFields[$contactID], $default
2383     );
2384   }
2385
2386   /**
2387    * Get the portion of the greeting string that relates to the contact.
2388    *
2389    * For example if the greeting id 'Dear Sarah' we are going to combine it with 'Dear Mike'
2390    * so we want to strip the 'Dear ' and just get 'Sarah
2391    * @param int $contactID
2392    * @param int $greetingID
2393    * @param string $type
2394    *   postal_greeting, addressee (email_greeting not currently implemented for unknown reasons.
2395    * @param string $defaultGreeting
2396    *
2397    * @return mixed|string
2398    */
2399   protected function getContactPortionOfGreeting(int $contactID, int $greetingID, string $type, string $defaultGreeting) {
2400     $copyPostalGreeting = $this->getContactGreeting($contactID, $type, $defaultGreeting);
2401     $template = $type === 'postal_greeting' ? $this->getPostalGreetingTemplate() : $this->getAddresseeGreetingTemplate();
2402     if ($copyPostalGreeting) {
2403       $copyPostalGreeting = $this->trimNonTokensFromAddressString($copyPostalGreeting,
2404         $this->greetingOptions[$type][$greetingID],
2405         $template
2406       );
2407     }
2408     return $copyPostalGreeting;
2409   }
2410
2411 }