webform_share.module

<?php

/**
 * @file
 * Module to handle importing and exporting of webforms, as well as adding the
 * ability to set content type defaults.
 */

/**
 * Implements hook_config_info().
 */
function webform_share_config_info() {
  $prefixes['webform_share.settings'] = array(
    'label' => t('Webform Share settings'),
    'group' => t('Configuration'),
  );
  return $prefixes;
}

/**
 * Implements hook_permission().
 */
function webform_share_permission() {
  return array(
    'access webform share functionality' => array(
      'title' => t('Configure Webform Share'),
      'description' => t("This permission enables the user to import, export and set content-type defaults for webforms. The latter also requires the 'administer content type' permission."),
      'restrict access' => FALSE,
    ),
  );
}

/**
 * Helper function to get the content type defaults.
 */
function webform_share_node_type_defaults($type) {
  if (in_array($type, webform_variable_get('webform_node_types'))) {
    return config_get('webform_share.settings', 'webform_default_components_' . $type);
  }
  return '';
}

/**
 * Implements hook_menu().
 */
function webform_share_menu() {
  $items = array();
  $items['node/%webform_menu/webform/ws-export'] = array(
    'title' => 'Export',
    'page callback' => 'webform_share_export',
    'page arguments' => array(1),
    'access callback' => 'node_access',
    'access arguments' => array('update', 1),
    'weight' => 31,
    'type' => MENU_LOCAL_TASK,
  );
  $items['node/%webform_menu/webform/ws-import'] = array(
    'title' => 'Import',
    'page callback' => 'backdrop_get_form',
    'page arguments' => array('webform_share_components_update_form', 1),
    'access callback' => 'webform_share_menu_access',
    'access arguments' => array(1),
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
  );
  $items['node/%webform_menu/webform/ws-reset'] = array(
    'title' => 'Reset',
    'page callback' => 'backdrop_get_form',
    'page arguments' => array('webform_share_components_update_form', 1, TRUE),
    'access callback' => 'webform_share_menu_access',
    'access arguments' => array(1, TRUE),
    'weight' => 32,
    'type' => MENU_LOCAL_TASK,
  );
  $items['node/%webform_menu/webform/ws-default'] = array(
    'title' => 'Set default',
    'description' => 'Set this webform as the default for the current content type.',
    'page callback' => 'backdrop_get_form',
    'page arguments' => array('webform_share_set_default_confirm',1),
    'access callback' => 'webform_share_menu_access',
    'access arguments' => array(1, FALSE, TRUE),
    'weight' => 33,
    'type' => MENU_LOCAL_TASK,
  );

  return $items;
}

/**
 * Menu access callback.
 * Custom check on both the user access and node access.
 */
function webform_share_menu_access($node, $reset = FALSE, $default = FALSE) {
  if (node_access('update', $node)) {
    // We can only reset if there is some defaults set.
    if ($reset && !webform_share_node_type_defaults($node->type)) {
      return FALSE;
    }
    // We can only set default if user has 'administer content types'
    // permission.
    if ($default && !user_access('administer content types')) {
      return FALSE;
    }
    return user_access('access webform share functionality');
  }
  return FALSE;
}

/**
 * This form is used to update or to reset the webform.
 */
function webform_share_components_update_form($form, &$form_state, $node, $op = 'import') {
  $form_state['node'] = $node;
  $form['components_only'] = array(
    '#type' => 'checkbox',
    '#title' => t('Update components and conditionals only'),
    '#default_value' => 1,
    '#description' => t('If unchecked, the emails and form settings will be overridden.'),
  );
  $form['keep_existing_components'] = array(
    '#type' => 'checkbox',
    '#title' => t('Keep existing components that are not included in the import'),
    '#default_value' => 1,
    '#description' => t('If unchecked, the existing components that do not map to an imported webform form_key will be deleted. All submission data associated with those components will be lost.'),
  );
  $form['import'] = array(
    '#type' => 'textarea',
    '#title' => t('Import code'),
    '#default_value' => '',
    '#description' => t('Copy the code that was generated from a webform share export.'),
    '#required' => TRUE,
  );
  if ($op == 'reset') {
    $form['import']['#access'] = FALSE;
    $form['import']['#default_value'] = config_get('webform_share.settings', 'webform_default_components_' . $node->type);
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => $op == 'reset' ? t('Reset') : t('Import'),
  );

  return $form;
}

/**
 * Menu callback for 'Set default'.
 * Check that the user wants to proceed with a confirm_form.
 */
function webform_share_set_default_confirm($form, &$form_state, $node) {
  $type = $node->type;
  $type_name = node_type_get_name($node);
  $nid = $node->nid;
  $title = $node->title;
  $form['nid'] = array('#type' => 'value', '#value' => $nid);
  $form['type'] = array('#type' => 'value', '#value' => $type);
  $form['type-name'] = array('#type' => 'value', '#value' => $type_name);
  $question = t('Are you sure you want to set this webform as the default for the current content type?');
  $path = 'node/' . $nid . '/webform';
  $description = '<p>' . t('This will replace any existing default webform configuration for the %type_name content type with the webform configuration on %title.', array(
    '%title' => $title,
    '%type_name' => $type_name,
  )) . '</p>';
  $yes = t('Set default');
  return confirm_form($form, $question, $path, $description, $yes);
}

/**
 * Set current node webform config as default for content type.
 */
function webform_share_set_default_confirm_submit($form, &$form_state) {
    $node = node_load($form_state['values']['nid']);
    $webform_share = backdrop_json_encode($node->webform);
    config_set('webform_share.settings', 'webform_default_components_' . $form_state['values']['type'], (string) $webform_share);
    backdrop_set_message(t('The webform configuration from %title has been set as the default for the %type_name content type.', array(
      '%title' => $node->title,
      '%type_name' => $form_state['values']['type-name'],
    )),'status', FALSE);
    $form_state['redirect'] = 'node/' . $form_state['values']['nid'] . '/webform';
    return;
}

/**
 * Submit callback to update the node.
 */
function webform_share_components_update_form_submit($form, &$form_state) {
  $node = $form_state['node'];
  if ($webform = backdrop_json_decode($form_state['values']['import'])) {
    $hook_params = array(
      'operation' => 'update',
      'node' => $node,
      'options' => array(
        'components_only' => $form_state['values']['components_only'],
        'keep_existing_components' => $form_state['values']['keep_existing_components'],
      ),
    );
    backdrop_alter('webform_share_import', $webform, $hook_params);
    // Load the original node and use this to map any fields based off
    // the form_key parameter. We need to preserve the existing cid if
    // possible to preserve the submission data.
    $original = node_load($node->nid, NULL, TRUE);
    $existing_components = array();
    foreach ($original->webform['components'] as $cid => $component) {
      $existing_components[$component['form_key']] = $cid;
    }

    // Get the max cid for this node's webform so we know where our safe
    // starting point is.
    $current_max_cid = webform_share_get_next_max_cid($node->nid);

    // Overwrite the entire form if the user is updating everything.
    if (empty($form_state['values']['components_only'])) {
      $node->webform = $webform;
      $webform['nid'] = $node->nid;
    }

    $old_to_new_mappings = array();

    // Map the imported components to the existing webform components.
    $node->webform['components'] = array();
    foreach ($webform['components'] as $index => $component) {
      if (isset($existing_components[$component['form_key']])) {
        $cid = $existing_components[$component['form_key']];
        unset($existing_components[$component['form_key']]);
      }
      else {
        $cid = ++$current_max_cid;
      }

      $old_to_new_mappings[$component['cid']] = $cid;
      if (!empty($component['pid'])) {
        // This mapping assumes that parents always come before children.
        if (empty($old_to_new_mappings[$component['pid']])) {
          backdrop_set_message(t('Unable to find the correct fieldset for %component.', array(
            '%component' => $component['name'],
            )), 'error', TRUE);
        }
        else {
          $component['pid'] = $old_to_new_mappings[$component['pid']];
        }
      }
      // Set the new cid.
      $component['cid'] = $cid;
      $component['nid'] = $node->nid;
      $node->webform['components'][$cid] = $component;
    }

    // Map the imported conditionals.
    $webform['conditionals'] = isset($webform['conditionals']) ? $webform['conditionals'] : array();
    foreach ($webform['conditionals'] as $index => $conditional) {
      foreach ($conditional['rules'] as $rindex => $rule) {
        if (isset($rule['source']) && $rule['source'] != NULL) {
          $rule['nid'] = $node->nid;
          if (!empty($old_to_new_mappings[$rule['source']])) {
            $rule['source'] = $old_to_new_mappings[$rule['source']];
          }
          else {
            backdrop_set_message(t('Unable to find the correct sources for conditionals.'), 'error', FALSE);
          }
          $conditional['rules'][$rindex] = $rule;
        }
      }

      foreach ($conditional['actions'] as $aindex => $action) {
        if (isset($action['target']) && $action['target'] != NULL) {
          $action['nid'] = $node->nid;
          if (!empty($old_to_new_mappings[$action['target']])) {
            $action['target'] = $old_to_new_mappings[$action['target']];
          }
          else {
            backdrop_set_message(t('Unable to find the correct targets for conditionals.'), 'error', FALSE);
          }
          $conditional['actions'][$aindex] = $action;
        }
      }

      $node->webform['conditionals'][$index] = $conditional;
    }

    // If requested, re-add the existing components rather than allowing these
    // to be deleted. Existing cid values are safe to reuse.
    if (!empty($form_state['values']['keep_existing_components'])) {
      foreach ($existing_components as $form_key => $cid) {
        $node->webform['components'][$cid] = $original->webform['components'][$cid];
      }
    }

    if (isset($node->webform['emails'])) {
      foreach ($node->webform['emails'] as $index => $component) {
        $node->webform['emails'][$index]['nid'] = $node->nid;
      }
    }
    node_save($node);
  }
  $form_state['redirect'] = 'node/' . $node->nid . '/webform';
}

/**
 * Retrieves that last "cid" for a node's webform.
 *
 * @param int $nid
 * @return int
 */
function webform_share_get_next_max_cid($nid) {
  $max_cid = db_select('webform_component', 'w')
      ->fields('w', array('cid'))
      ->condition('nid', $nid)
      ->orderBy('cid', 'DESC')
      ->range(0, 1)
      ->execute()
      ->fetchField();
  return (empty($max_cid) ? 0 : $max_cid);
}

/**
 * Menu callback to generate the webform dump.
 */
function webform_share_export($node) {
  backdrop_alter('webform_share_export', $node);
  $webform_share = backdrop_json_encode($node->webform);

  backdrop_add_http_header('Content-Type', 'application/json; charset=utf-8');
  backdrop_add_http_header('Content-Disposition', 'attachment; filename="webform-' . $node->type . '-' . $node->nid . '.json";');

  print $webform_share;

  exit();
}

/**
 * Implements hook_form_BASE_FORM_ID_alter().
 * 
 * This hooks into the node type form to add the webform share default settings
 * textarea.
 */
function webform_share_form_node_type_form_alter(&$form, $form_state) {
  // Targets content type edit forms
  if (isset($form['type'])) {
    // Only adds the element to content types that have been tag for webforms.
    if (in_array($form['#node_type']->type, webform_variable_get('webform_node_types'))) {
      // Make sure that the user has permission.
      if (user_access('access webform share functionality')) {
        $form['webform']['webform_share'] = array(
          '#type' => 'textarea',
          '#title' => t('Webform default components'),
          '#default_value' => config_get('webform_share.settings', 'webform_default_components_' . $form['#node_type']->type),
          '#access' => user_access('access webform share functionality'),
          '#description' => t('Copy the code that was generated from a webform share export.'),
        );
        $form['#submit'][] = 'webform_share_form_node_type_form_submit';
      }
    }
  }
}

function webform_share_form_node_type_form_submit(&$form, $form_state) {
  if (isset($form_state['values']['webform_share'])) {
    config_set('webform_share.settings', 'webform_default_components_' . $form_state['values']['type'], (string) $form_state['values']['webform_share']);
  }
}

/**
 * Implements hook_node_presave().
 */
function webform_share_node_presave(Node $node) {
  if ($type_defaults = webform_share_node_type_defaults($node->type)) {
    $webform_defaults = backdrop_json_decode($type_defaults);
    if ($webform = $webform_defaults) {
      $hook_params = array(
        'operation' => 'insert',
        'node' => $node,
        'options' => array(
          'components_only' => FALSE,
          'keep_existing_components' => FALSE,
        ),
      );
      backdrop_alter('webform_share_import', $webform, $hook_params);
      $node->webform = $webform;
      $node->webform['nid'] = $node->nid;
      if (isset($node->webform['components'])) {
        $node->webform['components'] = array_filter((array) $node->webform['components']);
        foreach ($node->webform['components'] as $index => $component) {
          $node->webform['components'][$index]['nid'] = $node->nid;
        }
      }
      if (isset($node->webform['emails'])) {
        foreach ($node->webform['emails'] as $index => $email) {
          $node->webform['emails'][$index]['nid'] = $node->nid;
        }
      }
    }
  }
}