sumfields.php

<?php

require_once 'sumfields.civix.php';
use CRM_Sumfields_ExtensionUtil as E;



/**
 * Implementation of hook_civicrm_config
 */
function sumfields_civicrm_config(&$config) {
  _sumfields_civix_civicrm_config($config);
}

/**
 * Implementation of hook_civicrm_navigationMenu
 *
 * @param $params array
 */
function sumfields_civicrm_navigationMenu(&$menu) {
  $path = "Administer/Customize Data and Screens";
  _sumfields_civix_insert_navigation_menu($menu, $path, array(
    'label' => E::ts('Summary Fields'),
    'name' => 'Summary Fields',
    'url' => 'civicrm/admin/setting/sumfields',
    'permission' => 'administer CiviCRM',
    'operator' => '',
    'separator' => '0'
  ));
  _sumfields_civix_navigationMenu($menu);
}

/**
 * Implementation of hook_civicrm_install
 */
function sumfields_civicrm_install() {
  _sumfields_civix_civicrm_install();
}

/**
 * Implementation of hook_civicrm_uninstall
 */
function sumfields_civicrm_uninstall() {
  sumfields_deinitialize_custom_data();
  sumfields_delete_user_settings();
}

/**
 * Impelmentation of hook_civicrm_postInstall
 */
function sumfields_civicrm_postInstall() {
  sumfields_initialize_user_settings();
  $session = CRM_Core_Session::singleton();
  if(!sumfields_create_custom_fields_and_table()) {
    $msg = E::ts("Failed to create custom fields and table. Maybe they already exist?");
    $session->setStatus($msg);
  }
  $msg = E::ts("The extension is enabled. Please go to Adminster -> Customize Data and Screens -> Summary Fields to configure it.");
  $session->setStatus($msg);

}

/**
 * Implementation of hook_civicrm_enable
 */
function sumfields_civicrm_enable() {
  sumfields_reenable_custom_group();
  _sumfields_civix_civicrm_enable();
}

/**
 * Implementation of hook_civicrm_disable
 */
function sumfields_civicrm_disable() {
  sumfields_disable_custom_group();
}

/**
 * Implementation of hook_civicrm_pageRun
 *
 * Add link to manage summary fields
 */
function sumfields_civicrm_pageRun($page) {
  if (CRM_Core_Permission::check('administer CiviCRM') && $page->getVar('_name') == 'CRM_Contact_Page_View_CustomData') {
    CRM_Core_Region::instance('custom-data-view-Summary_Fields')->add(array(
      'markup' => '
      <a class="no-popup button" href="' . CRM_Utils_System::url('civicrm/admin/setting/sumfields') . '">
        <span>
          <i class="crm-i fa-wrench"></i>&nbsp; ' . E::ts('Configure Summary Fields') . '
        </span>
      </a>
    ',
    ));
  }
}

/**
 * Force all values to be integers.
 *
 * This function is called in array_walk when rewriting sql statements
 * to ensure that all values put into "IN (1,2,3)" style clauses are
 * in fact integers.
 */
function sumfields_force_integer(&$value, $key) {
  if (!is_numeric($value)) {
    $session = CRM_Core_Session::singleton();
    $session->setStatus(E::ts("Failed to properly validate one of your options. Be sure to use integer values for all options."));
  }

  // is_numeric is not perfect, it will allow 4.2 and 0x539, etc.
  // To be safe, we really want an integer.
  $value = intval($value);
}

/**
 * Force all values to be dates in YYYY-MM-DD format..
 *
 * This function is called in array_walk when rewriting sql statements
 * to ensure that all date values are really date values..
 */
function sumfields_force_date(&$value, $key) {
  if (!preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/', $value)) {
    $session = CRM_Core_Session::singleton();
    $session->setStatus(E::ts("Failed to properly validate the date @date.", array('@date' => $value)));
    $value = '9999-99-99';
  }
}

/**
 * Replace %variable with the actual
 * values that the user has configured to limit to.
 **/
function sumfields_sql_rewrite($sql) {
  // Note: most of these token replacements fill in a sql IN statement,
  // e.g. field_name IN (%token). That means if the token is empty, we
  // get a SQL error. So... for each of these, if the token is empty,
  // we fill it with all possible values at the moment. If a new option
  // is added, summary fields will have to be re-configured.
  $ids = sumfields_get_setting('financial_type_ids', array());
  if(count($ids) == 0) {
    $ids = array_keys(sumfields_get_all_financial_types());
  }
  array_walk($ids, 'sumfields_force_integer');
  $str_ids = implode(',', $ids);
  $sql = str_replace('%financial_type_ids', $str_ids, $sql);

  $ids = sumfields_get_setting('membership_financial_type_ids', array());
  if(count($ids) == 0) {
    // Surely this is wrong... but better to avoid a sql error
    $ids = array_keys(sumfields_get_all_financial_types());
  }
  array_walk($ids, 'sumfields_force_integer');
  $str_ids = implode(',', $ids);
  $sql = str_replace('%membership_financial_type_ids', $str_ids, $sql);

  $ids = sumfields_get_setting('participant_status_ids', array());
  if(count($ids) == 0) {
    $ids = array_keys(sumfields_get_all_participant_status_types());
  }
  array_walk($ids, 'sumfields_force_integer');
  $str_ids = implode(',', $ids);
  $sql = str_replace('%participant_status_ids', $str_ids, $sql);

  $ids = sumfields_get_setting('participant_noshow_status_ids', array());
  if(count($ids) == 0) {
    $ids = array_keys(sumfields_get_all_participant_status_types());
  }
  array_walk($ids, 'sumfields_force_integer');
  $str_ids = implode(',', $ids);
  $sql = str_replace('%participant_noshow_status_ids', $str_ids, $sql);

  $ids = sumfields_get_setting('event_type_ids', array());
  if(count($ids) == 0) {
    $ids = array_keys(sumfields_get_all_event_types());
  }
  array_walk($ids, 'sumfields_force_integer');
  $str_ids = implode(',', $ids);
  $sql = str_replace('%event_type_ids', $str_ids, $sql);

  $fiscal_dates = sumfields_get_fiscal_dates();
  $keys = array_keys($fiscal_dates);
  $values = array_values($fiscal_dates);
  array_walk($values, 'sumfields_force_date');
  $sql = str_replace($keys, $values, $sql);

  return $sql;
}

/**
 * Based on the civicrm fiscal date setting, determine the dates for the
 * various begin and end fiscal year dates needed by the rewrite function.
 **/
function sumfields_get_fiscal_dates() {
  $ret = array(
    '%current_fiscal_year_begin' => NULL,
    '%current_fiscal_year_end' => NULL,
    '%last_fiscal_year_begin' => NULL,
    '%last_fiscal_year_end' => NULL,
    '%year_before_last_fiscal_year_begin' => NULL,
    '%year_before_last_fiscal_year_end' => NULL,
  );
  $config = CRM_Core_Config::singleton();

  // These are returned as not zero-padded numbers,
  // e.g. 1 and 1 or 9 and 1
  $fiscal_month = sumfields_zero_pad($config->fiscalYearStart['M']);
  $fiscal_day = sumfields_zero_pad($config->fiscalYearStart['d']);

  $this_calendar_year_fiscal_year_begin_ts = strtotime(date('Y') . '-' . $fiscal_month . '-' . $fiscal_day);
  $now = time();
  if($now < $this_calendar_year_fiscal_year_begin_ts) {
    // We need to adjust the current fiscal year back one year. For example, it's Feb 3
    // and the fiscal year begins Sep 1, the current fiscal year started Sep 1 of the
    // last calendar year.
    $current_fiscal_year_begin_ts = strtotime('-1 year', $this_calendar_year_fiscal_year_begin_ts);
    $current_fiscal_year_end_ts = strtotime('-1 day', $this_calendar_year_fiscal_year_begin_ts);
    $last_fiscal_year_begin_ts = strtotime('-2 year', $this_calendar_year_fiscal_year_begin_ts);
    $last_fiscal_year_end_ts = strtotime('-1 year -1 day', $this_calendar_year_fiscal_year_begin_ts);
    $year_before_last_fiscal_year_begin_ts = strtotime('-3 year', $this_calendar_year_fiscal_year_begin_ts);
    $year_before_last_fiscal_year_end_ts = strtotime('-2 year -1 day', $this_calendar_year_fiscal_year_begin_ts);
  }
  else {
    $current_fiscal_year_begin_ts = $this_calendar_year_fiscal_year_begin_ts;
    $current_fiscal_year_end_ts = strtotime('+1 year -1 day', $this_calendar_year_fiscal_year_begin_ts);
    $last_fiscal_year_begin_ts = strtotime('-1 year', $this_calendar_year_fiscal_year_begin_ts);
    $last_fiscal_year_end_ts = strtotime('-1 day', $this_calendar_year_fiscal_year_begin_ts);
    $year_before_last_fiscal_year_begin_ts = strtotime('-2 year', $this_calendar_year_fiscal_year_begin_ts);
    $year_before_last_fiscal_year_end_ts = strtotime('-1 year -1 day', $this_calendar_year_fiscal_year_begin_ts);
  }
  return array(
    '%current_fiscal_year_begin' => date('Y-m-d', $current_fiscal_year_begin_ts),
    '%current_fiscal_year_end' => date('Y-m-d', $current_fiscal_year_end_ts),
    '%last_fiscal_year_begin' => date('Y-m-d', $last_fiscal_year_begin_ts),
    '%last_fiscal_year_end' => date('Y-m-d', $last_fiscal_year_end_ts),
    '%year_before_last_fiscal_year_begin' => date('Y-m-d', $year_before_last_fiscal_year_begin_ts),
    '%year_before_last_fiscal_year_end' => date('Y-m-d', $year_before_last_fiscal_year_end_ts),
  );
}

/**
 * Utility function for calculating fiscal years
 **/
function sumfields_zero_pad($num) {
  if(strlen($num) == 1) return '0' . $num;
  return $num;
}

/**
 * hook_civicrm_triggerInfo()
 *
 * Add triggers for our tables
 **/

function sumfields_civicrm_triggerInfo(&$info, $tableName) {

  // Do a check if we are running through triggers or cronjob. We don't want
  // use system resources
  $data_update_method = sumfields_get_setting('data_update_method','default');
  if ($data_update_method == 'via_triggers') {

    // Our triggers all use custom fields. CiviCRM, when generating
    // custom fields, sometimes gives them different names (appending
    // the id in most cases) to avoid name collisions.
    //
    // So, we have to retrieve the actual name of each field that is in
    // use.

    $table_name = _sumfields_get_custom_table_name();
    $custom_fields = _sumfields_get_custom_field_parameters();

    // Load the field and group definitions because we need the trigger
    // clause that is stored here.
    $custom = sumfields_get_custom_field_definitions();

    // We create a trigger sql statement for each table that should
    // have a trigger
    $tables = array();

    $generic_sql = "INSERT INTO `$table_name` SET ";
    $sql_field_parts = array();

    $active_fields = sumfields_get_setting('active_fields', array());
    $session = CRM_Core_Session::singleton();

    // Iterate over all our fields, and build out a sql parts array
    foreach ($custom_fields as $base_column_name => $params) {
      if(!in_array($base_column_name, $active_fields)) continue;
      if(!array_key_exists($base_column_name, $custom['fields'])) {
        Civi::log()->debug("The $base_column_name field has been yanked, re-save custom field definitions. ");
        continue;
      }
      $table = $custom['fields'][$base_column_name]['trigger_table'];
      if(!is_null($tableName) && $tableName != $table) {
        // if triggerInfo is called with particular table name, we should
        // only respond if we are contributing triggers to that table.
        continue;
      }
      $trigger = $custom['fields'][$base_column_name]['trigger_sql'];
      $trigger = sumfields_sql_rewrite($trigger);
      // If we fail to properly rewrite the sql, don't set the trigger
      // to avoid sql exceptions.
      if(FALSE === $trigger) {
        $msg = sprintf(E::ts("Failed to rewrite sql for %s field."), $base_column_name);
        $session->setStatus($msg);
        continue;
      }
      $sql_field_parts[$table][] = '`' . $params['column_name'] . '` = ' .
        $trigger;
      // Keep track of which tables we need to build triggers for.
      if(!in_array($table, $tables)) $tables[] = $table;
    }

    // Iterate over each table that needs a trigger, build the trigger's
    // sql clause.
    foreach ($tables as $table) {
      // Most tables don't need to be enclosed in an if/then statement,
      // so pre_sql and post_sql are null.
      $pre_sql = NULL;
      $post_sql = NULL;

      $parts = $sql_field_parts[$table];

      // Most trigger tables have the contact_id field so calculating the
      // contact_id is as easy as referencing NEW.contact_id. However,
      // some trigger tables (e.g. civicrm_line_item) don't have contact_id
      // so triggers based on these tables have to calculate the value of
      // the contact_id (e.g. (SELECT contact_id FROM civicrm_contribution
      // WHERE id = NEW.contribution_id)). How it is calculated varies
      // depending on the table. This code abstracts that process - so you
      // simply need to add it to custom.php.
      if (isset($custom['tables'][$table]['calculated_contact_id'])) {
        $calculated_contact_id = $custom['tables'][$table]['calculated_contact_id'];

        // Wrap this trigger around an if/then to ensure we only execute if we
        // can calculate the contact_id.
        $pre_sql = " IF $calculated_contact_id IS NOT NULL\nTHEN\n";
        $post_sql = " END IF;";
      }
      else {
        // Choose the default.
        $calculated_contact_id = 'NEW.contact_id';
      }

      $parts[] = "entity_id = $calculated_contact_id";

      $extra_sql = implode(',', $parts);
      $sql = $pre_sql . $generic_sql . $extra_sql . ' ON DUPLICATE KEY UPDATE ' . $extra_sql . ';' . $post_sql;

      // We want to fire this trigger on insert, update and delete.
      $info[] = array(
        'table' => $table,
        'when' => 'AFTER',
        'event' => 'INSERT',
        'sql' => $sql,
       );
      $info[] = array(
        'table' => $table,
        'when' => 'AFTER',
        'event' => 'UPDATE',
        'sql' => $sql,
      );
      // For delete, we reference OLD.field instead of NEW.field
      $sql = str_replace('NEW.', 'OLD.', $sql);
      $info[] = array(
        'table' => $table,
        'when' => 'AFTER',
        'event' => 'DELETE',
        'sql' => $sql,
      );
    }

  }
}

/**
 * Generate a temporary table with just fields from either the contribution
 * or participant triggers. This function is used when populating the initial
 * data after changing fields, etc.
 */
function sumfields_create_temporary_table($trigger_table) {

  // These are the actual field names as created in this instance
  $custom_fields = _sumfields_get_custom_field_parameters();

  // Load the field and group definitions because we need to know
  // which fields are triggered on which tables
  $custom_field_definitions = sumfields_get_custom_field_definitions();
  $definitions = $custom_field_definitions['fields'];

  $create_fields = array();

  // Initialize with a field to hold the entity_id
  $create_fields[] = "`contact_id` INT";
  // Iterate over the actual instantiated summary fields
  foreach ($custom_fields as $field_name => $values) {
    // Avoid error - make sure we have a definition for this field.
    if(array_key_exists($field_name, $definitions)) {
      $field_definition = $definitions[$field_name];
      if($field_definition['trigger_table'] == $trigger_table) {
        $data_type = $field_definition['data_type'];
        if($data_type == 'Money') {
          $data_type = "DECIMAL(20,2)";
        }
        elseif($data_type == 'Date') {
          $data_type = 'datetime';
        }
        elseif($data_type == 'String') {
          $text_length = CRM_Utils_Array::value('text_length', $field_definition, 128);
          $data_type = "varchar($text_length)";
        }
        $create_fields[] = "`$field_name` $data_type";
      }
    }
  }
  return CRM_Utils_SQL_TempTable::build()->createWithColumns(
    implode(',', $create_fields)
  )->getName();
}

/**
 * Generate calculated fields for all contacts.
 * This function is designed to be run once when
 * the extension is installed or initialized.
 *
 * @param CRM_Core_Session $session
 * @return bool
 *   TRUE if successful, FALSE otherwise
 */
function sumfields_generate_data_based_on_current_data($session = NULL) {
  // Get the actual table name for summary fields.
  $table_name = _sumfields_get_custom_table_name();

  // These are the summary field definitions as they have been instantiated
  // on this site (with actual column names, etc.)
  $custom_fields = _sumfields_get_custom_field_parameters();
  if(is_null($session)) {
    $session = CRM_Core_Session::singleton();
  }
  if(empty($table_name)) {
    $msg = E::ts("Your configuration may be corrupted. Please disable and renable this extension.");
    $session::setStatus($msg, E::ts('Error'), 'error');
    \Civi::log()->debug($msg);
    return FALSE;
  }

  // If database logging is on, turn it off during summary fields calculation.
  // disableLoggingForThisConnection() checks the config for logging
  CRM_Logging_Schema::disableLoggingForThisConnection();

  // In theory we shouldn't have to truncate the table, but we
  // are doing it just to be sure it's empty.
  $sql = "TRUNCATE TABLE `$table_name`";
  $dao = CRM_Core_DAO::executeQuery($sql);

  // Load the field and group definitions because we need the trigger
  // clause that is stored here. These are the generically shipped
  // field definitions (via custom.php).
  $custom = sumfields_get_custom_field_definitions();
  $active_fields = sumfields_get_setting('active_fields', array());

  // Variables used for building the temp tables and temp insert statement.
  $temp_sql = array();

  foreach ($custom_fields as $base_column_name => $params) {
    if (!in_array($base_column_name, $active_fields)) {
      continue;
    }
    $table = $custom['fields'][$base_column_name]['trigger_table'];
    if (isset($custom['tables'][$table]['trigger_field'])) {
      $trigger_field = $custom['tables'][$table]['trigger_field'];
    }
    else {
      // Use the default.
      $trigger_field = 'contact_id';
    }

    $trigger = $custom['fields'][$base_column_name]['trigger_sql'];
    // We replace NEW.contact_id with trigger_table.contact_id (or a custom field
    // if the trigger table does not have contact_id) to reflect the difference
    // between the trigger sql statement and the initial sql statement
    // to load the data.
    $trigger = str_replace('NEW.' . $trigger_field, 'trigger_table.' . $trigger_field, $trigger);
    if (FALSE === $trigger = sumfields_sql_rewrite($trigger)) {
      $msg = sprintf(E::ts("Failed to rewrite sql for %s field."), $base_column_name);
      $session->setStatus($msg);
      \Civi::log()->debug($msg);
      continue;
    }
    // Avoid failures if sql_mode is set to ONLY_FULL_GROUP_BY
    // If we wrap the SELECT field in MAX, then we avoid the error.
    // Since the SELECT will only return one value anyway, adding
    // MAX should not change the value.
    $trigger = 'MAX(' . $trigger . ')';
    if (!isset($temp_sql[$table])) {
      $temp_sql[$table] = array(
        'temp_table' => sumfields_create_temporary_table($table),
        'triggers' => array(),
        'map' => array(),
      );
    }
    $temp_sql[$table]['triggers'][$base_column_name] = $trigger;
    $temp_sql[$table]['map'][$base_column_name] = $params['column_name'];
    // If we have not yet set the initialize_join value for this table
    // then set it here.
    if (!isset($temp_sql[$table]['initialize_join'])) {
      // Check custom.php for a custom value. This is only necessary
      // if the trigger table does not have a contact_id field.
      if (isset($custom['tables'][$table]['initialize_join'])) {
        // Overwrite with custom value. Since we have to group by contact_id,
        // this option allow us to add a join table with contact_id in it
        // in case our trigger table does not have a contact_id.
        $temp_sql[$table]['initialize_join'] = $custom['tables'][$table]['initialize_join'];
      }
      else {
        // $temp_sql[$table]['initialize_join'] = "JOIN civicrm_contact AS c ON trigger_table.contact_id = c.id ";
        $temp_sql[$table]['initialize_join'] = NULL;
      }
    }

  }

  if(empty($temp_sql)) {
    // Is this an error? Not sure. But it will be an error if we let this
    // function continue - it will produce a broken sql statement, so we
    // short circuit here.
    $session::setStatus(E::ts("Not regenerating content, no fields defined."), E::ts('Error'), 'error');
    return TRUE;
  }

  foreach ($temp_sql as $table => $data) {
    // Calculate data and insert into temp table
    $query = "INSERT INTO `{$data['temp_table']}` SELECT contact_id, "
      . implode(",\n", $data['triggers'])
      . " FROM `$table` AS trigger_table "
      . $data['initialize_join']
      . ' GROUP BY contact_id';

    CRM_Core_DAO::executeQuery($query);

    // Move temp data into custom field table
    $query = "INSERT INTO `$table_name` "
      . "(entity_id, " . implode(',', $data['map']) . ") "
      . "(SELECT contact_id, " . implode(',', array_keys($data['map'])) . " FROM `{$data['temp_table']}`) "
      . "ON DUPLICATE KEY UPDATE ";
    foreach ($data['map'] as $tmp => $val) {
      $query .= " $val = $tmp,";
    }
    $query = rtrim($query, ',');
    CRM_Core_DAO::executeQuery($query);
  }

  return TRUE;
}

/**
 * Alter CustomField create parameters.
 *
 * Before creating custom fields, we need to add some parameters.
 */
function sumfields_alter_custom_field_create_params(&$params) {
  // Use default date/time formats for Date fields.
  if($params['data_type'] == 'Date') {
    if (version_compare(CRM_Utils_System::version(), '4.7.alpha1','>=' )) {
      $params['date_format'] = Civi::settings()->get('dateInputFormat');
      $params['time_format'] = Civi::settings()->get('timeInputFormat');
    }
    else {
      $params['date_format'] = CRM_Core_Config::singleton()->dateInputFormat;
      $params['time_format'] = CRM_Core_Config::singleton()->timeInputFormat;
    }
    if(empty($params['date_format'])) {
      // If it is not set for some reason, set it to a default value
      // otherwise it won't display.
      $params['date_format'] = 'mm/dd/yy';
    }
  }

  // Don't rebuild triggers or this will take forever.
  $params['triggerRebuild'] = FALSE;

}

/**
 * Create custom fields - should be called on enable.
 **/
function sumfields_create_custom_fields_and_table() {
  // Load the field and group definitions.
  $custom = sumfields_get_custom_field_definitions();

  // Create the custom group first.
  $params = array_pop($custom['groups']);
  $params['version'] = 3;
  $result = civicrm_api('CustomGroup', 'create', $params);
  if($result['is_error'] == 1) {
    // Bail. No point in continuing if we can't get the table built.
    return FALSE;
  }
  // We need the id for creating the fields below.
  $value = array_pop($result['values']);
  $custom_group_id = $value['id'];

  // Save the info so we can delete it when uninstalling.
  $custom_table_parameters = array(
    'id' => $custom_group_id,
    'table_name' => $value['table_name'],
  );
  sumfields_save_setting('custom_table_parameters', $custom_table_parameters);
  $custom_field_parameters = array();

  // Get an array of fields that the user wants to use.
  $active_fields = sumfields_get_setting('active_fields', array());
  // Now create the fields.
  foreach ($custom['fields'] as $name => $field) {
    // Skip fields not selected by the user.
    if(!in_array($name, $active_fields)) {
      continue;
    }

    $params = $field;
    $params['version'] = 3;
    $params['custom_group_id'] = $custom_group_id;

    sumfields_alter_custom_field_create_params($params);

    $result = civicrm_api('CustomField', 'create', $params);
    if($result['is_error'] == 1) {
      CRM_Core_Session::setStatus(print_r($result, TRUE), E::ts("Error creating custom field '%1'", array(1 => $name)), 'error');
      continue;
    }
    $value = array_pop($result['values']);
    $custom_field_parameters[$name] = array(
      'id' => $value['id'],
      'column_name' => $value['column_name']
    );
  }
  sumfields_save_setting('custom_field_parameters', $custom_field_parameters);
  return TRUE;
}

/**
 * Helper function for storing persistant data
 * for this extension.
 **/
function sumfields_save_setting($key, $value) {
 civicrm_api3('Setting', 'create', array($key => $value));
}

/**
 * Helper function for getting persistant data
 * for this extension.
 **/
function sumfields_get_setting($key, $default = NULL) {
  if (version_compare(CRM_Utils_System::version(), '4.7.alpha1', '>=')) {
    $ret = civicrm_api3('Setting', 'getvalue', array('name' => $key));
  }
  else {
    $group = 'Summary Fields';
    $ret = civicrm_api3('Setting', 'getvalue', array('name' => $key, 'group' => $group));
  }
  if(empty($ret)) return $default;
  return $ret;
}
/**
 * Renable the custom field group
 *
 */
function sumfields_reenable_custom_group() {
  // If we are enabled after having been disabled, see if we have an
  // existing custom group that should be re-enabled.
  $custom_table_parameters = _sumfields_get_custom_table_parameters();
  $id = $custom_table_parameters['id'];
  if ($id) {
    $params = array('id' => $id);
    $result = civicrm_api3('CustomGroup', 'getsingle', $params);
    $result['is_active'] = 1;
    civicrm_api3('CustomGroup', 'create', $result);
  }
}
/**
 * Disable the custom field group
 *
 */
function sumfields_disable_custom_group() {
  $custom_table_parameters = _sumfields_get_custom_table_parameters();
  $id = $custom_table_parameters['id'];
  if ($id) {
    $params = array('id' => $id);
    $result = civicrm_api3('CustomGroup', 'getsingle', $params);
    $result['is_active'] = 0;
    civicrm_api3('CustomGroup', 'create', $result);
  }
}

/**
 * Delete custom fields. All data should be
 * generated data, so no worry about deleting
 * anything that should be kept.
 **/
function sumfields_delete_custom_fields_and_table() {
  $session = CRM_Core_Session::singleton();
  $custom_field_parameters = _sumfields_get_custom_field_parameters();

  $active_fields = sumfields_get_setting('active_fields', array());
  foreach ($custom_field_parameters as $key => $field) {
    // Skip fields not active (they should not have been created so
    // should not exist.
    if(!in_array($key, $active_fields)) continue;

    $params = array(
      'id' => $field['id'],
      'version' => 3
    );
    $result = civicrm_api('CustomField', 'delete', $params);
    if($result['is_error'] == 1) {
      $column_name = $field['column_name'];
      $session->setStatus(E::ts("Error deleting '%1'", array(1 => $column_name)));
      $session->setStatus(print_r($result,TRUE));
    }
  }
  $custom_table_parameters = _sumfields_get_custom_table_parameters();
  $id = $custom_table_parameters['id'];
  if ($id) {
    $params = array('version' => 3, 'id' => $id);
    $result = civicrm_api('CustomGroup', 'delete', $params);
    if($result['is_error'] == 1) {
      $table_name = $custom_table_parameters ['table_name'];
      $session->setStatus(E::ts("Error deleting '%1'", array(1 => $table_name)));
    }
  }
}

/**
 * Remove our values from civicrm_setting table
 **/
function sumfields_delete_user_settings() {
  $settings = require_once('settings/sumfields.setting.php');
  $sql = "DELETE FROM civicrm_setting WHERE name = %0";
  foreach ($settings as $key => $setting) {
    // No remove/delete for Setting api entity.
    $params = array(0 => array($key, 'String'));
    CRM_Core_DAO::executeQuery($sql, $params);
  }
}

/**
 * Helper helper to get just the table name out of
 * table parameters
 *
 **/
function _sumfields_get_custom_table_name() {
  $table_info = _sumfields_get_custom_table_parameters();
  if(array_key_exists('table_name', $table_info)) {
    return $table_info['table_name'];
  }
  return NULL;
}

/**
 * Since CiviCRM may give our fields a different name on different
 * sites, we store the actual name and id that was used.
 *
 **/
function _sumfields_get_custom_field_parameters() {
  return sumfields_get_setting('custom_field_parameters', array());
}

/**
 * Since CiviCRM may give our table a different name on different
 * sites, we store the actual name and id that was used.
 *
 **/
function _sumfields_get_custom_table_parameters() {
  $default = array('table_name' => NULL, 'id' => NULL);
  return sumfields_get_setting('custom_table_parameters', $default);
}

/**
 * Return the $custom array with all the custom field
 * definitions.
 **/
function sumfields_get_custom_field_definitions() {
  static $custom = NULL;
  if (is_null($custom)) {
    // The custom.php file defines the $custom array of field
    // definitions. Only require if necessary.
    require 'custom.php';
    // Invoke hook_civicrm_sumfields_definitions
    $null = NULL;
    CRM_Utils_Hook::singleton()->invoke(['custom'], $custom, $null, $null,
      $null, $null, $null,
      'civicrm_sumfields_definitions'
    );
    foreach ($custom['fields'] as $k => $v) {
      // Merge in defaults
      $custom['fields'][$k] += array(
        'html_type' => 'Text',
        'is_required' => '0',
        'is_searchable' => '1',
        'is_search_range' => '1',
        'weight' => '0',
        'is_active' => '1',
        'is_view' => '1',
        'text_length' => '32',
      );
      // Filter out any fields from tables that are not installed.
      if (isset($custom['optgroups'][$v['optgroup']]['component'])) {
        if (!sumfields_component_enabled($custom['optgroups'][$v['optgroup']]['component'])) {
          unset($custom['fields'][$k]);
        }
      }
    }
  }
  return $custom;
}

/**
 * Helper function: get column name for the given field
 * for this installation or FALSE if it's not enabled.
 **/
function sumfields_get_column_name($name) {
  $sql = "SELECT column_name FROM civicrm_custom_field WHERE name = %0 ".
    "OR column_name LIKE %1";
  $params = array(
    0 => array($name, 'String'),
    1 => array("{$name}%", 'String')
  );
  $dao = CRM_Core_DAO::executeQuery($sql, $params);
  if($dao->N == 0) return FALSE;

  $dao->fetch();
  return $dao->column_name;
}
/**
 * Helper script - report if Component is enabled
 **/
function sumfields_component_enabled($component) {
  static $config;
  if(is_null($config)) {
    $config = CRM_Core_Config::singleton();
  }
  return in_array($component, $config->enableComponents);
}

/**

 * Initialize all user settings.
 *
 * The user has the option to choose which fields they want, which contribution
 * types to include, which event types, etc.
 *
 * When initializing (which happens with the extension is enabled), we
 * don't choose any fields. By not choosing any fields, we don't add any
 * SQL triggers, and the extension is enabled relatively quickly.
 *
 * When the user selects the fields they want, they can choose whether to
 * have the change go through immediately (risks timing out) or via the next
 * cron job.
 *
 * To make it more user-friendly, we choose standard options for the other user
 * selected preferences (e.g. which event types should be included, etc.)
 *
 **/
function sumfields_initialize_user_settings() {
  $fields = array();
  sumfields_save_setting('active_fields', $fields);

  // Which financial_type_ids are used to calculate the general contribution
  // summary fields?
  $values = sumfields_get_all_financial_types();
  sumfields_save_setting('financial_type_ids', array_keys($values));

  // Which financial_type_ids are used to calculate the last membership
  // payment fields?
  sumfields_save_setting('membership_financial_type_ids', array_keys($values));

  // Which event type ids are used when calculating event fields?
  $values = sumfields_get_all_event_types();
  sumfields_save_setting('event_type_ids', array_keys($values));

  // Which participant status ids are used to calculate attendended events
  $values = sumfields_get_all_participant_status_types();
  // When initializing, only use the attended.
  $initial_status_types = preg_grep('/Attended/', $values);
  sumfields_save_setting('participant_status_ids', array_keys($initial_status_types));

  // Which participant status ids are used to calculate no shows
  $values = sumfields_get_all_participant_status_types();
  // When initializing, only use 'No-show' if it exists, otherwise nothing
  // (note: no-show was added in 4.4)
  $initial_noshow_status_types = preg_grep('/No-show/', $values);
  sumfields_save_setting('participant_noshow_status_ids', array_keys($initial_noshow_status_types));
}

/**
 * Get all contribution types
 **/
function sumfields_get_all_financial_types() {
  $values = array();
  CRM_Core_PseudoConstant::populate($values, 'CRM_Financial_DAO_FinancialType', $all = TRUE);
  return $values;
}

/**
 * Get all event types
 **/
function sumfields_get_all_event_types() {
  $values = CRM_Core_OptionGroup::values('event_type', FALSE, FALSE, FALSE, NULL, 'label', $onlyActive = FALSE);
  return $values;
}

/**
 * Get all participant status types.
 **/
function sumfields_get_all_participant_status_types() {
  $values = array();
  CRM_Core_PseudoConstant::populate($values, 'CRM_Event_DAO_ParticipantStatusType', $all = TRUE);
  return $values;
}

/**
 * Get all available active fields
 **/
function sumfields_get_all_custom_fields() {
  $custom = sumfields_get_custom_field_definitions();
  return array_keys($custom['fields']);
}

/**
 * Helper function to clean up
 **/
function sumfields_deinitialize_custom_data() {
  sumfields_delete_custom_fields_and_table();
}

/**
 * Find incorrect total lifetime contributions.
 *
 * Diangostic tool for collecting records with an incorrect
 * total lifetime contribution value in the summary field.
 *
 */
function sumfields_find_incorrect_total_lifetime_contribution_records() {
  $ret = array();

  // We're only interested in one field for this test.
  $base_column_name = 'contribution_total_lifetime';

  // We need to ensure this field is enabled on this site.
  $active_fields = sumfields_get_setting('active_fields', array());
  if(!in_array($base_column_name, $active_fields)) {
    drush_log(dt("The total lifetime contribution is not active, this test will not work."), 'error');
    return FALSE;
  }

  // Get the name of the actual summary fields table.
  $table_name = _sumfields_get_custom_table_name();

  // Get the actual names of the field in question
  $custom_fields = _sumfields_get_custom_field_parameters();
  $column_name = $custom_fields[$base_column_name]['column_name'];

  // Load the field and group definitions because we need the trigger
  // clause that is stored here.
  $custom = sumfields_get_custom_field_definitions();

  // Get the base sql
  $config_trigger_sql = $custom['fields'][$base_column_name]['trigger_sql'];

  if(empty($table_name) || empty($column_name) || empty($config_trigger_sql)) {
    // Perhaps we are not properly enabled?
    drush_log(dt("Can't get table name or column name or trigger sql. Something is wrong."), 'error');
    return FALSE;
  }
  if($db_trigger_sql != $config_trigger_sql) {
    drush_log(dt("Mis-match between db_trigger_sql (@db) and config_trigger_sql (@config). Using config.",
      array('@db' => $db_trigger_sql, '@config' => $config_trigger_sql)));
  }

  // Rewrite the sql with the appropriate variables filled in.
  if(FALSE === $trigger_sql = sumfields_sql_rewrite($config_trigger_sql)) {
    $msg = E::ts("Failed to rewrite sql for %1 field.", array(1 => $base_column_name));
    drush_log($msg, 'error');
    return FALSE;
  }
  // Iterate over all contacts with a contribution
  $contact_sql = "SELECT DISTINCT(contact_id) FROM civicrm_contribution WHERE ".
    "is_test = 0";
  $dao = CRM_Core_DAO::executeQuery($contact_sql);

  $trigger_dao = new CRM_Core_DAO();
  while($dao->fetch()) {
    $sql = str_replace("NEW.contact_id", $dao->contact_id, $trigger_sql);
    $trigger_dao->query($sql);
    $trigger_result = $trigger_dao->getDatabaseResult();
    $row = $trigger_result->fetchRow();
    $trigger_total = empty($row[0]) ? '0.00' : $row[0];

    $table_sql = "SELECT `$column_name` AS table_total FROM `$table_name` WHERE entity_id = %0";
    $table_dao = CRM_Core_DAO::executeQuery($table_sql, array(0 => array($dao->contact_id, 'Integer')));
    $table_dao->fetch();
    $table_total = empty($table_dao->table_total) ? '0.00' : $table_dao->table_total;

    if($table_total != $trigger_total) {
      $sql = "SELECT MAX(receive_date) AS last FROM civicrm_contribution WHERE contact_id = %0";
      $last_dao = CRM_Core_DAO::executeQuery($sql, array(0 => array($dao->contact_id, 'Integer')));
      $last_dao->fetch();
      $last_contribution = $last_dao->last;
      $ret[$dao->contact_id] = "Contact id: $dao->contact_id, Summary Table total: " . $table_total . ", Current trigger total: $trigger_total, Last Contribution: $last_contribution";
    }
  }
  return $ret;
}

/**
 * Test for inconsistent summaries
 *
 * Returns 1 if the test is successful, 2 if inconsistencies are found
 * and 3 if there was an error running the test and 4 if the field we
 * are testing is not active.
 *
 * FIXME: how can we convince drush to set error codes properly?
 **/
function sumfields_test_inconsistent_summaries() {
  // We're only interested in one field for this test.
  $base_column_name = 'contribution_total_lifetime';

  // We need to ensure this field is enabled on this site.
  $active_fields = sumfields_get_setting('active_fields', array());
  if(!in_array($base_column_name, $active_fields)) {
    echo "4\n";
    return FALSE;
  }

  if(!$db_trigger_sql = sumfields_get_update_trigger('civicrm_contribution')) {
    // If no triger is defined, there's no way this will work. Bail early. Save CPU
    // cycles.
    echo "2\n";
    return FALSE;
  }

  $ids = sumfields_find_incorrect_total_lifetime_contribution_records();
  if($ids === FALSE) {
    echo "3\n";
    return FALSE;
  }
  if(count($ids) == 0) {
    echo "1\n";
    return TRUE;
  }
  echo "2\n";
  return TRUE;
}

/**
 * Print incorrect total lifetime contributions.
 *
 * Diangostic tool for testing to see whether there are any records with an
 * incorrect total lifetime contribution value in the summary field. It appears
 * as though the trigger does not always get set. This tools helps identify which
 * records are affected. It can be run via * drush's php-eval sub-command, e.g.
 *
 * drush php-eval "_civicrm_init(); sumfields_print_inconsistent_summaries()"
 *
 *
 */
function sumfields_print_inconsistent_summaries() {
  // We're only interested in one field for this test.
  $base_column_name = 'contribution_total_lifetime';

  // We need to ensure this field is enabled on this site.
  $active_fields = sumfields_get_setting('active_fields', array());
  if(!in_array($base_column_name, $active_fields)) {
    drush_log(dt("The total lifetime contribution is not active, this test will not work."), 'error');
    return FALSE;
  }

  if(!$db_trigger_sql = sumfields_get_update_trigger('civicrm_contribution')) {
    // If no triger is defined, there's no way this will work. Bail early. Save CPU
    // cycles.
    drush_log("Contribution table trigger not defined. This won't work.", 'error');
    return FALSE;
  }

  $ids = sumfields_find_incorrect_total_lifetime_contribution_records();
  if($ids === FALSE) {
    drush_log("Failed to test for inconsistent data. Something went wrong.", 'error');
    return FALSE;
  }
  foreach ($ids as $id => $data) {
    drush_log($data, 'ok');
  }
}

/**
 * Get the update trigger statement as configured in the database.
 *
 **/
function sumfields_get_update_trigger($table = 'civicrm_contribution') {
  $config = CRM_Core_Config::singleton();
  $dsn = DB::connect($config->dsn);
  $dbName = $dsn->_db;
  $sql = "SELECT ACTION_STATEMENT FROM information_schema.TRIGGERS WHERE
    TRIGGER_NAME = '{$table}_after_update' AND TRIGGER_SCHEMA = '$dbName'";

  $dao = CRM_Core_DAO::executeQuery($sql);
  $dao->fetch();

  if($dao->N == 0) return FALSE;
  return $dao->ACTION_STATEMENT;
}

/**
 * Fix incorrect contributions summary fields.
 *
 * Find all summary fields with incorrect amounts and fix them. You may need to
 * add this as a cron job if you find that you are regularly getting
 * inconsistent summaries.
 *
 */
function sumfields_fix_inconsistent_summaries() {
  // This means there is no update triggered defined.
  if(!$db_trigger_sql = sumfields_get_update_trigger('civicrm_contribution')) {
    $msg = dt("Update trigger is not defined. This might explain inconsistent responses. ".
      "Rebuilding triggers, this may take a while.");
    drush_log($msg, 'error');
    CRM_Core_DAO::triggerRebuild();
    if(!sumfields_get_update_trigger('civicrm_contribution')) {
      $msg = dt("Still can't find trigger after rebuilding. Bailing...");
      drush_log($msg, 'error');
      return FALSE;
    }
  }
  $ids = sumfields_find_incorrect_total_lifetime_contribution_records();
  if($ids && count($ids) > 0) {
    // Just re-initiate everything - who knows what might have gone wrong.
    drush_log(dt("Data is wrong. Re-running trigger creation."), 'error');
    CRM_Core_DAO::triggerRebuild();
    drush_log(dt("Repopulating all data."), 'error');
    sumfields_generate_data_based_on_current_data($session = NULL);
    return TRUE;
  }
}

/**
 * Updates the custom table, ensuring all required fields are present
 * and no longer needed fields are removed
 *
 * @old_fields: the currently active fields
 * @new_fields: the desired fields
 *
 **/
function sumfields_alter_table() {
  $old_fields = sumfields_get_setting('active_fields', array());
  $new_fields = sumfields_get_setting('new_active_fields', NULL);

  if(is_null($new_fields)) {
    // This is an error - we should never be called without new fields
    // available;
    \Civi::log()->debug("The new_active_fields settings is NULL, cannot run sumfields_alter_table method.");
    return FALSE;
  }

  $session = CRM_Core_Session::singleton();
  $custom_field_parameters = sumfields_get_setting('custom_field_parameters', NULL);

  // Set default return - optimistically.
  $ret = TRUE;
  // Delete fields no longer needed
  foreach ($old_fields as $field) {
    if(!in_array($field, $new_fields)) {
      $params['id'] = $custom_field_parameters[$field]['id'];
      // First see if it exists. If it doesn't exist, don't bother (this is to help
      // with error/recovery problems)
      try {
        $result = civicrm_api3('CustomField', 'get', $params);
        if($result['count'] > 0) {
          civicrm_api3('CustomField', 'delete', $params);
        }
      }
      catch (CiviCRM_API3_Exception $e) {
        $msg = E::ts("Error deleting custom field '%1': %2", array(1 => $field, 2 => $e->getMessage()));
        $session->setStatus($msg);
        \Civi::log()->debug($msg);
        // This will result in a error, but let's continue anyway to see if we can get the rest of the fields
        // in working order.
        $ret = FALSE;
        continue;
      }
      // $session->setStatus(E::ts("Deleted custom field '%1'", array(1 => $field)));
      unset($custom_field_parameters[$field]);
    }
  }

  // Add new fields
  $custom_table_parameters = sumfields_get_setting('custom_table_parameters', NULL);
  if(is_null($custom_table_parameters)) {
    $msg = E::ts("Failed to get the custom group parameters. Can't add new fields.");
    $session->setStatus($msg);
    \Civi::log()->debug($msg);
    return FALSE;
  }
  $custom = sumfields_get_custom_field_definitions();
  $group_id = $custom_table_parameters['id'];
  foreach ($new_fields as $field) {
    if(!in_array($field, $old_fields)) {
      $params = $custom['fields'][$field];
      $params['custom_group_id'] = $group_id;
      try {
        $result = civicrm_api3('CustomField', 'get', $params);
        // Skip without error if it already exists.
        if($result['count'] == 0) {
          sumfields_alter_custom_field_create_params($params);
          $result = civicrm_api3('CustomField', 'create', $params);
        }
      }
      catch (CiviCRM_API3_Exception $e) {
        $msg = E::ts("Error adding custom field '%1': %2", array(1 => $field, 2 => $e->getMessage()));
        $session->setStatus($msg);
        \Civi::log()->debug($msg);
        $ret = FALSE;
        continue;
      }
      // $session->setStatus(E::ts("Added custom field '%1'", array(1 => $field)));
      $value = array_pop($result['values']);
      $custom_field_parameters[$field] = array(
        'id' => $value['id'],
        'column_name' => $value['column_name']
      );
    }
  }
  sumfields_save_setting('custom_field_parameters', $custom_field_parameters);
  if($ret == TRUE) {
    // This was successfully, make the new fields that active fields
    sumfields_save_setting('active_fields', $new_fields);
    sumfields_save_setting('new_active_fields', NULL);
  }
  return $ret;
}

/**
 * Helper/debug function: output all triggers with replacements.
 *
 **/
function sumfields_print_triggers() {
  // Get list of custom fields and triggers
  $custom = sumfields_get_custom_field_definitions();
  foreach ($custom['fields'] as $k => $v) {
    $out = sumfields_sql_rewrite($v['trigger_sql']);
    if(FALSE === $out) {
      $out = "Failed sql_write.";
    }
    drush_print("Field: $k");
    drush_print($out);
  }
}

/**
 * Used for generating the schema and data
 *
 * Should be called whenever the extension has the chosen
 * fields saved or via Cron job.
 *
 * Called by the API gendata.
 *
 * @return boolean
 *   TRUE if there was an error
 */
function sumfields_gen_data(&$returnValues) {
  // generate_schema_and_data variable can be set to any of the following:
  //
  // NULL It has never been run, no need to run
  // scheduled:YYYY-MM-DD HH:MM:SS -> it should be run
  // running:YYYY-MM-DD HH:MM:SS -> it is currently running, and started at the given date/time
  // success:YYYY-MM-DD HH:MM:SS -> It completed successfully on the last run at the given date/time
  // failed:YYYY-MM-DD HH:MM:SS -> It failed on the last run at the given date/time
  //

  // We will run if we are scheduled to run OR if the fiscal year has turned
  // and we haven't yet run this fiscal year
  $status = $new_status = sumfields_get_setting('generate_schema_and_data', FALSE);
  $date = date('Y-m-d H:i:s');
  $exception = FALSE;

  $status_name = NULL;
  $status_date = NULL;
  if(preg_match('/^([a-z]+):([0-9 -:]+)$/', $status, $matches)) {
    $status_name = $matches[1];
    $status_date = $matches[2];
    // Check if the fiscal year has turned over since we last ran.
    // (also, only attempt to do a new fiscal year run if the last run
    // was successful to avoid loops of failed runs).
    if($status_name == 'success') {
      $fiscal_dates = sumfields_get_fiscal_dates();
      $ts_fiscal_year_begin = strtotime($fiscal_dates['%current_fiscal_year_begin']);
      $ts_last_run = strtotime($status_date);
      if($ts_fiscal_year_begin > $ts_last_run) {
        // We need to re-generate totals because the fiscal year has changed.
        $status_name = 'scheduled';
      }
    }
  }
  if ($status_name == 'scheduled') {

    $new_status = 'running:' . $date;
    sumfields_save_setting('generate_schema_and_data', $new_status);

    // Check to see if the new_active_fields setting is set. This means we have to alter the fields
    // from the current setting.
    $new_active_fields = sumfields_get_setting('new_active_fields', NULL);
    // Get process type
    $data_update_method = sumfields_get_setting('data_update_method','via_triggers');
    if(!is_null($new_active_fields)) {
      if(!sumfields_alter_table()) {
        // If we fail to properly alter the table, bail and record that we had an error.
        $date = date('Y-m-d H:i:s');
        $new_status = 'failed:' . $date;
        $exception = TRUE;
        \Civi::log()->debug("The sumfields_alter_table method returned false while running sumfields_gen_data.");
      }
      else {
        // Set new active fields to NULL to indicate that they no longer
        // need to be updated
        sumfields_save_setting('new_active_fields', NULL);
      }
    }
    if(!$exception) {
      if(sumfields_generate_data_based_on_current_data()) {
        CRM_Core_DAO::triggerRebuild();
        $date = date('Y-m-d H:i:s');
        if ($data_update_method == 'via_cron') {
          // If we have big data, then after a successful task, re-set the status to scheduled
          $new_status = 'scheduled:' . $date;
        } else {
          $new_status = 'success:' . $date;
        }
      }
      else {
        $date = date('Y-m-d H:i:s');
        $new_status = 'fail:' . $date;
        $exception = TRUE;
        \Civi::log()->debug("Failed to run sumfields_generate_data_based_on_current_data when executing sumfields_gen_data.");
      }
    }
  }
  $returnValues = array("Original Status: $status, New Status: $new_status");
  sumfields_save_setting('generate_schema_and_data', $new_status);
  if($exception) {
    return FALSE;
  }
  return TRUE;
}

/**
 * Help function: if we are multi-lingual, rewrite the
 * given query.
 **/
function sumfields_multilingual_rewrite($query) {
  global $dbLocale;
  if($dbLocale) {
    return CRM_Core_I18n_Schema::rewriteQuery($query);
  }
  return $query;
}

/**
 * Implementation of hook_civicrm_batch.
 *
 * Don't create a conflict over summary fields. When batch merging you
 * will always have conflicts if each record has a different number of
 * contributions. We should not hold up the merge because these summaries
 * are different.
 */
function sumfields_civicrm_merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
  if($type == 'batch') {
    $custom_field_parameters = _sumfields_get_custom_field_parameters();
    $active_fields = sumfields_get_setting('active_fields', array());
    foreach ($custom_field_parameters as $key => $field) {
      // Skip fields not active (they should not have been created so
      // should not exist.
      if(!in_array($key, $active_fields)) continue;
      $check_key = 'move_custom_' . $field['id'];
      // Unset summary fields
      if(array_key_exists($check_key, $data['fields_in_conflict'])) {
        unset($data['fields_in_conflict'][$check_key]);
      }
    }
  }
}

/**
 * Implements hook_alterLogTables().
 *
 * @param array $logTableSpec
 */
function sumfields_civicrm_alterLogTables(&$logTableSpec) {
  $excludeLogging = sumfields_get_setting('exclude_from_logging', 0);
  if (!$excludeLogging) {
    return;
  }
  $tableName = _sumfields_get_custom_table_name();
  if (isset($logTableSpec[$tableName])) {
    unset($logTableSpec[$tableName]);
  }
}