CRM/Report/Form.php

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