[civicrm-core.git] / CRM / Logging / Differ.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.5                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2014                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2014
 * $Id$
 *
 */
class CRM_Logging_Differ {
  private $db;
  private $log_conn_id;
  private $log_date;
  private $interval;

  function __construct($log_conn_id, $log_date, $interval = '10 SECOND') {
    $dsn               = defined('CIVICRM_LOGGING_DSN') ? DB::parseDSN(CIVICRM_LOGGING_DSN) : DB::parseDSN(CIVICRM_DSN);
    $this->db          = $dsn['database'];
    $this->log_conn_id = $log_conn_id;
    $this->log_date    = $log_date;
    $this->interval    = $interval;
  }

  function diffsInTables($tables) {
    $diffs = array();
    foreach ($tables as $table) {
      $diff = $this->diffsInTable($table);
      if (!empty($diff)) {
        $diffs[$table] = $diff;
      }
    }
    return $diffs;
  }

  function diffsInTable($table, $contactID = null) {
    $diffs = array();

    $params = array(
      1 => array($this->log_conn_id, 'Integer'),
      2 => array($this->log_date, 'String'),
    );

    $logging = new CRM_Logging_Schema;
    $addressCustomTables = $logging->entityCustomDataLogTables('Address');

    $contactIdClause = $join = '';
    if ( $contactID ) {
      $params[3] = array($contactID, 'Integer');
      switch ($table) {
      case 'civicrm_contact':
        $contactIdClause = "AND id = %3";
        break;
      case 'civicrm_note':
        $contactIdClause = "AND ( entity_id = %3 AND entity_table = 'civicrm_contact' ) OR (entity_id IN (SELECT note.id FROM `{$this->db}`.log_civicrm_note note WHERE note.entity_id = %3 AND note.entity_table = 'civicrm_contact') AND entity_table = 'civicrm_note')";
        break;
      case 'civicrm_entity_tag':
        $contactIdClause = "AND entity_id = %3 AND entity_table = 'civicrm_contact'";
        break;
      case 'civicrm_relationship':
        $contactIdClause = "AND (contact_id_a = %3 OR contact_id_b = %3)";
        break;
      case 'civicrm_activity':
        $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
        $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
        $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
        $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);

        $join  = "
LEFT JOIN civicrm_activity_contact at ON at.activity_id = lt.id AND at.contact_id = %3 AND at.record_type_id = {$targetID}
LEFT JOIN civicrm_activity_contact aa ON aa.activity_id = lt.id AND aa.contact_id = %3 AND aa.record_type_id = {$assigneeID}
LEFT JOIN civicrm_activity_contact source ON source.activity_id = lt.id AND source.contact_id = %3 AND source.record_type_id = {$sourceID} ";
        $contactIdClause = "AND (at.id IS NOT NULL OR aa.id IS NOT NULL OR source.id IS NOT NULL)";
        break;
      case 'civicrm_case':
        $contactIdClause = "AND id = (select case_id FROM civicrm_case_contact WHERE contact_id = %3 LIMIT 1)";
        break;
      default:
        if (array_key_exists($table, $addressCustomTables)) {
          $join  = "INNER JOIN `{$this->db}`.`log_civicrm_address` et ON et.id = lt.entity_id";
          $contactIdClause = "AND contact_id = %3";
          break;
        }

        // allow tables to be extended by report hook query objects
        list($contactIdClause, $join) = CRM_Report_BAO_Hook::singleton()->logDiffClause($this, $table);

        if (empty($contactIdClause)) {
          $contactIdClause = "AND contact_id = %3";
        }
        if ( strpos($table, 'civicrm_value') !== false ) {
          $contactIdClause = "AND entity_id = %3";
        }
      }
    }

    // find ids in this table that were affected in the given connection (based on connection id and a ±10 s time period around the date)
    $sql = "
SELECT DISTINCT lt.id FROM `{$this->db}`.`log_$table` lt
{$join}
WHERE lt.log_conn_id = %1 AND
      lt.log_date BETWEEN DATE_SUB(%2, INTERVAL {$this->interval}) AND DATE_ADD(%2, INTERVAL {$this->interval})
      {$contactIdClause}";

    $dao = CRM_Core_DAO::executeQuery($sql, $params);
    while ($dao->fetch()) {
      $diffs = array_merge($diffs, $this->diffsInTableForId($table, $dao->id));
    }

    return $diffs;
  }

  private function diffsInTableForId($table, $id) {
    $diffs = array();

    $params = array(
      1 => array($this->log_conn_id, 'Integer'),
      2 => array($this->log_date, 'String'),
      3 => array($id, 'Integer'),
    );

    // look for all the changes in the given connection that happended less than {$this->interval} s later than log_date to the given id to catch multi-query changes
    $changedSQL = "SELECT * FROM `{$this->db}`.`log_$table` WHERE log_conn_id = %1 AND log_date >= %2 AND log_date < DATE_ADD(%2, INTERVAL {$this->interval}) AND id = %3 ORDER BY log_date DESC LIMIT 1";

    $changedDAO = CRM_Core_DAO::executeQuery($changedSQL, $params);
    while ($changedDAO->fetch( )) {
      $changed = $changedDAO->toArray();

      // return early if nothing found
      if (empty($changed)) {
        continue;
      }

      switch ($changed['log_action']) {
        case 'Delete':
          // the previous state is kept in the current state, current should keep the keys and clear the values
          $original = $changed;
          foreach ($changed as & $val) $val = NULL;
          $changed['log_action'] = 'Delete';
          break;

        case 'Insert':
          // the previous state does not exist
          $original = array();
          break;

        case 'Update':
          // look for the previous state (different log_conn_id) of the given id
          $originalSQL = "SELECT * FROM `{$this->db}`.`log_$table` WHERE log_conn_id != %1 AND log_date < %2 AND id = %3 ORDER BY log_date DESC LIMIT 1";
          $original = $this->sqlToArray($originalSQL, $params);
          if (empty($original)) {
            // A blank original array is not possible for Update action, otherwise we 'll end up displaying all information
            // in $changed variable as updated-info
            $original = $changed;
          }

          break;
      }

      // populate $diffs with only the differences between $changed and $original
      $skipped = array('log_action', 'log_conn_id', 'log_date', 'log_user_id');
      foreach (array_keys(array_diff_assoc($changed, $original)) as $diff) {
        if (in_array($diff, $skipped)) {
          continue;
        }

        if (CRM_Utils_Array::value($diff, $original) === CRM_Utils_Array::value($diff, $changed)) {
          continue;
        }

        // hack: case_type_id column is a varchar with separator. For proper mapping to type labels,
        // we need to make sure separators are trimmed
        if ($diff == 'case_type_id') {
          foreach (array('original', 'changed') as $var)  {
            if (!empty($$var[$diff])) {
              $holder =& $$var;
              $val = explode(CRM_Case_BAO_Case::VALUE_SEPARATOR, $holder[$diff]);
              $holder[$diff] = CRM_Utils_Array::value(1, $val);
            }
          }
        }

        $diffs[] = array(
          'action' => $changed['log_action'],
          'id' => $id,
          'field' => $diff,
          'from' => CRM_Utils_Array::value($diff, $original),
          'to' => CRM_Utils_Array::value($diff, $changed),
        );
      }
    }

    return $diffs;
  }

  function titlesAndValuesForTable($table) {
    // static caches for subsequent calls with the same $table
    static $titles = array();
    static $values = array();

    // FIXME: split off the table → DAO mapping to a GenCode-generated class
    static $daos = array(
      'civicrm_address' => 'CRM_Core_DAO_Address',
      'civicrm_contact' => 'CRM_Contact_DAO_Contact',
      'civicrm_email' => 'CRM_Core_DAO_Email',
      'civicrm_im' => 'CRM_Core_DAO_IM',
      'civicrm_openid' => 'CRM_Core_DAO_OpenID',
      'civicrm_phone' => 'CRM_Core_DAO_Phone',
      'civicrm_website' => 'CRM_Core_DAO_Website',
      'civicrm_contribution' => 'CRM_Contribute_DAO_Contribution',
      'civicrm_note' => 'CRM_Core_DAO_Note',
      'civicrm_relationship' => 'CRM_Contact_DAO_Relationship',
      'civicrm_activity' => 'CRM_Activity_DAO_Activity',
      'civicrm_case' => 'CRM_Case_DAO_Case',
    );

    if (!isset($titles[$table]) or !isset($values[$table])) {

      if (in_array($table, array_keys($daos))) {
        // FIXME: these should be populated with pseudo constants as they
        // were at the time of logging rather than their current values
        // FIXME: Use *_BAO:buildOptions() method rather than pseudoconstants & fetch programmatically
        $values[$table] = array(
          'contribution_page_id' => CRM_Contribute_PseudoConstant::contributionPage(),
          'contribution_status_id' => CRM_Contribute_PseudoConstant::contributionStatus(),
          'financial_type_id'              => CRM_Contribute_PseudoConstant::financialType(),
          'country_id' => CRM_Core_PseudoConstant::country(),
          'gender_id' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'),
          'location_type_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'),
          'payment_instrument_id' => CRM_Contribute_PseudoConstant::paymentInstrument(),
          'phone_type_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'),
          'preferred_communication_method' => CRM_Contact_BAO_Contact::buildOptions('preferred_communication_method'),
          'preferred_language' => CRM_Contact_BAO_Contact::buildOptions('preferred_language'),
          'prefix_id' => CRM_Contact_BAO_Contact::buildOptions('prefix_id'),
          'provider_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'),
          'state_province_id' => CRM_Core_PseudoConstant::stateProvince(),
          'suffix_id' => CRM_Contact_BAO_Contact::buildOptions('suffix_id'),
          'website_type_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'),
          'activity_type_id' => CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE),
          'case_type_id' => CRM_Case_PseudoConstant::caseType('title', FALSE),
          'priority_id'  => CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'priority_id'),
        );

        // for columns that appear in more than 1 table
        switch ($table) {
          case 'civicrm_case':
            $values[$table]['status_id'] = CRM_Case_PseudoConstant::caseStatus('label', FALSE);
            break;
          case 'civicrm_activity':
            $values[$table]['status_id'] = CRM_Core_PseudoConstant::activityStatus( );
            break;
        }

        $dao = new $daos[$table];
        foreach ($dao->fields() as $field) {
          $titles[$table][$field['name']] = CRM_Utils_Array::value('title', $field);

          if ($field['type'] == CRM_Utils_Type::T_BOOLEAN) {
            $values[$table][$field['name']] = array('0' => ts('false'), '1' => ts('true'));
          }
        }
      }
      elseif (substr($table, 0, 14) == 'civicrm_value_') {
        list($titles[$table], $values[$table]) = $this->titlesAndValuesForCustomDataTable($table);
      } else {
        $titles[$table] = $values[$table] = array();
      }
    }

    return array($titles[$table], $values[$table]);
  }

  private function sqlToArray($sql, $params) {
    $dao = CRM_Core_DAO::executeQuery($sql, $params);
    $dao->fetch();
    return $dao->toArray();
  }

  private function titlesAndValuesForCustomDataTable($table) {
    $titles = array();
    $values = array();

    $params = array(
      1 => array($this->log_conn_id, 'Integer'),
      2 => array($this->log_date, 'String'),
      3 => array($table, 'String'),
    );

    $sql = "SELECT id, title FROM `{$this->db}`.log_civicrm_custom_group WHERE log_date <= %2 AND table_name = %3 ORDER BY log_date DESC LIMIT 1";
    $cgDao = CRM_Core_DAO::executeQuery($sql, $params);
    $cgDao->fetch();

    $params[3] = array($cgDao->id, 'Integer');
    $sql = "
SELECT column_name, data_type, label, name, option_group_id
FROM   `{$this->db}`.log_civicrm_custom_field
WHERE  log_date <= %2
AND    custom_group_id = %3
ORDER BY log_date
";
    $cfDao = CRM_Core_DAO::executeQuery($sql, $params);

    while ($cfDao->fetch()) {
      $titles[$cfDao->column_name] = "{$cgDao->title}: {$cfDao->label}";

      switch ($cfDao->data_type) {
        case 'Boolean':
          $values[$cfDao->column_name] = array('0' => ts('false'), '1' => ts('true'));
          break;

        case 'String':
          $values[$cfDao->column_name] = array();
          if (!empty($cfDao->option_group_id)) {
            $params[3] = array($cfDao->option_group_id, 'Integer');
            $sql = "
SELECT   label, value
FROM     `{$this->db}`.log_civicrm_option_value
WHERE    log_date <= %2
AND      option_group_id = %3
ORDER BY log_date
";
            $ovDao = CRM_Core_DAO::executeQuery($sql, $params);
            while ($ovDao->fetch()) {
              $values[$cfDao->column_name][$ovDao->value] = $ovDao->label;
            }
          }
          break;
      }
    }

    return array($titles, $values);
  }
}
Commit	Line	Data
6a488035 TO	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
06b69b18	4	\| CiviCRM version 4.5 \|
6a488035	5	+--------------------------------------------------------------------+
06b69b18	6	\| Copyright CiviCRM LLC (c) 2004-2014 \|
6a488035 TO	7	+--------------------------------------------------------------------+
	8	\| This file is a part of CiviCRM. \|
	9	\| \|
	10	\| CiviCRM is free software; you can copy, modify, and distribute it \|
	11	\| under the terms of the GNU Affero General Public License \|
	12	\| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. \|
	13	\| \|
	14	\| CiviCRM is distributed in the hope that it will be useful, but \|
	15	\| WITHOUT ANY WARRANTY; without even the implied warranty of \|
	16	\| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. \|
	17	\| See the GNU Affero General Public License for more details. \|
	18	\| \|
	19	\| You should have received a copy of the GNU Affero General Public \|
	20	\| License and the CiviCRM Licensing Exception along \|
	21	\| with this program; if not, contact CiviCRM LLC \|
	22	\| at info[AT]civicrm[DOT]org. If you have questions about the \|
	23	\| GNU Affero General Public License or the licensing of CiviCRM, \|
	24	\| see the CiviCRM license FAQ at http://civicrm.org/licensing \|
	25	+--------------------------------------------------------------------+
	26	*/
	27
	28	/**
	29	*
	30	* @package CRM
06b69b18	31	* @copyright CiviCRM LLC (c) 2004-2014
6a488035 TO	32	* $Id$
	33	*
	34	*/
	35	class CRM_Logging_Differ {
	36	private $db;
	37	private $log_conn_id;
	38	private $log_date;
	39	private $interval;
	40
	41	function __construct($log_conn_id, $log_date, $interval = '10 SECOND') {
	42	$dsn = defined('CIVICRM_LOGGING_DSN') ? DB::parseDSN(CIVICRM_LOGGING_DSN) : DB::parseDSN(CIVICRM_DSN);
	43	$this->db = $dsn['database'];
	44	$this->log_conn_id = $log_conn_id;
	45	$this->log_date = $log_date;
	46	$this->interval = $interval;
	47	}
	48
	49	function diffsInTables($tables) {
	50	$diffs = array();
	51	foreach ($tables as $table) {
	52	$diff = $this->diffsInTable($table);
	53	if (!empty($diff)) {
	54	$diffs[$table] = $diff;
	55	}
	56	}
	57	return $diffs;
	58	}
	59
	60	function diffsInTable($table, $contactID = null) {
	61	$diffs = array();
	62
	63	$params = array(
	64	1 => array($this->log_conn_id, 'Integer'),
	65	2 => array($this->log_date, 'String'),
	66	);
	67
694e78fd DS	68	$logging = new CRM_Logging_Schema;
	69	$addressCustomTables = $logging->entityCustomDataLogTables('Address');
	70
0b4c85c3	71	$contactIdClause = $join = '';
6a488035 TO	72	if ( $contactID ) {
	73	$params[3] = array($contactID, 'Integer');
	74	switch ($table) {
	75	case 'civicrm_contact':
	76	$contactIdClause = "AND id = %3";
	77	break;
	78	case 'civicrm_note':
b10fb376	79	$contactIdClause = "AND ( entity_id = %3 AND entity_table = 'civicrm_contact' ) OR (entity_id IN (SELECT note.id FROM `{$this->db}`.log_civicrm_note note WHERE note.entity_id = %3 AND note.entity_table = 'civicrm_contact') AND entity_table = 'civicrm_note')";
6a488035 TO	80	break;
	81	case 'civicrm_entity_tag':
	82	$contactIdClause = "AND entity_id = %3 AND entity_table = 'civicrm_contact'";
	83	break;
	84	case 'civicrm_relationship':
	85	$contactIdClause = "AND (contact_id_a = %3 OR contact_id_b = %3)";
	86	break;
	87	case 'civicrm_activity':
e7e657f0	88	$activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
9e74e3ce	89	$sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
	90	$assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
	91	$targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
	92
0b4c85c3	93	$join = "
9e74e3ce	94	LEFT JOIN civicrm_activity_contact at ON at.activity_id = lt.id AND at.contact_id = %3 AND at.record_type_id = {$targetID}
	95	LEFT JOIN civicrm_activity_contact aa ON aa.activity_id = lt.id AND aa.contact_id = %3 AND aa.record_type_id = {$assigneeID}
	96	LEFT JOIN civicrm_activity_contact source ON source.activity_id = lt.id AND source.contact_id = %3 AND source.record_type_id = {$sourceID} ";
0b4c85c3	97	$contactIdClause = "AND (at.id IS NOT NULL OR aa.id IS NOT NULL OR source.id IS NOT NULL)";
6a488035 TO	98	break;
	99	case 'civicrm_case':
	100	$contactIdClause = "AND id = (select case_id FROM civicrm_case_contact WHERE contact_id = %3 LIMIT 1)";
	101	break;
	102	default:
694e78fd DS	103	if (array_key_exists($table, $addressCustomTables)) {
	104	$join = "INNER JOIN `{$this->db}`.`log_civicrm_address` et ON et.id = lt.entity_id";
	105	$contactIdClause = "AND contact_id = %3";
	106	break;
	107	}
	108
6b4b11c4 DS	109	// allow tables to be extended by report hook query objects
	110	list($contactIdClause, $join) = CRM_Report_BAO_Hook::singleton()->logDiffClause($this, $table);
	111
	112	if (empty($contactIdClause)) {
	113	$contactIdClause = "AND contact_id = %3";
	114	}
6a488035 TO	115	if ( strpos($table, 'civicrm_value') !== false ) {
	116	$contactIdClause = "AND entity_id = %3";
	117	}
	118	}
	119	}
	120
	121	// find ids in this table that were affected in the given connection (based on connection id and a ±10 s time period around the date)
0b4c85c3	122	$sql = "
8ef12e64	123	SELECT DISTINCT lt.id FROM `{$this->db}`.`log_$table` lt
8ef12e64	124	{$join}
694e78fd DS	125	WHERE lt.log_conn_id = %1 AND
694e78fd DS	126	lt.log_date BETWEEN DATE_SUB(%2, INTERVAL {$this->interval}) AND DATE_ADD(%2, INTERVAL {$this->interval})
0b4c85c3	127	{$contactIdClause}";
5a1bd70b	128
6a488035 TO	129	$dao = CRM_Core_DAO::executeQuery($sql, $params);
	130	while ($dao->fetch()) {
	131	$diffs = array_merge($diffs, $this->diffsInTableForId($table, $dao->id));
	132	}
	133
	134	return $diffs;
	135	}
	136
	137	private function diffsInTableForId($table, $id) {
	138	$diffs = array();
	139
	140	$params = array(
	141	1 => array($this->log_conn_id, 'Integer'),
	142	2 => array($this->log_date, 'String'),
	143	3 => array($id, 'Integer'),
	144	);
	145
	146	// look for all the changes in the given connection that happended less than {$this->interval} s later than log_date to the given id to catch multi-query changes
	147	$changedSQL = "SELECT * FROM `{$this->db}`.`log_$table` WHERE log_conn_id = %1 AND log_date >= %2 AND log_date < DATE_ADD(%2, INTERVAL {$this->interval}) AND id = %3 ORDER BY log_date DESC LIMIT 1";
	148
	149	$changedDAO = CRM_Core_DAO::executeQuery($changedSQL, $params);
	150	while ($changedDAO->fetch( )) {
	151	$changed = $changedDAO->toArray();
	152
	153	// return early if nothing found
	154	if (empty($changed)) {
	155	continue;
	156	}
	157
	158	switch ($changed['log_action']) {
	159	case 'Delete':
	160	// the previous state is kept in the current state, current should keep the keys and clear the values
	161	$original = $changed;
	162	foreach ($changed as & $val) $val = NULL;
	163	$changed['log_action'] = 'Delete';
	164	break;
	165
	166	case 'Insert':
	167	// the previous state does not exist
	168	$original = array();
	169	break;
	170
	171	case 'Update':
	172	// look for the previous state (different log_conn_id) of the given id
	173	$originalSQL = "SELECT * FROM `{$this->db}`.`log_$table` WHERE log_conn_id != %1 AND log_date < %2 AND id = %3 ORDER BY log_date DESC LIMIT 1";
	174	$original = $this->sqlToArray($originalSQL, $params);
	175	if (empty($original)) {
8ef12e64	176	// A blank original array is not possible for Update action, otherwise we 'll end up displaying all information
6a488035 TO	177	// in $changed variable as updated-info
	178	$original = $changed;
	179	}
	180
	181	break;
	182	}
	183
	184	// populate $diffs with only the differences between $changed and $original
	185	$skipped = array('log_action', 'log_conn_id', 'log_date', 'log_user_id');
	186	foreach (array_keys(array_diff_assoc($changed, $original)) as $diff) {
	187	if (in_array($diff, $skipped)) {
	188	continue;
	189	}
	190
	191	if (CRM_Utils_Array::value($diff, $original) === CRM_Utils_Array::value($diff, $changed)) {
	192	continue;
	193	}
8ef12e64	194
8ef12e64	195	// hack: case_type_id column is a varchar with separator. For proper mapping to type labels,
6a488035 TO	196	// we need to make sure separators are trimmed
	197	if ($diff == 'case_type_id') {
	198	foreach (array('original', 'changed') as $var) {
a7488080	199	if (!empty($$var[$diff])) {
6a488035 TO	200	$holder =& $$var;
	201	$val = explode(CRM_Case_BAO_Case::VALUE_SEPARATOR, $holder[$diff]);
	202	$holder[$diff] = CRM_Utils_Array::value(1, $val);
	203	}
	204	}
	205	}
	206
	207	$diffs[] = array(
	208	'action' => $changed['log_action'],
	209	'id' => $id,
	210	'field' => $diff,
	211	'from' => CRM_Utils_Array::value($diff, $original),
	212	'to' => CRM_Utils_Array::value($diff, $changed),
	213	);
	214	}
	215	}
	216
	217	return $diffs;
	218	}
	219
	220	function titlesAndValuesForTable($table) {
	221	// static caches for subsequent calls with the same $table
	222	static $titles = array();
	223	static $values = array();
	224
	225	// FIXME: split off the table → DAO mapping to a GenCode-generated class
	226	static $daos = array(
	227	'civicrm_address' => 'CRM_Core_DAO_Address',
	228	'civicrm_contact' => 'CRM_Contact_DAO_Contact',
	229	'civicrm_email' => 'CRM_Core_DAO_Email',
	230	'civicrm_im' => 'CRM_Core_DAO_IM',
	231	'civicrm_openid' => 'CRM_Core_DAO_OpenID',
	232	'civicrm_phone' => 'CRM_Core_DAO_Phone',
	233	'civicrm_website' => 'CRM_Core_DAO_Website',
	234	'civicrm_contribution' => 'CRM_Contribute_DAO_Contribution',
	235	'civicrm_note' => 'CRM_Core_DAO_Note',
	236	'civicrm_relationship' => 'CRM_Contact_DAO_Relationship',
	237	'civicrm_activity' => 'CRM_Activity_DAO_Activity',
	238	'civicrm_case' => 'CRM_Case_DAO_Case',
	239	);
	240
	241	if (!isset($titles[$table]) or !isset($values[$table])) {
	242
	243	if (in_array($table, array_keys($daos))) {
	244	// FIXME: these should be populated with pseudo constants as they
	245	// were at the time of logging rather than their current values
c0c9cd82	246	// FIXME: Use *_BAO:buildOptions() method rather than pseudoconstants & fetch programmatically
6a488035 TO	247	$values[$table] = array(
	248	'contribution_page_id' => CRM_Contribute_PseudoConstant::contributionPage(),
	249	'contribution_status_id' => CRM_Contribute_PseudoConstant::contributionStatus(),
	250	'financial_type_id' => CRM_Contribute_PseudoConstant::financialType(),
	251	'country_id' => CRM_Core_PseudoConstant::country(),
26cf88b5	252	'gender_id' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'),
b2b0530a	253	'location_type_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'),
6a488035	254	'payment_instrument_id' => CRM_Contribute_PseudoConstant::paymentInstrument(),
b4f964d9	255	'phone_type_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'),
c0c9cd82 CW	256	'preferred_communication_method' => CRM_Contact_BAO_Contact::buildOptions('preferred_communication_method'),
	257	'preferred_language' => CRM_Contact_BAO_Contact::buildOptions('preferred_language'),
	258	'prefix_id' => CRM_Contact_BAO_Contact::buildOptions('prefix_id'),
e7e657f0	259	'provider_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'),
6a488035	260	'state_province_id' => CRM_Core_PseudoConstant::stateProvince(),
c0c9cd82	261	'suffix_id' => CRM_Contact_BAO_Contact::buildOptions('suffix_id'),
cbf48754	262	'website_type_id' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'),
6a488035	263	'activity_type_id' => CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE),
42047ce4	264	'case_type_id' => CRM_Case_PseudoConstant::caseType('title', FALSE),
cbf48754	265	'priority_id' => CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'priority_id'),
6a488035 TO	266	);
	267
	268	// for columns that appear in more than 1 table
	269	switch ($table) {
	270	case 'civicrm_case':
	271	$values[$table]['status_id'] = CRM_Case_PseudoConstant::caseStatus('label', FALSE);
	272	break;
	273	case 'civicrm_activity':
	274	$values[$table]['status_id'] = CRM_Core_PseudoConstant::activityStatus( );
	275	break;
	276	}
	277
4d5c2eb5	278	$dao = new $daos[$table];
6a488035 TO	279	foreach ($dao->fields() as $field) {
	280	$titles[$table][$field['name']] = CRM_Utils_Array::value('title', $field);
	281
	282	if ($field['type'] == CRM_Utils_Type::T_BOOLEAN) {
	283	$values[$table][$field['name']] = array('0' => ts('false'), '1' => ts('true'));
	284	}
	285	}
	286	}
	287	elseif (substr($table, 0, 14) == 'civicrm_value_') {
	288	list($titles[$table], $values[$table]) = $this->titlesAndValuesForCustomDataTable($table);
6b4b11c4 DS	289	} else {
6b4b11c4 DS	290	$titles[$table] = $values[$table] = array();
6a488035 TO	291	}
	292	}
	293
	294	return array($titles[$table], $values[$table]);
	295	}
	296
	297	private function sqlToArray($sql, $params) {
	298	$dao = CRM_Core_DAO::executeQuery($sql, $params);
	299	$dao->fetch();
	300	return $dao->toArray();
	301	}
	302
	303	private function titlesAndValuesForCustomDataTable($table) {
	304	$titles = array();
	305	$values = array();
	306
	307	$params = array(
	308	1 => array($this->log_conn_id, 'Integer'),
	309	2 => array($this->log_date, 'String'),
	310	3 => array($table, 'String'),
	311	);
	312
	313	$sql = "SELECT id, title FROM `{$this->db}`.log_civicrm_custom_group WHERE log_date <= %2 AND table_name = %3 ORDER BY log_date DESC LIMIT 1";
	314	$cgDao = CRM_Core_DAO::executeQuery($sql, $params);
	315	$cgDao->fetch();
	316
	317	$params[3] = array($cgDao->id, 'Integer');
	318	$sql = "
	319	SELECT column_name, data_type, label, name, option_group_id
	320	FROM `{$this->db}`.log_civicrm_custom_field
	321	WHERE log_date <= %2
	322	AND custom_group_id = %3
	323	ORDER BY log_date
	324	";
	325	$cfDao = CRM_Core_DAO::executeQuery($sql, $params);
	326
	327	while ($cfDao->fetch()) {
	328	$titles[$cfDao->column_name] = "{$cgDao->title}: {$cfDao->label}";
	329
	330	switch ($cfDao->data_type) {
	331	case 'Boolean':
	332	$values[$cfDao->column_name] = array('0' => ts('false'), '1' => ts('true'));
	333	break;
	334
	335	case 'String':
	336	$values[$cfDao->column_name] = array();
	337	if (!empty($cfDao->option_group_id)) {
	338	$params[3] = array($cfDao->option_group_id, 'Integer');
	339	$sql = "
	340	SELECT label, value
	341	FROM `{$this->db}`.log_civicrm_option_value
	342	WHERE log_date <= %2
	343	AND option_group_id = %3
	344	ORDER BY log_date
	345	";
	346	$ovDao = CRM_Core_DAO::executeQuery($sql, $params);
	347	while ($ovDao->fetch()) {
	348	$values[$cfDao->column_name][$ovDao->value] = $ovDao->label;
	349	}
	350	}
	351	break;
	352	}
	353	}
	354
355	return array($titles, $values);
356	}
357	}
358