CRM/Report/Form.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  * Class CRM_Report_Form
  30  */
  31 class CRM_Report_Form extends CRM_Core_Form {
  32   const ROW_COUNT_LIMIT = 50;
  33
  34   /**
  35    * Operator types - used for displaying filter elements
  36    */
  37   const
  38     OP_INT = 1,
  39     OP_STRING = 2,
  40     OP_DATE = 4,
  41     OP_DATETIME = 5,
  42     OP_FLOAT = 8,
  43     OP_SELECT = 64,
  44     OP_MULTISELECT = 65,
  45     OP_MULTISELECT_SEPARATOR = 66,
  46     OP_MONTH = 128,
  47     OP_ENTITYREF = 256;
  48
  49   /**
  50    * The id of the report instance
  51    *
  52    * @var integer
  53    */
  54   protected $_id;
  55
  56   /**
  57    * The id of the report template
  58    *
  59    * @var integer;
  60    */
  61   protected $_templateID;
  62
  63   /**
  64    * The report title
  65    *
  66    * @var string
  67    */
  68   protected $_title;
  69   protected $_noFields = FALSE;
  70
  71   /**
  72    * The set of all columns in the report. An associative array
  73    * with column name as the key and attributes as the value
  74    *
  75    * @var array
  76    */
  77   protected $_columns = array();
  78
  79   /**
  80    * The set of filters in the report
  81    *
  82    * @var array
  83    */
  84   protected $_filters = array();
  85
  86   /**
  87    * The set of optional columns in the report
  88    *
  89    * @var array
  90    */
  91   public $_options = array();
  92
  93   /**
  94    * By default most reports hide contact id.
  95    * Setting this to true makes it available
  96    */
  97   protected $_exposeContactID = TRUE;
  98
  99   /**
 100    * Set of statistic fields
 101    *
 102    * @var array
 103    */
 104   protected $_statFields = array();
 105
 106   /**
 107    * Set of statistics data
 108    *
 109    * @var array
 110    */
 111   protected $_statistics = array();
 112
 113   /**
 114    * List of fields not to be repeated during display
 115    *
 116    * @var array
 117    */
 118   protected $_noRepeats = array();
 119
 120   /**
 121    * List of fields not to be displayed
 122    *
 123    * @var array
 124    */
 125   protected $_noDisplay = array();
 126
 127   /**
 128    * Object type that a custom group extends
 129    *
 130    * @var null
 131    */
 132   protected $_customGroupExtends = NULL;
 133   protected $_customGroupExtendsJoin = array();
 134   protected $_customGroupFilters = TRUE;
 135   protected $_customGroupGroupBy = FALSE;
 136   protected $_customGroupJoin = 'LEFT JOIN';
 137
 138   /**
 139    * Build tags filter
 140    */
 141   protected $_tagFilter = FALSE;
 142
 143   /**
 144    * specify entity table for tags filter
 145    */
 146   protected $_tagFilterTable = 'civicrm_contact';
 147
 148   /**
 149    * Build groups filter.
 150    *
 151    * @var bool
 152    */
 153   protected $_groupFilter = FALSE;
 154
 155   /**
 156    * Has the report been optimised for group filtering.
 157    *
 158    * The functionality for group filtering has been improved but not
 159    * all reports have been adjusted to take care of it.
 160    *
 161    * This property exists to highlight the reports which are still using the
 162    * slow method & allow group filtering to still work for them until they
 163    * can be migrated.
 164    *
 165    * In order to protect extensions we have to default to TRUE - but I have
 166    * separately marked every class with a groupFilter in the hope that will trigger
 167    * people to fix them as they touch them.
 168    *
 169    * CRM-19170
 170    *
 171    * @var bool
 172    */
 173   protected $groupFilterNotOptimised = TRUE;
 174
 175   /**
 176    * Navigation fields
 177    *
 178    * @var array
 179    */
 180   public $_navigation = array();
 181
 182   public $_drilldownReport = array();
 183
 184   /**
 185    * Array of tabs to display on report.
 186    *
 187    * E.g we define the tab title, the tpl and the tab-specific part of the css or  html link.
 188    *
 189    *  $this->tabs['OrderBy'] = array(
 190    *    'title' => ts('Sorting'),
 191    *    'tpl' => 'OrderBy',
 192    *    'div_label' => 'order-by',
 193    *  );
 194    *
 195    * @var array
 196    */
 197   protected $tabs = array();
 198
 199   /**
 200    * Should we add paging.
 201    *
 202    * @var bool
 203    */
 204   protected $addPaging = TRUE;
 205
 206   protected $isForceGroupBy = FALSE;
 207
 208   protected $groupConcatTested = FALSE;
 209
 210   /**
 211    * An attribute for checkbox/radio form field layout
 212    *
 213    * @var array
 214    */
 215   protected $_fourColumnAttribute = array(
 216     '</td><td width="25%">',
 217     '</td><td width="25%">',
 218     '</td><td width="25%">',
 219     '</tr><tr><td>',
 220   );
 221
 222   protected $_force = 1;
 223
 224   protected $_params = NULL;
 225   protected $_formValues = NULL;
 226   protected $_instanceValues = NULL;
 227
 228   protected $_instanceForm = FALSE;
 229   protected $_criteriaForm = FALSE;
 230
 231   protected $_instanceButtonName = NULL;
 232   protected $_createNewButtonName = NULL;
 233   protected $_printButtonName = NULL;
 234   protected $_pdfButtonName = NULL;
 235   protected $_csvButtonName = NULL;
 236   protected $_groupButtonName = NULL;
 237   protected $_chartButtonName = NULL;
 238   protected $_csvSupported = TRUE;
 239   protected $_add2groupSupported = TRUE;
 240   protected $_groups = NULL;
 241   protected $_grandFlag = FALSE;
 242   protected $_rowsFound = NULL;
 243   protected $_selectAliases = array();
 244   protected $_rollup = NULL;
 245
 246   /**
 247    * Table containing list of contact IDs within the group filter.
 248    *
 249    * @var string
 250    */
 251   protected $groupTempTable = '';
 252
 253   /**
 254    * @var array
 255    */
 256   protected $_aliases = array();
 257
 258   /**
 259    * @var string
 260    */
 261   protected $_where;
 262
 263   /**
 264    * @var string
 265    */
 266   protected $_from;
 267
 268   /**
 269    * SQL Limit clause
 270    * @var  string
 271    */
 272   protected $_limit = NULL;
 273
 274   /**
 275    * This can be set to specify a limit to the number of rows
 276    * Since it is currently envisaged as part of the api usage it is only being applied
 277    * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
 278    * of the code (see limit() fn.
 279    *
 280    * @var integer
 281    */
 282   protected $_limitValue = NULL;
 283
 284   /**
 285    * This can be set to specify row offset
 286    * See notes on _limitValue
 287    * @var integer
 288    */
 289   protected $_offsetValue = NULL;
 290   /**
 291    * @var null
 292    */
 293   protected $_sections = NULL;
 294   protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
 295   protected $_absoluteUrl = FALSE;
 296
 297   /**
 298    * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
 299    *
 300    * @var boolean
 301    */
 302   protected $_storeResultSet = FALSE;
 303
 304   /**
 305    * When _storeResultSet Flag is set use this var to store result set in form of array
 306    *
 307    * @var boolean
 308    */
 309   protected $_resultSet = array();
 310
 311   /**
 312    * To what frequency group-by a date column
 313    *
 314    * @var array
 315    */
 316   protected $_groupByDateFreq = array(
 317     'MONTH' => 'Month',
 318     'YEARWEEK' => 'Week',
 319     'QUARTER' => 'Quarter',
 320     'YEAR' => 'Year',
 321   );
 322
 323   /**
 324    * Variables to hold the acl inner join and where clause
 325    */
 326   protected $_aclFrom = NULL;
 327   protected $_aclWhere = NULL;
 328
 329   /**
 330    * Array of DAO tables having columns included in SELECT or ORDER BY clause.
 331    *
 332    * Where has also been added to this although perhaps the 'includes both' array should have a different name.
 333    *
 334    * @var array
 335    */
 336   protected $_selectedTables = array();
 337
 338   /**
 339    * Array of DAO tables having columns included in WHERE or HAVING clause
 340    *
 341    * @var array
 342    */
 343   protected $filteredTables;
 344
 345   /**
 346    * Output mode e.g 'print', 'csv', 'pdf'.
 347    *
 348    * @var string
 349    */
 350   protected $_outputMode;
 351
 352   /**
 353    * Format of any chart in use.
 354    *
 355    * (it's unclear if this could be merged with outputMode at this stage)
 356    *
 357    * @var
 358    */
 359   protected $_format;
 360
 361   public $_having = NULL;
 362   public $_select = NULL;
 363   public $_selectClauses = array();
 364   public $_columnHeaders = array();
 365   public $_orderBy = NULL;
 366   public $_orderByFields = array();
 367   public $_orderByArray = array();
 368   /**
 369    * Array of clauses to group by.
 370    *
 371    * @var array
 372    */
 373   protected $_groupByArray = array();
 374   public $_groupBy = NULL;
 375   public $_whereClauses = array();
 376   public $_havingClauses = array();
 377
 378   /**
 379    * DashBoardRowCount Dashboard row count
 380    * @var Integer
 381    */
 382   public $_dashBoardRowCount;
 383
 384   /**
 385    * Is this being called without a form controller (ie. the report is being render outside the normal form
 386    * - e.g the api is retrieving the rows
 387    * @var boolean
 388    */
 389   public $noController = FALSE;
 390
 391   /**
 392    * Variable to hold the currency alias
 393    */
 394   protected $_currencyColumn = NULL;
 395
 396   /**
 397    * @var string
 398    */
 399   protected $_interval;
 400
 401   /**
 402    * @var bool
 403    */
 404   protected $_sendmail;
 405
 406   /**
 407    * @var int
 408    */
 409   protected $_chartId;
 410
 411   /**
 412    * @var int
 413    */
 414   public $_section;
 415
 416   /**
 417    * @var string Report description.
 418    */
 419   public $_description;
 420
 421   /**
 422    * @var bool Is an address field selected.
 423    *   This was intended to determine if the address table should be joined in
 424    *   The isTableSelected function is now preferred for this purpose
 425    */
 426   protected $_addressField;
 427
 428   /**
 429    * @var bool Is an email field selected.
 430    *   This was intended to determine if the email table should be joined in
 431    *   The isTableSelected function is now preferred for this purpose
 432    */
 433   protected $_emailField;
 434
 435   /**
 436    * @var bool Is a phone field selected.
 437    *   This was intended to determine if the phone table should be joined in
 438    *   The isTableSelected function is now preferred for this purpose
 439    */
 440   protected $_phoneField;
 441
 442   /**
 443    * @var bool Create new report instance? (or update existing) on save.
 444    */
 445   protected $_createNew;
 446
 447   /**
 448    *  When a grand total row has calculated the status we pop it off to here.
 449    *
 450    * This allows us to access it from the stats function and avoid recalculating.
 451    */
 452   protected $rollupRow = array();
 453
 454   /**
 455    * @var string Database attributes - character set and collation
 456    */
 457   protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
 458
 459   /**
 460    * SQL being run in this report.
 461    *
 462    * The sql in the report is stored in this variable in order to be displayed on the developer tab.
 463    *
 464    * @var string
 465    */
 466
 467   protected $sql;
 468
 469   /**
 470    * An instruction not to add a Group By.
 471    *
 472    * This is relevant where the group by might be otherwise added after the code that determines the group by array.
 473    *
 474    * e.g. where stat fields are being added but other settings cause it to not be desirable to add a group by
 475    * such as in pivot charts when no row header is set
 476    *
 477    * @var bool
 478    */
 479   protected $noGroupBy = FALSE;
 480
 481   /**
 482    * SQL being run in this report as an array.
 483    *
 484    * The sql in the report is stored in this variable in order to be returned to api & test calls.
 485    *
 486    * @var string
 487    */
 488
 489   protected $sqlArray;
 490
 491   /**
 492    * Tables created for the report that need removal afterwards.
 493    *
 494    * ['civicrm_temp_report_x' => ['temporary' => TRUE, 'name' => 'civicrm_temp_report_x']
 495    * @var array
 496    */
 497   protected $temporaryTables = [];
 498
 499   /**
 500    * Can this report use the sql mode ONLY_FULL_GROUP_BY.
 501    * @var bool
 502    */
 503   public $optimisedForOnlyFullGroupBy = TRUE;
 504   /**
 505    * Class constructor.
 506    */
 507   public function __construct() {
 508     parent::__construct();
 509
 510     $this->addClass('crm-report-form');
 511
 512     if ($this->_tagFilter) {
 513       $this->buildTagFilter();
 514     }
 515     if ($this->_exposeContactID) {
 516       if (array_key_exists('civicrm_contact', $this->_columns)) {
 517         $this->_columns['civicrm_contact']['fields']['exposed_id'] = array(
 518           'name' => 'id',
 519           'title' => ts('Contact ID'),
 520           'no_repeat' => TRUE,
 521         );
 522       }
 523     }
 524
 525     if ($this->_groupFilter) {
 526       $this->buildGroupFilter();
 527     }
 528
 529     // Get all custom groups
 530     $allGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id');
 531
 532     // Get the custom groupIds for which the user has VIEW permission
 533     // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty
 534     // and addCustomDataToColumns() will allow access to all custom groups.
 535     $permCustomGroupIds = array();
 536     if (!CRM_Core_Permission::check('access all custom data')) {
 537       $permCustomGroupIds = CRM_ACL_API::group(CRM_Core_Permission::VIEW, NULL, 'civicrm_custom_group', $allGroups, NULL);
 538       // do not allow custom data for reports if user doesn't have
 539       // permission to access custom data.
 540       if (!empty($this->_customGroupExtends) && empty($permCustomGroupIds)) {
 541         $this->_customGroupExtends = array();
 542       }
 543     }
 544
 545     // merge custom data columns to _columns list, if any
 546     $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
 547
 548     // add / modify display columns, filters ..etc
 549     CRM_Utils_Hook::alterReportVar('columns', $this->_columns, $this);
 550
 551     //assign currencyColumn variable to tpl
 552     $this->assign('currencyColumn', $this->_currencyColumn);
 553   }
 554
 555   /**
 556    * Shared pre-process function.
 557    *
 558    * If overriding preProcess function this should still be called.
 559    *
 560    * @throws \Exception
 561    */
 562   public function preProcessCommon() {
 563     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean');
 564
 565     $this->_dashBoardRowCount = CRM_Utils_Request::retrieve('rowCount', 'Integer');
 566
 567     $this->_section = CRM_Utils_Request::retrieve('section', 'Integer');
 568
 569     $this->assign('section', $this->_section);
 570     CRM_Core_Region::instance('page-header')->add(array(
 571       'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
 572     ));
 573     if (!$this->noController) {
 574       $this->setID($this->get('instanceId'));
 575
 576       if (!$this->_id) {
 577         $this->setID(CRM_Report_Utils_Report::getInstanceID());
 578         if (!$this->_id) {
 579           $this->setID(CRM_Report_Utils_Report::getInstanceIDForPath());
 580         }
 581       }
 582
 583       // set qfkey so that pager picks it up and use it in the "Next > Last >>" links.
 584       // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING
 585       $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}";
 586     }
 587
 588     if ($this->_id) {
 589       $this->assign('instanceId', $this->_id);
 590       $params = array('id' => $this->_id);
 591       $this->_instanceValues = array();
 592       CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_ReportInstance',
 593         $params,
 594         $this->_instanceValues
 595       );
 596       if (empty($this->_instanceValues)) {
 597         CRM_Core_Error::fatal("Report could not be loaded.");
 598       }
 599       $this->_title = $this->_instanceValues['title'];
 600       if (!empty($this->_instanceValues['permission']) &&
 601         (!(CRM_Core_Permission::check($this->_instanceValues['permission']) ||
 602           CRM_Core_Permission::check('administer Reports')
 603         ))
 604       ) {
 605         CRM_Utils_System::permissionDenied();
 606         CRM_Utils_System::civiExit();
 607       }
 608
 609       $formValues = CRM_Utils_Array::value('form_values', $this->_instanceValues);
 610       if ($formValues) {
 611         $this->_formValues = unserialize($formValues);
 612       }
 613       else {
 614         $this->_formValues = NULL;
 615       }
 616
 617       $this->setOutputMode();
 618
 619       if ($this->_outputMode == 'copy') {
 620         $this->_createNew = TRUE;
 621         $this->_params = $this->_formValues;
 622         $this->_params['view_mode'] = 'criteria';
 623         $this->_params['title'] = $this->getTitle() . ts(' (copy created by %1 on %2)', array(
 624           CRM_Core_Session::singleton()->getLoggedInContactDisplayName(),
 625           CRM_Utils_Date::customFormat(date('Y-m-d H:i')),
 626         ));
 627         // Do not pass go. Do not collect another chance to re-run the same query.
 628         CRM_Report_Form_Instance::postProcess($this);
 629       }
 630
 631       // lets always do a force if reset is found in the url.
 632       // Hey why not? see CRM-17225 for more about this. The use of reset to be force is historical for reasons stated
 633       // in the comment line above these 2.
 634       if (!empty($_REQUEST['reset'])
 635           && !in_array(CRM_Utils_Request::retrieve('output', 'String'), array('save', 'criteria'))) {
 636         $this->_force = 1;
 637       }
 638
 639       // set the mode
 640       $this->assign('mode', 'instance');
 641     }
 642     elseif (!$this->noController) {
 643       list($optionValueID, $optionValue) = CRM_Report_Utils_Report::getValueIDFromUrl();
 644       $instanceCount = CRM_Report_Utils_Report::getInstanceCount($optionValue);
 645       if (($instanceCount > 0) && $optionValueID) {
 646         $this->assign('instanceUrl',
 647           CRM_Utils_System::url('civicrm/report/list',
 648             "reset=1&ovid=$optionValueID"
 649           )
 650         );
 651       }
 652       if ($optionValueID) {
 653         $this->_description = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
 654       }
 655
 656       // set the mode
 657       $this->assign('mode', 'template');
 658     }
 659
 660     // lets display the Report Settings section
 661     $this->_instanceForm = $this->_force || $this->_id || (!empty($_POST));
 662
 663     // Do not display Report Settings section if administer Reports permission is absent OR
 664     // if report instance is reserved and administer reserved reports absent
 665     if (!CRM_Core_Permission::check('administer Reports') ||
 666       ($this->_instanceValues['is_reserved'] &&
 667         !CRM_Core_Permission::check('administer reserved reports'))
 668     ) {
 669       $this->_instanceForm = FALSE;
 670     }
 671
 672     $this->assign('criteriaForm', FALSE);
 673     // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved
 674     if (CRM_Core_Permission::check('administer Reports') ||
 675       CRM_Core_Permission::check('access Report Criteria')
 676     ) {
 677       if (!$this->_instanceValues['is_reserved'] ||
 678         CRM_Core_Permission::check('administer reserved reports')
 679       ) {
 680         $this->assign('criteriaForm', TRUE);
 681         $this->_criteriaForm = TRUE;
 682       }
 683     }
 684
 685     // Special permissions check for private instance if it's not the current contact instance
 686     if ($this->_id &&
 687       (CRM_Report_BAO_ReportInstance::reportIsPrivate($this->_id) &&
 688       !CRM_Report_BAO_ReportInstance::contactIsOwner($this->_id))) {
 689       if (!CRM_Core_Permission::check('access all private reports')) {
 690         $this->_instanceForm = FALSE;
 691         $this->assign('criteriaForm', FALSE);
 692       }
 693     }
 694
 695     $this->_instanceButtonName = $this->getButtonName('submit', 'save');
 696     $this->_createNewButtonName = $this->getButtonName('submit', 'next');
 697     $this->_groupButtonName = $this->getButtonName('submit', 'group');
 698     $this->_chartButtonName = $this->getButtonName('submit', 'chart');
 699   }
 700
 701   /**
 702    * Add bread crumb.
 703    */
 704   public function addBreadCrumb() {
 705     $breadCrumbs
 706       = array(
 707         array(
 708           'title' => ts('Report Templates'),
 709           'url' => CRM_Utils_System::url('civicrm/admin/report/template/list', 'reset=1'),
 710         ),
 711       );
 712
 713     CRM_Utils_System::appendBreadCrumb($breadCrumbs);
 714   }
 715
 716   /**
 717    * Pre process function.
 718    *
 719    * Called prior to build form.
 720    */
 721   public function preProcess() {
 722     $this->preProcessCommon();
 723
 724     if (!$this->_id) {
 725       $this->addBreadCrumb();
 726     }
 727
 728     foreach ($this->_columns as $tableName => $table) {
 729       $this->setTableAlias($table, $tableName);
 730
 731       $expFields = array();
 732       // higher preference to bao object
 733       $daoOrBaoName = CRM_Utils_Array::value('bao', $table, CRM_Utils_Array::value('dao', $table));
 734
 735       if ($daoOrBaoName) {
 736         if (method_exists($daoOrBaoName, 'exportableFields')) {
 737           $expFields = $daoOrBaoName::exportableFields();
 738         }
 739         else {
 740           $expFields = $daoOrBaoName::export();
 741         }
 742       }
 743
 744       $doNotCopy = array('required', 'default');
 745
 746       $fieldGroups = array('fields', 'filters', 'group_bys', 'order_bys');
 747       foreach ($fieldGroups as $fieldGrp) {
 748         if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) {
 749           foreach ($table[$fieldGrp] as $fieldName => $field) {
 750             // $name is the field name used to reference the BAO/DAO export fields array
 751             $name = isset($field['name']) ? $field['name'] : $fieldName;
 752
 753             // Sometimes the field name key in the BAO/DAO export fields array is
 754             // different from the actual database field name.
 755             // Unset $field['name'] so that actual database field name can be obtained
 756             // from the BAO/DAO export fields array.
 757             unset($field['name']);
 758
 759             if (array_key_exists($name, $expFields)) {
 760               foreach ($doNotCopy as $dnc) {
 761                 // unset the values we don't want to be copied.
 762                 unset($expFields[$name][$dnc]);
 763               }
 764               if (empty($field)) {
 765                 $this->_columns[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
 766               }
 767               else {
 768                 foreach ($expFields[$name] as $property => $val) {
 769                   if (!array_key_exists($property, $field)) {
 770                     $this->_columns[$tableName][$fieldGrp][$fieldName][$property] = $val;
 771                   }
 772                 }
 773               }
 774             }
 775
 776             // fill other vars
 777             if (!empty($field['no_repeat'])) {
 778               $this->_noRepeats[] = "{$tableName}_{$fieldName}";
 779             }
 780             if (!empty($field['no_display'])) {
 781               $this->_noDisplay[] = "{$tableName}_{$fieldName}";
 782             }
 783
 784             // set alias = table-name, unless already set
 785             $alias = isset($field['alias']) ? $field['alias'] : (
 786               isset($this->_columns[$tableName]['alias']) ? $this->_columns[$tableName]['alias'] : $tableName
 787             );
 788             $this->_columns[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
 789
 790             // set name = fieldName, unless already set
 791             if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['name'])) {
 792               $this->_columns[$tableName][$fieldGrp][$fieldName]['name'] = $name;
 793             }
 794
 795             if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['table_name'])) {
 796               $this->_columns[$tableName][$fieldGrp][$fieldName]['table_name'] = $tableName;
 797             }
 798
 799             // set dbAlias = alias.name, unless already set
 800             if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
 801               $this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias']
 802                 = $alias . '.' .
 803                 $this->_columns[$tableName][$fieldGrp][$fieldName]['name'];
 804             }
 805
 806             // a few auto fills for filters
 807             if ($fieldGrp == 'filters') {
 808               // fill operator types
 809               if (!array_key_exists('operatorType', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 810                 switch (CRM_Utils_Array::value('type', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 811                   case CRM_Utils_Type::T_MONEY:
 812                   case CRM_Utils_Type::T_FLOAT:
 813                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
 814                     break;
 815
 816                   case CRM_Utils_Type::T_INT:
 817                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
 818                     break;
 819
 820                   case CRM_Utils_Type::T_DATE:
 821                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
 822                     break;
 823
 824                   case CRM_Utils_Type::T_BOOLEAN:
 825                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
 826                     if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 827                       $this->_columns[$tableName][$fieldGrp][$fieldName]['options']
 828                         = array(
 829                           '' => ts('Any'),
 830                           '0' => ts('No'),
 831                           '1' => ts('Yes'),
 832                         );
 833                     }
 834                     break;
 835
 836                   default:
 837                     if ($daoOrBaoName &&
 838                       array_key_exists('pseudoconstant', $this->_columns[$tableName][$fieldGrp][$fieldName])
 839                     ) {
 840                       // with multiple options operator-type is generally multi-select
 841                       $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT;
 842                       if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 843                         // fill options
 844                         $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant::get($daoOrBaoName, $fieldName);
 845                       }
 846                     }
 847                     break;
 848                 }
 849               }
 850             }
 851             if (!isset($this->_columns[$tableName]['metadata'][$fieldName])) {
 852               $this->_columns[$tableName]['metadata'][$fieldName] = $this->_columns[$tableName][$fieldGrp][$fieldName];
 853             }
 854             else {
 855               $this->_columns[$tableName]['metadata'][$fieldName] = array_merge($this->_columns[$tableName][$fieldGrp][$fieldName], $this->_columns[$tableName]['metadata'][$fieldName]);
 856             }
 857           }
 858         }
 859       }
 860
 861       // copy filters to a separate handy variable
 862       if (array_key_exists('filters', $table)) {
 863         $this->_filters[$tableName] = $this->_columns[$tableName]['filters'];
 864       }
 865
 866       if (array_key_exists('group_bys', $table)) {
 867         $groupBys[$tableName] = $this->_columns[$tableName]['group_bys'];
 868       }
 869
 870       if (array_key_exists('fields', $table)) {
 871         $reportFields[$tableName] = $this->_columns[$tableName]['fields'];
 872       }
 873     }
 874
 875     if ($this->_force) {
 876       $this->setDefaultValues(FALSE);
 877     }
 878
 879     CRM_Report_Utils_Get::processFilter($this->_filters, $this->_defaults);
 880     CRM_Report_Utils_Get::processGroupBy($groupBys, $this->_defaults);
 881     CRM_Report_Utils_Get::processFields($reportFields, $this->_defaults);
 882     CRM_Report_Utils_Get::processChart($this->_defaults);
 883
 884     if ($this->_force) {
 885       $this->_formValues = $this->_defaults;
 886       $this->postProcess();
 887     }
 888   }
 889
 890   /**
 891    * Set default values.
 892    *
 893    * @param bool $freeze
 894    *
 895    * @return array
 896    */
 897   public function setDefaultValues($freeze = TRUE) {
 898     $freezeGroup = array();
 899
 900     // FIXME: generalizing form field naming conventions would reduce
 901     // Lots of lines below.
 902     foreach ($this->_columns as $tableName => $table) {
 903       if (array_key_exists('fields', $table)) {
 904         foreach ($table['fields'] as $fieldName => $field) {
 905           if (empty($field['no_display'])) {
 906             if (!empty($field['required'])) {
 907               // set default
 908               $this->_defaults['fields'][$fieldName] = 1;
 909
 910               if ($freeze) {
 911                 // find element object, so that we could use quickform's freeze method
 912                 // for required elements
 913                 $obj = $this->getElementFromGroup("fields", $fieldName);
 914                 if ($obj) {
 915                   $freezeGroup[] = $obj;
 916                 }
 917               }
 918             }
 919             elseif (isset($field['default'])) {
 920               $this->_defaults['fields'][$fieldName] = $field['default'];
 921             }
 922           }
 923         }
 924       }
 925
 926       if (array_key_exists('group_bys', $table)) {
 927         foreach ($table['group_bys'] as $fieldName => $field) {
 928           if (isset($field['default'])) {
 929             if (!empty($field['frequency'])) {
 930               $this->_defaults['group_bys_freq'][$fieldName] = 'MONTH';
 931             }
 932             $this->_defaults['group_bys'][$fieldName] = $field['default'];
 933           }
 934         }
 935       }
 936       if (array_key_exists('filters', $table)) {
 937         foreach ($table['filters'] as $fieldName => $field) {
 938           if (isset($field['default'])) {
 939             if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE
 940             ) {
 941               if (is_array($field['default'])) {
 942                 $this->_defaults["{$fieldName}_from"] = CRM_Utils_Array::value('from', $field['default']);
 943                 $this->_defaults["{$fieldName}_to"] = CRM_Utils_Array::value('to', $field['default']);
 944                 $this->_defaults["{$fieldName}_relative"] = 0;
 945               }
 946               else {
 947                 $this->_defaults["{$fieldName}_relative"] = $field['default'];
 948               }
 949             }
 950             else {
 951               if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_INT) && is_array($field['default'])) {
 952                 $this->_defaults["{$fieldName}_min"] = CRM_Utils_Array::value('min', $field['default']);
 953                 $this->_defaults["{$fieldName}_max"] = CRM_Utils_Array::value('max', $field['default']);
 954               }
 955               $this->_defaults["{$fieldName}_value"] = $field['default'];
 956             }
 957           }
 958           //assign default value as "in" for multiselect
 959           //operator, To freeze the select element
 960           if (CRM_Utils_Array::value('operatorType', $field) ==
 961             CRM_Report_Form::OP_MULTISELECT
 962           ) {
 963             $this->_defaults["{$fieldName}_op"] = 'in';
 964           }
 965           if (CRM_Utils_Array::value('operatorType', $field) ==
 966             CRM_Report_Form::OP_ENTITYREF
 967           ) {
 968             $this->_defaults["{$fieldName}_op"] = 'in';
 969           }
 970           elseif (CRM_Utils_Array::value('operatorType', $field) ==
 971             CRM_Report_Form::OP_MULTISELECT_SEPARATOR
 972           ) {
 973             $this->_defaults["{$fieldName}_op"] = 'mhas';
 974           }
 975           elseif ($op = CRM_Utils_Array::value('default_op', $field)) {
 976             $this->_defaults["{$fieldName}_op"] = $op;
 977           }
 978         }
 979       }
 980
 981       if (
 982         empty($this->_formValues['order_bys']) &&
 983         (array_key_exists('order_bys', $table) &&
 984         is_array($table['order_bys']))
 985       ) {
 986         if (!array_key_exists('order_bys', $this->_defaults)) {
 987           $this->_defaults['order_bys'] = array();
 988         }
 989         foreach ($table['order_bys'] as $fieldName => $field) {
 990           if (!empty($field['default']) || !empty($field['default_order']) ||
 991             CRM_Utils_Array::value('default_is_section', $field) ||
 992             !empty($field['default_weight'])
 993           ) {
 994             $order_by = array(
 995               'column' => $fieldName,
 996               'order' => CRM_Utils_Array::value('default_order', $field, 'ASC'),
 997               'section' => CRM_Utils_Array::value('default_is_section', $field, 0),
 998             );
 999
1000             if (!empty($field['default_weight'])) {
1001               $this->_defaults['order_bys'][(int) $field['default_weight']] = $order_by;
1002             }
1003             else {
1004               array_unshift($this->_defaults['order_bys'], $order_by);
1005             }
1006           }
1007         }
1008       }
1009
1010       foreach ($this->_options as $fieldName => $field) {
1011         if (isset($field['default'])) {
1012           $this->_defaults['options'][$fieldName] = $field['default'];
1013         }
1014       }
1015     }
1016
1017     if (!empty($this->_submitValues)) {
1018       $this->preProcessOrderBy($this->_submitValues);
1019     }
1020     else {
1021       $this->preProcessOrderBy($this->_defaults);
1022     }
1023
1024     // lets finish freezing task here itself
1025     if (!empty($freezeGroup)) {
1026       foreach ($freezeGroup as $elem) {
1027         $elem->freeze();
1028       }
1029     }
1030
1031     if ($this->_formValues) {
1032       $this->_defaults = array_merge($this->_defaults, $this->_formValues);
1033     }
1034
1035     if ($this->_instanceValues) {
1036       $this->_defaults = array_merge($this->_defaults, $this->_instanceValues);
1037     }
1038
1039     CRM_Report_Form_Instance::setDefaultValues($this, $this->_defaults);
1040
1041     return $this->_defaults;
1042   }
1043
1044   /**
1045    * Get element from group.
1046    *
1047    * @param string $group
1048    * @param string $grpFieldName
1049    *
1050    * @return bool
1051    */
1052   public function getElementFromGroup($group, $grpFieldName) {
1053     $eleObj = $this->getElement($group);
1054     foreach ($eleObj->_elements as $index => $obj) {
1055       if ($grpFieldName == $obj->_attributes['name']) {
1056         return $obj;
1057       }
1058     }
1059     return FALSE;
1060   }
1061
1062   /**
1063    * Setter for $_params.
1064    *
1065    * @param array $params
1066    */
1067   public function setParams($params) {
1068     $this->_params = $params;
1069   }
1070
1071   /**
1072    * Getter for $_params.
1073    *
1074    * @return void|array $params
1075    */
1076   public function getParams() {
1077     return $this->_params;
1078   }
1079
1080   /**
1081    * Setter for $_id.
1082    *
1083    * @param int $instanceID
1084    */
1085   public function setID($instanceID) {
1086     $this->_id = $instanceID;
1087   }
1088
1089   /**
1090    * Setter for $_force.
1091    *
1092    * @param bool $isForce
1093    */
1094   public function setForce($isForce) {
1095     $this->_force = $isForce;
1096   }
1097
1098   /**
1099    * Setter for $_limitValue.
1100    *
1101    * @param int $_limitValue
1102    */
1103   public function setLimitValue($_limitValue) {
1104     $this->_limitValue = $_limitValue;
1105   }
1106
1107   /**
1108    * Setter for $_offsetValue.
1109    *
1110    * @param int $_offsetValue
1111    */
1112   public function setOffsetValue($_offsetValue) {
1113     $this->_offsetValue = $_offsetValue;
1114   }
1115
1116   /**
1117    * Setter for $addPaging.
1118    *
1119    * @param bool $value
1120    */
1121   public function setAddPaging($value) {
1122     $this->addPaging = $value;
1123   }
1124
1125   /**
1126    * Getter for $_defaultValues.
1127    *
1128    * @return array
1129    */
1130   public function getDefaultValues() {
1131     return $this->_defaults;
1132   }
1133
1134   /**
1135    * Remove any temporary tables.
1136    */
1137   public function cleanUpTemporaryTables() {
1138     foreach ($this->temporaryTables as $temporaryTable) {
1139       CRM_Core_DAO::executeQuery('DROP ' . ($temporaryTable['temporary'] ? 'TEMPORARY' : '') . ' TABLE IF EXISTS ' . $temporaryTable['name']);
1140     }
1141   }
1142
1143   /**
1144    * Create a temporary table.
1145    *
1146    * This function creates a table AND adds the details to the developer tab & $this->>temporary tables.
1147    *
1148    * @param string $identifier
1149    *   This is the key that will be used for the table in the temporaryTables property.
1150    * @param string $sql
1151    *   Sql select statement or column description (the latter requires the columns flag)
1152    * @param bool $isColumns
1153    *   Is the sql describing columns to create (rather than using a select query).
1154    * @param bool $isMemory
1155    *   Create a memory table rather than a normal INNODB table.
1156    *
1157    * @return string
1158    */
1159   public function createTemporaryTable($identifier, $sql, $isColumns = FALSE, $isMemory = FALSE) {
1160     $tempTable = CRM_Utils_SQL_TempTable::build()->setUtf8();
1161     if ($isMemory) {
1162       $tempTable->setMemory();
1163     }
1164     if ($isColumns) {
1165       $tempTable->createWithColumns($sql);
1166     }
1167     else {
1168       $tempTable->createWithQuery($sql);
1169     }
1170     $name = $tempTable->getName();
1171     // Developers may force tables to be durable to assist in debugging so lets check.
1172     $isNotTrueTemporary = $tempTable->isDurable();
1173     $this->addToDeveloperTab($tempTable->getCreateSql());
1174     $this->temporaryTables[$identifier] = ['temporary' => !$isNotTrueTemporary, 'name' => $name];
1175     return $name;
1176   }
1177
1178   /**
1179    * Add columns to report.
1180    */
1181   public function addColumns() {
1182     $options = array();
1183     $colGroups = NULL;
1184     foreach ($this->_columns as $tableName => $table) {
1185       if (array_key_exists('fields', $table)) {
1186         foreach ($table['fields'] as $fieldName => $field) {
1187           $groupTitle = '';
1188           if (empty($field['no_display'])) {
1189             foreach (array('table', 'field') as $var) {
1190               if (!empty(${$var}['grouping'])) {
1191                 if (!is_array(${$var}['grouping'])) {
1192                   $tableName = ${$var}['grouping'];
1193                 }
1194                 else {
1195                   $tableName = array_keys(${$var}['grouping']);
1196                   $tableName = $tableName[0];
1197                   $groupTitle = array_values(${$var}['grouping']);
1198                   $groupTitle = $groupTitle[0];
1199                 }
1200               }
1201             }
1202
1203             if (!$groupTitle && isset($table['group_title'])) {
1204               $groupTitle = $table['group_title'];
1205               // Having a group_title is secret code for being a custom group
1206               // which cryptically translates to needing an accordion.
1207               // here we make that explicit.
1208               $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE;
1209             }
1210
1211             $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array::value('title', $field);
1212             if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1213               $colGroups[$tableName]['group_title'] = $groupTitle;
1214             }
1215             $options[$fieldName] = CRM_Utils_Array::value('title', $field);
1216           }
1217         }
1218       }
1219     }
1220
1221     $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
1222       NULL, NULL, NULL, $this->_fourColumnAttribute, TRUE
1223     );
1224     if (!empty($colGroups)) {
1225       $this->tabs['FieldSelection'] = array(
1226         'title' => ts('Columns'),
1227         'tpl' => 'FieldSelection',
1228         'div_label' => 'col-groups',
1229       );
1230
1231       // Note this assignment is only really required in buildForm. It is being 'over-called'
1232       // to reduce risk of being missed due to overridden functions.
1233       $this->assign('tabs', $this->tabs);
1234     }
1235
1236     $this->assign('colGroups', $colGroups);
1237   }
1238
1239   /**
1240    * Add filters to report.
1241    */
1242   public function addFilters() {
1243     $filters = $filterGroups = array();
1244     $count = 1;
1245
1246     foreach ($this->_filters as $table => $attributes) {
1247       if (isset($this->_columns[$table]['group_title'])) {
1248         // The presence of 'group_title' is secret code for 'is_a_custom_table'
1249         // which magically means to 'display in an accordian'
1250         // here we make this explicit.
1251         $filterGroups[$table] = array(
1252           'group_title' => $this->_columns[$table]['group_title'],
1253           'use_accordian_for_field_selection' => TRUE,
1254
1255         );
1256       }
1257       foreach ($attributes as $fieldName => $field) {
1258         // get ready with option value pair
1259         // @ todo being able to specific options for a field (e.g a date field) in the field spec as an array rather than an override
1260         // would be useful
1261         $operations = $this->getOperationPair(
1262           CRM_Utils_Array::value('operatorType', $field),
1263           $fieldName);
1264
1265         $filters[$table][$fieldName] = $field;
1266
1267         switch (CRM_Utils_Array::value('operatorType', $field)) {
1268           case CRM_Report_Form::OP_MONTH:
1269             if (!array_key_exists('options', $field) ||
1270               !is_array($field['options']) || empty($field['options'])
1271             ) {
1272               // If there's no option list for this filter, define one.
1273               $field['options'] = array(
1274                 1 => ts('January'),
1275                 2 => ts('February'),
1276                 3 => ts('March'),
1277                 4 => ts('April'),
1278                 5 => ts('May'),
1279                 6 => ts('June'),
1280                 7 => ts('July'),
1281                 8 => ts('August'),
1282                 9 => ts('September'),
1283                 10 => ts('October'),
1284                 11 => ts('November'),
1285                 12 => ts('December'),
1286               );
1287               // Add this option list to this column _columns. This is
1288               // required so that filter statistics show properly.
1289               $this->_columns[$table]['filters'][$fieldName]['options'] = $field['options'];
1290             }
1291           case CRM_Report_Form::OP_MULTISELECT:
1292           case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
1293             // assume a multi-select field
1294             if (!empty($field['options']) ||
1295               $fieldName == 'state_province_id' || $fieldName == 'county_id'
1296             ) {
1297               $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1298               if (count($operations) <= 1) {
1299                 $element->freeze();
1300               }
1301               if ($fieldName == 'state_province_id' ||
1302                 $fieldName == 'county_id'
1303               ) {
1304                 $this->addChainSelect($fieldName . '_value', array(
1305                   'multiple' => TRUE,
1306                   'label' => NULL,
1307                   'class' => 'huge',
1308                 ));
1309               }
1310               else {
1311                 $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], array(
1312                   'style' => 'min-width:250px',
1313                   'class' => 'crm-select2 huge',
1314                   'multiple' => TRUE,
1315                   'placeholder' => ts('- select -'),
1316                 ));
1317               }
1318             }
1319             break;
1320
1321           case CRM_Report_Form::OP_SELECT:
1322             // assume a select field
1323             $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1324             if (!empty($field['options'])) {
1325               $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
1326             }
1327             break;
1328
1329           case CRM_Report_Form::OP_ENTITYREF:
1330             $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1331             $this->setEntityRefDefaults($field, $table);
1332             $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']);
1333             break;
1334
1335           case CRM_Report_Form::OP_DATE:
1336             // build datetime fields
1337             CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations);
1338             $count++;
1339             break;
1340
1341           case CRM_Report_Form::OP_DATETIME:
1342             // build datetime fields
1343             CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations, 'searchDate', TRUE);
1344             $count++;
1345             break;
1346
1347           case CRM_Report_Form::OP_INT:
1348           case CRM_Report_Form::OP_FLOAT:
1349             // and a min value input box
1350             $this->add('text', "{$fieldName}_min", ts('Min'));
1351             // and a max value input box
1352             $this->add('text', "{$fieldName}_max", ts('Max'));
1353           default:
1354             // default type is string
1355             $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1356               array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
1357             );
1358             // we need text box for value input
1359             $this->add('text', "{$fieldName}_value", NULL, array('class' => 'huge'));
1360             break;
1361         }
1362       }
1363     }
1364     if (!empty($filters)) {
1365       $this->tabs['Filters'] = array(
1366         'title' => ts('Filters'),
1367         'tpl' => 'Filters',
1368         'div_label' => 'set-filters',
1369       );
1370     }
1371     $this->assign('filters', $filters);
1372     $this->assign('filterGroups', $filterGroups);
1373   }
1374
1375   /**
1376    * Function to assign the tabs to the template in the correct order.
1377    *
1378    * We want the tabs to wind up in this order (if not overridden).
1379    *
1380    *   - Field Selection
1381    *   - Group Bys
1382    *   - Order Bys
1383    *   - Other Options
1384    *   - Filters
1385    */
1386   protected function assignTabs() {
1387     $order = array(
1388       'FieldSelection',
1389       'GroupBy',
1390       'OrderBy',
1391       'ReportOptions',
1392       'Filters',
1393     );
1394     $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs);
1395     $order = array_merge($order, $this->tabs);
1396     $this->assign('tabs', $order);
1397   }
1398
1399   /**
1400    * The intent is to add a tab for developers to view the sql.
1401    *
1402    * Currently using dpm.
1403    *
1404    * @param string $sql
1405    */
1406   public function addToDeveloperTab($sql) {
1407     if (!CRM_Core_Permission::check('view report sql')) {
1408       return;
1409     }
1410     $ignored_output_modes = array('pdf', 'csv', 'print');
1411     if (in_array($this->_outputMode, $ignored_output_modes)) {
1412       return;
1413     }
1414     $this->tabs['Developer'] = array(
1415       'title' => ts('Developer'),
1416       'tpl' => 'Developer',
1417       'div_label' => 'set-developer',
1418     );
1419
1420     $this->assignTabs();
1421     $this->sqlArray[] = $sql;
1422     foreach ($this->sqlArray as $sql) {
1423       foreach (array('LEFT JOIN') as $term) {
1424         $sql = str_replace($term, '<br>  ' . $term, $sql);
1425       }
1426       foreach (array('FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';') as $term) {
1427         $sql = str_replace($term, '<br><br>' . $term, $sql);
1428       }
1429       $this->sqlFormattedArray[] = $sql;
1430       $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray));
1431     }
1432     $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL::getSqlModes());
1433
1434   }
1435
1436   /**
1437    * Add options defined in $this->_options to the report.
1438    */
1439   public function addOptions() {
1440     if (!empty($this->_options)) {
1441       // FIXME: For now lets build all elements as checkboxes.
1442       // Once we clear with the format we can build elements based on type
1443
1444       foreach ($this->_options as $fieldName => $field) {
1445         $options = array();
1446
1447         if ($field['type'] == 'select') {
1448           $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1449         }
1450         elseif ($field['type'] == 'checkbox') {
1451           $options[$field['title']] = $fieldName;
1452           $this->addCheckBox($fieldName, NULL,
1453             $options, NULL,
1454             NULL, NULL, NULL, $this->_fourColumnAttribute
1455           );
1456         }
1457       }
1458     }
1459     if (!empty($this->_options) &&
1460         (!$this->_id
1461           || ($this->_id && CRM_Report_BAO_ReportInstance::contactCanAdministerReport($this->_id)))
1462     ) {
1463       $this->tabs['ReportOptions'] = array(
1464         'title' => ts('Display Options'),
1465         'tpl' => 'ReportOptions',
1466         'div_label' => 'other-options',
1467       );
1468     }
1469     $this->assign('otherOptions', $this->_options);
1470   }
1471
1472   /**
1473    * Add chart options to the report.
1474    */
1475   public function addChartOptions() {
1476     if (!empty($this->_charts)) {
1477       $this->addElement('select', "charts", ts('Chart'), $this->_charts);
1478       $this->assign('charts', $this->_charts);
1479       $this->addElement('submit', $this->_chartButtonName, ts('View'));
1480     }
1481   }
1482
1483   /**
1484    * Add group by options to the report.
1485    */
1486   public function addGroupBys() {
1487     $options = $freqElements = array();
1488
1489     foreach ($this->_columns as $tableName => $table) {
1490       if (array_key_exists('group_bys', $table)) {
1491         foreach ($table['group_bys'] as $fieldName => $field) {
1492           if (!empty($field) && empty($field['no_display'])) {
1493             $options[$field['title']] = $fieldName;
1494             if (!empty($field['frequency'])) {
1495               $freqElements[$field['title']] = $fieldName;
1496             }
1497           }
1498         }
1499       }
1500     }
1501     $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1502       NULL, NULL, NULL, $this->_fourColumnAttribute
1503     );
1504     $this->assign('groupByElements', $options);
1505     if (!empty($options)) {
1506       $this->tabs['GroupBy'] = array(
1507         'title' => ts('Grouping'),
1508         'tpl' => 'GroupBy',
1509         'div_label' => 'group-by-elements',
1510       );
1511     }
1512
1513     foreach ($freqElements as $name) {
1514       $this->addElement('select', "group_bys_freq[$name]",
1515         ts('Frequency'), $this->_groupByDateFreq
1516       );
1517     }
1518   }
1519
1520   /**
1521    * Add data for order by tab.
1522    */
1523   public function addOrderBys() {
1524     $options = array();
1525     foreach ($this->_columns as $tableName => $table) {
1526
1527       // Report developer may define any column to order by; include these as order-by options.
1528       if (array_key_exists('order_bys', $table)) {
1529         foreach ($table['order_bys'] as $fieldName => $field) {
1530           if (!empty($field)) {
1531             $options[$fieldName] = $field['title'];
1532           }
1533         }
1534       }
1535
1536       // Add searchable custom fields as order-by options, if so requested
1537       // (These are already indexed, so allowing to order on them is cheap.)
1538
1539       if ($this->_autoIncludeIndexedFieldsAsOrderBys &&
1540         array_key_exists('extends', $table) && !empty($table['extends'])
1541       ) {
1542         foreach ($table['fields'] as $fieldName => $field) {
1543           if (empty($field['no_display'])) {
1544             $options[$fieldName] = $field['title'];
1545           }
1546         }
1547       }
1548     }
1549
1550     asort($options);
1551
1552     $this->assign('orderByOptions', $options);
1553     if (!empty($options)) {
1554       $this->tabs['OrderBy'] = array(
1555         'title' => ts('Sorting'),
1556         'tpl' => 'OrderBy',
1557         'div_label' => 'order-by-elements',
1558       );
1559     }
1560
1561     if (!empty($options)) {
1562       $options = array(
1563         '-' => ' - none - ',
1564       ) + $options;
1565       for ($i = 1; $i <= 5; $i++) {
1566         $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1567         $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array(
1568           'ASC' => ts('Ascending'),
1569           'DESC' => ts('Descending'),
1570         ));
1571         $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, array('id' => "order_by_section_$i"));
1572         $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, array('id' => "order_by_pagebreak_$i"));
1573       }
1574     }
1575   }
1576
1577   /**
1578    * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
1579    *
1580    * @todo call this tab into the report template in the same way as OrderBy etc, ie
1581    * by adding a description of the tab to $this->tabs, causing the tab to be added in
1582    * Criteria.tpl.
1583    */
1584   public function buildInstanceAndButtons() {
1585     CRM_Report_Form_Instance::buildForm($this);
1586     $this->_actionButtonName = $this->getButtonName('submit');
1587     $this->addTaskMenu($this->getActions($this->_id));
1588
1589     $this->assign('instanceForm', $this->_instanceForm);
1590
1591     // CRM-16274 Determine if user has 'edit all contacts' or equivalent
1592     $permission = CRM_Core_Permission::getPermission();
1593     if ($this->_instanceForm && $permission == CRM_Core_Permission::EDIT &&
1594       $this->_add2groupSupported
1595     ) {
1596       $this->addElement('select', 'groups', ts('Group'),
1597         array('' => ts('Add Contacts to Group')) +
1598         CRM_Core_PseudoConstant::nestedGroup(),
1599         array('class' => 'crm-select2 crm-action-menu fa-plus huge')
1600       );
1601       $this->assign('group', TRUE);
1602     }
1603
1604     $this->addElement('submit', $this->_groupButtonName, '', array('style' => 'display: none;'));
1605
1606     $this->addChartOptions();
1607     $showResultsLabel = $this->getResultsLabel();
1608     $this->addButtons(array(
1609         array(
1610           'type' => 'submit',
1611           'name' => $showResultsLabel,
1612           'isDefault' => TRUE,
1613         ),
1614       )
1615     );
1616   }
1617
1618   /**
1619    * Has this form been submitted already?
1620    *
1621    * @return bool
1622    */
1623   public function resultsDisplayed() {
1624     $buttonName = $this->controller->getButtonName();
1625     return ($buttonName || $this->_outputMode);
1626   }
1627
1628   /**
1629    * Get the actions for this report instance.
1630    *
1631    * @param int $instanceId
1632    *
1633    * @return array
1634    */
1635   protected function getActions($instanceId) {
1636     $actions = CRM_Report_BAO_ReportInstance::getActionMetadata();
1637     if (empty($instanceId)) {
1638       $actions['report_instance.save'] = array(
1639         'title' => ts('Create Report'),
1640         'data' => array(
1641           'is_confirm' => TRUE,
1642           'confirm_title' => ts('Create Report'),
1643           'confirm_refresh_fields' => json_encode(array(
1644             'title' => array('selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''),
1645             'description' => array('selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''),
1646           )),
1647         ),
1648       );
1649       unset($actions['report_instance.delete']);
1650     }
1651
1652     if (!$this->_csvSupported) {
1653       unset($actions['report_instance.csv']);
1654     }
1655
1656     return $actions;
1657   }
1658
1659   /**
1660    * Main build form function.
1661    */
1662   public function buildQuickForm() {
1663     $this->addColumns();
1664
1665     $this->addFilters();
1666
1667     $this->addOptions();
1668
1669     $this->addGroupBys();
1670
1671     $this->addOrderBys();
1672
1673     $this->buildInstanceAndButtons();
1674
1675     // Add form rule for report.
1676     if (is_callable(array(
1677       $this,
1678       'formRule',
1679     ))) {
1680       $this->addFormRule(array(get_class($this), 'formRule'), $this);
1681     }
1682     $this->assignTabs();
1683   }
1684
1685   /**
1686    * A form rule function for custom data.
1687    *
1688    * The rule ensures that fields selected in group_by if any) should only be the ones
1689    * present in display/select fields criteria;
1690    * note: works if and only if any custom field selected in group_by.
1691    *
1692    * @param array $fields
1693    * @param array $ignoreFields
1694    *
1695    * @return array
1696    */
1697   public function customDataFormRule($fields, $ignoreFields = array()) {
1698     $errors = array();
1699     if (!empty($this->_customGroupExtends) && $this->_customGroupGroupBy &&
1700       !empty($fields['group_bys'])
1701     ) {
1702       foreach ($this->_columns as $tableName => $table) {
1703         if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1704             substr($tableName, 0, 12) == 'custom_value') &&
1705           !empty($this->_columns[$tableName]['fields'])
1706         ) {
1707           foreach ($this->_columns[$tableName]['fields'] as $fieldName => $field) {
1708             if (array_key_exists($fieldName, $fields['group_bys']) &&
1709               !array_key_exists($fieldName, $fields['fields'])
1710             ) {
1711               $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1712             }
1713             elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1714               foreach ($fields['fields'] as $fld => $val) {
1715                 if (!array_key_exists($fld, $fields['group_bys']) &&
1716                   !in_array($fld, $ignoreFields)
1717                 ) {
1718                   $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1719                 }
1720               }
1721             }
1722           }
1723         }
1724       }
1725     }
1726     return $errors;
1727   }
1728
1729   /**
1730    * Get operators to display on form.
1731    *
1732    * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1733    *
1734    * @param string $type
1735    * @param string $fieldName
1736    *
1737    * @return array
1738    */
1739   public function getOperationPair($type = "string", $fieldName = NULL) {
1740     // FIXME: At some point we should move these key-val pairs
1741     // to option_group and option_value table.
1742     switch ($type) {
1743       case CRM_Report_Form::OP_INT:
1744       case CRM_Report_Form::OP_FLOAT:
1745
1746         $result = array(
1747           'lte' => ts('Is less than or equal to'),
1748           'gte' => ts('Is greater than or equal to'),
1749           'bw' => ts('Is between'),
1750           'eq' => ts('Is equal to'),
1751           'lt' => ts('Is less than'),
1752           'gt' => ts('Is greater than'),
1753           'neq' => ts('Is not equal to'),
1754           'nbw' => ts('Is not between'),
1755           'nll' => ts('Is empty (Null)'),
1756           'nnll' => ts('Is not empty (Null)'),
1757         );
1758         return $result;
1759
1760       case CRM_Report_Form::OP_SELECT:
1761         $result = array(
1762           'eq' => ts('Is equal to'),
1763         );
1764         return $result;
1765
1766       case CRM_Report_Form::OP_MONTH:
1767       case CRM_Report_Form::OP_MULTISELECT:
1768       case CRM_Report_Form::OP_ENTITYREF:
1769
1770         $result = array(
1771           'in' => ts('Is one of'),
1772           'notin' => ts('Is not one of'),
1773         );
1774         return $result;
1775
1776       case CRM_Report_Form::OP_DATE:
1777
1778         $result = array(
1779           'nll' => ts('Is empty (Null)'),
1780           'nnll' => ts('Is not empty (Null)'),
1781         );
1782         return $result;
1783
1784       case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
1785         // use this operator for the values, concatenated with separator. For e.g if
1786         // multiple options for a column is stored as ^A{val1}^A{val2}^A
1787         $result = array(
1788           'mhas' => ts('Is one of'),
1789           'mnot' => ts('Is not one of'),
1790         );
1791         return $result;
1792
1793       default:
1794         // type is string
1795         $result = array(
1796           'has' => ts('Contains'),
1797           'sw' => ts('Starts with'),
1798           'ew' => ts('Ends with'),
1799           'nhas' => ts('Does not contain'),
1800           'eq' => ts('Is equal to'),
1801           'neq' => ts('Is not equal to'),
1802           'nll' => ts('Is empty (Null)'),
1803           'nnll' => ts('Is not empty (Null)'),
1804         );
1805         return $result;
1806     }
1807   }
1808
1809   /**
1810    * Build the tag filter field to display on the filters tab.
1811    */
1812   public function buildTagFilter() {
1813     $contactTags = CRM_Core_BAO_Tag::getTags($this->_tagFilterTable);
1814     if (!empty($contactTags)) {
1815       $this->_columns['civicrm_tag'] = array(
1816         'dao' => 'CRM_Core_DAO_Tag',
1817         'filters' => array(
1818           'tagid' => array(
1819             'name' => 'tag_id',
1820             'title' => ts('Tag'),
1821             'type' => CRM_Utils_Type::T_INT,
1822             'tag' => TRUE,
1823             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1824             'options' => $contactTags,
1825           ),
1826         ),
1827       );
1828     }
1829   }
1830
1831   /**
1832    * Adds group filters to _columns (called from _Construct).
1833    */
1834   public function buildGroupFilter() {
1835     $this->_columns['civicrm_group']['filters'] = array(
1836       'gid' => array(
1837         'name' => 'group_id',
1838         'title' => ts('Group'),
1839         'type' => CRM_Utils_Type::T_INT,
1840         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1841         'group' => TRUE,
1842         'options' => CRM_Core_PseudoConstant::nestedGroup(),
1843       ),
1844     );
1845     if (empty($this->_columns['civicrm_group']['dao'])) {
1846       $this->_columns['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1847     }
1848     if (empty($this->_columns['civicrm_group']['alias'])) {
1849       $this->_columns['civicrm_group']['alias'] = 'cgroup';
1850     }
1851   }
1852
1853   /**
1854    * Get SQL operator from form text version.
1855    *
1856    * @param string $operator
1857    *
1858    * @return string
1859    */
1860   public function getSQLOperator($operator = "like") {
1861     switch ($operator) {
1862       case 'eq':
1863         return '=';
1864
1865       case 'lt':
1866         return '<';
1867
1868       case 'lte':
1869         return '<=';
1870
1871       case 'gt':
1872         return '>';
1873
1874       case 'gte':
1875         return '>=';
1876
1877       case 'ne':
1878       case 'neq':
1879         return '!=';
1880
1881       case 'nhas':
1882         return 'NOT LIKE';
1883
1884       case 'in':
1885         return 'IN';
1886
1887       case 'notin':
1888         return 'NOT IN';
1889
1890       case 'nll':
1891         return 'IS NULL';
1892
1893       case 'nnll':
1894         return 'IS NOT NULL';
1895
1896       default:
1897         // type is string
1898         return 'LIKE';
1899     }
1900   }
1901
1902   /**
1903    * Generate where clause.
1904    *
1905    * This can be overridden in reports for special treatment of a field
1906    *
1907    * @param array $field Field specifications
1908    * @param string $op Query operator (not an exact match to sql)
1909    * @param mixed $value
1910    * @param float $min
1911    * @param float $max
1912    *
1913    * @return null|string
1914    */
1915   public function whereClause(&$field, $op, $value, $min, $max) {
1916
1917     $type = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $field));
1918
1919     // CRM-18010: Ensure type of each report filters
1920     if (!$type) {
1921       trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING);
1922     }
1923     $clause = NULL;
1924
1925     switch ($op) {
1926       case 'bw':
1927       case 'nbw':
1928         if (($min !== NULL && strlen($min) > 0) ||
1929           ($max !== NULL && strlen($max) > 0)
1930         ) {
1931           $clauses = array();
1932           if ($min) {
1933             $min = CRM_Utils_Type::escape($min, $type);
1934             if ($op == 'bw') {
1935               $clauses[] = "( {$field['dbAlias']} >= $min )";
1936             }
1937             else {
1938               $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
1939             }
1940           }
1941           if ($max) {
1942             $max = CRM_Utils_Type::escape($max, $type);
1943             if ($op == 'bw') {
1944               $clauses[] = "( {$field['dbAlias']} <= $max )";
1945             }
1946             else {
1947               $clauses[] = "( {$field['dbAlias']} > $max )";
1948             }
1949           }
1950
1951           if (!empty($clauses)) {
1952             if ($op == 'bw') {
1953               $clause = implode(' AND ', $clauses);
1954             }
1955             else {
1956               $clause = '(' . implode('OR', $clauses) . ')';
1957             }
1958           }
1959         }
1960         break;
1961
1962       case 'has':
1963       case 'nhas':
1964         if ($value !== NULL && strlen($value) > 0) {
1965           $value = CRM_Utils_Type::escape($value, $type);
1966           if (strpos($value, '%') === FALSE) {
1967             $value = "'%{$value}%'";
1968           }
1969           else {
1970             $value = "'{$value}'";
1971           }
1972           $sqlOP = $this->getSQLOperator($op);
1973           $clause = "( {$field['dbAlias']} $sqlOP $value )";
1974         }
1975         break;
1976
1977       case 'in':
1978       case 'notin':
1979         if ((is_string($value) || is_numeric($value)) && strlen($value)) {
1980           $value = explode(',', $value);
1981         }
1982         if ($value !== NULL && is_array($value) && count($value) > 0) {
1983           $sqlOP = $this->getSQLOperator($op);
1984           if (CRM_Utils_Array::value('type', $field) ==
1985             CRM_Utils_Type::T_STRING
1986           ) {
1987             //cycle through selections and escape values
1988             foreach ($value as $key => $selection) {
1989               $value[$key] = CRM_Utils_Type::escape($selection, $type);
1990             }
1991             $clause
1992               = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
1993               "') )";
1994           }
1995           else {
1996             // for numerical values
1997             $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
1998               ")";
1999           }
2000           if ($op == 'notin') {
2001             $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
2002           }
2003           else {
2004             $clause = "( " . $clause . " )";
2005           }
2006         }
2007         break;
2008
2009       case 'mhas':
2010       case 'mnot':
2011         // multiple has or multiple not
2012         if ($value !== NULL && count($value) > 0) {
2013           $value = CRM_Utils_Type::escapeAll($value, $type);
2014           $operator = $op == 'mnot' ? 'NOT' : '';
2015           $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
2016           $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
2017         }
2018         break;
2019
2020       case 'sw':
2021       case 'ew':
2022         if ($value !== NULL && strlen($value) > 0) {
2023           $value = CRM_Utils_Type::escape($value, $type);
2024           if (strpos($value, '%') === FALSE) {
2025             if ($op == 'sw') {
2026               $value = "'{$value}%'";
2027             }
2028             else {
2029               $value = "'%{$value}'";
2030             }
2031           }
2032           else {
2033             $value = "'{$value}'";
2034           }
2035           $sqlOP = $this->getSQLOperator($op);
2036           $clause = "( {$field['dbAlias']} $sqlOP $value )";
2037         }
2038         break;
2039
2040       case 'nll':
2041       case 'nnll':
2042         $sqlOP = $this->getSQLOperator($op);
2043         $clause = "( {$field['dbAlias']} $sqlOP )";
2044         break;
2045
2046       case 'eq':
2047       case 'neq':
2048       case 'ne':
2049         //CRM-18457: some custom field passes value in array format against binary operator
2050         if (is_array($value) && count($value)) {
2051           $value = $value[0];
2052         }
2053
2054       default:
2055         if ($value !== NULL && $value !== '') {
2056           if (isset($field['clause'])) {
2057             // FIXME: we not doing escape here. Better solution is to use two
2058             // different types - data-type and filter-type
2059             $clause = $field['clause'];
2060           }
2061           elseif (!is_array($value)) {
2062             $value = CRM_Utils_Type::escape($value, $type);
2063             $sqlOP = $this->getSQLOperator($op);
2064             if ($field['type'] == CRM_Utils_Type::T_STRING) {
2065               $value = "'{$value}'";
2066             }
2067             $clause = "( {$field['dbAlias']} $sqlOP $value )";
2068           }
2069         }
2070         break;
2071     }
2072
2073     if (!empty($field['group']) && $clause) {
2074       $clause = $this->whereGroupClause($field, $value, $op);
2075     }
2076     elseif (!empty($field['tag']) && $clause) {
2077       // not using left join in query because if any contact
2078       // belongs to more than one tag, results duplicate
2079       // entries.
2080       $clause = $this->whereTagClause($field, $value, $op);
2081     }
2082     elseif (!empty($field['membership_org']) && $clause) {
2083       $clause = $this->whereMembershipOrgClause($value, $op);
2084     }
2085     elseif (!empty($field['membership_type']) && $clause) {
2086       $clause = $this->whereMembershipTypeClause($value, $op);
2087     }
2088     return $clause;
2089   }
2090
2091   /**
2092    * Get SQL where clause for a date field.
2093    *
2094    * @param string $fieldName
2095    * @param string $relative
2096    * @param string $from
2097    * @param string $to
2098    * @param string $type
2099    * @param string $fromTime
2100    * @param string $toTime
2101    *
2102    * @return null|string
2103    */
2104   public function dateClause(
2105     $fieldName,
2106     $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2107   ) {
2108     $clauses = array();
2109     if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)))) {
2110       $sqlOP = $this->getSQLOperator($relative);
2111       return "( {$fieldName} {$sqlOP} )";
2112     }
2113
2114     list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2115
2116     if ($from) {
2117       $from = ($type == CRM_Utils_Type::T_DATE) ? substr($from, 0, 8) : $from;
2118       $clauses[] = "( {$fieldName} >= $from )";
2119     }
2120
2121     if ($to) {
2122       $to = ($type == CRM_Utils_Type::T_DATE) ? substr($to, 0, 8) : $to;
2123       $clauses[] = "( {$fieldName} <= {$to} )";
2124     }
2125
2126     if (!empty($clauses)) {
2127       return implode(' AND ', $clauses);
2128     }
2129
2130     return NULL;
2131   }
2132
2133   /**
2134    * Get values for from and to for date ranges.
2135    *
2136    * @deprecated
2137    *
2138    * @param bool $relative
2139    * @param string $from
2140    * @param string $to
2141    * @param string $fromTime
2142    * @param string $toTime
2143    *
2144    * @return array
2145    */
2146   public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2147     if (empty($toTime)) {
2148       // odd legacy behaviour to treat NULL as 'end of the day'
2149       // recommend updating reports to call CRM_Utils_Date::getFromTo
2150       //directly (default on the function is the actual default there).
2151       $toTime = '235959';
2152     }
2153     return CRM_Utils_Date::getFromTo($relative, $from, $to, $fromTime, $toTime);
2154   }
2155
2156   /**
2157    * Alter display of rows.
2158    *
2159    * Iterate through the rows retrieved via SQL and make changes for display purposes,
2160    * such as rendering contacts as links.
2161    *
2162    * @param array $rows
2163    *   Rows generated by SQL, with an array for each row.
2164    */
2165   public function alterDisplay(&$rows) {
2166   }
2167
2168   /**
2169    * Alter the way in which custom data fields are displayed.
2170    *
2171    * @param array $rows
2172    */
2173   public function alterCustomDataDisplay(&$rows) {
2174     // custom code to alter rows having custom values
2175     if (empty($this->_customGroupExtends)) {
2176       return;
2177     }
2178
2179     $customFields = array();
2180     $customFieldIds = array();
2181     foreach ($this->_params['fields'] as $fieldAlias => $value) {
2182       if ($fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) {
2183         $customFieldIds[$fieldAlias] = $fieldId;
2184       }
2185     }
2186     if (empty($customFieldIds)) {
2187       return;
2188     }
2189
2190     // skip for type date and ContactReference since date format is already handled
2191     $query = "
2192 SELECT cg.table_name, cf.id
2193 FROM  civicrm_custom_field cf
2194 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2195 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
2196       cg.is_active = 1 AND
2197       cf.is_active = 1 AND
2198       cf.is_searchable = 1 AND
2199       cf.data_type   NOT IN ('ContactReference', 'Date') AND
2200       cf.id IN (" . implode(",", $customFieldIds) . ")";
2201
2202     $dao = CRM_Core_DAO::executeQuery($query);
2203     while ($dao->fetch()) {
2204       $customFields[$dao->table_name . '_custom_' . $dao->id] = $dao->id;
2205     }
2206     $dao->free();
2207
2208     $entryFound = FALSE;
2209     foreach ($rows as $rowNum => $row) {
2210       foreach ($row as $tableCol => $val) {
2211         if (array_key_exists($tableCol, $customFields)) {
2212           $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField::displayValue($val, $customFields[$tableCol]);
2213           $entryFound = TRUE;
2214         }
2215       }
2216
2217       // skip looking further in rows, if first row itself doesn't
2218       // have the column we need
2219       if (!$entryFound) {
2220         break;
2221       }
2222     }
2223   }
2224
2225   /**
2226    * Remove duplicate rows.
2227    *
2228    * @param array $rows
2229    */
2230   public function removeDuplicates(&$rows) {
2231     if (empty($this->_noRepeats)) {
2232       return;
2233     }
2234     $checkList = array();
2235
2236     foreach ($rows as $key => $list) {
2237       foreach ($list as $colName => $colVal) {
2238         if (array_key_exists($colName, $checkList) &&
2239           $checkList[$colName] == $colVal
2240         ) {
2241           $rows[$key][$colName] = "";
2242         }
2243         if (in_array($colName, $this->_noRepeats)) {
2244           $checkList[$colName] = $colVal;
2245         }
2246       }
2247     }
2248   }
2249
2250   /**
2251    * Fix subtotal display.
2252    *
2253    * @param array $row
2254    * @param array $fields
2255    * @param bool $subtotal
2256    */
2257   public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2258     foreach ($row as $colName => $colVal) {
2259       if (in_array($colName, $fields)) {
2260       }
2261       elseif (isset($this->_columnHeaders[$colName])) {
2262         if ($subtotal) {
2263           $row[$colName] = 'Subtotal';
2264           $subtotal = FALSE;
2265         }
2266         else {
2267           unset($row[$colName]);
2268         }
2269       }
2270     }
2271   }
2272
2273   /**
2274    * Calculate grant total.
2275    *
2276    * @param array $rows
2277    *
2278    * @return bool
2279    */
2280   public function grandTotal(&$rows) {
2281     if (!$this->_rollup  || count($rows) == 1) {
2282       return FALSE;
2283     }
2284
2285     $this->moveSummaryColumnsToTheRightHandSide();
2286
2287     if ($this->_limit && count($rows) >= self::ROW_COUNT_LIMIT) {
2288       return FALSE;
2289     }
2290
2291     $this->rollupRow = array_pop($rows);
2292
2293     foreach ($this->_columnHeaders as $fld => $val) {
2294       if (!in_array($fld, $this->_statFields)) {
2295         if (!$this->_grandFlag) {
2296           $this->rollupRow[$fld] = ts('Grand Total');
2297           $this->_grandFlag = TRUE;
2298         }
2299         else {
2300           $this->rollupRow[$fld] = "";
2301         }
2302       }
2303     }
2304
2305     $this->assign('grandStat', $this->rollupRow);
2306     return TRUE;
2307   }
2308
2309   /**
2310    * Format display output.
2311    *
2312    * @param array $rows
2313    * @param bool $pager
2314    */
2315   public function formatDisplay(&$rows, $pager = TRUE) {
2316     // set pager based on if any limit was applied in the query.
2317     if ($pager) {
2318       $this->setPager();
2319     }
2320
2321     // allow building charts if any
2322     if (!empty($this->_params['charts']) && !empty($rows)) {
2323       $this->buildChart($rows);
2324       $this->assign('chartEnabled', TRUE);
2325       $this->_chartId = "{$this->_params['charts']}_" .
2326         ($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' .
2327         session_id();
2328       $this->assign('chartId', $this->_chartId);
2329     }
2330
2331     // unset columns not to be displayed.
2332     foreach ($this->_columnHeaders as $key => $value) {
2333       if (!empty($value['no_display'])) {
2334         unset($this->_columnHeaders[$key]);
2335       }
2336     }
2337
2338     // unset columns not to be displayed.
2339     if (!empty($rows)) {
2340       foreach ($this->_noDisplay as $noDisplayField) {
2341         foreach ($rows as $rowNum => $row) {
2342           unset($this->_columnHeaders[$noDisplayField]);
2343         }
2344       }
2345     }
2346
2347     // build array of section totals
2348     $this->sectionTotals();
2349
2350     // process grand-total row
2351     $this->grandTotal($rows);
2352
2353     // Find alter display functions.
2354     $firstRow = reset($rows);
2355     if ($firstRow) {
2356       $selectedFields = array_keys($firstRow);
2357       $alterFunctions = $alterMap = $alterSpecs = array();
2358       foreach ($this->_columns as $tableName => $table) {
2359         if (array_key_exists('metadata', $table)) {
2360           foreach ($table['metadata'] as $field => $specs) {
2361             if (in_array($tableName . '_' . $field, $selectedFields)) {
2362               if (array_key_exists('alter_display', $specs)) {
2363                 $alterFunctions[$tableName . '_' . $field] = $specs['alter_display'];
2364                 $alterMap[$tableName . '_' . $field] = $field;
2365                 $alterSpecs[$tableName . '_' . $field] = NULL;
2366               }
2367               // Add any alters that can be intuited from the field specs.
2368               // So far only boolean but a lot more could be.
2369               if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type::T_BOOLEAN) {
2370                 $alterFunctions[$tableName . '_' . $field] = 'alterBoolean';
2371                 $alterMap[$tableName . '_' . $field] = $field;
2372                 $alterSpecs[$tableName . '_' . $field] = NULL;
2373               }
2374             }
2375           }
2376         }
2377       }
2378
2379       // Run the alter display functions
2380       foreach ($rows as $index => & $row) {
2381         foreach ($row as $selectedField => $value) {
2382           if (array_key_exists($selectedField, $alterFunctions)) {
2383             $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]);
2384           }
2385         }
2386       }
2387     }
2388
2389     // use this method for formatting rows for display purpose.
2390     $this->alterDisplay($rows);
2391     CRM_Utils_Hook::alterReportVar('rows', $rows, $this);
2392
2393     // use this method for formatting custom rows for display purpose.
2394     $this->alterCustomDataDisplay($rows);
2395   }
2396
2397   /**
2398    * @param $value
2399    * @param $row
2400    * @param $selectedfield
2401    * @param $criteriaFieldName
2402    *
2403    * @return array
2404    */
2405   protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) {
2406     $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl);
2407     $row[$selectedfield . '_link'] = $url;
2408     $row[$selectedfield . '_hover'] = ts("%1 for this state.", array(
2409       1 => $value,
2410     ));
2411
2412     $states = CRM_Core_PseudoConstant::stateProvince($value, FALSE);
2413     if (!is_array($states)) {
2414       return $states;
2415     }
2416   }
2417
2418   /**
2419    * @param $value
2420    * @param $row
2421    * @param $selectedField
2422    * @param $criteriaFieldName
2423    *
2424    * @return array
2425    */
2426   protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) {
2427     $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl);
2428     $row[$selectedField . '_link'] = $url;
2429     $row[$selectedField . '_hover'] = ts("%1 for this country.", array(
2430       1 => $value,
2431     ));
2432     $countries = CRM_Core_PseudoConstant::country($value, FALSE);
2433     if (!is_array($countries)) {
2434       return $countries;
2435     }
2436   }
2437
2438   /**
2439    * @param $value
2440    * @param $row
2441    * @param $selectedfield
2442    * @param $criteriaFieldName
2443    *
2444    * @return array
2445    */
2446   protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) {
2447     $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl);
2448     $row[$selectedfield . '_link'] = $url;
2449     $row[$selectedfield . '_hover'] = ts("%1 for this county.", array(
2450       1 => $value,
2451     ));
2452     $counties = CRM_Core_PseudoConstant::county($value, FALSE);
2453     if (!is_array($counties)) {
2454       return $counties;
2455     }
2456   }
2457
2458   /**
2459    * @param $value
2460    * @param $row
2461    * @param $selectedfield
2462    * @param $criteriaFieldName
2463    *
2464    * @return mixed
2465    */
2466   protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) {
2467     return CRM_Core_PseudoConstant::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value);
2468   }
2469
2470   /**
2471    * @param $value
2472    * @param $row
2473    * @param $fieldname
2474    *
2475    * @return mixed
2476    */
2477   protected function alterContactID($value, &$row, $fieldname) {
2478     $nameField = substr($fieldname, 0, -2) . 'name';
2479     static $first = TRUE;
2480     static $viewContactList = FALSE;
2481     if ($first) {
2482       $viewContactList = CRM_Core_Permission::check('access CiviCRM');
2483       $first = FALSE;
2484     }
2485     if (!$viewContactList) {
2486       return $value;
2487     }
2488     if (array_key_exists($nameField, $row)) {
2489       $row[$nameField . '_link'] = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl);
2490     }
2491     else {
2492       $row[$fieldname . '_link'] = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl);
2493     }
2494     return $value;
2495   }
2496
2497   /**
2498    * @param $value
2499    *
2500    * @return mixed
2501    */
2502   protected function alterBoolean($value) {
2503     $options = array(0 => '', 1 => ts('Yes'));
2504     if (isset($options[$value])) {
2505       return $options[$value];
2506     }
2507     return $value;
2508   }
2509
2510   /**
2511    * Build chart.
2512    *
2513    * @param array $rows
2514    */
2515   public function buildChart(&$rows) {
2516     // override this method for building charts.
2517   }
2518
2519   // select() method below has been added recently (v3.3), and many of the report templates might
2520   // still be having their own select() method. We should fix them as and when encountered and move
2521   // towards generalizing the select() method below.
2522
2523   /**
2524    * Generate the SELECT clause and set class variable $_select.
2525    */
2526   public function select() {
2527     $select = $this->_selectAliases = array();
2528     $this->storeGroupByArray();
2529
2530     foreach ($this->_columns as $tableName => $table) {
2531       if (array_key_exists('fields', $table)) {
2532         foreach ($table['fields'] as $fieldName => $field) {
2533           if ($tableName == 'civicrm_address') {
2534             // deprecated, use $this->isTableSelected.
2535             $this->_addressField = TRUE;
2536           }
2537           if ($tableName == 'civicrm_email') {
2538             $this->_emailField = TRUE;
2539           }
2540           if ($tableName == 'civicrm_phone') {
2541             $this->_phoneField = TRUE;
2542           }
2543
2544           if (!empty($field['required']) ||
2545             !empty($this->_params['fields'][$fieldName])
2546           ) {
2547
2548             // 1. In many cases we want select clause to be built in slightly different way
2549             // for a particular field of a particular type.
2550             // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2551             // as needed.
2552             $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2553             if ($selectClause) {
2554               $select[] = $selectClause;
2555               continue;
2556             }
2557
2558             // include statistics columns only if set
2559             if (!empty($field['statistics']) && !empty($this->_groupByArray)) {
2560               $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select);
2561             }
2562             else {
2563
2564               $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field);
2565               if ($selectClause) {
2566                 $select[] = $selectClause;
2567               }
2568               else {
2569                 $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select);
2570               }
2571             }
2572           }
2573         }
2574       }
2575
2576       // select for group bys
2577       if (array_key_exists('group_bys', $table)) {
2578         foreach ($table['group_bys'] as $fieldName => $field) {
2579
2580           if ($tableName == 'civicrm_address') {
2581             $this->_addressField = TRUE;
2582           }
2583           if ($tableName == 'civicrm_email') {
2584             $this->_emailField = TRUE;
2585           }
2586           if ($tableName == 'civicrm_phone') {
2587             $this->_phoneField = TRUE;
2588           }
2589           // 1. In many cases we want select clause to be built in slightly different way
2590           // for a particular field of a particular type.
2591           // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2592           // as needed.
2593           $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2594           if ($selectClause) {
2595             $select[] = $selectClause;
2596             continue;
2597           }
2598
2599           if (!empty($this->_params['group_bys']) &&
2600             !empty($this->_params['group_bys'][$fieldName]) &&
2601             !empty($this->_params['group_bys_freq'])
2602           ) {
2603             switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) {
2604               case 'YEARWEEK':
2605                 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2606                 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2607                 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2608                 $field['title'] = 'Week';
2609                 break;
2610
2611               case 'YEAR':
2612                 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1)  AS {$tableName}_{$fieldName}_start";
2613                 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2614                 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2615                 $field['title'] = 'Year';
2616                 break;
2617
2618               case 'MONTH':
2619                 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2620                 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2621                 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2622                 $field['title'] = 'Month';
2623                 break;
2624
2625               case 'QUARTER':
2626                 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2627                 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2628                 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2629                 $field['title'] = 'Quarter';
2630                 break;
2631             }
2632             // for graphs and charts -
2633             if (!empty($this->_params['group_bys_freq'][$fieldName])) {
2634               $this->_interval = $field['title'];
2635               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title']
2636                 = $field['title'] . ' Beginning';
2637               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2638               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName];
2639
2640               // just to make sure these values are transferred to rows.
2641               // since we 'll need them for calculation purpose,
2642               // e.g making subtotals look nicer or graphs
2643               $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
2644               $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
2645             }
2646           }
2647         }
2648       }
2649     }
2650
2651     if (empty($select)) {
2652       // CRM-21412 Do not give fatal error on report when no fields selected
2653       $select = array(1);
2654     }
2655
2656     $this->_selectClauses = $select;
2657     $this->_select = "SELECT " . implode(', ', $select) . " ";
2658   }
2659
2660   /**
2661    * Build select clause for a single field.
2662    *
2663    * @param string $tableName
2664    * @param string $tableKey
2665    * @param string $fieldName
2666    * @param string $field
2667    *
2668    * @return bool
2669    */
2670   public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2671     if (!empty($field['pseudofield'])) {
2672       $alias = "{$tableName}_{$fieldName}";
2673       $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
2674       $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
2675       $this->_columnHeaders["{$tableName}_{$fieldName}"]['dbAlias'] = CRM_Utils_Array::value('dbAlias', $field);
2676       $this->_selectAliases[] = $alias;
2677       return ' 1 as  ' . $alias;
2678     }
2679     return FALSE;
2680   }
2681
2682   /**
2683    * Build where clause.
2684    */
2685   public function where() {
2686     $this->storeWhereHavingClauseArray();
2687
2688     if (empty($this->_whereClauses)) {
2689       $this->_where = "WHERE ( 1 ) ";
2690       $this->_having = "";
2691     }
2692     else {
2693       $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses);
2694     }
2695
2696     if ($this->_aclWhere) {
2697       $this->_where .= " AND {$this->_aclWhere} ";
2698     }
2699
2700     if (!empty($this->_havingClauses)) {
2701       // use this clause to construct group by clause.
2702       $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses);
2703     }
2704   }
2705
2706   /**
2707    * Store Where clauses into an array.
2708    *
2709    * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2710    * temp table that may not be part of the final where clause or added
2711    * in other functions
2712    */
2713   public function storeWhereHavingClauseArray() {
2714     foreach ($this->_columns as $tableName => $table) {
2715       if (array_key_exists('filters', $table)) {
2716         foreach ($table['filters'] as $fieldName => $field) {
2717           // respect pseudofield to filter spec so fields can be marked as
2718           // not to be handled here
2719           if (!empty($field['pseudofield'])) {
2720             continue;
2721           }
2722           $clause = $this->generateFilterClause($field, $fieldName);
2723
2724           if (!empty($clause)) {
2725             if (!empty($field['having'])) {
2726               $this->_havingClauses[] = $clause;
2727             }
2728             else {
2729               $this->_whereClauses[] = $clause;
2730             }
2731           }
2732         }
2733       }
2734     }
2735
2736   }
2737
2738   /**
2739    * Set output mode.
2740    */
2741   public function processReportMode() {
2742     $this->setOutputMode();
2743
2744     $this->_sendmail
2745       = CRM_Utils_Request::retrieve(
2746         'sendmail',
2747         'Boolean',
2748         CRM_Core_DAO::$_nullObject
2749       );
2750
2751     $this->_absoluteUrl = FALSE;
2752     $printOnly = FALSE;
2753     $this->assign('printOnly', FALSE);
2754
2755     if ($this->_outputMode == 'print' ||
2756       ($this->_sendmail && !$this->_outputMode)
2757     ) {
2758       $this->assign('printOnly', TRUE);
2759       $printOnly = TRUE;
2760       $this->addPaging = FALSE;
2761       $this->assign('outputMode', 'print');
2762       $this->_outputMode = 'print';
2763       if ($this->_sendmail) {
2764         $this->_absoluteUrl = TRUE;
2765       }
2766     }
2767     elseif ($this->_outputMode == 'pdf') {
2768       $printOnly = TRUE;
2769       $this->addPaging = FALSE;
2770       $this->_absoluteUrl = TRUE;
2771     }
2772     elseif ($this->_outputMode == 'csv') {
2773       $printOnly = TRUE;
2774       $this->_absoluteUrl = TRUE;
2775       $this->addPaging = FALSE;
2776     }
2777     elseif ($this->_outputMode == 'group') {
2778       $this->assign('outputMode', 'group');
2779     }
2780     elseif ($this->_outputMode == 'create_report' && $this->_criteriaForm) {
2781       $this->assign('outputMode', 'create_report');
2782     }
2783     elseif ($this->_outputMode == 'copy' && $this->_criteriaForm) {
2784       $this->_createNew = TRUE;
2785     }
2786
2787     $this->assign('outputMode', $this->_outputMode);
2788     $this->assign('printOnly', $printOnly);
2789     // Get today's date to include in printed reports
2790     if ($printOnly) {
2791       $reportDate = CRM_Utils_Date::customFormat(date('Y-m-d H:i'));
2792       $this->assign('reportDate', $reportDate);
2793     }
2794   }
2795
2796   /**
2797    * Post Processing function for Form.
2798    *
2799    * postProcessCommon should be used to set other variables from input as the api accesses that function.
2800    * This function is not accessed when the api calls the report.
2801    */
2802   public function beginPostProcess() {
2803     $this->setParams($this->controller->exportValues($this->_name));
2804     if (empty($this->_params) &&
2805       $this->_force
2806     ) {
2807       $this->setParams($this->_formValues);
2808     }
2809
2810     // hack to fix params when submitted from dashboard, CRM-8532
2811     // fields array is missing because form building etc is skipped
2812     // in dashboard mode for report
2813     //@todo - this could be done in the dashboard no we have a setter
2814     if (empty($this->_params['fields']) && !$this->_noFields) {
2815       $this->setParams($this->_formValues);
2816     }
2817
2818     $this->processReportMode();
2819
2820     if ($this->_outputMode == 'save' || $this->_outputMode == 'copy') {
2821       $this->_createNew = ($this->_outputMode == 'copy');
2822       CRM_Report_Form_Instance::postProcess($this);
2823     }
2824     if ($this->_outputMode == 'delete') {
2825       CRM_Report_BAO_ReportInstance::doFormDelete($this->_id, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2826     }
2827
2828     $this->_formValues = $this->_params;
2829
2830     $this->beginPostProcessCommon();
2831   }
2832
2833   /**
2834    * BeginPostProcess function run in both report mode and non-report mode (api).
2835    */
2836   public function beginPostProcessCommon() {
2837   }
2838
2839   /**
2840    * Build the report query.
2841    *
2842    * @param bool $applyLimit
2843    *
2844    * @return string
2845    */
2846   public function buildQuery($applyLimit = TRUE) {
2847     $this->buildGroupTempTable();
2848     $this->select();
2849     $this->from();
2850     $this->customDataFrom();
2851     $this->buildPermissionClause();
2852     $this->where();
2853     $this->groupBy();
2854     $this->orderBy();
2855
2856     foreach ($this->unselectedOrderByColumns() as $alias => $field) {
2857       $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field);
2858       if (!$clause) {
2859         $clause = "{$field['dbAlias']} as {$alias}";
2860       }
2861       $this->_select .= ", $clause ";
2862     }
2863
2864     if ($applyLimit && empty($this->_params['charts'])) {
2865       $this->limit();
2866     }
2867     CRM_Utils_Hook::alterReportVar('sql', $this, $this);
2868
2869     $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2870     $this->addToDeveloperTab($sql);
2871     return $sql;
2872   }
2873
2874   /**
2875    * Build group by clause.
2876    */
2877   public function groupBy() {
2878     $this->storeGroupByArray();
2879
2880     if (!empty($this->_groupByArray)) {
2881       if ($this->optimisedForOnlyFullGroupBy) {
2882         // We should probably deprecate this code path. What happens here is that
2883         // the group by is amended to reflect the select columns. This often breaks the
2884         // results. Retrofitting group strict group by onto existing report classes
2885         // went badly.
2886         $this->_groupBy = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($this->_selectClauses, $this->_groupByArray);
2887       }
2888       else {
2889         $this->_groupBy = ' GROUP BY ' . implode($this->_groupByArray);
2890       }
2891     }
2892   }
2893
2894   /**
2895    * Build order by clause.
2896    */
2897   public function orderBy() {
2898     $this->_orderBy = "";
2899     $this->_sections = array();
2900     $this->storeOrderByArray();
2901     if (!empty($this->_orderByArray) && !$this->_rollup == 'WITH ROLLUP') {
2902       $this->_orderBy = "ORDER BY " . implode(', ', $this->_orderByArray);
2903     }
2904     $this->assign('sections', $this->_sections);
2905   }
2906
2907   /**
2908    * Extract order by fields and store as an array.
2909    *
2910    * In some cases other functions want to know which fields are selected for ordering by
2911    * Separating this into a separate function allows it to be called separately from constructing
2912    * the order by clause
2913    */
2914   public function storeOrderByArray() {
2915     $orderBys = array();
2916
2917     if (!empty($this->_params['order_bys']) &&
2918       is_array($this->_params['order_bys']) &&
2919       !empty($this->_params['order_bys'])
2920     ) {
2921
2922       // Process order_bys in user-specified order
2923       foreach ($this->_params['order_bys'] as $orderBy) {
2924         $orderByField = array();
2925         foreach ($this->_columns as $tableName => $table) {
2926           if (array_key_exists('order_bys', $table)) {
2927             // For DAO columns defined in $this->_columns
2928             $fields = $table['order_bys'];
2929           }
2930           elseif (array_key_exists('extends', $table)) {
2931             // For custom fields referenced in $this->_customGroupExtends
2932             $fields = CRM_Utils_Array::value('fields', $table, array());
2933           }
2934           else {
2935             continue;
2936           }
2937           if (!empty($fields) && is_array($fields)) {
2938             foreach ($fields as $fieldName => $field) {
2939               if ($fieldName == $orderBy['column']) {
2940                 $orderByField = array_merge($field, $orderBy);
2941                 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
2942                 break 2;
2943               }
2944             }
2945           }
2946         }
2947
2948         if (!empty($orderByField)) {
2949           $this->_orderByFields[$orderByField['tplField']] = $orderByField;
2950           if ($this->groupConcatTested) {
2951             $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}";
2952           }
2953           else {
2954             // Not sure when this is preferable to using tplField (which has
2955             // definitely been tested to work in cases then this does not.
2956             // in caution not switching unless report has been tested for
2957             // group concat functionality.
2958             $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}";
2959           }
2960
2961           // Record any section headers for assignment to the template
2962           if (!empty($orderBy['section'])) {
2963             $orderByField['pageBreak'] = CRM_Utils_Array::value('pageBreak', $orderBy);
2964             $this->_sections[$orderByField['tplField']] = $orderByField;
2965           }
2966         }
2967       }
2968     }
2969
2970     $this->_orderByArray = $orderBys;
2971
2972     $this->assign('sections', $this->_sections);
2973   }
2974
2975   /**
2976    * Determine unselected columns.
2977    *
2978    * @return array
2979    */
2980   public function unselectedOrderByColumns() {
2981     return array_diff_key($this->_orderByFields, $this->getSelectColumns());
2982   }
2983
2984   /**
2985    * Determine unselected columns.
2986    *
2987    * @return array
2988    */
2989   public function unselectedSectionColumns() {
2990     if (is_array($this->_sections)) {
2991       return array_diff_key($this->_sections, $this->getSelectColumns());
2992     }
2993     else {
2994       return array();
2995     }
2996   }
2997
2998   /**
2999    * Build output rows.
3000    *
3001    * @param string $sql
3002    * @param array $rows
3003    */
3004   public function buildRows($sql, &$rows) {
3005     if (!$this->optimisedForOnlyFullGroupBy) {
3006       CRM_Core_DAO::disableFullGroupByMode();
3007     }
3008     $dao = CRM_Core_DAO::executeQuery($sql);
3009     if (stristr($this->_select, 'SQL_CALC_FOUND_ROWS')) {
3010       $this->_rowsFound = CRM_Core_DAO::singleValueQuery('SELECT FOUND_ROWS()');
3011     }
3012     CRM_Core_DAO::reenableFullGroupByMode();
3013     if (!is_array($rows)) {
3014       $rows = array();
3015     }
3016
3017     // use this method to modify $this->_columnHeaders
3018     $this->modifyColumnHeaders();
3019
3020     $unselectedSectionColumns = $this->unselectedSectionColumns();
3021
3022     while ($dao->fetch()) {
3023       $row = array();
3024       foreach ($this->_columnHeaders as $key => $value) {
3025         if (property_exists($dao, $key)) {
3026           $row[$key] = $dao->$key;
3027         }
3028       }
3029
3030       // section headers not selected for display need to be added to row
3031       foreach ($unselectedSectionColumns as $key => $values) {
3032         if (property_exists($dao, $key)) {
3033           $row[$key] = $dao->$key;
3034         }
3035       }
3036
3037       $rows[] = $row;
3038     }
3039   }
3040
3041   /**
3042    * Calculate section totals.
3043    *
3044    * When "order by" fields are marked as sections, this assigns to the template
3045    * an array of total counts for each section. This data is used by the Smarty
3046    * plugin {sectionTotal}.
3047    */
3048   public function sectionTotals() {
3049
3050     // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
3051     if (empty($this->_selectAliases)) {
3052       return;
3053     }
3054
3055     if (!empty($this->_sections)) {
3056       // build the query with no LIMIT clause
3057       $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select);
3058       $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3059
3060       // pull section aliases out of $this->_sections
3061       $sectionAliases = array_keys($this->_sections);
3062
3063       $ifnulls = array();
3064       foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) {
3065         $ifnulls[] = "ifnull($alias, '') as $alias";
3066       }
3067       $this->_select = "SELECT " . implode(", ", $ifnulls);
3068       $this->_select = CRM_Contact_BAO_Query::appendAnyValueToSelect($ifnulls, $sectionAliases);
3069
3070       // Group (un-limited) report by all aliases and get counts. This might
3071       // be done more efficiently when the contents of $sql are known, ie. by
3072       // overriding this method in the report class.
3073
3074       $query = $this->_select .
3075         ", count(*) as ct from ($sql) as subquery group by " .
3076         implode(", ", $sectionAliases);
3077
3078       // initialize array of total counts
3079       $totals = array();
3080       $dao = CRM_Core_DAO::executeQuery($query);
3081       while ($dao->fetch()) {
3082
3083         // let $this->_alterDisplay translate any integer ids to human-readable values.
3084         $rows[0] = $dao->toArray();
3085         $this->alterDisplay($rows);
3086         $row = $rows[0];
3087
3088         // add totals for all permutations of section values
3089         $values = array();
3090         $i = 1;
3091         $aliasCount = count($sectionAliases);
3092         foreach ($sectionAliases as $alias) {
3093           $values[] = $row[$alias];
3094           $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values);
3095           if ($i == $aliasCount) {
3096             // the last alias is the lowest-level section header; use count as-is
3097             $totals[$key] = $dao->ct;
3098           }
3099           else {
3100             // other aliases are higher level; roll count into their total
3101             $totals[$key] += $dao->ct;
3102           }
3103         }
3104       }
3105       $this->assign('sectionTotals', $totals);
3106     }
3107   }
3108
3109   /**
3110    * Modify column headers.
3111    */
3112   public function modifyColumnHeaders() {
3113     // use this method to modify $this->_columnHeaders
3114   }
3115
3116   /**
3117    * Move totals columns to the right edge of the table.
3118    *
3119    * It seems like a more logical layout to have any totals columns on the far right regardless of
3120    * the location of the rest of their table.
3121    */
3122   public function moveSummaryColumnsToTheRightHandSide() {
3123     $statHeaders = (array_intersect_key($this->_columnHeaders, array_flip($this->_statFields)));
3124     $this->_columnHeaders = array_merge(array_diff_key($this->_columnHeaders, $statHeaders), $this->_columnHeaders, $statHeaders);
3125   }
3126
3127   /**
3128    * Assign rows to the template.
3129    *
3130    * @param array $rows
3131    */
3132   public function doTemplateAssignment(&$rows) {
3133     $this->assign_by_ref('columnHeaders', $this->_columnHeaders);
3134     $this->assign_by_ref('rows', $rows);
3135     $this->assign('statistics', $this->statistics($rows));
3136   }
3137
3138   /**
3139    * Build report statistics.
3140    *
3141    * Override this method to build your own statistics.
3142    *
3143    * @param array $rows
3144    *
3145    * @return array
3146    */
3147   public function statistics(&$rows) {
3148     $statistics = array();
3149
3150     $count = count($rows);
3151     // Why do we increment the count for rollup seems to artificially inflate the count.
3152     // It seems perhaps intentional to include the summary row in the count of results - although
3153     // this just seems odd.
3154     if ($this->_rollup && ($this->_rollup != '') && $this->_grandFlag) {
3155       $count++;
3156     }
3157
3158     $this->countStat($statistics, $count);
3159
3160     $this->groupByStat($statistics);
3161
3162     $this->filterStat($statistics);
3163
3164     return $statistics;
3165   }
3166
3167   /**
3168    * Add count statistics.
3169    *
3170    * @param array $statistics
3171    * @param int $count
3172    */
3173   public function countStat(&$statistics, $count) {
3174     $statistics['counts']['rowCount'] = array(
3175       'title' => ts('Row(s) Listed'),
3176       'value' => $count,
3177     );
3178
3179     if ($this->_rowsFound && ($this->_rowsFound > $count)) {
3180       $statistics['counts']['rowsFound'] = array(
3181         'title' => ts('Total Row(s)'),
3182         'value' => $this->_rowsFound,
3183       );
3184     }
3185   }
3186
3187   /**
3188    * Add group by statistics.
3189    *
3190    * @param array $statistics
3191    */
3192   public function groupByStat(&$statistics) {
3193     if (!empty($this->_params['group_bys']) &&
3194       is_array($this->_params['group_bys']) &&
3195       !empty($this->_params['group_bys'])
3196     ) {
3197       foreach ($this->_columns as $tableName => $table) {
3198         if (array_key_exists('group_bys', $table)) {
3199           foreach ($table['group_bys'] as $fieldName => $field) {
3200             if (!empty($this->_params['group_bys'][$fieldName])) {
3201               $combinations[] = $field['title'];
3202             }
3203           }
3204         }
3205       }
3206       $statistics['groups'][] = array(
3207         'title' => ts('Grouping(s)'),
3208         'value' => implode(' & ', $combinations),
3209       );
3210     }
3211   }
3212
3213   /**
3214    * Filter statistics.
3215    *
3216    * @param array $statistics
3217    */
3218   public function filterStat(&$statistics) {
3219     foreach ($this->_columns as $tableName => $table) {
3220       if (array_key_exists('filters', $table)) {
3221         foreach ($table['filters'] as $fieldName => $field) {
3222           if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE ||
3223               CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_TIME) &&
3224             CRM_Utils_Array::value('operatorType', $field) !=
3225             CRM_Report_Form::OP_MONTH
3226           ) {
3227             list($from, $to)
3228               = $this->getFromTo(
3229                 CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
3230                 CRM_Utils_Array::value("{$fieldName}_from", $this->_params),
3231                 CRM_Utils_Array::value("{$fieldName}_to", $this->_params),
3232                 CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params),
3233                 CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params)
3234               );
3235             $from_time_format = !empty($this->_params["{$fieldName}_from_time"]) ? 'h' : 'd';
3236             $from = CRM_Utils_Date::customFormat($from, NULL, array($from_time_format));
3237
3238             $to_time_format = !empty($this->_params["{$fieldName}_to_time"]) ? 'h' : 'd';
3239             $to = CRM_Utils_Date::customFormat($to, NULL, array($to_time_format));
3240
3241             if ($from || $to) {
3242               $statistics['filters'][] = array(
3243                 'title' => $field['title'],
3244                 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)),
3245               );
3246             }
3247             elseif (in_array($rel = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
3248               array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE))
3249             )) {
3250               $pair = $this->getOperationPair(CRM_Report_Form::OP_DATE);
3251               $statistics['filters'][] = array(
3252                 'title' => $field['title'],
3253                 'value' => $pair[$rel],
3254               );
3255             }
3256           }
3257           else {
3258             $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
3259             $value = NULL;
3260             if ($op) {
3261               $pair = $this->getOperationPair(
3262                 CRM_Utils_Array::value('operatorType', $field),
3263                 $fieldName
3264               );
3265               $min = CRM_Utils_Array::value("{$fieldName}_min", $this->_params);
3266               $max = CRM_Utils_Array::value("{$fieldName}_max", $this->_params);
3267               $val = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
3268               if (in_array($op, array('bw', 'nbw')) && ($min || $max)) {
3269                 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3270               }
3271               elseif ($val && CRM_Utils_Array::value('operatorType', $field) & self::OP_ENTITYREF) {
3272                 $this->setEntityRefDefaults($field, $tableName);
3273                 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3274                   array('id' => $val) +
3275                   CRM_Utils_Array::value('api', $field['attributes'], array()));
3276                 $values = array();
3277                 foreach ($result['values'] as $v) {
3278                   $values[] = $v['label'];
3279                 }
3280                 $value = "{$pair[$op]} " . implode(', ', $values);
3281               }
3282               elseif ($op == 'nll' || $op == 'nnll') {
3283                 $value = $pair[$op];
3284               }
3285               elseif (is_array($val) && (!empty($val))) {
3286                 $options = CRM_Utils_Array::value('options', $field, array());
3287                 foreach ($val as $key => $valIds) {
3288                   if (isset($options[$valIds])) {
3289                     $val[$key] = $options[$valIds];
3290                   }
3291                 }
3292                 $pair[$op] = (count($val) == 1) ? (($op == 'notin' || $op ==
3293                   'mnot') ? ts('Is Not') : ts('Is')) : CRM_Utils_Array::value($op, $pair);
3294                 $val = implode(', ', $val);
3295                 $value = "{$pair[$op]} " . $val;
3296               }
3297               elseif (!is_array($val) && (!empty($val) || $val == '0') &&
3298                 isset($field['options']) &&
3299                 is_array($field['options']) && !empty($field['options'])
3300               ) {
3301                 $value = CRM_Utils_Array::value($op, $pair) . " " .
3302                   CRM_Utils_Array::value($val, $field['options'], $val);
3303               }
3304               elseif ($val) {
3305                 $value = CRM_Utils_Array::value($op, $pair) . " " . $val;
3306               }
3307             }
3308             if ($value && empty($field['no_display'])) {
3309               $statistics['filters'][] = array(
3310                 'title' => CRM_Utils_Array::value('title', $field),
3311                 'value' => $value,
3312               );
3313             }
3314           }
3315         }
3316       }
3317     }
3318   }
3319
3320   /**
3321    * End post processing.
3322    *
3323    * @param array|null $rows
3324    */
3325   public function endPostProcess(&$rows = NULL) {
3326     $this->assign('report_class', get_class($this));
3327     if ($this->_storeResultSet) {
3328       $this->_resultSet = $rows;
3329     }
3330
3331     if ($this->_outputMode == 'print' ||
3332       $this->_outputMode == 'pdf' ||
3333       $this->_sendmail
3334     ) {
3335
3336       $content = $this->compileContent();
3337       $url = CRM_Utils_System::url("civicrm/report/instance/{$this->_id}",
3338         "reset=1", TRUE
3339       );
3340
3341       if ($this->_sendmail) {
3342         $config = CRM_Core_Config::singleton();
3343         $attachments = array();
3344
3345         if ($this->_outputMode == 'csv') {
3346           $content
3347             = $this->_formValues['report_header'] . '<p>' . ts('Report URL') .
3348             ": {$url}</p>" . '<p>' .
3349             ts('The report is attached as a CSV file.') . '</p>' .
3350             $this->_formValues['report_footer'];
3351
3352           $csvFullFilename = $config->templateCompileDir .
3353             CRM_Utils_File::makeFileName('CiviReport.csv');
3354           $csvContent = CRM_Report_Utils_Report::makeCsv($this, $rows);
3355           file_put_contents($csvFullFilename, $csvContent);
3356           $attachments[] = array(
3357             'fullPath' => $csvFullFilename,
3358             'mime_type' => 'text/csv',
3359             'cleanName' => 'CiviReport.csv',
3360           );
3361         }
3362         if ($this->_outputMode == 'pdf') {
3363           // generate PDF content
3364           $pdfFullFilename = $config->templateCompileDir .
3365             CRM_Utils_File::makeFileName('CiviReport.pdf');
3366           file_put_contents($pdfFullFilename,
3367             CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf",
3368               TRUE, array('orientation' => 'landscape')
3369             )
3370           );
3371           // generate Email Content
3372           $content
3373             = $this->_formValues['report_header'] . '<p>' . ts('Report URL') .
3374             ": {$url}</p>" . '<p>' .
3375             ts('The report is attached as a PDF file.') . '</p>' .
3376             $this->_formValues['report_footer'];
3377
3378           $attachments[] = array(
3379             'fullPath' => $pdfFullFilename,
3380             'mime_type' => 'application/pdf',
3381             'cleanName' => 'CiviReport.pdf',
3382           );
3383         }
3384
3385         if (CRM_Report_Utils_Report::mailReport($content, $this->_id,
3386           $this->_outputMode, $attachments
3387         )
3388         ) {
3389           CRM_Core_Session::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
3390         }
3391         else {
3392           CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
3393         }
3394         return;
3395       }
3396       elseif ($this->_outputMode == 'print') {
3397         echo $content;
3398       }
3399       else {
3400         if ($chartType = CRM_Utils_Array::value('charts', $this->_params)) {
3401           $config = CRM_Core_Config::singleton();
3402           //get chart image name
3403           $chartImg = $this->_chartId . '.png';
3404           //get image url path
3405           $uploadUrl
3406             = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL) .
3407             'openFlashChart/';
3408           $uploadUrl .= $chartImg;
3409           //get image doc path to overwrite
3410           $uploadImg
3411             = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) .
3412             'openFlashChart/' . $chartImg;
3413           //Load the image
3414           $chart = imagecreatefrompng($uploadUrl);
3415           //convert it into formatted png
3416           CRM_Utils_System::setHttpHeader('Content-type', 'image/png');
3417           //overwrite with same image
3418           imagepng($chart, $uploadImg);
3419           //delete the object
3420           imagedestroy($chart);
3421         }
3422         CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape'));
3423       }
3424       CRM_Utils_System::civiExit();
3425     }
3426     elseif ($this->_outputMode == 'csv') {
3427       CRM_Report_Utils_Report::export2csv($this, $rows);
3428     }
3429     elseif ($this->_outputMode == 'group') {
3430       $group = $this->_params['groups'];
3431       $this->add2group($group);
3432     }
3433   }
3434
3435   /**
3436    * Set store result set indicator to TRUE.
3437    *
3438    * @todo explain what this does
3439    */
3440   public function storeResultSet() {
3441     $this->_storeResultSet = TRUE;
3442   }
3443
3444   /**
3445    * Get result set.
3446    *
3447    * @return bool
3448    */
3449   public function getResultSet() {
3450     return $this->_resultSet;
3451   }
3452
3453   /**
3454    * Get the sql used to generate the report.
3455    *
3456    * @return string
3457    */
3458   public function getReportSql() {
3459     return $this->sqlArray;
3460   }
3461
3462   /**
3463    * Use the form name to create the tpl file name.
3464    *
3465    * @return string
3466    */
3467   public function getTemplateFileName() {
3468     $defaultTpl = parent::getTemplateFileName();
3469     $template = CRM_Core_Smarty::singleton();
3470     if (!$template->template_exists($defaultTpl)) {
3471       $defaultTpl = 'CRM/Report/Form.tpl';
3472     }
3473     return $defaultTpl;
3474   }
3475
3476   /**
3477    * Compile the report content.
3478    *
3479    * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3480    *
3481    * @return string
3482    */
3483   public function compileContent() {
3484     $templateFile = $this->getHookedTemplateFileName();
3485     return CRM_Utils_Array::value('report_header', $this->_formValues) .
3486     CRM_Core_Form::$_template->fetch($templateFile) .
3487     CRM_Utils_Array::value('report_footer', $this->_formValues);
3488   }
3489
3490
3491   /**
3492    * Post process function.
3493    */
3494   public function postProcess() {
3495     // get ready with post process params
3496     $this->beginPostProcess();
3497
3498     // build query
3499     $sql = $this->buildQuery();
3500
3501     // build array of result based on column headers. This method also allows
3502     // modifying column headers before using it to build result set i.e $rows.
3503     $rows = array();
3504     $this->buildRows($sql, $rows);
3505
3506     // format result set.
3507     $this->formatDisplay($rows);
3508
3509     // assign variables to templates
3510     $this->doTemplateAssignment($rows);
3511
3512     // do print / pdf / instance stuff if needed
3513     $this->endPostProcess($rows);
3514   }
3515
3516   /**
3517    * Set limit.
3518    *
3519    * @param int $rowCount
3520    *
3521    * @return array
3522    */
3523   public function limit($rowCount = self::ROW_COUNT_LIMIT) {
3524     // lets do the pager if in html mode
3525     $this->_limit = NULL;
3526
3527     // CRM-14115, over-ride row count if rowCount is specified in URL
3528     if ($this->_dashBoardRowCount) {
3529       $rowCount = $this->_dashBoardRowCount;
3530     }
3531     if ($this->addPaging) {
3532       $this->_select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select);
3533
3534       $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer');
3535
3536       // @todo all http vars should be extracted in the preProcess
3537       // - not randomly in the class
3538       if (!$pageId && !empty($_POST)) {
3539         if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3540           $pageId = max((int) $_POST['crmPID_B'], 1);
3541         }
3542         elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3543           $pageId = max((int) $_POST['crmPID'], 1);
3544         }
3545         unset($_POST['crmPID_B'], $_POST['crmPID']);
3546       }
3547
3548       $pageId = $pageId ? $pageId : 1;
3549       $this->set(CRM_Utils_Pager::PAGE_ID, $pageId);
3550       $offset = ($pageId - 1) * $rowCount;
3551
3552       $offset = CRM_Utils_Type::escape($offset, 'Int');
3553       $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
3554
3555       $this->_limit = " LIMIT $offset, $rowCount";
3556       return array($offset, $rowCount);
3557     }
3558     if ($this->_limitValue) {
3559       if ($this->_offsetValue) {
3560         $this->_limit = " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3561       }
3562       else {
3563         $this->_limit = " LIMIT " . $this->_limitValue;
3564       }
3565     }
3566   }
3567
3568   /**
3569    * Set pager.
3570    *
3571    * @param int $rowCount
3572    */
3573   public function setPager($rowCount = self::ROW_COUNT_LIMIT) {
3574     // CRM-14115, over-ride row count if rowCount is specified in URL
3575     if ($this->_dashBoardRowCount) {
3576       $rowCount = $this->_dashBoardRowCount;
3577     }
3578
3579     if ($this->_limit && ($this->_limit != '')) {
3580       if (!$this->_rowsFound) {
3581         $sql = "SELECT FOUND_ROWS();";
3582         $this->_rowsFound = CRM_Core_DAO::singleValueQuery($sql);
3583       }
3584       $params = array(
3585         'total' => $this->_rowsFound,
3586         'rowCount' => $rowCount,
3587         'status' => ts('Records') . ' %%StatusMessage%%',
3588         'buttonBottom' => 'PagerBottomButton',
3589         'buttonTop' => 'PagerTopButton',
3590       );
3591       if (!empty($this->controller)) {
3592         // This happens when being called from the api Really we want the api to be able to
3593         // pass paging parameters, but at this stage just preventing test crashes.
3594         $params['pageID'] = $this->get(CRM_Utils_Pager::PAGE_ID);
3595       }
3596
3597       $pager = new CRM_Utils_Pager($params);
3598       $this->assign_by_ref('pager', $pager);
3599       $this->ajaxResponse['totalRows'] = $this->_rowsFound;
3600     }
3601   }
3602
3603   /**
3604    * Build a group filter with contempt for large data sets.
3605    *
3606    * This function has been retained as it takes time to migrate the reports over
3607    * to the new method which will not crash on large datasets.
3608    *
3609    * @deprecated
3610    *
3611    * @param string $field
3612    * @param mixed $value
3613    * @param string $op
3614    *
3615    * @return string
3616    */
3617   public function legacySlowGroupFilterClause($field, $value, $op) {
3618     $smartGroupQuery = "";
3619
3620     $group = new CRM_Contact_DAO_Group();
3621     $group->is_active = 1;
3622     $group->find();
3623     $smartGroups = array();
3624     while ($group->fetch()) {
3625       if (in_array($group->id, (array) $this->_params['gid_value']) &&
3626         $group->saved_search_id
3627       ) {
3628         $smartGroups[] = $group->id;
3629       }
3630     }
3631
3632     CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3633
3634     $smartGroupQuery = '';
3635     if (!empty($smartGroups)) {
3636       $smartGroups = implode(',', $smartGroups);
3637       $smartGroupQuery = " UNION DISTINCT
3638                   SELECT DISTINCT smartgroup_contact.contact_id
3639                   FROM civicrm_group_contact_cache smartgroup_contact
3640                   WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3641     }
3642
3643     $sqlOp = $this->getSQLOperator($op);
3644     if (!is_array($value)) {
3645       $value = array($value);
3646     }
3647     //include child groups if any
3648     $value = array_merge($value, CRM_Contact_BAO_Group::getChildGroupIds($value));
3649
3650     $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3651
3652     $contactAlias = $this->_aliases['civicrm_contact'];
3653     if (!empty($this->relationType) && $this->relationType == 'b_a') {
3654       $contactAlias = $this->_aliases['civicrm_contact_b'];
3655     }
3656     return " {$contactAlias}.id {$sqlOp} (
3657                           SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3658                           FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3659                           WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3660                           {$smartGroupQuery} ) ";
3661   }
3662
3663   /**
3664    * Build where clause for groups.
3665    *
3666    * @param string $field
3667    * @param mixed $value
3668    * @param string $op
3669    *
3670    * @return string
3671    */
3672   public function whereGroupClause($field, $value, $op) {
3673     if ($this->groupFilterNotOptimised) {
3674       return $this->legacySlowGroupFilterClause($field, $value, $op);
3675     }
3676     if ($op === 'notin') {
3677       return " group_temp_table.id IS NULL ";
3678     }
3679     // We will have used an inner join instead.
3680     return "1";
3681   }
3682
3683
3684   /**
3685    * Create a table of the contact ids included by the group filter.
3686    *
3687    * This function is called by both the api (tests) and the UI.
3688    */
3689   public function buildGroupTempTable() {
3690     if (!empty($this->groupTempTable) || empty($this->_params['gid_value']) || $this->groupFilterNotOptimised) {
3691       return;
3692     }
3693     $filteredGroups = (array) $this->_params['gid_value'];
3694
3695     $groups = civicrm_api3('Group', 'get', array(
3696       'is_active' => 1,
3697       'id' => array('IN' => $filteredGroups),
3698       'saved_search_id' => array('>' => 0),
3699       'return' => 'id',
3700     ));
3701     $smartGroups = array_keys($groups['values']);
3702
3703     $query = "
3704        SELECT DISTINCT group_contact.contact_id as id
3705        FROM civicrm_group_contact group_contact
3706        WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3707        AND group_contact.status = 'Added' ";
3708
3709     if (!empty($smartGroups)) {
3710       CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3711       $smartGroups = implode(',', $smartGroups);
3712       $query .= "
3713         UNION DISTINCT
3714         SELECT smartgroup_contact.contact_id as id
3715         FROM civicrm_group_contact_cache smartgroup_contact
3716         WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3717     }
3718
3719     $this->groupTempTable = $this->createTemporaryTable('rptgrp', $query);
3720     CRM_Core_DAO::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3721   }
3722
3723   /**
3724    * Execute query and add it to the developer tab.
3725    *
3726    * @param string $query
3727    * @param array $params
3728    *
3729    * @return \CRM_Core_DAO|object
3730    */
3731   protected function executeReportQuery($query, $params = array()) {
3732     $this->addToDeveloperTab($query);
3733     return CRM_Core_DAO::executeQuery($query, $params);
3734   }
3735
3736   /**
3737    * Build where clause for tags.
3738    *
3739    * @param string $field
3740    * @param mixed $value
3741    * @param string $op
3742    *
3743    * @return string
3744    */
3745   public function whereTagClause($field, $value, $op) {
3746     // not using left join in query because if any contact
3747     // belongs to more than one tag, results duplicate
3748     // entries.
3749     $sqlOp = $this->getSQLOperator($op);
3750     if (!is_array($value)) {
3751       $value = array($value);
3752     }
3753     $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3754     $entity_table = $this->_tagFilterTable;
3755     return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3756                           SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3757                           FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3758                           WHERE entity_table = '$entity_table' AND {$clause} ) ";
3759   }
3760
3761   /**
3762    * Generate membership organization clause.
3763    *
3764    * @param mixed $value
3765    * @param string $op SQL Operator
3766    *
3767    * @return string
3768    */
3769   public function whereMembershipOrgClause($value, $op) {
3770     $sqlOp = $this->getSQLOperator($op);
3771     if (!is_array($value)) {
3772       $value = array($value);
3773     }
3774
3775     $tmp_membership_org_sql_list = implode(', ', $value);
3776     return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3777                           SELECT DISTINCT mem.contact_id
3778                           FROM civicrm_membership mem
3779                           LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3780                           LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3781                           WHERE mt.member_of_contact_id IN (" .
3782     $tmp_membership_org_sql_list . ")
3783                           AND mt.is_active = '1'
3784                           AND mem_status.is_current_member = '1'
3785                           AND mem_status.is_active = '1' )  ";
3786   }
3787
3788   /**
3789    * Generate Membership Type SQL Clause.
3790    *
3791    * @param mixed $value
3792    * @param string $op
3793    *
3794    * @return string
3795    *   SQL query string
3796    */
3797   public function whereMembershipTypeClause($value, $op) {
3798     $sqlOp = $this->getSQLOperator($op);
3799     if (!is_array($value)) {
3800       $value = array($value);
3801     }
3802
3803     $tmp_membership_sql_list = implode(', ', $value);
3804     return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3805                           SELECT DISTINCT mem.contact_id
3806                           FROM civicrm_membership mem
3807                           LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3808                           LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3809                           WHERE mem.membership_type_id IN (" .
3810     $tmp_membership_sql_list . ")
3811                           AND mt.is_active = '1'
3812                           AND mem_status.is_current_member = '1'
3813                           AND mem_status.is_active = '1' ) ";
3814   }
3815
3816   /**
3817    * Buld contact acl clause
3818    * @deprecated in favor of buildPermissionClause
3819    *
3820    * @param string $tableAlias
3821    */
3822   public function buildACLClause($tableAlias = 'contact_a') {
3823     list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias);
3824   }
3825
3826   /**
3827    * Build the permision clause for all entities in this report
3828    */
3829   public function buildPermissionClause() {
3830     $ret = array();
3831     foreach ($this->selectedTables() as $tableName) {
3832       $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables::getClassForTable($tableName));
3833       if ($baoName && class_exists($baoName) && !empty($this->_columns[$tableName]['alias'])) {
3834         $tableAlias = $this->_columns[$tableName]['alias'];
3835         $clauses = array_filter($baoName::getSelectWhereClause($tableAlias));
3836         foreach ($clauses as $field => $clause) {
3837           // Skip contact_id field if redundant
3838           if ($field != 'contact_id' || !in_array('civicrm_contact', $this->selectedTables())) {
3839             $ret["$tableName.$field"] = $clause;
3840           }
3841         }
3842       }
3843     }
3844     // Override output from buildACLClause
3845     $this->_aclFrom = NULL;
3846     $this->_aclWhere = implode(' AND ', $ret);
3847   }
3848
3849   /**
3850    * Add custom data to the columns.
3851    *
3852    * @param bool $addFields
3853    * @param array $permCustomGroupIds
3854    */
3855   public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) {
3856     if (empty($this->_customGroupExtends)) {
3857       return;
3858     }
3859     if (!is_array($this->_customGroupExtends)) {
3860       $this->_customGroupExtends = array($this->_customGroupExtends);
3861     }
3862     $customGroupWhere = '';
3863     if (!empty($permCustomGroupIds)) {
3864       $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3865         ") AND";
3866     }
3867     $sql = "
3868 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3869        cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3870 FROM   civicrm_custom_group cg
3871 INNER  JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3872 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
3873       {$customGroupWhere}
3874       cg.is_active = 1 AND
3875       cf.is_active = 1 AND
3876       cf.is_searchable = 1
3877 ORDER BY cg.weight, cf.weight";
3878     $customDAO = CRM_Core_DAO::executeQuery($sql);
3879
3880     $curTable = NULL;
3881     while ($customDAO->fetch()) {
3882       if ($customDAO->table_name != $curTable) {
3883         $curTable = $customDAO->table_name;
3884         $curFields = $curFilters = array();
3885
3886         // dummy dao object
3887         $this->_columns[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3888         $this->_columns[$curTable]['extends'] = $customDAO->extends;
3889         $this->_columns[$curTable]['grouping'] = $customDAO->table_name;
3890         $this->_columns[$curTable]['group_title'] = $customDAO->title;
3891
3892         foreach (array('fields', 'filters', 'group_bys') as $colKey) {
3893           if (!array_key_exists($colKey, $this->_columns[$curTable])) {
3894             $this->_columns[$curTable][$colKey] = array();
3895           }
3896         }
3897       }
3898       $fieldName = 'custom_' . $customDAO->cf_id;
3899
3900       if ($addFields) {
3901         // this makes aliasing work in favor
3902         $curFields[$fieldName] = array(
3903           'name' => $customDAO->column_name,
3904           'title' => $customDAO->label,
3905           'dataType' => $customDAO->data_type,
3906           'htmlType' => $customDAO->html_type,
3907         );
3908       }
3909       if ($this->_customGroupFilters) {
3910         // this makes aliasing work in favor
3911         $curFilters[$fieldName] = array(
3912           'name' => $customDAO->column_name,
3913           'title' => $customDAO->label,
3914           'dataType' => $customDAO->data_type,
3915           'htmlType' => $customDAO->html_type,
3916         );
3917       }
3918
3919       switch ($customDAO->data_type) {
3920         case 'Date':
3921           // filters
3922           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
3923           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_DATE;
3924           // CRM-6946, show time part for datetime date fields
3925           if ($customDAO->time_format) {
3926             $curFields[$fieldName]['type'] = CRM_Utils_Type::T_TIMESTAMP;
3927           }
3928           break;
3929
3930         case 'Boolean':
3931           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
3932           $curFilters[$fieldName]['options'] = array('' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, array(), 'search');
3933           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3934           break;
3935
3936         case 'Int':
3937           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
3938           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3939           break;
3940
3941         case 'Money':
3942           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3943           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3944           $curFields[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3945           break;
3946
3947         case 'Float':
3948           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3949           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_FLOAT;
3950           break;
3951
3952         case 'String':
3953         case 'StateProvince':
3954         case 'Country':
3955           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3956
3957           $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, array(), 'search');
3958           if ((is_array($options) && count($options) != 0) || (!is_array($options) && $options !== FALSE)) {
3959             $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT;
3960             $curFilters[$fieldName]['options'] = $options;
3961           }
3962           break;
3963
3964         case 'ContactReference':
3965           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3966           $curFilters[$fieldName]['name'] = 'display_name';
3967           $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3968
3969           $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3970           $curFields[$fieldName]['name'] = 'display_name';
3971           $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3972           break;
3973
3974         default:
3975           $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3976           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3977       }
3978
3979       // CRM-19401 fix
3980       if ($customDAO->html_type == 'Select' && !array_key_exists('options', $curFilters[$fieldName])) {
3981         $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, array(), 'search');
3982         if ($options !== FALSE) {
3983           $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT;
3984           $curFilters[$fieldName]['options'] = $options;
3985         }
3986       }
3987
3988       if (!array_key_exists('type', $curFields[$fieldName])) {
3989         $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], array());
3990       }
3991
3992       if ($addFields) {
3993         $this->_columns[$curTable]['fields'] = array_merge($this->_columns[$curTable]['fields'], $curFields);
3994       }
3995       if ($this->_customGroupFilters) {
3996         $this->_columns[$curTable]['filters'] = array_merge($this->_columns[$curTable]['filters'], $curFilters);
3997       }
3998       if ($this->_customGroupGroupBy) {
3999         $this->_columns[$curTable]['group_bys'] = array_merge($this->_columns[$curTable]['group_bys'], $curFields);
4000       }
4001     }
4002   }
4003
4004   /**
4005    * Build custom data from clause.
4006    *
4007    * @param bool $joinsForFiltersOnly
4008    *   Only include joins to support filters. This would be used if creating a table of contacts to include first.
4009    */
4010   public function customDataFrom($joinsForFiltersOnly = FALSE) {
4011     if (empty($this->_customGroupExtends)) {
4012       return;
4013     }
4014     $mapper = CRM_Core_BAO_CustomQuery::$extendsMap;
4015     //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
4016     //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
4017     $customTables = array();
4018     $customTablesDAO = CRM_Core_DAO::executeQuery("SELECT table_name FROM civicrm_custom_group");
4019     while ($customTablesDAO->fetch()) {
4020       $customTables[] = $customTablesDAO->table_name;
4021     }
4022
4023     foreach ($this->_columns as $table => $prop) {
4024       if (in_array($table, $customTables)) {
4025         $extendsTable = $mapper[$prop['extends']];
4026         // Check field is required for rendering the report.
4027         if ((!$this->isFieldSelected($prop)) || ($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
4028           continue;
4029         }
4030         $baseJoin = CRM_Utils_Array::value($prop['extends'], $this->_customGroupExtendsJoin, "{$this->_aliases[$extendsTable]}.id");
4031
4032         $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin;
4033         $this->_from .= "
4034 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
4035         // handle for ContactReference
4036         if (array_key_exists('fields', $prop)) {
4037           foreach ($prop['fields'] as $fieldName => $field) {
4038             if (CRM_Utils_Array::value('dataType', $field) ==
4039               'ContactReference'
4040             ) {
4041               $columnName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField::getKeyID($fieldName), 'column_name');
4042               $this->_from .= "
4043 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
4044             }
4045           }
4046         }
4047       }
4048     }
4049   }
4050
4051   /**
4052    * Check if the field is selected.
4053    *
4054    * @param string $prop
4055    *
4056    * @return bool
4057    */
4058   public function isFieldSelected($prop) {
4059     if (empty($prop)) {
4060       return FALSE;
4061     }
4062
4063     if (!empty($this->_params['fields'])) {
4064       foreach (array_keys($prop['fields']) as $fieldAlias) {
4065         $customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias);
4066         if ($customFieldId) {
4067           if (array_key_exists($fieldAlias, $this->_params['fields'])) {
4068             return TRUE;
4069           }
4070
4071           //might be survey response field.
4072           if (!empty($this->_params['fields']['survey_response']) &&
4073             !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
4074           ) {
4075             return TRUE;
4076           }
4077         }
4078       }
4079     }
4080
4081     if (!empty($this->_params['group_bys']) && $this->_customGroupGroupBy) {
4082       foreach (array_keys($prop['group_bys']) as $fieldAlias) {
4083         if (array_key_exists($fieldAlias, $this->_params['group_bys']) &&
4084           CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
4085         ) {
4086           return TRUE;
4087         }
4088       }
4089     }
4090
4091     if (!empty($this->_params['order_bys'])) {
4092       foreach (array_keys($prop['fields']) as $fieldAlias) {
4093         foreach ($this->_params['order_bys'] as $orderBy) {
4094           if ($fieldAlias == $orderBy['column'] &&
4095             CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
4096           ) {
4097             return TRUE;
4098           }
4099         }
4100       }
4101     }
4102     return $this->isFieldFiltered($prop);
4103
4104   }
4105
4106   /**
4107    * Check if the field is used as a filter.
4108    *
4109    * @param string $prop
4110    *
4111    * @return bool
4112    */
4113   protected function isFieldFiltered($prop) {
4114     if (!empty($prop['filters']) && $this->_customGroupFilters) {
4115       foreach ($prop['filters'] as $fieldAlias => $val) {
4116         foreach (array(
4117                    'value',
4118                    'min',
4119                    'max',
4120                    'relative',
4121                    'from',
4122                    'to',
4123                  ) as $attach) {
4124           if (isset($this->_params[$fieldAlias . '_' . $attach]) &&
4125             (!empty($this->_params[$fieldAlias . '_' . $attach])
4126               || ($attach != 'relative' &&
4127                 $this->_params[$fieldAlias . '_' . $attach] == '0')
4128             )
4129           ) {
4130             return TRUE;
4131           }
4132         }
4133         if (!empty($this->_params[$fieldAlias . '_op']) &&
4134           in_array($this->_params[$fieldAlias . '_op'], array('nll', 'nnll'))
4135         ) {
4136           return TRUE;
4137         }
4138       }
4139     }
4140
4141     return FALSE;
4142   }
4143
4144   /**
4145    * Check for empty order_by configurations and remove them.
4146    *
4147    * Also set template to hide them.
4148    *
4149    * @param array $formValues
4150    */
4151   public function preProcessOrderBy(&$formValues) {
4152     // Object to show/hide form elements
4153     $_showHide = new CRM_Core_ShowHideBlocks('', '');
4154
4155     $_showHide->addShow('optionField_1');
4156
4157     // Cycle through order_by options; skip any empty ones, and hide them as well
4158     $n = 1;
4159
4160     if (!empty($formValues['order_bys'])) {
4161       foreach ($formValues['order_bys'] as $order_by) {
4162         if ($order_by['column'] && $order_by['column'] != '-') {
4163           $_showHide->addShow('optionField_' . $n);
4164           $orderBys[$n] = $order_by;
4165           $n++;
4166         }
4167       }
4168     }
4169     for ($i = $n; $i <= 5; $i++) {
4170       if ($i > 1) {
4171         $_showHide->addHide('optionField_' . $i);
4172       }
4173     }
4174
4175     // overwrite order_by options with modified values
4176     if (!empty($orderBys)) {
4177       $formValues['order_bys'] = $orderBys;
4178     }
4179     else {
4180       $formValues['order_bys'] = array(1 => array('column' => '-'));
4181     }
4182
4183     // assign show/hide data to template
4184     $_showHide->addToTemplate();
4185   }
4186
4187   /**
4188    * Check if table name has columns in SELECT clause.
4189    *
4190    * @param string $tableName
4191    *   Name of table (index of $this->_columns array).
4192    *
4193    * @return bool
4194    */
4195   public function isTableSelected($tableName) {
4196     return in_array($tableName, $this->selectedTables());
4197   }
4198
4199   /**
4200    * Check if table name has columns in WHERE or HAVING clause.
4201    *
4202    * @param string $tableName
4203    *   Name of table (index of $this->_columns array).
4204    *
4205    * @return bool
4206    */
4207   public function isTableFiltered($tableName) {
4208     // Cause the array to be generated if not previously done.
4209     if (!$this->_selectedTables && !$this->filteredTables) {
4210       $this->selectedTables();
4211     }
4212     return in_array($tableName, $this->filteredTables);
4213   }
4214
4215   /**
4216    * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
4217    *
4218    * If the array is unset it will be built.
4219    *
4220    * @return array
4221    *   selectedTables
4222    */
4223   public function selectedTables() {
4224     if (!$this->_selectedTables) {
4225       $orderByColumns = array();
4226       if (array_key_exists('order_bys', $this->_params) &&
4227         is_array($this->_params['order_bys'])
4228       ) {
4229         foreach ($this->_params['order_bys'] as $orderBy) {
4230           $orderByColumns[] = $orderBy['column'];
4231         }
4232       }
4233
4234       foreach ($this->_columns as $tableName => $table) {
4235         if (array_key_exists('fields', $table)) {
4236           foreach ($table['fields'] as $fieldName => $field) {
4237             if (!empty($field['required']) ||
4238               !empty($this->_params['fields'][$fieldName])
4239             ) {
4240               $this->_selectedTables[] = $tableName;
4241               break;
4242             }
4243           }
4244         }
4245         if (array_key_exists('order_bys', $table)) {
4246           foreach ($table['order_bys'] as $orderByName => $orderBy) {
4247             if (in_array($orderByName, $orderByColumns)) {
4248               $this->_selectedTables[] = $tableName;
4249               break;
4250             }
4251           }
4252         }
4253         if (array_key_exists('filters', $table)) {
4254           foreach ($table['filters'] as $filterName => $filter) {
4255             if (!empty($this->_params["{$filterName}_value"])
4256               || !empty($this->_params["{$filterName}_relative"])
4257               || CRM_Utils_Array::value("{$filterName}_op", $this->_params) ==
4258               'nll'
4259               || CRM_Utils_Array::value("{$filterName}_op", $this->_params) ==
4260               'nnll'
4261             ) {
4262               $this->_selectedTables[] = $tableName;
4263               $this->filteredTables[] = $tableName;
4264               break;
4265             }
4266           }
4267         }
4268       }
4269     }
4270     return $this->_selectedTables;
4271   }
4272
4273   /**
4274    * Add campaign fields.
4275    *
4276    * @param bool $groupBy
4277    *   Add GroupBy? Not appropriate for detail report.
4278    * @param bool $orderBy
4279    *   Add OrderBy? Not appropriate for detail report.
4280    * @param bool $filters
4281    *
4282    */
4283   public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) {
4284     // Check if CiviCampaign is a) enabled and b) has active campaigns
4285     $config = CRM_Core_Config::singleton();
4286     $campaignEnabled = in_array('CiviCampaign', $config->enableComponents);
4287     if ($campaignEnabled) {
4288       $getCampaigns = CRM_Campaign_BAO_Campaign::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE);
4289       // If we have a campaign, build out the relevant elements
4290       if (!empty($getCampaigns['campaigns'])) {
4291         $this->campaigns = $getCampaigns['campaigns'];
4292         asort($this->campaigns);
4293         $this->_columns[$entityTable]['fields']['campaign_id'] = array('title' => ts('Campaign'), 'default' => 'false');
4294         if ($filters) {
4295           $this->_columns[$entityTable]['filters']['campaign_id'] = array(
4296             'title' => ts('Campaign'),
4297             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4298             'options' => $this->campaigns,
4299             'type' => CRM_Utils_Type::T_INT,
4300           );
4301         }
4302
4303         if ($groupBy) {
4304           $this->_columns[$entityTable]['group_bys']['campaign_id'] = array('title' => ts('Campaign'));
4305         }
4306
4307         if ($orderBy) {
4308           $this->_columns[$entityTable]['order_bys']['campaign_id'] = array('title' => ts('Campaign'));
4309         }
4310       }
4311     }
4312   }
4313
4314   /**
4315    * Add address fields.
4316    *
4317    * @deprecated - use getAddressColumns which is a more accurate description
4318    * and also accepts an array of options rather than a long list
4319    *
4320    * adding address fields to construct function in reports
4321    *
4322    * @param bool $groupBy
4323    *   Add GroupBy? Not appropriate for detail report.
4324    * @param bool $orderBy
4325    *   Add GroupBy? Not appropriate for detail report.
4326    * @param bool $filters
4327    * @param array $defaults
4328    *
4329    * @return array
4330    *   address fields for construct clause
4331    */
4332   public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) {
4333     $defaultAddressFields = array(
4334       'street_address' => ts('Street Address'),
4335       'supplemental_address_1' => ts('Supplementary Address Field 1'),
4336       'supplemental_address_2' => ts('Supplementary Address Field 2'),
4337       'supplemental_address_3' => ts('Supplementary Address Field 3'),
4338       'street_number' => ts('Street Number'),
4339       'street_name' => ts('Street Name'),
4340       'street_unit' => ts('Street Unit'),
4341       'city' => ts('City'),
4342       'postal_code' => ts('Postal Code'),
4343       'postal_code_suffix' => ts('Postal Code Suffix'),
4344       'country_id' => ts('Country'),
4345       'state_province_id' => ts('State/Province'),
4346       'county_id' => ts('County'),
4347     );
4348     $addressFields = array(
4349       'civicrm_address' => array(
4350         'dao' => 'CRM_Core_DAO_Address',
4351         'fields' => array(
4352           'address_name' => array(
4353             'title' => ts('Address Name'),
4354             'default' => CRM_Utils_Array::value('name', $defaults, FALSE),
4355             'name' => 'name',
4356           ),
4357         ),
4358         'grouping' => 'location-fields',
4359       ),
4360     );
4361     foreach ($defaultAddressFields as $fieldName => $fieldLabel) {
4362       $addressFields['civicrm_address']['fields'][$fieldName] = array(
4363         'title' => $fieldLabel,
4364         'default' => CRM_Utils_Array::value($fieldName, $defaults, FALSE),
4365       );
4366     }
4367
4368     $street_address_filters = $general_address_filters = array();
4369     if ($filters) {
4370       // Address filter depends on whether street address parsing is enabled.
4371       // (CRM-18696)
4372       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
4373         'address_options'
4374       );
4375       if ($addressOptions['street_address_parsing']) {
4376         $street_address_filters = array(
4377           'street_number' => array(
4378             'title' => ts('Street Number'),
4379             'type' => CRM_Utils_Type::T_INT,
4380             'name' => 'street_number',
4381           ),
4382           'street_name' => array(
4383             'title' => ts('Street Name'),
4384             'name' => 'street_name',
4385             'type' => CRM_Utils_Type::T_STRING,
4386           ),
4387         );
4388       }
4389       else {
4390         $street_address_filters = array(
4391           'street_address' => array(
4392             'title' => ts('Street Address'),
4393             'type' => CRM_Utils_Type::T_STRING,
4394             'name' => 'street_address',
4395           ),
4396         );
4397       }
4398       $general_address_filters = array(
4399         'postal_code' => array(
4400           'title' => ts('Postal Code'),
4401           'type' => CRM_Utils_Type::T_STRING,
4402           'name' => 'postal_code',
4403         ),
4404         'city' => array(
4405           'title' => ts('City'),
4406           'type' => CRM_Utils_Type::T_STRING,
4407           'name' => 'city',
4408         ),
4409         'country_id' => array(
4410           'name' => 'country_id',
4411           'title' => ts('Country'),
4412           'type' => CRM_Utils_Type::T_INT,
4413           'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4414           'options' => CRM_Core_PseudoConstant::country(),
4415         ),
4416         'state_province_id' => array(
4417           'name' => 'state_province_id',
4418           'title' => ts('State/Province'),
4419           'type' => CRM_Utils_Type::T_INT,
4420           'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4421           'options' => array(),
4422         ),
4423         'county_id' => array(
4424           'name' => 'county_id',
4425           'title' => ts('County'),
4426           'type' => CRM_Utils_Type::T_INT,
4427           'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4428           'options' => array(),
4429         ),
4430       );
4431     }
4432     $addressFields['civicrm_address']['filters'] = array_merge(
4433         $street_address_filters,
4434         $general_address_filters);
4435
4436     if ($orderBy) {
4437       $addressFields['civicrm_address']['order_bys'] = array(
4438         'street_name' => array('title' => ts('Street Name')),
4439         'street_number' => array('title' => ts('Odd / Even Street Number')),
4440         'street_address' => NULL,
4441         'city' => NULL,
4442         'postal_code' => NULL,
4443       );
4444     }
4445
4446     if ($groupBy) {
4447       $addressFields['civicrm_address']['group_bys'] = array(
4448         'street_address' => NULL,
4449         'city' => NULL,
4450         'postal_code' => NULL,
4451         'state_province_id' => array(
4452           'title' => ts('State/Province'),
4453         ),
4454         'country_id' => array(
4455           'title' => ts('Country'),
4456         ),
4457         'county_id' => array(
4458           'title' => ts('County'),
4459         ),
4460       );
4461     }
4462     return $addressFields;
4463   }
4464
4465   /**
4466    * Do AlterDisplay processing on Address Fields.
4467    *  If there are multiple address field values then
4468    *  on basis of provided separator the code values are translated into respective labels
4469    *
4470    * @param array $row
4471    * @param array $rows
4472    * @param int $rowNum
4473    * @param string $baseUrl
4474    * @param string $linkText
4475    * @param string $separator
4476    *
4477    * @return bool
4478    */
4479   public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') {
4480     $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
4481     $entryFound = FALSE;
4482     $columnMap = array(
4483       'civicrm_address_country_id' => 'country',
4484       'civicrm_address_county_id' => 'county',
4485       'civicrm_address_state_province_id' => 'stateProvince',
4486     );
4487     foreach ($columnMap as $fieldName => $fnName) {
4488       if (array_key_exists($fieldName, $row)) {
4489         if ($values = $row[$fieldName]) {
4490           $values = (array) explode($separator, $values);
4491           $rows[$rowNum][$fieldName] = [];
4492           $addressField = $fnName == 'stateProvince' ? 'state' : $fnName;
4493           foreach ($values as $value) {
4494             $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant::$fnName($value);
4495           }
4496           $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]);
4497           if ($baseUrl) {
4498             $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4499               sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s",
4500                 $criteriaQueryParams,
4501                 str_replace('civicrm_address_', '', $fieldName),
4502                 str_replace('civicrm_address_', '', $fieldName),
4503                 implode(',', $values)
4504               ), $this->_absoluteUrl, $this->_id
4505             );
4506             $rows[$rowNum]["{$fieldName}_link"] = $url;
4507             $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", array(1 => $linkText, 2 => $addressField));
4508           }
4509         }
4510         $entryFound = TRUE;
4511       }
4512     }
4513
4514     return $entryFound;
4515   }
4516
4517   /**
4518    * Do AlterDisplay processing on Address Fields.
4519    *
4520    * @param array $row
4521    * @param array $rows
4522    * @param int $rowNum
4523    * @param string $baseUrl
4524    * @param string $linkText
4525    *
4526    * @return bool
4527    */
4528   public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4529     $entryFound = FALSE;
4530     // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4531     // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4532     $addLinks = array('gender_id' => 'Gender');
4533     foreach (array('prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language') as $fieldName) {
4534       if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4535         if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4536           $rowValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
4537           $rowLabels = array();
4538           foreach ($rowValues as $rowValue) {
4539             if ($rowValue) {
4540               $rowLabels[] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue);
4541             }
4542           }
4543           $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels);
4544           if ($baseUrl && ($title = CRM_Utils_Array::value($fieldName, $addLinks)) != FALSE) {
4545             $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4546           }
4547         }
4548         $entryFound = TRUE;
4549       }
4550     }
4551     $yesNoFields = array(
4552       'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4553     );
4554     foreach ($yesNoFields as $fieldName) {
4555       if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4556         // Since these are essentially 'negative fields' it feels like it
4557         // makes sense to only highlight the exceptions hence no 'No'.
4558         $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ? ts('Yes') : '';
4559         $entryFound = TRUE;
4560       }
4561     }
4562
4563     // Handle employer id
4564     if (array_key_exists('civicrm_contact_employer_id', $row)) {
4565       $employerId = $row['civicrm_contact_employer_id'];
4566       if ($employerId) {
4567         $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact::displayName($employerId);
4568         $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl);
4569         $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.');
4570         $entryFound = TRUE;
4571       }
4572     }
4573
4574     return $entryFound;
4575   }
4576
4577   /**
4578    * Adjusts dates passed in to YEAR() for fiscal year.
4579    *
4580    * @param string $fieldName
4581    *
4582    * @return string
4583    */
4584   public function fiscalYearOffset($fieldName) {
4585     $config = CRM_Core_Config::singleton();
4586     $fy = $config->fiscalYearStart;
4587     if (CRM_Utils_Array::value('yid_op', $this->_params) == 'calendar' ||
4588       ($fy['d'] == 1 && $fy['M'] == 1)
4589     ) {
4590       return "YEAR( $fieldName )";
4591     }
4592     return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4593     ($fy['d'] > 1 ? (" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4594   }
4595
4596   /**
4597    * Add Address into From Table if required.
4598    *
4599    * @deprecated use joinAddressFromContact
4600    * (left here in case extensions use it).
4601    */
4602   public function addAddressFromClause() {
4603     CRM_Core_Error::deprecatedFunctionWarning('CRM_Report_Form::joinAddressFromContact');
4604     // include address field if address column is to be included
4605     if ((isset($this->_addressField) &&
4606         $this->_addressField
4607       ) ||
4608       $this->isTableSelected('civicrm_address')
4609     ) {
4610       $this->_from .= "
4611                  LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4612                            ON ({$this->_aliases['civicrm_contact']}.id =
4613                                {$this->_aliases['civicrm_address']}.contact_id) AND
4614                                {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4615     }
4616   }
4617
4618   /**
4619    * Add Phone into From Table if required.
4620    *
4621    * @deprecated use joinPhoneFromContact
4622    *  (left here in case extensions use it).
4623    */
4624   public function addPhoneFromClause() {
4625     CRM_Core_Error::deprecatedFunctionWarning('CRM_Report_Form::joinPhoneFromContact');
4626     // include address field if address column is to be included
4627     if ($this->isTableSelected('civicrm_phone')) {
4628       $this->_from .= "
4629       LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4630       ON ({$this->_aliases['civicrm_contact']}.id =
4631       {$this->_aliases['civicrm_phone']}.contact_id) AND
4632       {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
4633     }
4634   }
4635
4636   /**
4637    * Add Address into From Table if required.
4638    *
4639    * Prefix will be added to both tables as
4640    * it is assumed you are using it to get address of a secondary contact.
4641    *
4642    * @param string $prefix
4643    * @param array $extra Additional options.
4644    *      Not currently used in core but may be used in override extensions.
4645    */
4646   protected function joinAddressFromContact($prefix = '', $extra = array()) {
4647     $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province'];
4648     $isJoinRequired = $this->_addressField;
4649     foreach ($addressTables as $addressTable) {
4650       if ($this->isTableSelected($prefix . $addressTable)) {
4651         $isJoinRequired = TRUE;
4652       }
4653     }
4654     if ($isJoinRequired) {
4655       $this->_from .= "
4656                  LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']}
4657                            ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id =
4658                                {$this->_aliases[$prefix . 'civicrm_address']}.contact_id) AND
4659                                {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n";
4660     }
4661   }
4662
4663   /**
4664    * Add Country into From Table if required.
4665    *
4666    * Prefix will be added to both tables as
4667    * it is assumed you are using it to get address of a secondary contact.
4668    *
4669    * @param string $prefix
4670    * @param array $extra Additional options.
4671    *      Not currently used in core but may be used in override extensions.
4672    */
4673   protected function joinCountryFromAddress($prefix = '', $extra = array()) {
4674     // include country field if country column is to be included
4675     if ($this->isTableSelected($prefix . 'civicrm_country') || $this->isTableSelected($prefix . 'civicrm_worldregion')) {
4676       if (empty($this->_aliases[$prefix . 'civicrm_country'])) {
4677         $this->_aliases[$prefix . 'civicrm_country'] = $prefix . '_report_country';
4678       }
4679       $this->_from .= "
4680             LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']}
4681                    ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id AND
4682                       {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 ";
4683     }
4684   }
4685
4686   /**
4687    * Add Phone into From Table if required.
4688    *
4689    * Prefix will be added to both tables as
4690    * it is assumed you are using it to get address of a secondary contact.
4691    *
4692    * @param string $prefix
4693    * @param array $extra Additional options.
4694    *      Not currently used in core but may be used in override extensions.
4695    */
4696   protected function joinPhoneFromContact($prefix = '', $extra = array()) {
4697     // include phone field if phone column is to be included
4698     if ($this->isTableSelected($prefix . 'civicrm_phone')) {
4699       $this->_from .= "
4700       LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']}
4701              ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id AND
4702                 {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n";
4703     }
4704   }
4705
4706   /**
4707    * Add Email into From Table if required.
4708    *
4709    * Prefix will be added to both tables as
4710    * it is assumed you are using it to get address of a secondary contact.
4711    *
4712    * @param string $prefix
4713    * @param array $extra Additional options.
4714    *      Not currently used in core but may be used in override extensions.
4715    */
4716   protected function joinEmailFromContact($prefix = '', $extra = array()) {
4717     // include email field if email column is to be included
4718     if ($this->isTableSelected($prefix . 'civicrm_email')) {
4719       $this->_from .= "
4720             LEFT JOIN  civicrm_email {$this->_aliases[$prefix . 'civicrm_email']}
4721                    ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id AND
4722                        {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1) ";
4723     }
4724   }
4725
4726   /**
4727    * Add Financial Transaction into From Table if required.
4728    */
4729   public function addFinancialTrxnFromClause() {
4730     if ($this->isTableSelected('civicrm_financial_trxn')) {
4731       $this->_from .= "
4732          LEFT JOIN civicrm_entity_financial_trxn eftcc
4733            ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND
4734              eftcc.entity_table = 'civicrm_contribution')
4735          LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
4736            ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n";
4737     }
4738   }
4739
4740   /**
4741    * Get phone columns to add to array.
4742    *
4743    * @param array $options
4744    *   - prefix Prefix to add to table (in case of more than one instance of the table)
4745    *   - prefix_label Label to give columns from this phone table instance
4746    *
4747    * @return array
4748    *   phone columns definition
4749    */
4750   public function getPhoneColumns($options = array()) {
4751     $defaultOptions = array(
4752       'prefix' => '',
4753       'prefix_label' => '',
4754     );
4755
4756     $options = array_merge($defaultOptions, $options);
4757
4758     $fields = array(
4759       $options['prefix'] . 'civicrm_phone' => array(
4760         'dao' => 'CRM_Core_DAO_Phone',
4761         'fields' => array(
4762           $options['prefix'] . 'phone' => array(
4763             'title' => $options['prefix_label'] . ts('Phone'),
4764             'name' => 'phone',
4765           ),
4766         ),
4767       ),
4768     );
4769     return $fields;
4770   }
4771
4772   /**
4773    * Get a standard set of contact fields.
4774    * @deprecated - use getColumns('Contact') instead
4775    * @return array
4776    */
4777   public function getBasicContactFields() {
4778     return array(
4779       'sort_name' => array(
4780         'title' => ts('Contact Name'),
4781         'required' => TRUE,
4782         'default' => TRUE,
4783       ),
4784       'id' => array(
4785         'no_display' => TRUE,
4786         'required' => TRUE,
4787       ),
4788       'prefix_id' => array(
4789         'title' => ts('Contact Prefix'),
4790       ),
4791       'first_name' => array(
4792         'title' => ts('First Name'),
4793       ),
4794       'nick_name' => array(
4795         'title' => ts('Nick Name'),
4796       ),
4797       'middle_name' => array(
4798         'title' => ts('Middle Name'),
4799       ),
4800       'last_name' => array(
4801         'title' => ts('Last Name'),
4802       ),
4803       'suffix_id' => array(
4804         'title' => ts('Contact Suffix'),
4805       ),
4806       'postal_greeting_display' => array('title' => ts('Postal Greeting')),
4807       'email_greeting_display' => array('title' => ts('Email Greeting')),
4808       'addressee_display' => array('title' => ts('Addressee')),
4809       'contact_type' => array(
4810         'title' => ts('Contact Type'),
4811       ),
4812       'contact_sub_type' => array(
4813         'title' => ts('Contact Subtype'),
4814       ),
4815       'gender_id' => array(
4816         'title' => ts('Gender'),
4817       ),
4818       'birth_date' => array(
4819         'title' => ts('Birth Date'),
4820       ),
4821       'age' => array(
4822         'title' => ts('Age'),
4823         'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4824       ),
4825       'job_title' => array(
4826         'title' => ts('Contact Job title'),
4827       ),
4828       'organization_name' => array(
4829         'title' => ts('Organization Name'),
4830       ),
4831       'external_identifier' => array(
4832         'title' => ts('Contact identifier from external system'),
4833       ),
4834       'do_not_email' => array(),
4835       'do_not_phone' => array(),
4836       'do_not_mail' => array(),
4837       'do_not_sms' => array(),
4838       'is_opt_out' => array(),
4839       'is_deceased' => array(),
4840       'preferred_language' => array(),
4841       'employer_id' => array(
4842         'title' => ts('Current Employer'),
4843       ),
4844     );
4845   }
4846
4847   /**
4848    * Get a standard set of contact filters.
4849    *
4850    * @param array $defaults
4851    *
4852    * @return array
4853    */
4854   public function getBasicContactFilters($defaults = array()) {
4855     return array(
4856       'sort_name' => array(
4857         'title' => ts('Contact Name'),
4858       ),
4859       'source' => array(
4860         'title' => ts('Contact Source'),
4861         'type' => CRM_Utils_Type::T_STRING,
4862       ),
4863       'id' => array(
4864         'title' => ts('Contact ID'),
4865         'no_display' => TRUE,
4866       ),
4867       'gender_id' => array(
4868         'title' => ts('Gender'),
4869         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4870         'options' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'),
4871       ),
4872       'birth_date' => array(
4873         'title' => ts('Birth Date'),
4874         'operatorType' => CRM_Report_Form::OP_DATE,
4875       ),
4876       'contact_type' => array(
4877         'title' => ts('Contact Type'),
4878       ),
4879       'contact_sub_type' => array(
4880         'title' => ts('Contact Subtype'),
4881       ),
4882       'modified_date' => array(
4883         'title' => ts('Contact Modified'),
4884         'operatorType' => CRM_Report_Form::OP_DATE,
4885         'type' => CRM_Utils_Type::T_DATE,
4886       ),
4887       'is_deceased' => array(
4888         'title' => ts('Deceased'),
4889         'type' => CRM_Utils_Type::T_BOOLEAN,
4890         'default' => CRM_Utils_Array::value('deceased', $defaults, 0),
4891       ),
4892       'do_not_email' => array(
4893         'title' => ts('Do not email'),
4894         'type' => CRM_Utils_Type::T_BOOLEAN,
4895       ),
4896       'do_not_phone' => array(
4897         'title' => ts('Do not phone'),
4898         'type' => CRM_Utils_Type::T_BOOLEAN,
4899       ),
4900       'do_not_mail' => array(
4901         'title' => ts('Do not mail'),
4902         'type' => CRM_Utils_Type::T_BOOLEAN,
4903       ),
4904       'do_not_sms' => array(
4905         'title' => ts('Do not SMS'),
4906         'type' => CRM_Utils_Type::T_BOOLEAN,
4907       ),
4908       'is_opt_out' => array(
4909         'title' => ts('Do not bulk email'),
4910         'type' => CRM_Utils_Type::T_BOOLEAN,
4911       ),
4912       'preferred_language' => array(
4913         'title' => ts('Preferred Language'),
4914       ),
4915       'is_deleted' => array(
4916         'no_display' => TRUE,
4917         'default' => 0,
4918         'type' => CRM_Utils_Type::T_BOOLEAN,
4919       ),
4920     );
4921   }
4922
4923   /**
4924    * Add contact to group.
4925    *
4926    * @param int $groupID
4927    */
4928   public function add2group($groupID) {
4929     if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) {
4930       $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4931       $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select);
4932       $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4933       $sql = str_replace('WITH ROLLUP', '', $sql);
4934       $dao = CRM_Core_DAO::executeQuery($sql);
4935
4936       $contact_ids = array();
4937       // Add resulting contacts to group
4938       while ($dao->fetch()) {
4939         if ($dao->addtogroup_contact_id) {
4940           $contact_ids[$dao->addtogroup_contact_id] = $dao->addtogroup_contact_id;
4941         }
4942       }
4943
4944       if (!empty($contact_ids)) {
4945         CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID);
4946         CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4947       }
4948       else {
4949         CRM_Core_Session::setStatus(ts("The listed records(s) cannot be added to the group."));
4950       }
4951     }
4952   }
4953
4954   /**
4955    * Show charts on print screen.
4956    */
4957   public static function uploadChartImage() {
4958     // upload strictly for '.png' images
4959     $name = trim(basename(CRM_Utils_Request::retrieve('name', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET')));
4960     if (preg_match('/\.png$/', $name)) {
4961
4962       // Get the RAW .png from the input.
4963       $httpRawPostData = file_get_contents("php://input");
4964
4965       // prepare the directory
4966       $config = CRM_Core_Config::singleton();
4967       $defaultPath
4968         = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) .
4969         '/openFlashChart/';
4970       if (!file_exists($defaultPath)) {
4971         mkdir($defaultPath, 0777, TRUE);
4972       }
4973
4974       // full path to the saved image including filename
4975       $destination = $defaultPath . $name;
4976
4977       //write and save
4978       $jfh = fopen($destination, 'w') or die("can't open file");
4979       fwrite($jfh, $httpRawPostData);
4980       fclose($jfh);
4981       CRM_Utils_System::civiExit();
4982     }
4983   }
4984
4985   /**
4986    * Apply common settings to entityRef fields.
4987    *
4988    * @param array $field
4989    * @param string $table
4990    */
4991   public function setEntityRefDefaults(&$field, $table) {
4992     $field['attributes'] = $field['attributes'] ? $field['attributes'] : array();
4993     $field['attributes'] += array(
4994       'entity' => CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getClassForTable($table)),
4995       'multiple' => TRUE,
4996       'placeholder' => ts('- select -'),
4997     );
4998   }
4999
5000   /**
5001    * Add link fields to the row.
5002    *
5003    * Function adds the _link & _hover fields to the row.
5004    *
5005    * @param array $row
5006    * @param string $baseUrl
5007    * @param string $linkText
5008    * @param string $value
5009    * @param string $fieldName
5010    * @param string $tablePrefix
5011    * @param string $fieldLabel
5012    *
5013    * @return mixed
5014    */
5015   protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
5016     $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
5017     $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
5018       "reset=1&force=1&{$criteriaQueryParams}&" .
5019       $fieldName . "_op=in&{$fieldName}_value={$value}",
5020       $this->_absoluteUrl, $this->_id
5021     );
5022     $row["{$tablePrefix}_{$fieldName}_link"] = $url;
5023     $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
5024       array(1 => $linkText, 2 => $fieldLabel)
5025     );
5026   }
5027
5028   /**
5029    * Get label for show results buttons.
5030    *
5031    * @return string
5032    */
5033   public function getResultsLabel() {
5034     $showResultsLabel = $this->resultsDisplayed() ? ts('Refresh results') : ts('View results');
5035     return $showResultsLabel;
5036   }
5037
5038   /**
5039    * Determine the output mode from the url or input.
5040    *
5041    * Output could be
5042    *   - pdf : Render as pdf
5043    *   - csv : Render as csv
5044    *   - print : Render in print format
5045    *   - save : save the report and display the new report
5046    *   - copy : save the report as a new instance and display that.
5047    *   - group : go to the add to group screen.
5048    *
5049    *  Potentially chart variations could also be included but the complexity
5050    *   is that we might print a bar chart as a pdf.
5051    */
5052   protected function setOutputMode() {
5053     $this->_outputMode = str_replace('report_instance.', '', CRM_Utils_Request::retrieve(
5054       'output',
5055       'String',
5056       CRM_Core_DAO::$_nullObject,
5057       FALSE,
5058       CRM_Utils_Array::value('task', $this->_params)
5059     ));
5060     // if contacts are added to group
5061     if (!empty($this->_params['groups']) && empty($this->_outputMode)) {
5062       $this->_outputMode = 'group';
5063     }
5064     if (isset($this->_params['task'])) {
5065       unset($this->_params['task']);
5066     }
5067   }
5068
5069   /**
5070    * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
5071    *
5072    * @param $tempTable
5073    * @param $columnName
5074    */
5075   public function alterSectionHeaderForDateTime($tempTable, $columnName) {
5076     // add new column with date value for the datetime field
5077     $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
5078     CRM_Core_DAO::executeQuery($tempQuery);
5079     $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
5080     CRM_Core_DAO::executeQuery($updateQuery);
5081     $this->_selectClauses[] = "{$columnName}_date";
5082     $this->_select .= ", {$columnName}_date";
5083     $this->_sections["{$columnName}_date"] = $this->_sections["{$columnName}"];
5084     unset($this->_sections["{$columnName}"]);
5085     $this->assign('sections', $this->_sections);
5086   }
5087
5088   /**
5089    * Get an array of the columns that have been selected for display.
5090    *
5091    * @return array
5092    */
5093   public function getSelectColumns() {
5094     $selectColumns = array();
5095     foreach ($this->_columns as $tableName => $table) {
5096       if (array_key_exists('fields', $table)) {
5097         foreach ($table['fields'] as $fieldName => $field) {
5098           if (!empty($field['required']) ||
5099             !empty($this->_params['fields'][$fieldName])
5100           ) {
5101
5102             $selectColumns["{$tableName}_{$fieldName}"] = 1;
5103           }
5104         }
5105       }
5106     }
5107     return $selectColumns;
5108   }
5109
5110   /**
5111    * Add location tables to the query if they are used for filtering.
5112    *
5113    * This is for when we are running the query separately for filtering and retrieving display fields.
5114    */
5115   public function selectivelyAddLocationTablesJoinsToFilterQuery() {
5116     if ($this->isTableFiltered('civicrm_email')) {
5117       $this->_from .= "
5118           LEFT  JOIN civicrm_email  {$this->_aliases['civicrm_email']}
5119             ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
5120             AND {$this->_aliases['civicrm_email']}.is_primary = 1";
5121     }
5122     if ($this->isTableFiltered('civicrm_phone')) {
5123       $this->_from .= "
5124           LEFT  JOIN civicrm_phone  {$this->_aliases['civicrm_phone']}
5125             ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
5126             AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
5127     }
5128     if ($this->isTableFiltered('civicrm_address')) {
5129       $this->_from .= "
5130           LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
5131           ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
5132           AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
5133     }
5134   }
5135
5136   /**
5137    * Set the base table for the FROM clause.
5138    *
5139    * Sets up the from clause, allowing for the possibility it might be a
5140    * temp table pre-filtered by groups if a group filter is in use.
5141    *
5142    * @param string $baseTable
5143    * @param string $field
5144    * @param null $tableAlias
5145    */
5146   public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
5147     if (!$tableAlias) {
5148       $tableAlias = $this->_aliases[$baseTable];
5149     }
5150     $this->_from = $this->_from = " FROM $baseTable $tableAlias ";
5151     $this->joinGroupTempTable($baseTable, $field, $tableAlias);
5152     $this->_from .= " {$this->_aclFrom} ";
5153   }
5154
5155   /**
5156    * Join the temp table contacting contacts who are members of the filtered groups.
5157    *
5158    * If we are using an IN filter we use an inner join, otherwise a left join.
5159    *
5160    * @param string $baseTable
5161    * @param string $field
5162    * @param string $tableAlias
5163    */
5164   public function joinGroupTempTable($baseTable, $field, $tableAlias) {
5165     if ($this->groupTempTable) {
5166       if ($this->_params['gid_op'] == 'in') {
5167         $this->_from = " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
5168         ON group_temp_table.id = $tableAlias.{$field} ";
5169       }
5170       else {
5171         $this->_from .= "
5172           LEFT JOIN $this->groupTempTable group_temp_table
5173           ON $tableAlias.{$field} = group_temp_table.id ";
5174       }
5175     }
5176   }
5177
5178   /**
5179    * Get all labels for fields that are used in a group concat.
5180    *
5181    * @param string $options
5182    *   comma separated option values.
5183    * @param string $baoName
5184    *   The BAO name for the field.
5185    * @param string $fieldName
5186    *   The name of the field for which labels should be retrieved.
5187    *
5188    * return string
5189    */
5190   public function getLabels($options, $baoName, $fieldName) {
5191     $types = explode(',', $options);
5192     $labels = array();
5193     foreach ($types as $value) {
5194       $labels[$value] = CRM_Core_PseudoConstant::getLabel($baoName, $fieldName, $value);
5195     }
5196     return implode(', ', array_filter($labels));
5197   }
5198
5199   /**
5200    * Add statistics columns.
5201    *
5202    * If a group by is in play then add columns for the statistics fields.
5203    *
5204    * This would lead to a new field in the $row such as $fieldName_sum and a new, matching
5205    * column header field.
5206    *
5207    * @param array $field
5208    * @param string $tableName
5209    * @param string $fieldName
5210    * @param array $select
5211    *
5212    * @return array
5213    */
5214   protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) {
5215     foreach ($field['statistics'] as $stat => $label) {
5216       $alias = "{$tableName}_{$fieldName}_{$stat}";
5217       switch (strtolower($stat)) {
5218         case 'max':
5219         case 'sum':
5220           $select[] = "$stat({$field['dbAlias']}) as $alias";
5221           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5222           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5223           $this->_statFields[$label] = $alias;
5224           $this->_selectAliases[] = $alias;
5225           break;
5226
5227         case 'count':
5228           $select[] = "COUNT({$field['dbAlias']}) as $alias";
5229           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5230           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
5231           $this->_statFields[$label] = $alias;
5232           $this->_selectAliases[] = $alias;
5233           break;
5234
5235         case 'count_distinct':
5236           $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
5237           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5238           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
5239           $this->_statFields[$label] = $alias;
5240           $this->_selectAliases[] = $alias;
5241           break;
5242
5243         case 'avg':
5244           $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
5245           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5246           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5247           $this->_statFields[$label] = $alias;
5248           $this->_selectAliases[] = $alias;
5249           break;
5250       }
5251     }
5252     return $select;
5253   }
5254
5255   /**
5256    * Add a basic field to the select clause.
5257    *
5258    * @param string $tableName
5259    * @param string $fieldName
5260    * @param array $field
5261    * @param string $select
5262    * @return array
5263    */
5264   protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) {
5265     $alias = "{$tableName}_{$fieldName}";
5266     $select[] = "{$field['dbAlias']} as $alias";
5267     $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
5268     $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
5269     $this->_selectAliases[] = $alias;
5270     return $select;
5271   }
5272
5273   /**
5274    * Set table alias.
5275    *
5276    * @param array $table
5277    * @param string $tableName
5278    *
5279    * @return string
5280    *   Alias for table.
5281    */
5282   protected function setTableAlias($table, $tableName) {
5283     if (!isset($table['alias'])) {
5284       $this->_columns[$tableName]['alias'] = substr($tableName, 8) .
5285         '_civireport';
5286     }
5287     else {
5288       $this->_columns[$tableName]['alias'] = $table['alias'] . '_civireport';
5289     }
5290
5291     $this->_aliases[$tableName] = $this->_columns[$tableName]['alias'];
5292     return $this->_aliases[$tableName];
5293   }
5294
5295   /**
5296    * Function to add columns to reports.
5297    *
5298    * This is ported from extended reports, which also adds join filters to the options.
5299    *
5300    * @param string $type
5301    * @param array $options
5302    *  - prefix - A string to prepend to the table name
5303    *  - prefix_label  A string to prepend to the fields
5304    *  - fields (bool) - should the fields for this table be made available
5305    *  - group_by (bool) - should the group bys for this table be made available.
5306    *  - order_by (bool) - should the group bys for this table be made available.
5307    *  - filters (bool) - should the filters for this table by made available.
5308    *  - fields_defaults (array) array of fields that should be displayed by default.
5309    *  - filters_defaults (array) array of fields that should be filtered by default.
5310    *  - join_filters (array) fields available for filtering joins (requires additional custom code).
5311    *  - join_fields (array) fields available from join (requires additional custom code).
5312    *  - group_by_defaults (array) array of group bys that should be applied by default.
5313    *  - order_by_defaults (array) array of order bys that should be applied by default.
5314    *  - custom_fields (array) array of entity types for custom fields (not usually required).
5315    *  - contact_type (string) optional restriction on contact type for some tables.
5316    *  - fields_excluded (array) fields that are in the generic set for the table but not in the report.
5317    *
5318    * @return array
5319    */
5320   protected function getColumns($type, $options = array()) {
5321     $defaultOptions = array(
5322       'prefix' => '',
5323       'prefix_label' => '',
5324       'fields' => TRUE,
5325       'group_bys' => FALSE,
5326       'order_bys' => TRUE,
5327       'filters' => TRUE,
5328       'join_filters' => FALSE,
5329       'fields_defaults' => array(),
5330       'filters_defaults' => array(),
5331       'group_bys_defaults' => array(),
5332       'order_bys_defaults' => array(),
5333     );
5334     $options = array_merge($defaultOptions, $options);
5335
5336     $fn = 'get' . $type . 'Columns';
5337     return $this->$fn($options);
5338   }
5339
5340   /**
5341    * Get columns for contact table.
5342    *
5343    * @param array $options
5344    *
5345    * @return array
5346    */
5347   protected function getContactColumns($options = array()) {
5348     $defaultOptions = array(
5349       'custom_fields' => array('Individual', 'Contact', 'Organization'),
5350       'fields_defaults' => array('display_name', 'id'),
5351       'order_bys_defaults' => array('sort_name ASC'),
5352       'contact_type' => NULL,
5353     );
5354
5355     $options = array_merge($defaultOptions, $options);
5356
5357     $tableAlias = $options['prefix'] . 'contact';
5358
5359     $spec = array(
5360       $options['prefix'] . 'display_name' => array(
5361         'name' => 'display_name',
5362         'title' => $options['prefix_label'] . ts('Contact Name'),
5363         'is_fields' => TRUE,
5364       ),
5365       $options['prefix'] . 'sort_name' => array(
5366         'name' => 'sort_name',
5367         'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'),
5368         'is_fields' => TRUE,
5369         'is_filters' => TRUE,
5370         'is_order_bys' => TRUE,
5371       ),
5372       $options['prefix'] . 'id' => array(
5373         'name' => 'id',
5374         'title' => $options['prefix_label'] . ts('Contact ID'),
5375         'alter_display' => 'alterContactID',
5376         'type' => CRM_Utils_Type::T_INT,
5377         'is_order_bys' => TRUE,
5378         'is_group_bys' => TRUE,
5379         'is_fields' => TRUE,
5380         'is_filters' => TRUE,
5381       ),
5382       $options['prefix'] . 'external_identifier' => array(
5383         'name' => 'external_identifier',
5384         'title' => $options['prefix_label'] . ts('External ID'),
5385         'type' => CRM_Utils_Type::T_INT,
5386         'is_fields' => TRUE,
5387       ),
5388       $options['prefix'] . 'contact_type' => array(
5389         'title' => $options['prefix_label'] . ts('Contact Type'),
5390         'name' => 'contact_type',
5391         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5392         'options' => CRM_Contact_BAO_Contact::buildOptions('contact_type'),
5393         'is_fields' => TRUE,
5394         'is_filters' => TRUE,
5395         'is_group_bys' => TRUE,
5396       ),
5397       $options['prefix'] . 'contact_sub_type' => array(
5398         'title' => $options['prefix_label'] . ts('Contact Sub Type'),
5399         'name' => 'contact_sub_type',
5400         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5401         'options' => CRM_Contact_BAO_Contact::buildOptions('contact_sub_type'),
5402         'is_fields' => TRUE,
5403         'is_filters' => TRUE,
5404         'is_group_bys' => TRUE,
5405       ),
5406       $options['prefix'] . 'is_deleted' => array(
5407         'title' => $options['prefix_label'] . ts('Is deleted'),
5408         'name' => 'is_deleted',
5409         'type' => CRM_Utils_Type::T_BOOLEAN,
5410         'is_fields' => FALSE,
5411         'is_filters' => TRUE,
5412         'is_group_bys' => FALSE,
5413       ),
5414       $options['prefix'] . 'external_identifier' => array(
5415         'title' => $options['prefix_label'] . ts('Contact identifier from external system'),
5416         'name' => 'external_identifier',
5417         'is_fields' => TRUE,
5418         'is_filters' => FALSE,
5419         'is_group_bys' => FALSE,
5420         'is_order_bys' => TRUE,
5421       ),
5422       $options['prefix'] . 'preferred_language' => array(
5423         'title' => $options['prefix_label'] . ts('Preferred Language'),
5424         'name' => 'preferred_language',
5425         'is_fields' => TRUE,
5426         'is_filters' => TRUE,
5427         'is_group_bys' => TRUE,
5428         'is_order_bys' => TRUE,
5429       ),
5430     );
5431     foreach ([
5432       'postal_greeting_display' => 'Postal Greeting',
5433       'email_greeting_display' => 'Email Greeting',
5434       'addressee_display' => 'Addressee',
5435     ] as $field => $title) {
5436       $spec[$options['prefix'] . $field] = array(
5437         'title' => $options['prefix_label'] . ts($title),
5438         'name' => $field,
5439         'is_fields' => TRUE,
5440         'is_filters' => FALSE,
5441         'is_group_bys' => FALSE,
5442       );
5443     }
5444     foreach (['do_not_email', 'do_not_phone', 'do_not_mail', 'do_not_sms', 'is_opt_out'] as $field) {
5445       $spec[$options['prefix'] . $field] = [
5446         'name' => $field,
5447         'type' => CRM_Utils_Type::T_BOOLEAN,
5448         'is_fields' => TRUE,
5449         'is_filters' => TRUE,
5450         'is_group_bys' => FALSE,
5451       ];
5452     }
5453     $individualFields = array(
5454       $options['prefix'] . 'first_name' => array(
5455         'name' => 'first_name',
5456         'title' => $options['prefix_label'] . ts('First Name'),
5457         'is_fields' => TRUE,
5458         'is_filters' => TRUE,
5459         'is_order_bys' => TRUE,
5460       ),
5461       $options['prefix'] . 'middle_name' => array(
5462         'name' => 'middle_name',
5463         'title' => $options['prefix_label'] . ts('Middle Name'),
5464         'is_fields' => TRUE,
5465       ),
5466       $options['prefix'] . 'last_name' => array(
5467         'name' => 'last_name',
5468         'title' => $options['prefix_label'] . ts('Last Name'),
5469         'default_order' => 'ASC',
5470         'is_fields' => TRUE,
5471       ),
5472       $options['prefix'] . 'nick_name' => array(
5473         'name' => 'nick_name',
5474         'title' => $options['prefix_label'] . ts('Nick Name'),
5475         'is_fields' => TRUE,
5476       ),
5477       $options['prefix'] . 'prefix_id' => array(
5478         'name' => 'prefix_id',
5479         'title' => $options['prefix_label'] . ts('Prefix'),
5480         'options' => CRM_Contact_BAO_Contact::buildOptions('prefix_id'),
5481         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5482         'is_fields' => TRUE,
5483         'is_filters' => TRUE,
5484       ),
5485       $options['prefix'] . 'suffix_id' => array(
5486         'name' => 'suffix_id',
5487         'title' => $options['prefix_label'] . ts('Suffix'),
5488         'options' => CRM_Contact_BAO_Contact::buildOptions('suffix_id'),
5489         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5490         'is_fields' => TRUE,
5491         'is_filters' => TRUE,
5492       ),
5493       $options['prefix'] . 'gender_id' => array(
5494         'name' => 'gender_id',
5495         'title' => $options['prefix_label'] . ts('Gender'),
5496         'options' => CRM_Contact_BAO_Contact::buildOptions('gender_id'),
5497         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5498         'is_fields' => TRUE,
5499         'is_filters' => TRUE,
5500       ),
5501       'birth_date' => array(
5502         'title' => $options['prefix_label'] . ts('Birth Date'),
5503         'operatorType' => CRM_Report_Form::OP_DATE,
5504         'type' => CRM_Utils_Type::T_DATE,
5505         'is_fields' => TRUE,
5506         'is_filters' => TRUE,
5507       ),
5508       'age' => array(
5509         'title' => $options['prefix_label'] . ts('Age'),
5510         'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())',
5511         'type' => CRM_Utils_Type::T_INT,
5512         'is_fields' => TRUE,
5513       ),
5514       $options['prefix'] . 'is_deceased' => array(
5515         'title' => $options['prefix_label'] . ts('Is deceased'),
5516         'name' => 'is_deceased',
5517         'type' => CRM_Utils_Type::T_BOOLEAN,
5518         'is_fields' => FALSE,
5519         'is_filters' => TRUE,
5520         'is_group_bys' => FALSE,
5521       ),
5522       $options['prefix'] . 'job_title' => array(
5523         'name' => 'job_title',
5524         'is_fields' => TRUE,
5525         'is_filters' => FALSE,
5526         'is_group_bys' => FALSE,
5527       ),
5528       $options['prefix'] . 'employer_id' => array(
5529         'title' => $options['prefix_label'] . ts('Current Employer'),
5530         'type' => CRM_Utils_Type::T_INT,
5531         'name' => 'employer_id',
5532         'is_fields' => TRUE,
5533         'is_filters' => FALSE,
5534         'is_group_bys' => TRUE,
5535       ),
5536     );
5537     if (!$options['contact_type'] || $options['contact_type'] === 'Individual') {
5538       $spec = array_merge($spec, $individualFields);
5539     }
5540
5541     if (!empty($options['custom_fields'])) {
5542       $this->_customGroupExtended[$options['prefix'] . 'civicrm_contact'] = array(
5543         'extends' => $options['custom_fields'],
5544         'title' => $options['prefix_label'],
5545         'filters' => $options['filters'],
5546         'prefix' => $options['prefix'],
5547         'prefix_label' => $options['prefix_label'],
5548       );
5549     }
5550
5551     return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options);
5552   }
5553
5554   /**
5555    * Get address columns to add to array.
5556    *
5557    * @param array $options
5558    *  - prefix Prefix to add to table (in case of more than one instance of the table)
5559    *  - prefix_label Label to give columns from this address table instance
5560    *  - group_bys enable these fields for group by - default false
5561    *  - order_bys enable these fields for order by
5562    *  - filters enable these fields for filtering
5563    *
5564    * @return array address columns definition
5565    */
5566   protected function getAddressColumns($options = array()) {
5567     $defaultOptions = array(
5568       'prefix' => '',
5569       'prefix_label' => '',
5570       'fields' => TRUE,
5571       'group_bys' => FALSE,
5572       'order_bys' => TRUE,
5573       'filters' => TRUE,
5574       'join_filters' => FALSE,
5575       'fields_defaults' => array(),
5576       'filters_defaults' => array(),
5577       'group_bys_defaults' => array(),
5578       'order_bys_defaults' => array(),
5579     );
5580
5581     $options = array_merge($defaultOptions, $options);
5582     $defaults = $this->getDefaultsFromOptions($options);
5583     $tableAlias = $options['prefix'] . 'address';
5584
5585     $spec = array(
5586       $options['prefix'] . 'name' => array(
5587         'title' => ts($options['prefix_label'] . 'Address Name'),
5588         'name' => 'name',
5589         'is_fields' => TRUE,
5590       ),
5591       $options['prefix'] . 'street_number' => array(
5592         'name' => 'street_number',
5593         'title' => ts($options['prefix_label'] . 'Street Number'),
5594         'type' => 1,
5595         'is_fields' => TRUE,
5596       ),
5597       $options['prefix'] . 'odd_street_number' => array(
5598         'title' => ts('Odd / Even Street Number'),
5599         'name' => 'odd_street_number',
5600         'type' => CRM_Utils_Type::T_INT,
5601         'no_display' => TRUE,
5602         'required' => TRUE,
5603         'dbAlias' => '(address_civireport.street_number % 2)',
5604         'is_fields' => TRUE,
5605         'is_order_bys' => TRUE,
5606       ),
5607       $options['prefix'] . 'street_name' => array(
5608         'name' => 'street_name',
5609         'title' => ts($options['prefix_label'] . 'Street Name'),
5610         'type' => 1,
5611         'is_fields' => TRUE,
5612         'is_filters' => TRUE,
5613         'operator' => 'like',
5614         'is_order_bys' => TRUE,
5615       ),
5616       $options['prefix'] . 'street_address' => array(
5617         'title' => ts($options['prefix_label'] . 'Street Address'),
5618         'name' => 'street_address',
5619         'is_fields' => TRUE,
5620         'is_filters' => TRUE,
5621         'is_group_bys' => TRUE,
5622       ),
5623       $options['prefix'] . 'supplemental_address_1' => array(
5624         'title' => ts($options['prefix_label'] . 'Supplementary Address Field 1'),
5625         'name' => 'supplemental_address_1',
5626         'is_fields' => TRUE,
5627       ),
5628       $options['prefix'] . 'supplemental_address_2' => array(
5629         'title' => ts($options['prefix_label'] . 'Supplementary Address Field 2'),
5630         'name' => 'supplemental_address_2',
5631         'is_fields' => TRUE,
5632       ),
5633       $options['prefix'] . 'supplemental_address_3' => array(
5634         'title' => ts($options['prefix_label'] . 'Supplementary Address Field 3'),
5635         'name' => 'supplemental_address_3',
5636         'is_fields' => TRUE,
5637       ),
5638       $options['prefix'] . 'street_number' => array(
5639         'name' => 'street_number',
5640         'title' => ts($options['prefix_label'] . 'Street Number'),
5641         'type' => 1,
5642         'is_order_bys' => TRUE,
5643         'is_filters' => TRUE,
5644         'is_fields' => TRUE,
5645       ),
5646       $options['prefix'] . 'street_unit' => array(
5647         'name' => 'street_unit',
5648         'title' => ts($options['prefix_label'] . 'Street Unit'),
5649         'type' => 1,
5650         'is_fields' => TRUE,
5651       ),
5652       $options['prefix'] . 'city' => array(
5653         'title' => ts($options['prefix_label'] . 'City'),
5654         'name' => 'city',
5655         'operator' => 'like',
5656         'is_fields' => TRUE,
5657         'is_filters' => TRUE,
5658         'is_group_bys' => TRUE,
5659         'is_order_bys' => TRUE,
5660       ),
5661       $options['prefix'] . 'postal_code' => array(
5662         'title' => ts($options['prefix_label'] . 'Postal Code'),
5663         'name' => 'postal_code',
5664         'type' => 1,
5665         'is_fields' => TRUE,
5666         'is_filters' => TRUE,
5667         'is_group_bys' => TRUE,
5668         'is_order_bys' => TRUE,
5669       ),
5670       $options['prefix'] . 'postal_code_suffix' => array(
5671         'title' => ts($options['prefix_label'] . 'Postal Code Suffix'),
5672         'name' => 'postal_code',
5673         'type' => 1,
5674         'is_fields' => TRUE,
5675         'is_filters' => TRUE,
5676         'is_group_bys' => TRUE,
5677         'is_order_bys' => TRUE,
5678       ),
5679       $options['prefix'] . 'county_id' => array(
5680         'title' => ts($options['prefix_label'] . 'County'),
5681         'alter_display' => 'alterCountyID',
5682         'name' => 'county_id',
5683         'type' => CRM_Utils_Type::T_INT,
5684         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5685         'options' => CRM_Core_PseudoConstant::county(),
5686         'is_fields' => TRUE,
5687         'is_filters' => TRUE,
5688         'is_group_bys' => TRUE,
5689       ),
5690       $options['prefix'] . 'state_province_id' => array(
5691         'title' => ts($options['prefix_label'] . 'State/Province'),
5692         'alter_display' => 'alterStateProvinceID',
5693         'name' => 'state_province_id',
5694         'type' => CRM_Utils_Type::T_INT,
5695         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5696         'options' => CRM_Core_PseudoConstant::stateProvince(),
5697         'is_fields' => TRUE,
5698         'is_filters' => TRUE,
5699         'is_group_bys' => TRUE,
5700       ),
5701       $options['prefix'] . 'country_id' => array(
5702         'title' => ts($options['prefix_label'] . 'Country'),
5703         'alter_display' => 'alterCountryID',
5704         'name' => 'country_id',
5705         'is_fields' => TRUE,
5706         'is_filters' => TRUE,
5707         'is_group_bys' => TRUE,
5708         'type' => CRM_Utils_Type::T_INT,
5709         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5710         'options' => CRM_Core_PseudoConstant::country(),
5711       ),
5712       $options['prefix'] . 'location_type_id' => array(
5713         'name' => 'is_primary',
5714         'title' => ts($options['prefix_label'] . 'Location Type'),
5715         'type' => CRM_Utils_Type::T_INT,
5716         'is_fields' => TRUE,
5717         'alter_display' => 'alterLocationTypeID',
5718       ),
5719       $options['prefix'] . 'id' => array(
5720         'title' => ts($options['prefix_label'] . 'ID'),
5721         'name' => 'id',
5722         'is_fields' => TRUE,
5723       ),
5724       $options['prefix'] . 'is_primary' => array(
5725         'name' => 'is_primary',
5726         'title' => ts($options['prefix_label'] . 'Primary Address?'),
5727         'type' => CRM_Utils_Type::T_BOOLEAN,
5728         'is_fields' => TRUE,
5729       ),
5730     );
5731     return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options);
5732   }
5733
5734   /**
5735    * Build the columns.
5736    *
5737    * The normal report class needs you to remember to do a few things that are often erratic
5738    *
5739    * 1) use a unique key for any field that might not be unique (e.g. start date, label)
5740    * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself.
5741    *  You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This
5742    *  means any saved filters / fields on saved report instances. This will mean that matching names from
5743    *  different tables may be ambigious, but it will smooth any code transition.
5744    * - note that it assumes the value being passed in is the actual table field name
5745    *
5746    * 2) set the field & set it to no display if you don't want the field but you might want to use the field in other
5747    * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show
5748    *
5749    * 3) this function also sets the 'metadata' array - the extended report class now uses this in place
5750    *  of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in
5751    *  the core classes can start to move towards that.
5752    *
5753    * @param array $specs
5754    * @param string $tableName
5755    * @param string $daoName
5756    * @param string $tableAlias
5757    * @param array $defaults
5758    * @param array $options
5759    *
5760    * @return array
5761    */
5762   protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = array(), $options = array()) {
5763     if (!$tableAlias) {
5764       $tableAlias = str_replace('civicrm_', '', $tableName);
5765     }
5766     $types = array('filters', 'group_bys', 'order_bys', 'join_filters');
5767     $columns = array($tableName => array_fill_keys($types, array()));
5768     // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO.
5769     $columns[$tableName]['dao'] = $daoName;
5770     $columns[$tableName]['alias'] = $tableAlias;
5771
5772     foreach ($specs as $specName => $spec) {
5773       if (empty($spec['name'])) {
5774         $spec['name'] = $specName;
5775       }
5776
5777       $fieldAlias = (empty($options['no_field_disambiguation']) ? $tableAlias . '_' : '') . $specName;
5778       $columns[$tableName]['metadata'][$fieldAlias] = $spec;
5779       $columns[$tableName]['fields'][$fieldAlias] = $spec;
5780       if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) {
5781         $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE;
5782       }
5783
5784       if (!$spec['is_fields'] || (isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) {
5785         $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE;
5786       }
5787
5788       if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) {
5789         $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE;
5790       }
5791
5792       foreach ($types as $type) {
5793         if ($options[$type] && !empty($spec['is_' . $type])) {
5794           $columns[$tableName][$type][$fieldAlias] = $spec;
5795           if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) {
5796             $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']];
5797           }
5798         }
5799       }
5800     }
5801     return $columns;
5802   }
5803
5804   /**
5805    * Store group bys into array - so we can check elsewhere what is grouped.
5806    */
5807   protected function storeGroupByArray() {
5808
5809     if (!CRM_Utils_Array::value('group_bys', $this->_params)
5810       || !is_array($this->_params['group_bys'])) {
5811       $this->_params['group_bys'] = [];
5812     }
5813
5814     foreach ($this->_columns as $tableName => $table) {
5815       $table = $this->_columns[$tableName];
5816       if (array_key_exists('group_bys', $table)) {
5817         foreach ($table['group_bys'] as $fieldName => $fieldData) {
5818           $field = $this->_columns[$tableName]['metadata'][$fieldName];
5819           if (!empty($this->_params['group_bys'][$fieldName]) || !empty($fieldData['required'])) {
5820             if (!empty($field['chart'])) {
5821               $this->assign('chartSupported', TRUE);
5822             }
5823
5824             if (!empty($table['group_bys'][$fieldName]['frequency']) &&
5825               !empty($this->_params['group_bys_freq'][$fieldName])
5826             ) {
5827
5828               switch ($this->_params['group_bys_freq'][$fieldName]) {
5829                 case 'FISCALYEAR':
5830                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = self::fiscalYearOffset($field['dbAlias']);
5831
5832                 case 'YEAR':
5833                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = " {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
5834
5835                 default:
5836                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_{$this->_params['group_bys_freq'][$fieldName]} FROM {$field['dbAlias']})";
5837
5838               }
5839             }
5840             else {
5841               if (!in_array($field['dbAlias'], $this->_groupByArray)) {
5842                 $this->_groupByArray[$tableName . '_' . $fieldName] = $field['dbAlias'];
5843               }
5844             }
5845           }
5846         }
5847
5848       }
5849     }
5850   }
5851
5852   /**
5853    * @param $options
5854    *
5855    * @return array
5856    */
5857   protected function getDefaultsFromOptions($options) {
5858     $defaults = array(
5859       'fields_defaults' => $options['fields_defaults'],
5860       'filters_defaults' => $options['filters_defaults'],
5861       'group_bys_defaults' => $options['group_bys_defaults'],
5862       'order_bys_defaults' => $options['order_bys_defaults'],
5863     );
5864     return $defaults;
5865   }
5866
5867   /**
5868    * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
5869    *
5870    * Full group by mode dictates that a field must either be in the group by function or
5871    * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the
5872    * group concat.
5873    *
5874    * @param string $tableName
5875    * @param string $fieldName
5876    * @param string $field
5877    * @return string
5878    */
5879   protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) {
5880     if ($this->groupConcatTested && (!empty($this->_groupByArray) || $this->isForceGroupBy)) {
5881       if ((empty($field['statistics']) || in_array('GROUP_CONCAT', $field['statistics']))) {
5882         $label = CRM_Utils_Array::value('title', $field);
5883         $alias = "{$tableName}_{$fieldName}";
5884         $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $label;
5885         $this->_selectAliases[] = $alias;
5886         if (empty($this->_groupByArray[$tableName . '_' . $fieldName])) {
5887           return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias";
5888         }
5889         return "({$field['dbAlias']}) as $alias";
5890       }
5891     }
5892   }
5893
5894   /**
5895    * Generate clause for the selected filter.
5896    *
5897    * @param array $field
5898    *   Field specification
5899    * @param string $fieldName
5900    *   Field name.
5901    *
5902    * @return string
5903    *   Relevant where clause.
5904    */
5905   protected function generateFilterClause($field, $fieldName) {
5906     if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
5907       if (CRM_Utils_Array::value('operatorType', $field) ==
5908         CRM_Report_Form::OP_MONTH
5909       ) {
5910         $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
5911         $value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
5912         if (is_array($value) && !empty($value)) {
5913           return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
5914             '))';
5915         }
5916       }
5917       else {
5918         $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
5919         $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
5920         $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
5921         $fromTime = CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params);
5922         $toTime = CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params);
5923         return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
5924       }
5925     }
5926     else {
5927       $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
5928       if ($op) {
5929         return $this->whereClause($field,
5930           $op,
5931           CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
5932           CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
5933           CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
5934         );
5935       }
5936     }
5937     return '';
5938   }
5939
5940 }