webform_civicrm.module

<?php

/**
 * @file
 * Webform CiviCRM Integration Module:
 * Links webform submissions to contacts in a CiviCRM database.
 * @author Coleman Watts
 */

/**
 * The versions of CiviCRM and WebForm. Min is >=.  Max is <. FALSE = no MAX
 */
define('WEBFORM_CIVICRM_CIVICRM_VERSION_MIN', '4.4');
define('WEBFORM_CIVICRM_CIVICRM_VERSION_MAX', FALSE);

define('WEBFORM_CIVICRM_WEBFORM_VERSION', '4.12');

/**
 * Implements hook_menu().
 *
 * @return array
 */
function webform_civicrm_menu() {
  $items = array();
  $items['node/%webform_menu/civicrm'] = array(
    'title' => 'CiviCRM',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('wf_crm_configure_form', 1),
    'access callback' => 'wf_crm_admin_access',
    'access arguments' => array(1),
    'file' => 'includes/wf_crm_admin_form.inc',
    'weight' => 3,
    'type' => MENU_LOCAL_TASK,
  );
  $items['webform-civicrm/js/%'] = array(
    'page callback' => 'wf_crm_ajax',
    'file' => 'includes/wf_crm_webform_ajax.inc',
    'access callback' => TRUE,
    'page arguments' => array(2),
    'type' => MENU_CALLBACK,
  );
  $items['webform-civicrm/help/%'] = array(
    'page callback' => 'wf_crm_admin_help',
    'file' => 'includes/wf_crm_admin_help.inc',
    'access arguments' => array('access CiviCRM'),
    'page arguments' => array(2),
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Access callback to determine if user can see the CiviCRM tab of a webform.
 *
 * @param object $node
 * @return bool
 */
function wf_crm_admin_access($node) {
  return (node_access('update', $node) && user_access('access CiviCRM'));
}

/**
 * Implements hook_form_alter().
 */
function webform_civicrm_form_alter(&$form, &$form_state, $form_id) {
  // Alter back-end webform component edit forms
  if ($form_id == 'webform_component_edit_form') {
    if (substr($form['form_key']['#default_value'], 0, 7) == 'civicrm') {
      form_load_include($form_state, 'inc', 'webform_civicrm', 'includes/wf_crm_admin_component');
      $admin_form = new wf_crm_admin_component($form, $form_state);
      $admin_form->alterForm();
    }
    if ($form['type']['#value'] == 'pagebreak') {
      form_load_include($form_state, 'inc', 'webform_civicrm', 'includes/wf_crm_admin_component');
      $admin_form = new wf_crm_admin_component($form, $form_state);
      $admin_form->adjustPageBreak();
    }
  }

  // Alter front-end of webforms
  elseif (strpos($form_id, 'webform_client_form_') !== FALSE
    && !empty($form['#node']->webform_civicrm)) {
    form_load_include($form_state, 'inc', 'webform_civicrm', 'includes/wf_crm_webform_preprocess');
    $processor = new wf_crm_webform_preprocess($form, $form_state);
    $processor->alterForm();
  }

  // Validation for webform components tab
  elseif ($form_id == 'webform_components_form') {
    form_load_include($form_state, 'inc', 'webform_civicrm', 'includes/wf_crm_admin_component');
    $form['#validate'][] = 'wf_crm_components_form_validate';
    if (empty($form_state['input'])) {
      wf_crm_admin_component::checkBillingPagination($form['#node']);
    }
  }
}

/**
 * Implements hook_node_load().
 *
 * @param array $nodes
 */
function webform_civicrm_node_load($nodes, $types) {
  $db = db_query('SELECT * FROM {webform_civicrm_forms} WHERE nid IN(:nids)', array(':nids' => array_keys($nodes)));
  foreach ($db as $settings) {
    $node = &$nodes[$settings->nid];
    $settings->data = unserialize($settings->data);
    $node->webform_civicrm = (array) $settings;
    // Allow a component widget to be changed
    if (!empty($_GET['type']) && arg(0) == 'node' && arg(1) == $node->nid && arg(3) == 'components') {
      if (!empty($node->webform['components'][arg(4)]) && array_key_exists($_GET['type'], webform_components())) {
        $node->webform['components'][arg(4)]['type'] = $_GET['type'];
        webform_component_defaults($node->webform['components'][arg(4)]);
        if ($_GET['type'] == 'select') {
          module_load_include('inc', 'webform_civicrm', 'includes/utils');
          civicrm_initialize();
          $node->webform['components'][arg(4)]['extra']['items'] = wf_crm_array2str(wf_crm_field_options($node->webform['components'][arg(4)], 'component_insert', $node->webform_civicrm['data']));
        }
      }
    }
  }
}

/**
 * Implements hook_node_insert().
 * Preserve webform_civicrm data when cloning or importing a node
 *
 * @param object $node
 */
function webform_civicrm_node_insert($node) {
  if (isset($node->webform_civicrm)) {
    $node->webform_civicrm['nid'] = $node->nid;
    drupal_write_record('webform_civicrm_forms', $node->webform_civicrm);
  }
}

/**
 * Implements hook_node_delete().
 *
 * @param object $node
 */
function webform_civicrm_node_delete($node) {
  if (!empty($node->webform)) {
    db_delete('webform_civicrm_forms')
      ->condition('nid', $node->nid)
      ->execute();
    // Submissions have already been deleted from webform_submissions table
    // So we'll do the opposite of a join to find them
    db_delete('webform_civicrm_submissions')
      ->where('sid NOT IN (SELECT sid FROM {webform_submissions})')
      ->execute();
  }
}

/**
 * Implements hook_theme().
 *
 * @return array
 */
function webform_civicrm_theme() {
  $theme = array(
    'webform_civicrm_options_table' => array(
      'render element' => 'element',
      'file' => 'includes/wf_crm_admin_form.inc',
    ),
    'display_civicrm_contact' => array(
      'render element' => 'element',
      'file' => 'includes/contact_component.inc',
    ),
    'static_contact_element' => array(
      'render element' => 'element',
      'file' => 'includes/contact_component.inc',
    ),
  );
  return $theme;
}

/**
 * Implements hook_webform_component_info().
 *
 * @return array
 */
function webform_civicrm_webform_component_info() {
  return array(
    'civicrm_contact' => array(
      'label' => t('CiviCRM Contact'),
      'description' => t('Choose existing contact.'),
      'features' => array(
        'email_name' => TRUE,
      ),
      'file' => 'includes/contact_component.inc',
    ),
  );
}

/**
 * Implements hook_webform_submission_presave().
 * Uses cached instance of wf_crm_webform_postprocess that was created during validation.
 */
function webform_civicrm_webform_submission_presave($node, &$submission) {
  if (!empty($node->webform_civicrm)) {
    module_load_include('inc', 'webform_civicrm', 'includes/wf_crm_webform_postprocess');
    $processor = wf_crm_webform_postprocess::singleton($node);
    $processor->preSave($submission);
  }
}

/**
 * Implements hook_webform_submission_insert().
 * Uses cached instance of wf_crm_webform_postprocess that was created during validation.
 */
function webform_civicrm_webform_submission_insert($node, $submission) {
  if (!empty($node->webform_civicrm)) {
    $processor = wf_crm_webform_postprocess::singleton($node);
    $processor->postSave($submission);
  }
}

/**
 * Implements hook_webform_submission_update().
 * Uses cached instance of wf_crm_webform_postprocess that was created during validation.
 */
function webform_civicrm_webform_submission_update($node, $submission) {
  if (!empty($node->webform_civicrm)) {
    $processor = wf_crm_webform_postprocess::singleton($node);
    $processor->postSave($submission);
  }
}

/**
 * Implements hook_webform_submission_delete().
 */
function webform_civicrm_webform_submission_delete($node, $submission) {
  db_delete('webform_civicrm_submissions')
    ->condition('sid', $submission->sid)
    ->execute();
}

/**
 * Implements hook_webform_submission_load().
 * Add CiviCRM contact info to submission objects.
 */
function webform_civicrm_webform_submission_load(&$submissions) {
  if (empty($submissions)) {
    return;
  }
  $db = db_query('SELECT * FROM {webform_civicrm_submissions} WHERE sid IN (' . implode(',', array_keys($submissions)) . ')');
  $contacts = array();
  foreach ($db as $row) {
    $data = unserialize($row->civicrm_data) + array('contact' => array());
    if ($row->contact_id) {
      foreach (explode('-', trim($row->contact_id, '-')) as $c => $cid) {
        $data['contact'][$c + 1]['id'] = $cid;
        $data['contact'][$c + 1]['display_name'] = '';
        if ($c == 0 && $cid) {
          $contacts[$cid] = '';
        }
      }
    }
    $submissions[$row->sid]->civicrm = $data;
  }
  if ($contacts) {
    // Retrieve contact names and add to submission objects
    civicrm_initialize();
    $sql = 'SELECT id, display_name FROM civicrm_contact WHERE id IN (' . implode(',', array_keys($contacts)) . ')';

    $dao = CRM_Core_DAO::executeQuery($sql);
    while ($dao->fetch()) {
      $contacts[$dao->id] = $dao->display_name;
    }
    foreach ($submissions as &$s) {
      if (!empty($s->civicrm['contact'][1]['id'])) {
        $s->civicrm['contact'][1]['display_name'] = $contacts[$s->civicrm['contact'][1]['id']];
      }
    }
  }
}

/**
 * Implements hook_webform_submission_render_alter().
 * Add display name to title while viewing a submission.
 */
function webform_civicrm_webform_submission_render_alter(&$sub) {
  if (!empty($sub['#submission']->civicrm['contact'][1]['display_name']) && empty($sub['#email']) && $sub['#format'] == 'html') {
    drupal_set_title(t('Submission #!num by @name', array('!num' => $sub['#submission']->sid, '@name' => $sub['#submission']->civicrm['contact'][1]['display_name'])));
  }
}

/**
 * Implements hook_webform_submission_actions().
 * Add links to view contact & activity.
 */
function webform_civicrm_webform_submission_actions($node, $submission) {
  $actions = array();
  if (!empty($node->webform_civicrm)
    && !empty($submission->civicrm)
    && webform_results_access($node)
    && user_access('access CiviCRM')) {
    $data = $submission->civicrm;
    if (!empty($data['contact'][1]['display_name'])) {
      $actions['civicrm_action contact_view'] = array(
        'title' => t('View @name', array('@name' => $data['contact'][1]['display_name'])),
        'href' => 'civicrm/contact/view',
        'query' => array('reset' => 1, 'cid' => $data['contact'][1]['id']),
      );
      if (!empty($data['activity'][1]['id'])) {
        $actions['civicrm_action activity_view'] = array(
          'title' => t('View Activity'),
          'href' => 'civicrm/activity',
          'query' => array('action' => 'view', 'reset' => 1, 'cid' => $data['contact'][1]['id'], 'id' => $data['activity'][1]['id']),
        );
      }
      if (!empty($data['contribution'][1]['id'])) {
        $actions['civicrm_action contribution_view'] = array(
          'title' => t('View Contribution'),
          'href' => 'civicrm/contact/view/contribution',
          'query' => array('action' => 'view', 'reset' => 1, 'cid' => $data['contact'][1]['id'], 'id' => $data['contribution'][1]['id']),
        );
      }
    }
  }
  return $actions;
}

/**
 * Implements hook_civicrm_postSave_tableName().
 *
 * Handles adding/editing a custom field.
 *
 * @param CRM_Core_DAO_CustomField $dao
 */
function webform_civicrm_civicrm_postSave_civicrm_custom_field($dao) {
  module_load_include('inc', 'webform_civicrm', 'includes/wf_crm_admin_form');
  if (empty($dao->custom_group_id)) {
    $dao->find(TRUE);
  }
  wf_crm_admin_form::handleDynamicCustomField('create', $dao->id, $dao->custom_group_id);
}

/**
 * Implements hook_civicrm_post().
 *
 * Handles delete of a custom field.
 *
 * TODO: In theory, this could also handle save, and we don't need to impliment the above hook.
 * However, this hook dosen't support CustomField in CiviCRM < 4.7.14 (or LTS < 4.6.24).
 *
 * @param string $op
 * @param string $name
 * @param int $id
 * @param CRM_Core_DAO $dao
 */
function webform_civicrm_civicrm_post($op, $name, $id, $dao) {
  if ($name == 'CustomField' && $op == 'delete') {
    module_load_include('inc', 'webform_civicrm', 'includes/wf_crm_admin_form');
    wf_crm_admin_form::handleDynamicCustomField($op, $id, $dao->custom_group_id);
  }
}

/**
 * Implements hook_civicrm_buildForm().
 * @param string $formName
 * @param CRM_Core_Form $form
 */
function webform_civicrm_civicrm_buildForm($formName, $form) {
  // Warn user when deleting custom fields used by webforms
  if ($formName == 'CRM_Custom_Form_DeleteField') {
    $nodes = array();
    $fid = $form->getVar('_id');
    if ($fid) {
      $webforms = db_query("SELECT nid FROM {webform_component} WHERE form_key LIKE 'civicrm_%_custom_{$fid}' GROUP BY nid");
      foreach ($webforms as $webform) {
        $node = node_load($webform->nid);
        $nodes[] = l($node->title, 'node/' . $webform->nid);
      }
    }
    if ($nodes) {
      $list = '<ul><li>' . implode('</li><li>', $nodes) . '</li></ul>';
      CRM_Core_Region::instance('page-body')->add(array(
        'markup' => '<strong>' . t('This field is used in the following webforms:') . '</strong>' . $list,
      ));
    }
  }
}

/**
 * Implements hook_civicrm_merge().
 * Update submission data to reflect new cids when contacts are merged.
 */
function webform_civicrm_civicrm_merge($type, $data, $new_id = NULL, $old_id = NULL, $tables = NULL) {
  if (!empty($new_id) && !empty($old_id) && $type == 'sqls') {
    // Update civicrm submissions table
    db_update('webform_civicrm_submissions')
      ->expression('contact_id', 'REPLACE(contact_id, :old, :new)', array(':old' => '-' . $old_id . '-', ':new' => '-' . $new_id . '-'))
      ->condition('contact_id', '%-' . $old_id . '-%', 'LIKE')
      ->execute();
    // Update contact reference field data
    db_query("UPDATE {webform_submitted_data} d, {webform_component} c SET d.data = :new
      WHERE d.data = :old AND d.cid = c.cid AND d.nid = c.nid AND c.type = 'civicrm_contact'",
      array(':new' => $new_id, ':old' => $old_id)
    );
  }
}

/**
 * Implements hook_admin_paths().
 */
function webform_civicrm_admin_paths() {
  return array('node/*/civicrm' => TRUE);
}

/**
 * Implements hook_help().
 */
function webform_civicrm_help($section) {
  if ($section == 'admin/help#webform_civicrm') {
    // Return a line-break version of the module README.md
    return nl2br(file_get_contents(drupal_get_path('module', 'webform_civicrm') . '/README.md'));
  }
}

/**
 * Implements hook_webform_component_presave().
 * Alter form keys when cloning a contact.
 */
function webform_civicrm_webform_component_presave(&$component) {
  if ($c = wf_crm_contact_clone_storage()) {
    $component['form_key'] = str_replace($c['old'], $c['new'], $component['form_key']);
    if ($component['type'] == 'civicrm_contact') {
      // Only contact 1 can be the current user
      if (wf_crm_aval($component, 'extra:default') == 'user') {
        unset($component['extra']['default']);
      }
    }
  }
}

/**
 * Implements hook_preprocess_HOOK().
 * Add CiviCRM names to webform submission results table.
 */
function webform_civicrm_preprocess_webform_results_submissions(&$vars) {
  if (count($vars['table']['#rows']) && !empty($vars['node']->webform_civicrm) && webform_results_access($vars['node'])) {
    module_load_include('inc', 'webform_civicrm', 'includes/utils');
    $access = user_access('access CiviCRM');
    $temp = $vars['table']['#header'];
    $vars['table']['#header'] = array();
    // Move contact col to position 2
    foreach ($temp as $k => $v) {
      $vars['table']['#header'][] = $v;
      if ($k == 1) {
        $vars['table']['#header'][] = wf_crm_contact_label(1, $vars['node']->webform_civicrm['data']);
      }
    }
    foreach ($vars['table']['#rows'] as &$row) {
      $name = '';
      // Get submission id from url
      preg_match('#/submission/(\d+)#', $row[4], $preg);
      $sid = $preg[1];
      if (!empty($vars['submissions'][$sid]->civicrm['contact'][1])) {
        $data = $vars['submissions'][$sid]->civicrm;
        $name = $data['contact'][1]['display_name'];
        if ($name !== '' && $access) {
          $name = l($name, 'civicrm/contact/view', array(
            'query' => array('reset' => 1, 'cid' => $data['contact'][1]['id']),
            'attributes' => array('title' => t('View CiviCRM contact')),
            'alias' => TRUE,
          ));
        }
      }
      $temp = $row;
      $row = array();
      // Move name to position 2
      foreach ($temp as $k => $v) {
        $row[] = $v;
        if ($k == 1) {
          $row[] = $name;
        }
      }
    }
  }
}

/**
 * Implements hook_preprocess_HOOK().
 */
function webform_civicrm_preprocess_webform_components_form(&$vars) {
  module_load_include('inc', 'webform_civicrm', 'includes/wf_crm_admin_component');
  wf_crm_admin_component::preprocessComponentsForm($vars['form'], $vars['rows'], $vars['form']['#node']);
}

/**
 * Implements hook_civicrm_alterPaymentProcessorParams().
 *
 * Legacy handling for paypal.
 * We use it to override the return url so that the user gets redirected to the right place from paypal.
 *
 * Remove when dropping support for CiviCRM 4.6 and below.
 */
function webform_civicrm_civicrm_alterPaymentProcessorParams($paymentObj, $rawParams, &$cookedParams) {
  if (!empty($rawParams['webform_redirect_cancel']) && !empty($rawParams['webform_redirect_success'])
    && !empty($cookedParams['return']) && !empty($cookedParams['cancel_return'])
  ) {
    $cookedParams['return'] = $rawParams['webform_redirect_success'];
    $cookedParams['cancel_return'] = $rawParams['webform_redirect_cancel'];
  }
}

/**
 * Return a value from nested arrays or objects.
 *
 * @param array|object $haystack
 *   The array to search
 * @param string $keys
 *   Pass a single key, or multiple keys separated by : to get a nested value
 * @param mixed $default
 *   Value to return if given array key does not exist
 * @param bool $strict
 *   Should we use empty or isset to determine if array key exists?
 *
 * @return mixed
 *   found value or default
 */
function wf_crm_aval($haystack, $keys, $default = NULL, $strict = FALSE) {
  foreach (explode(':', $keys) as $key) {
    if (is_object($haystack)) {
      $haystack = (array) $haystack;
    }
    if (!is_array($haystack) || !isset($haystack[$key]) || (empty($haystack[$key]) && $default !== NULL && !$strict)) {
      return $default;
    }
    $haystack = $haystack[$key];
  }
  // $haystack has been reduced down to the item we want
  return $haystack;
}

/**
 * Store info while a clone operation is running.
 *
 * @param array $input
 *   Data to store
 * @return array
 */
function wf_crm_contact_clone_storage($input = NULL) {
  static $storage = NULL;
  if ($input) {
    $storage = $input;
  }
  return $storage;
}

/**
 * Clone a contact via webform.
 * This submit handler is called when cloning a contact's fieldset
 */
function wf_crm_contact_clone($form, $form_state) {
  form_load_include($form_state, 'inc', 'webform_civicrm', 'includes/utils');
  $fid = $form['form_key']['#default_value'];
  list(, $old) = wf_crm_explode_key($fid);
  $node = node_load($form['nid']['#value']);
  $settings = $node->webform_civicrm;
  $new = count($settings['data']['contact']) + 1;
  // Clone contact
  $settings['data']['contact'][$new] = $settings['data']['contact'][$old];
  // Set label
  $settings['data']['contact'][$new]['contact'][1]['webform_label'] = $form_state['input']['name'];
  $storage = array(
    'old' => array("civicrm_{$old}_contact_"),
    'new' => array("civicrm_{$new}_contact_"),
  );
  // Clone participant if registering separately
  if (wf_crm_aval($settings['data'], 'participant_reg_type') == 'separate') {
    $settings['data']['participant'][$new] = $settings['data']['participant'][$old];
    $storage['old'][] = "civicrm_{$old}_participant_";
    $storage['new'][] = "civicrm_{$new}_participant_";
  }
  drupal_write_record('webform_civicrm_forms', $settings, 'nid');
  // Store data to rewrite form keys
  wf_crm_contact_clone_storage($storage);
}

/**
 * Validation callback for webform submissions.
 */
function wf_crm_validate($form, &$form_state) {
  form_load_include($form_state, 'inc', 'webform_civicrm', 'includes/wf_crm_webform_postprocess');
  $processor = wf_crm_webform_postprocess::singleton($form['#node']);
  $processor->validate($form, $form_state);
}

/**
 * Checks dependencies.
 *
 * @return array
 *   Array with TRUE/FALSE for each dependency.
 *
 * @see webform_civicrm_requirements
 */
function _webform_civicrm_status() {
  $status = array();
  $status['webform_civicrm'] = FALSE;

  $civicrm = system_get_info('module', 'civicrm');
  $webform = system_get_info('module', 'webform');

  if (version_compare($civicrm['version'], WEBFORM_CIVICRM_CIVICRM_VERSION_MIN, '>=') &&
    version_compare($webform['version'], WEBFORM_CIVICRM_WEBFORM_VERSION, '>=')) {
    $status['webform_civicrm'] = TRUE;
  }

  // If there is a max version of CiviCRM supported, check it too.
  if (WEBFORM_CIVICRM_CIVICRM_VERSION_MAX && version_compare($civicrm['version'], WEBFORM_CIVICRM_CIVICRM_VERSION_MAX, '>=')) {
    $status['webform_civicrm'] = FALSE;
  }

  return $status;
}