remoteidsync.php

<?php

require_once 'remoteidsync.civix.php';
use CRM_Remoteidsync_ExtensionUtil as E;
use GuzzleHttp\Client;

/**
 * Implements hook_civicrm_summary().
 */
function remoteidsync_civicrm_summary($contactID, &$content, &$contentPlacement) {
  $remoteID = NULL;
  $customFieldInThisDB = CRM_Remoteidsync_Form_Settings::getCustomFieldForThisDB();
  $contentPlacement = CRM_Utils_Hook::SUMMARY_ABOVE;
  $settings = CRM_Remoteidsync_Form_Settings::getSettings([]);
  if (!empty($customFieldInThisDB['custom_field_id']) && !empty($settings['remoteidsync_baseurl'])) {
    $customField = 'custom_' . $customFieldInThisDB['custom_field_id'];
    try {
      $remoteIDCall = civicrm_api3('Contact', 'getsingle', array(
        'id' => $contactID,
        'return' => $customField,
        'sequential' => 1,
      ));
    }
    catch (CiviCRM_API3_Exception $e) {
      $error = $e->getMessage();
      CRM_Core_Error::debug_log_message(ts('API Error %1', array(
        'domain' => 'com.aghstrategies.remoteidsync',
        1 => $error,
      )));
    }
    if (!empty($remoteIDCall[$customField])) {
      $remoteID = $remoteIDCall[$customField];
      $content = "<div class='remoteid crm-summary-row'>
      <a class='button round' href='{$settings['remoteidsync_baseurl']}{$remoteID}'>Visit Linked Contact (id: $remoteID)</a>
    </div>";
    }
  }
}

/**
 * Rest API Call using guzzle
 *
 * @param string $url
 *
 * @return
 */
function remoteidsync_apicall($url, $method = 'POST') {
  $result = 'nothing happened yet';
  try {
    $guzzleClient = new GuzzleHttp\Client();
    $guzzleResponse = $guzzleClient->request($method, $url, array(
      'timeout' => 0.0,
    ));
    $result = 'Guzzle call went thru';
    if ($method == 'GET') {
      $result = json_decode($guzzleResponse->getBody()->getContents());
    }
  }
  catch (Exception $e) {
    $result = 'Something Went Wrong with guzzle';
    // At this stage we are not checking for variants of not being able to receive it.
    // However, we might later enhance this to distinguish forbidden from a 500 error.
  }
  return $result;
}

/**
 * Implements hook_civicrm_pageRun().
 */
function remoteidsync_civicrm_pageRun(&$page) {
  $customFieldInfo = CRM_Remoteidsync_Form_Settings::getCustomFieldForThisDB();
  $settings = CRM_Remoteidsync_Form_Settings::getSettings([]);
  if (!empty($settings['remoteidsync_baseurl'])) {
    $customFieldInfo['base_url'] = $settings['remoteidsync_baseurl'];
    CRM_Core_Resources::singleton()->addVars('remoteidsync', array('info' => $customFieldInfo));
    CRM_Core_Resources::singleton()->addScriptFile('com.aghstrategies.remoteidsync', 'js/link.js');
  }
}

/**
 * Implements hook_civicrm_buildForm().
 */
function remoteidsync_civicrm_buildForm($formName, &$form) {
  // Strip out white space
  if ($formName == 'CRM_Contact_Form_Contact' || $formName == 'CRM_Contact_Form_Inline_CustomData') {
    $customFieldInfo = CRM_Remoteidsync_Form_Settings::getCustomFieldForThisDB();
    $settings = CRM_Remoteidsync_Form_Settings::getSettings([]);
    $customFieldInfo['base_url'] = $settings['remoteidsync_baseurl'];
    CRM_Core_Resources::singleton()->addVars('remoteidsync', array('info' => $customFieldInfo));
    CRM_Core_Resources::singleton()->addScriptFile('com.aghstrategies.remoteidsync', 'js/stripWhiteSpace.js');
  }
}

/**
 * Implements hook_civicrm_custom().
 */
function remoteidsync_civicrm_custom($op, $groupID, $entityID, $params) {
  if ($op == 'create' || $op == 'edit') {
    $customFieldInThisDB = CRM_Remoteidsync_Form_Settings::getCustomFieldForThisDB();
    $settings = CRM_Remoteidsync_Form_Settings::getSettings([]);
    // $contactIdInThisDB = $entityID;
    if (!empty($settings['remoteidsync_customfield'])
    && !empty($entityID)
    && !empty($customFieldInThisDB['custom_group_id'])
    && !empty($customFieldInThisDB['custom_field_id'])
    && $groupID == $customFieldInThisDB['custom_group_id']) {
      foreach ($params as $key => $values) {
        // If we are looking at the right custom field
        if ($values['custom_field_id'] == $customFieldInThisDB['custom_field_id']) {
          // If the field has a value
          if (!empty($values['value'])) {
            $contactIdInOtherDB = $values['value'];
            $checkIfWeNeedToUpdate = remoteidsync_checkForContactInOtherDB($settings, $entityID);
            // More than one id found throw an error
            if ($checkIfWeNeedToUpdate->count > 1) {
              CRM_Core_Session::setStatus(ts('Remote ID NOT synced, multiple links found'), ts('Remote ID'), 'error');
            }
            // 1 match found and its up to date do nothing
            elseif ($checkIfWeNeedToUpdate->count == 1 && !empty($contactInOtherDB->id) && $checkIfWeNeedToUpdate->id == $contactIdInOtherDB) {
              exit;
            }
            // the remote id has been changed need to update accordingly
            elseif ($checkIfWeNeedToUpdate->count == 1 && !empty($checkIfWeNeedToUpdate->id) && $checkIfWeNeedToUpdate->id != $contactIdInOtherDB) {
              // first delete the other remote id
              remoteidsync_deleteOutOfDateReference($settings, $checkIfWeNeedToUpdate->id);

              // then create new one
              remoteidsync_createnewlink('updated', $settings, $contactIdInOtherDB, $entityID);
            }
            // no match found need to create
            elseif ($checkIfWeNeedToUpdate->count == 0) {
              remoteidsync_createnewlink('created', $settings, $contactIdInOtherDB, $entityID);
            }
          }
          // Remote ID has been deleted, delete it on the other side
          elseif (empty($values['value'])) {
            $contactInOtherDB = remoteidsync_checkForContactInOtherDB($settings, $entityID);
            if ($contactInOtherDB->count == 1 && !empty($contactInOtherDB->id)) {
              remoteidsync_deleteOutOfDateReference($settings, $contactInOtherDB->id);
              $contactInOtherDB2 = remoteidsync_checkForContactInOtherDB($settings, $entityID);
              if ($contactInOtherDB2->count == 0) {
                CRM_Core_Session::setStatus(ts('the Remote ID was deleted for this contact. The remote database has been updated to reflect that these contacts are no longer synced.'), ts('Remote ID'), 'success');
              }
            }
          }
        }
      }
    }
  }
}

/**
 * Create a link
 * @param  string $operation         creating or updating
 * @param  array $settings           apiURL, api key and site key
 * @param  int $contactIdInOtherDB   contact id in the other database
 * @param  int $contactIdInThisDB    contact id in this database
 */
function remoteidsync_createnewlink($operation, $settings, $contactIdInOtherDB, $contactIdInThisDB) {
  $apiCall = "{$settings['remoteidsync_apiendpoint']}?entity=Contact&action=create&api_key={$settings['remoteidsync_apikey']}&key={$settings['remoteidsync_sitekey']}&json=1&id={$contactIdInOtherDB}&custom_{$settings['remoteidsync_customfield']}={$contactIdInThisDB}";
  $result = remoteidsync_apicall($apiCall, 'POST');
  $check = remoteidsync_checkForContactInOtherDB($settings, $contactIdInThisDB);
  // check that the sync worked and show success or error message
 // if ($check->count >= 1) {
  //  CRM_Core_Session::setStatus(ts("Remote ID link $operation"), ts('Remote ID'), 'success');
 // }
 // else {
  //  CRM_Core_Session::setStatus(ts("Remote ID link not $operation"), ts('Remote ID'), 'error');
 // }
}

/**
 * Delete link
 * @param  array $settings           apiURL, api key and site key
 * @param  int $contactInOtherDB   contact id of the contact in the other database that needs to be updated
 */
function remoteidsync_deleteOutOfDateReference($settings, $contactInOtherDB) {
  $apiCall = "{$settings['remoteidsync_apiendpoint']}?entity=Contact&action=create&api_key={$settings['remoteidsync_apikey']}&key={$settings['remoteidsync_sitekey']}&json=1&id={$contactInOtherDB}&custom_{$settings['remoteidsync_customfield']}=";
  $result = remoteidsync_apicall($apiCall, 'POST');
}

/**
 * Check if there is a contact in the other database that is linked to this one
 * @param  array $settings            apiURL, api key and site key
 * @param  boolean $contactIdInThisDB contact record in this db being edited
 * @return obj                        response from other site
 */
function remoteidsync_checkForContactInOtherDB($settings, $contactIdInThisDB) {
  $apiCall = "{$settings['remoteidsync_apiendpoint']}?entity=Contact&action=get&api_key={$settings['remoteidsync_apikey']}&key={$settings['remoteidsync_sitekey']}&json=1&custom_{$settings['remoteidsync_customfield']}={$contactIdInThisDB}";
  $result = remoteidsync_apicall($apiCall, 'GET');
  return $result;
}

/**
 * Implements hook_civicrm_config().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
 */
function remoteidsync_civicrm_config(&$config) {
  _remoteidsync_civix_civicrm_config($config);
}

/**
 * Implements hook_civicrm_install().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
 */
function remoteidsync_civicrm_install() {
  $groupID = NULL;
  // Check if custom field group exsists
  try {
    $groupCheck = civicrm_api3('CustomGroup', 'getsingle', [
      'name' => 'Remote_ID',
    ]);
  }
  catch (CiviCRM_API3_Exception $e) {
    $error = $e->getMessage();
    CRM_Core_Error::debug_log_message(ts('API Error %1', array(
      'domain' => 'com.aghstrategies.remoteidsync',
      1 => $error,
    )));
  }
  // If found save
  if (!empty($groupCheck['id'])) {
    $groupID = $groupCheck['id'];
  }
  // If no existing custom field group create one
  else {
    try {
      $group = civicrm_api3('CustomGroup', 'create', [
        'title' => "Remote ID",
        'name' => 'Remote_ID',
        'extends' => "Contact",
      ]);
    }
    catch (CiviCRM_API3_Exception $e) {
      $error = $e->getMessage();
      CRM_Core_Error::debug_log_message(ts('API Error %1', array(
        'domain' => 'com.aghstrategies.remoteidsync',
        1 => $error,
      )));
    }
    if (!empty($group['id'])) {
      $groupID = $group['id'];
    }
  }
  // Now we should have a group id lets check for a field
  if ($groupID) {
    try {
      $fieldCheck = civicrm_api3('CustomField', 'getsingle', [
        'custom_group_id' => $groupID,
        // 'label' => "Remote ID",
        'name' => "Remote_Id",
        // "data_type" => "Int",
        // "html_type" => "Text",
        // "is_active" => "1",
        // "is_view" => "0",
        // "text_length" => "255",
      ]);
    }
    catch (CiviCRM_API3_Exception $e) {
      $error = $e->getMessage();
      CRM_Core_Error::debug_log_message(ts('API Error %1', array(
        'domain' => 'com.aghstrategies.remoteidsync',
        1 => $error,
      )));
    }
    if (empty($fieldCheck['id'])) {
      try {
        $fieldCheck = civicrm_api3('CustomField', 'create', [
          'custom_group_id' => $groupID,
          'label' => "Remote ID",
          'name' => "Remote_Id",
          "data_type" => "Int",
          "html_type" => "Text",
          "is_active" => "1",
          "is_view" => "0",
          "text_length" => "255",
        ]);
      }
      catch (CiviCRM_API3_Exception $e) {
        $error = $e->getMessage();
        CRM_Core_Error::debug_log_message(ts('API Error %1', array(
          'domain' => 'com.aghstrategies.remoteidsync',
          1 => $error,
        )));
      }
    }
  }

  _remoteidsync_civix_civicrm_install();
}

/**
 * Implements hook_civicrm_postInstall().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
 */
function remoteidsync_civicrm_postInstall() {
  _remoteidsync_civix_civicrm_postInstall();
}

/**
 * Implements hook_civicrm_uninstall().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
 */
function remoteidsync_civicrm_uninstall() {
  _remoteidsync_civix_civicrm_uninstall();
}

/**
 * Implements hook_civicrm_enable().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
 */
function remoteidsync_civicrm_enable() {
  _remoteidsync_civix_civicrm_enable();
}

/**
 * Implements hook_civicrm_disable().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
 */
function remoteidsync_civicrm_disable() {
  _remoteidsync_civix_civicrm_disable();
}

/**
 * Implements hook_civicrm_upgrade().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
 */
function remoteidsync_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
  return _remoteidsync_civix_civicrm_upgrade($op, $queue);
}

/**
 * Implements hook_civicrm_entityTypes().
 *
 * Declare entity types provided by this module.
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_entityTypes
 */
function remoteidsync_civicrm_entityTypes(&$entityTypes) {
  _remoteidsync_civix_civicrm_entityTypes($entityTypes);
}

// --- Functions below this ship commented out. Uncomment as required. ---

/**
 * Implements hook_civicrm_preProcess().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_preProcess
 *

 // */

/**
 * Implements hook_civicrm_navigationMenu().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu
 *
function remoteidsync_civicrm_navigationMenu(&$menu) {
  _remoteidsync_civix_insert_navigation_menu($menu, 'Mailings', array(
    'label' => E::ts('New subliminal message'),
    'name' => 'mailing_subliminal_message',
    'url' => 'civicrm/mailing/subliminal',
    'permission' => 'access CiviMail',
    'operator' => 'OR',
    'separator' => 0,
  ));
  _remoteidsync_civix_navigationMenu($menu);
} // */