CRM/Logging/Differ.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  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
  68     $contactIdClause = $join = '';
  69     if ( $contactID ) {
  70       $params[3] = array($contactID, 'Integer');
  71       switch ($table) {
  72       case 'civicrm_contact':
  73         $contactIdClause = "AND id = %3";
  74         break;
  75       case 'civicrm_note':
  76         $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')";
  77         break;
  78       case 'civicrm_entity_tag':
  79         $contactIdClause = "AND entity_id = %3 AND entity_table = 'civicrm_contact'";
  80         break;
  81       case 'civicrm_relationship':
  82         $contactIdClause = "AND (contact_id_a = %3 OR contact_id_b = %3)";
  83         break;
  84       case 'civicrm_activity':
  85         $join  = "
  86 LEFT JOIN civicrm_activity_contact at ON at.activity_id = lt.id AND at.contact_id = %3 AND at.record_type = 'Target'
  87 LEFT JOIN civicrm_activity_contact aa ON aa.activity_id = lt.id AND aa.contact_id = %3 AND aa.record_type = 'Assignee'
  88 LEFT JOIN civicrm_activity_contact source ON source.activity_id = lt.id AND source.contact_id = %3 AND source.record_type = 'Source' ";
  89         $contactIdClause = "AND (at.id IS NOT NULL OR aa.id IS NOT NULL OR source.id IS NOT NULL)";
  90         break;
  91       case 'civicrm_case':
  92         $contactIdClause = "AND id = (select case_id FROM civicrm_case_contact WHERE contact_id = %3 LIMIT 1)";
  93         break;
  94       default:
  95         $contactIdClause = "AND contact_id = %3";
  96         if ( strpos($table, 'civicrm_value') !== false ) {
  97           $contactIdClause = "AND entity_id = %3";
  98         }
  99       }
 100     }
 101
 102     // 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)
 103     $sql = "
 104 SELECT DISTINCT lt.id FROM `{$this->db}`.`log_$table` lt
 105 {$join}
 106 WHERE log_conn_id = %1 AND
 107       log_date BETWEEN DATE_SUB(%2, INTERVAL {$this->interval}) AND DATE_ADD(%2, INTERVAL {$this->interval})
 108       {$contactIdClause}";
 109
 110     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 111     while ($dao->fetch()) {
 112       $diffs = array_merge($diffs, $this->diffsInTableForId($table, $dao->id));
 113     }
 114
 115     return $diffs;
 116   }
 117
 118   private function diffsInTableForId($table, $id) {
 119     $diffs = array();
 120
 121     $params = array(
 122       1 => array($this->log_conn_id, 'Integer'),
 123       2 => array($this->log_date, 'String'),
 124       3 => array($id, 'Integer'),
 125     );
 126
 127     // 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
 128     $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";
 129
 130     $changedDAO = CRM_Core_DAO::executeQuery($changedSQL, $params);
 131     while ($changedDAO->fetch( )) {
 132       $changed = $changedDAO->toArray();
 133
 134       // return early if nothing found
 135       if (empty($changed)) {
 136         continue;
 137       }
 138
 139       switch ($changed['log_action']) {
 140         case 'Delete':
 141           // the previous state is kept in the current state, current should keep the keys and clear the values
 142           $original = $changed;
 143           foreach ($changed as & $val) $val = NULL;
 144           $changed['log_action'] = 'Delete';
 145           break;
 146
 147         case 'Insert':
 148           // the previous state does not exist
 149           $original = array();
 150           break;
 151
 152         case 'Update':
 153           // look for the previous state (different log_conn_id) of the given id
 154           $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";
 155           $original = $this->sqlToArray($originalSQL, $params);
 156           if (empty($original)) {
 157             // A blank original array is not possible for Update action, otherwise we 'll end up displaying all information
 158             // in $changed variable as updated-info
 159             $original = $changed;
 160           }
 161
 162           break;
 163       }
 164
 165       // populate $diffs with only the differences between $changed and $original
 166       $skipped = array('log_action', 'log_conn_id', 'log_date', 'log_user_id');
 167       foreach (array_keys(array_diff_assoc($changed, $original)) as $diff) {
 168         if (in_array($diff, $skipped)) {
 169           continue;
 170         }
 171
 172         if (CRM_Utils_Array::value($diff, $original) === CRM_Utils_Array::value($diff, $changed)) {
 173           continue;
 174         }
 175
 176         // hack: case_type_id column is a varchar with separator. For proper mapping to type labels,
 177         // we need to make sure separators are trimmed
 178         if ($diff == 'case_type_id') {
 179           foreach (array('original', 'changed') as $var)  {
 180             if (CRM_Utils_Array::value($diff, $$var)) {
 181               $holder =& $$var;
 182               $val = explode(CRM_Case_BAO_Case::VALUE_SEPARATOR, $holder[$diff]);
 183               $holder[$diff] = CRM_Utils_Array::value(1, $val);
 184             }
 185           }
 186         }
 187
 188         $diffs[] = array(
 189           'action' => $changed['log_action'],
 190           'id' => $id,
 191           'field' => $diff,
 192           'from' => CRM_Utils_Array::value($diff, $original),
 193           'to' => CRM_Utils_Array::value($diff, $changed),
 194         );
 195       }
 196     }
 197
 198     return $diffs;
 199   }
 200
 201   function titlesAndValuesForTable($table) {
 202     // static caches for subsequent calls with the same $table
 203     static $titles = array();
 204     static $values = array();
 205
 206     // FIXME: split off the table → DAO mapping to a GenCode-generated class
 207     static $daos = array(
 208       'civicrm_address' => 'CRM_Core_DAO_Address',
 209       'civicrm_contact' => 'CRM_Contact_DAO_Contact',
 210       'civicrm_email' => 'CRM_Core_DAO_Email',
 211       'civicrm_im' => 'CRM_Core_DAO_IM',
 212       'civicrm_openid' => 'CRM_Core_DAO_OpenID',
 213       'civicrm_phone' => 'CRM_Core_DAO_Phone',
 214       'civicrm_website' => 'CRM_Core_DAO_Website',
 215       'civicrm_contribution' => 'CRM_Contribute_DAO_Contribution',
 216       'civicrm_note' => 'CRM_Core_DAO_Note',
 217       'civicrm_relationship' => 'CRM_Contact_DAO_Relationship',
 218       'civicrm_activity' => 'CRM_Activity_DAO_Activity',
 219       'civicrm_case' => 'CRM_Case_DAO_Case',
 220     );
 221
 222     if (!isset($titles[$table]) or !isset($values[$table])) {
 223
 224       if (in_array($table, array_keys($daos))) {
 225         // FIXME: these should be populated with pseudo constants as they
 226         // were at the time of logging rather than their current values
 227         $values[$table] = array(
 228           'contribution_page_id' => CRM_Contribute_PseudoConstant::contributionPage(),
 229           'contribution_status_id' => CRM_Contribute_PseudoConstant::contributionStatus(),
 230           'financial_type_id'              => CRM_Contribute_PseudoConstant::financialType(),
 231           'country_id' => CRM_Core_PseudoConstant::country(),
 232           'gender_id' => CRM_Core_PseudoConstant::gender(),
 233           'location_type_id' => CRM_Core_PseudoConstant::locationType(),
 234           'payment_instrument_id' => CRM_Contribute_PseudoConstant::paymentInstrument(),
 235           'phone_type_id' => CRM_Core_PseudoConstant::phoneType(),
 236           'preferred_communication_method' => CRM_Core_PseudoConstant::pcm(),
 237           'preferred_language' => CRM_Core_PseudoConstant::languages(),
 238           'prefix_id' => CRM_Core_PseudoConstant::individualPrefix(),
 239           'provider_id' => CRM_Core_PseudoConstant::IMProvider(),
 240           'state_province_id' => CRM_Core_PseudoConstant::stateProvince(),
 241           'suffix_id' => CRM_Core_PseudoConstant::individualSuffix(),
 242           'website_type_id' => CRM_Core_PseudoConstant::websiteType(),
 243           'activity_type_id' => CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE),
 244           'case_type_id' => CRM_Case_PseudoConstant::caseType('label', FALSE),
 245           'priority_id'  => CRM_Core_PseudoConstant::priority(),
 246         );
 247
 248         // for columns that appear in more than 1 table
 249         switch ($table) {
 250           case 'civicrm_case':
 251             $values[$table]['status_id'] = CRM_Case_PseudoConstant::caseStatus('label', FALSE);
 252             break;
 253           case 'civicrm_activity':
 254             $values[$table]['status_id'] = CRM_Core_PseudoConstant::activityStatus( );
 255             break;
 256         }
 257
 258         require_once str_replace('_', DIRECTORY_SEPARATOR, $daos[$table]) . '.php';
 259         eval("\$dao = new $daos[$table];");
 260         foreach ($dao->fields() as $field) {
 261           $titles[$table][$field['name']] = CRM_Utils_Array::value('title', $field);
 262
 263           if ($field['type'] == CRM_Utils_Type::T_BOOLEAN) {
 264             $values[$table][$field['name']] = array('0' => ts('false'), '1' => ts('true'));
 265           }
 266         }
 267       }
 268       elseif (substr($table, 0, 14) == 'civicrm_value_') {
 269         list($titles[$table], $values[$table]) = $this->titlesAndValuesForCustomDataTable($table);
 270       }
 271     }
 272
 273     return array($titles[$table], $values[$table]);
 274   }
 275
 276   private function sqlToArray($sql, $params) {
 277     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 278     $dao->fetch();
 279     return $dao->toArray();
 280   }
 281
 282   private function titlesAndValuesForCustomDataTable($table) {
 283     $titles = array();
 284     $values = array();
 285
 286     $params = array(
 287       1 => array($this->log_conn_id, 'Integer'),
 288       2 => array($this->log_date, 'String'),
 289       3 => array($table, 'String'),
 290     );
 291
 292     $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";
 293     $cgDao = CRM_Core_DAO::executeQuery($sql, $params);
 294     $cgDao->fetch();
 295
 296     $params[3] = array($cgDao->id, 'Integer');
 297     $sql = "
 298 SELECT column_name, data_type, label, name, option_group_id
 299 FROM   `{$this->db}`.log_civicrm_custom_field
 300 WHERE  log_date <= %2
 301 AND    custom_group_id = %3
 302 ORDER BY log_date
 303 ";
 304     $cfDao = CRM_Core_DAO::executeQuery($sql, $params);
 305
 306     while ($cfDao->fetch()) {
 307       $titles[$cfDao->column_name] = "{$cgDao->title}: {$cfDao->label}";
 308
 309       switch ($cfDao->data_type) {
 310         case 'Boolean':
 311           $values[$cfDao->column_name] = array('0' => ts('false'), '1' => ts('true'));
 312           break;
 313
 314         case 'String':
 315           $values[$cfDao->column_name] = array();
 316           if (!empty($cfDao->option_group_id)) {
 317             $params[3] = array($cfDao->option_group_id, 'Integer');
 318             $sql = "
 319 SELECT   label, value
 320 FROM     `{$this->db}`.log_civicrm_option_value
 321 WHERE    log_date <= %2
 322 AND      option_group_id = %3
 323 ORDER BY log_date
 324 ";
 325             $ovDao = CRM_Core_DAO::executeQuery($sql, $params);
 326             while ($ovDao->fetch()) {
 327               $values[$cfDao->column_name][$ovDao->value] = $ovDao->label;
 328             }
 329           }
 330           break;
 331       }
 332     }
 333
 334     return array($titles, $values);
 335   }
 336 }
 337