Club Drupal

<?php

/**

 * @file

 * Webform module component handling.

 */

/**

 * Provides interface and database handling for editing components of a webform.

 *

 * @author Nathan Haug <nate@lullabot.com>

 */

/**

 * Overview page of all components for this webform.

 */

function webform_components_page($node, $page_number = 1) {

  $output = drupal_get_form('webform_components_form', $node);

  return array(

    '#theme' => 'webform_components_page',

    '#node' => $node,

    '#form' => $output,

  );

}

/**

 * Theme the output of the main components page.

 *

 * This theming provides a way to toggle between the editing modes if Form

 * Builder module is available.

 */

function theme_webform_components_page($variables) {

  $form = $variables['form'];

  return drupal_render($form);

}

/**

 * The table-based listing of all components for this webform.

 */

function webform_components_form($form, $form_state, $node) {

  $form = array(

    '#tree' => TRUE,

    '#node' => $node,

    'components' => array(),

  );

  $form['nid'] = array(

    '#type' => 'value',

    '#value' => $node->nid,

  );

  $options = array();

  foreach ($node->webform['components'] as $cid => $component) {

    $options[$cid] = check_plain($component['name']);

    $form['components'][$cid]['cid'] = array(

      '#type' => 'hidden',

      '#default_value' => $component['cid'],

    );

    $form['components'][$cid]['pid'] = array(

      '#type' => 'hidden',

      '#default_value' => $component['pid'],

    );

    $form['components'][$cid]['weight'] = array(

      '#type' => 'textfield',

      '#size' => 4,

      '#title' => t('Weight'),

      '#default_value' => $component['weight'],

    );

    $form['components'][$cid]['required'] = array(

      '#type' => 'checkbox',

      '#title' => t('Required'),

      '#default_value' => $component['required'],

      '#access' => webform_component_feature($component['type'], 'required'),

    );

    if (!isset($max_weight) || $component['weight'] > $max_weight) {

      $max_weight = $component['weight'];

    }

  }

  $form['add']['name'] = array(

    '#type' => 'textfield',

    '#size' => 30,

    '#maxlength' => NULL,

  );

  $form['add']['type'] = array(

    '#type' => 'select',

    '#options' => webform_component_options(),

    '#weight' => 3,

    '#default_value' => (isset($_GET['cid']) && isset($node->webform['components'][$_GET['cid']])) ? $node->webform['components'][$_GET['cid']]['type'] : 'textfield',

  );

  $form['add']['required'] = array(

    '#type' => 'checkbox',

  );

  $form['add']['cid'] = array(

    '#type' => 'hidden',

    '#default_value' => '',

  );

  $form['add']['pid'] = array(

    '#type' => 'hidden',

    '#default_value' => (isset($_GET['cid']) && isset($node->webform['components'][$_GET['cid']])) ? $node->webform['components'][$_GET['cid']]['pid'] : 0,

  );

  $form['add']['weight'] = array(

    '#type' => 'textfield',

    '#size' => 4,

    '#delta' => count($node->webform['components']) > 10 ? count($node->webform['components']) : 10,

  );

  if (isset($_GET['cid']) && isset($node->webform['components'][$_GET['cid']])) {

    // Make the new component appear by default directly after the one that was

    // just added.

    $form['add']['weight']['#default_value'] = $node->webform['components'][$_GET['cid']]['weight'] + 1;

    foreach (array_keys($node->webform['components']) as $cid) {

      // Adjust all later components also, to make sure none of them have the

      // same weight as the new component.

      if ($form['components'][$cid]['weight']['#default_value'] >= $form['add']['weight']['#default_value']) {

        $form['components'][$cid]['weight']['#default_value']++;

      }

    }

  }

  else {

    // If no component was just added, the new component should appear by

    // default at the end of the list.

    $form['add']['weight']['#default_value'] = isset($max_weight) ? $max_weight + 1 : 0;

  }

  $form['add']['add'] = array(

    '#type' => 'submit',

    '#value' => t('Add'),

    '#weight' => 45,

    '#validate' => array('webform_components_form_add_validate', 'webform_components_form_validate'),

    '#submit' => array('webform_components_form_add_submit'),

  );

  $form['actions'] = array(

    '#type' => 'actions',

    '#weight' => 45,

  );

  $form['actions']['submit'] = array(

    '#type' => 'submit',

    '#value' => t('Save'),

    '#access' => count($node->webform['components']) > 0,

  );

  $form['warning'] = array(

    '#weight' => -1,

  );

  webform_input_vars_check($form, $form_state, 'components', 'warning');

  return $form;

}

/**

 * Preprocess variables for theming the webform components form.

 */

function template_preprocess_webform_components_form(&$variables) {

  $form = $variables['form'];

  $form['components']['#attached']['library'][] = array('webform', 'admin');

  // @todo: Attach these. See http://drupal.org/node/732022.

  drupal_add_tabledrag('webform-components', 'order', 'sibling', 'webform-weight');

  drupal_add_tabledrag('webform-components', 'match', 'parent', 'webform-pid', 'webform-pid', 'webform-cid');

  $node = $form['#node'];

  $header = array(t('Label'), t('Form key'), t('Type'), t('Value'), t('Required'), t('Weight'), array('data' => t('Operations'), 'colspan' => 3));

  $rows = array();

  // Add a row containing form elements for a new item.

  unset($form['add']['name']['#title'], $form['add_type']['#description']);

  $form['add']['name']['#attributes']['placeholder'] = t('New component name');

  $form['add']['cid']['#attributes']['class'][] = 'webform-cid';

  $form['add']['pid']['#attributes']['class'][] = 'webform-pid';

  $form['add']['weight']['#attributes']['class'][] = 'webform-weight';

  $row_data = array(

    array('data' => drupal_render($form['add']['name']), 'class' => array('webform-component-name'), 'colspan' => 2),

    array('data' => drupal_render($form['add']['type']), 'class' => array('webform-component-type')),

    array('data' => '', 'class' => array('webform-component-value')),

    array('data' => drupal_render($form['add']['required']), 'class' => array('webform-component-required', 'checkbox')),

    array('data' => drupal_render($form['add']['cid']) . drupal_render($form['add']['pid']) . drupal_render($form['add']['weight'])),

    array('colspan' => 3, 'data' => drupal_render($form['add']['add']), 'class' => array('webform-component-add')),

  );

  $add_form = array('data' => $row_data, 'class' => array('draggable', 'webform-add-form', 'tabledrag-leaf'));

  if (!empty($node->webform['components'])) {

    $component_tree = array();

    $page_count = 1;

    _webform_components_tree_build($node->webform['components'], $component_tree, 0, $page_count);

    $component_tree = _webform_components_tree_sort($component_tree);

    // Build the table rows recursively.

    foreach ($component_tree['children'] as $cid => $component) {

      _webform_components_form_rows($node, $cid, $component, 0, $form, $rows, $add_form);

    }

  }

  else {

    $rows[] = array(array('data' => t('No Components, add a component below.'), 'colspan' => 9));

    // When there are no components, tabledrag.js will look to the add component

    // row to locate the weight column. Because of the name/form_key colspan

    // it will mis-count the columns and locate the Required column instead of

    // the Weight column.

    unset($add_form['data'][0]['colspan']);

    array_splice($add_form['data'], 1, 0, ' ');

  }

  // Append the add form if not already printed.

  if ($add_form) {

    $rows[] = $add_form;

  }

  $variables['rows'] = $rows;

  $variables['header'] = $header;

  $variables['form'] = $form;

}

/**

 * Recursive function for nesting components into a table.

 *

 * @see preprocess_webform_components_form()

 */

function _webform_components_form_rows($node, $cid, $component, $level, &$form, &$rows, &$add_form) {

  // Create presentable values.

  $form_key = truncate_utf8($component['form_key'], 30, FALSE, TRUE);

  $value = truncate_utf8($component['value'], 30, TRUE, TRUE, 20);

  // Remove individual titles from the required and weight fields.

  unset($form['components'][$cid]['required']['#title']);

  unset($form['components'][$cid]['pid']['#title']);

  unset($form['components'][$cid]['weight']['#title']);

  // Add special classes for weight and parent fields.

  $form['components'][$cid]['cid']['#attributes']['class'] = array('webform-cid');

  $form['components'][$cid]['pid']['#attributes']['class'] = array('webform-pid');

  $form['components'][$cid]['weight']['#attributes']['class'] = array('webform-weight');

  // Build indentation for this row.

  $indents = '';

  for ($n = 1; $n <= $level; $n++) {

    $indents .= '<div class="indentation">&nbsp;</div>';

  }

  // Add each component to a table row.

  $row_data = array(

    array('data' => $indents . filter_xss($component['name']), 'class' => array('webform-component-name')),

    array('data' => check_plain($form_key), 'class' => array('webform-component-formkey')) +

    ((string) $component['form_key'] === (string) $form_key ? array() : array('title' => $component['form_key'])),

    array('data' => $form['add']['type']['#options'][$component['type']], 'class' => array('webform-component-type')),

    array('data' => ($value == '') ? '-' : check_plain($value), 'class' => array('webform-component-value')) +

    ($component['value'] == $value ? array() : array('title' => $component['value'])),

    array('data' => drupal_render($form['components'][$cid]['required']), 'class' => array('webform-component-required', 'checkbox')),

    array('data' => drupal_render($form['components'][$cid]['cid']) . drupal_render($form['components'][$cid]['pid']) . drupal_render($form['components'][$cid]['weight'])),

    array('data' => l(t('Edit'), 'node/' . $node->nid . '/webform/components/' . $cid, array('query' => drupal_get_destination())), 'class' => array('webform-component-edit')),

    array('data' => l(t('Clone'), 'node/' . $node->nid . '/webform/components/' . $cid . '/clone', array('query' => drupal_get_destination())), 'class' => array('webform-component-clone')),

    array('data' => l(t('Delete'), 'node/' . $node->nid . '/webform/components/' . $cid . '/delete', array('query' => drupal_get_destination())), 'class' => array('webform-component-delete')),

  );

  $row_class = array('draggable');

  if (!webform_component_feature($component['type'], 'group')) {

    $row_class[] = 'tabledrag-leaf';

  }

  if ($component['type'] == 'pagebreak') {

    $row_class[] = 'tabledrag-root';

    $row_class[] = 'webform-pagebreak';

    $row_data[0]['class'][] = 'webform-pagebreak';

  }

  $rows[] = array('data' => $row_data, 'class' => $row_class, 'data-cid' => $cid);

  if (isset($component['children']) && is_array($component['children'])) {

    foreach ($component['children'] as $cid => $component) {

      _webform_components_form_rows($node, $cid, $component, $level + 1, $form, $rows, $add_form);

    }

  }

  // Add the add form if this was the last edited component.

  if (isset($_GET['cid']) && $component['cid'] == $_GET['cid'] && $add_form) {

    $add_form['data'][0]['data'] = $indents . $add_form['data'][0]['data'];

    $rows[] = $add_form;

    $add_form = FALSE;

  }

}

/**

 * Theme the node components form. Use a table to organize the components.

 *

 * @return string

 *   Formatted HTML form, ready for display.

 */

function theme_webform_components_form($variables) {

  $output = '';

  $output .= drupal_render_children($variables['form']['warning']);

  $output .= theme('table', array('header' => $variables['header'], 'rows' => $variables['rows'], 'attributes' => array('id' => 'webform-components')));

  $output .= drupal_render_children($variables['form']);

  return $output;

}

/**

 * Validate handler for webform_components_form().

 */

function webform_components_form_validate($form, &$form_state) {

  // Check that no two components end up with the same form key.

  $duplicates = array();

  $parents = array();

  if (isset($form_state['values']['components'])) {

    foreach ($form_state['values']['components'] as $cid => $component) {

      $form_key = (string) $form['#node']->webform['components'][$cid]['form_key'];

      if (isset($parents[$component['pid']]) && ($existing = array_search($form_key, $parents[$component['pid']], TRUE)) && $existing !== FALSE) {

        if (!isset($duplicates[$form_key])) {

          $duplicates[$form_key] = array($existing);

        }

        $duplicates[$form_key][] = $cid;

      }

      $parents[$component['pid']][$cid] = $form_key;

    }

  }

  if (!empty($duplicates)) {

    $error = t('The form order failed to save because the following elements have same form keys and are under the same parent. Edit each component and give them a unique form key, then try moving them again.');

    $items = array();

    foreach ($duplicates as $form_key => $cids) {

      foreach ($cids as $cid) {

        $items[] = webform_filter_xss($form['#node']->webform['components'][$cid]['name']);

      }

    }

    form_error($form['components'], $error . theme('item_list', array('items' => $items)));

  }

}

/**

 * Validate handler for webform_component_form() when adding a new component.

 */

function webform_components_form_add_validate($form, &$form_state) {

  // Check that the entered component name is valid.

  if (drupal_strlen(trim($form_state['values']['add']['name'])) <= 0) {

    form_error($form['add']['name'], t('When adding a new component, the name field is required.'));

  }

}

/**

 * Submit handler for webform_components_form() to save component order.

 */

function webform_components_form_submit($form, &$form_state) {

  $node = node_load($form_state['values']['nid']);

  // Update all required and weight values.

  $changes = FALSE;

  foreach ($node->webform['components'] as $cid => $component) {

    if ($component['pid'] != $form_state['values']['components'][$cid]['pid'] || $component['weight'] != $form_state['values']['components'][$cid]['weight'] || $component['required'] != $form_state['values']['components'][$cid]['required']) {

      $changes = TRUE;

      $node->webform['components'][$cid]['weight'] = $form_state['values']['components'][$cid]['weight'];

      $node->webform['components'][$cid]['required'] = $form_state['values']['components'][$cid]['required'];

      $node->webform['components'][$cid]['pid'] = $form_state['values']['components'][$cid]['pid'];

    }

  }

  if ($changes) {

    node_save($node);

  }

  drupal_set_message(t('The component positions and required values have been updated.'));

}

/**

 * Submit handler for webform_components_form() that adds a new component.

 */

function webform_components_form_add_submit($form, &$form_state) {

  $node = node_load($form_state['values']['nid']);

  $component = $form_state['values']['add'];

  // Set the values in the query string for the add component page.

  $query = array(

    'name' => $component['name'],

    'required' => $component['required'],

    'pid' => $component['pid'],

    'weight' => $component['weight'],

  );

  // Forward the "destination" query string value to the next form.

  if (isset($_GET['destination'])) {

    $query['destination'] = $_GET['destination'];

    unset($_GET['destination']);

    drupal_static_reset('drupal_get_destination');

  }

  $form_state['redirect'] = array('node/' . $node->nid . '/webform/components/new/' . $component['type'], array('query' => $query));

}

/**

 * Form to configure a webform component.

 */

function webform_component_edit_form($form, $form_state, $node, $component, $clone = FALSE) {

  drupal_set_title(t('Edit component: @name', array('@name' => $component['name'])), PASS_THROUGH);

  $form['#node'] = $node;

  $form['#tree'] = TRUE;

  // Print the correct field type specification.

  // We always need: name and description.

  $form['type'] = array(

    '#type' => 'value',

    '#value' => $component['type'],

  );

  $form['nid'] = array(

    '#type' => 'value',

    '#value' => $node->nid,

  );

  $form['cid'] = array(

    '#type' => 'value',

    '#value' => isset($component['cid']) ? $component['cid'] : NULL,

  );

  $form['clone'] = array(

    '#type' => 'value',

    '#value' => $clone,

  );

  if (webform_component_feature($component['type'], 'title')) {

    $form['name'] = array(

      '#type' => 'textfield',

      '#default_value' => $component['name'],

      '#title' => t('Label'),

      '#description' => t('This is used as a descriptive label when displaying this form element.'),

      '#required' => TRUE,

      '#weight' => -10,

      '#maxlength' => NULL,

    );

  }

  $form['form_key'] = array(

    '#type' => 'textfield',

    '#default_value' => empty($component['form_key']) ? _webform_safe_name($component['name']) : $component['form_key'],

    '#title' => t('Form Key'),

    '#description' => t('Enter a machine readable key for this form element. May contain only alphanumeric characters and underscores. This key will be used as the name attribute of the form element. This value has no effect on the way data is saved, but may be helpful if doing custom form processing.'),

    '#required' => TRUE,

    '#weight' => -9,

  );

  $form['extra'] = array();

  if (webform_component_feature($component['type'], 'description')) {

    $form['extra']['description'] = array(

      '#type' => 'textarea',

      '#default_value' => isset($component['extra']['description']) ? $component['extra']['description'] : '',

      '#title' => t('Description'),

      '#description' => t('A short description of the field used as help for the user when he/she uses the form.') . ' ' . theme('webform_token_help'),

      '#weight' => -1,

    );

  }

  // Display settings.

  $form['display'] = array(

    '#type' => 'fieldset',

    '#title' => t('Display'),

    '#collapsible' => TRUE,

    '#collapsed' => FALSE,

    '#weight' => 8,

  );

  if (webform_component_feature($component['type'], 'title_display')) {

    $inline_option = webform_component_feature($component['type'], 'title_inline') ? array('inline' => t('Inline')) : array();

    $internal_option = webform_component_feature($component['type'], 'title_internal') ? array('internal' => t('Inside the component')) : array();

    if ($inline_option || $internal_option) {

      $form['display']['title_display'] = array(

        '#type' => 'select',

        '#title' => t('Label display'),

        '#default_value' => !empty($component['extra']['title_display']) ? $component['extra']['title_display'] : 'before',

        '#options' => array('before' => t('Above')) +

                      $inline_option +

                      $internal_option +

                      array('none' => t('None')),

        '#description' => t("Determines the placement of the component's label."),

      );

    }

    else {

      $form['display']['title_display'] = array(

        '#type' => 'checkbox',

        '#title' => t('Hide label'),

        '#default_value' => strcmp($component['extra']['title_display'], 'none') === 0,

        '#return_value' => 'none',

        '#description' => t('Do not display the label of this component.'),

      );

    }

    $form['display']['title_display']['#weight'] = 8;

    $form['display']['title_display']['#parents'] = array('extra', 'title_display');

  }

  if (webform_component_feature($component['type'], 'description')) {

    $form['display']['description_above'] = array(

      '#type' => 'checkbox',

      '#default_value' => !empty($component['extra']['description_above']),

      '#title' => t('Description above field'),

      '#description' => t('Place the description above — rather than below — the field.'),

      '#weight' => 8.5,

      '#parents' => array('extra', 'description_above'),

    );

  }

  if (webform_component_feature($component['type'], 'private')) {

    // May user mark fields as Private?

    $form['display']['private'] = array(

      '#type' => 'checkbox',

      '#title' => t('Private'),

      '#default_value' => ($component['extra']['private'] == '1' ? TRUE : FALSE),

      '#description' => t('Private fields are shown only to users with results access.'),

      '#weight' => 45,

      '#parents' => array('extra', 'private'),

      '#disabled' => empty($node->nid) ? FALSE : !webform_results_access($node),

    );

  }

  if (webform_component_feature($component['type'], 'wrapper_classes')) {

    $form['display']['wrapper_classes'] = array(

      '#type' => 'textfield',

      '#title' => t('Wrapper CSS classes'),

      '#default_value' => isset($component['extra']['wrapper_classes']) ? $component['extra']['wrapper_classes'] : '',

      '#description' => t('Apply a class to the wrapper around both the field and its label. Separate multiple by spaces.'),

      '#weight' => 50,

      '#parents' => array('extra', 'wrapper_classes'),

    );

  }

  if (webform_component_feature($component['type'], 'css_classes')) {

    $form['display']['css_classes'] = array(

      '#type' => 'textfield',

      '#title' => t('CSS classes'),

      '#default_value' => isset($component['extra']['css_classes']) ? $component['extra']['css_classes'] : '',

      '#description' => t('Apply a class to the field. Separate multiple by spaces.'),

      '#weight' => 51,

      '#parents' => array('extra', 'css_classes'),

    );

  }

  // Validation settings.

  $form['validation'] = array(

    '#type' => 'fieldset',

    '#title' => t('Validation'),

    '#collapsible' => TRUE,

    '#collapsed' => FALSE,

    '#weight' => 5,

  );

  if (webform_component_feature($component['type'], 'required')) {

    $form['validation']['required'] = array(

      '#type' => 'checkbox',

      '#title' => t('Required'),

      '#default_value' => ($component['required'] == '1' ? TRUE : FALSE),

      '#description' => t('Check this option if the user must enter a value.'),

      '#weight' => -1,

      '#parents' => array('required'),

    );

  }

  // Position settings, only shown if JavaScript is disabled.

  $form['position'] = array(

    '#type' => 'fieldset',

    '#title' => t('Position'),

    '#collapsible' => TRUE,

    '#collapsed' => TRUE,

    '#tree' => FALSE,

    '#weight' => 20,

    '#attributes' => array('class' => array('webform-position')),

  );

  $options = array('0' => t('Root'));

  foreach ($node->webform['components'] as $existing_cid => $value) {

    if (webform_component_feature($value['type'], 'group') && (!isset($component['cid']) || $existing_cid != $component['cid'])) {

      $options[$existing_cid] = $value['name'];

    }

  }

  $form['position']['pid'] = array(

    '#type' => 'select',

    '#title' => t('Parent'),

    '#default_value' => $component['pid'],

    '#description' => t('Optional. You may organize your form by placing this component inside another fieldset.'),

    '#options' => $options,

    '#access' => count($options) > 1,

    '#weight' => 3,

  );

  $form['position']['weight'] = array(

    '#type' => 'textfield',

    '#size' => 4,

    '#title' => t('Weight'),

    '#default_value' => $component['weight'],

    '#description' => t('Optional. In the menu, the heavier items will sink and the lighter items will be positioned nearer the top.'),

    '#weight' => 4,

  );

  // Add the fields specific to this component type:

  $additional_form_elements = (array) webform_component_invoke($component['type'], 'edit', $component, $form, $form_state);

  if (empty($additional_form_elements)) {

    drupal_set_message(t('The webform component of type @type does not have an edit function defined.', array('@type' => $component['type'])));

  }

  // Merge the additional fields with the current fields:

  if (isset($additional_form_elements['extra'])) {

    $form['extra'] = array_merge($form['extra'], $additional_form_elements['extra']);

    unset($additional_form_elements['extra']);

  }

  if (isset($additional_form_elements['position'])) {

    $form['position'] = array_merge($form['position'], $additional_form_elements['position']);

    unset($additional_form_elements['position']);

  }

  if (isset($additional_form_elements['display'])) {

    $form['display'] = array_merge($form['display'], $additional_form_elements['display']);

    unset($additional_form_elements['display']);

  }

  if (isset($additional_form_elements['validation'])) {

    $form['validation'] = array_merge($form['validation'], $additional_form_elements['validation']);

    unset($additional_form_elements['validation']);

  }

  elseif (count(element_children($form['validation'])) == 0) {

    unset($form['validation']);

  }

  $form = array_merge($form, $additional_form_elements);

  // Ensure that the webform admin library is attached, possibly in addition to

  // component-specific attachments.

  $form['#attached']['library'][] = array('webform', 'admin');

  // Add the submit button.

  $form['actions'] = array(

    '#type' => 'actions',

    '#weight' => 50,

  );

  $form['actions']['submit'] = array(

    '#type' => 'submit',

    '#value' => t('Save component'),

  );

  // Remove fieldsets without any child form controls.

  foreach (element_children($form) as $group_key) {

    $group = $form[$group_key];

    if (isset($group['#type']) && $group['#type'] === 'fieldset' && !element_children($group)) {

      unset($form[$group_key]);

    }

  }

  return $form;

}

/**

 * Field name validation for the webform unique key. Must be alphanumeric.

 */

function webform_component_edit_form_validate($form, &$form_state) {

  $node = $form['#node'];

  if (!preg_match('/^[a-z0-9_]+$/i', $form_state['values']['form_key'])) {

    form_set_error('form_key', t('The form key %form_key is invalid. Please include only lowercase alphanumeric characters and underscores.', array('%form_key' => $form_state['values']['form_key'])));

  }

  foreach ($node->webform['components'] as $cid => $component) {

    if (($component['cid'] != $form_state['values']['cid'] || $form_state['values']['clone']) && ($component['pid'] == $form_state['values']['pid']) && (strcasecmp($component['form_key'], $form_state['values']['form_key']) == 0)) {

      form_set_error('form_key', t('The form key %form_key is already in use by the field labeled %existing_field. Please use a unique key.', array('%form_key' => $form_state['values']['form_key'], '%existing_field' => $component['name'])));

    }

  }

}

/**

 * Submit handler for webform_component_edit_form().

 */

function webform_component_edit_form_submit($form, &$form_state) {

  // Ensure a webform record exists.

  $node = $form['#node'];

  webform_ensure_record($node);

  // Remove extra values that match the default.

  if (isset($form_state['values']['extra'])) {

    $default = array('type' => $form_state['values']['type'], 'extra' => array());

    webform_component_defaults($default);

    foreach ($form_state['values']['extra'] as $key => $value) {

      if (isset($default['extra'][$key]) && $default['extra'][$key] === $value) {

        unset($form_state['values']['extra'][$key]);

      }

    }

  }

  // Remove empty attribute values.

  if (isset($form_state['values']['extra']['attributes'])) {

    foreach ($form_state['values']['extra']['attributes'] as $key => $value) {

      if ($value === '') {

        unset($form_state['values']['extra']['attributes'][$key]);

      }

    }

  }

  if ($form_state['values']['clone']) {

    webform_component_clone($node, $form_state['values']);

    drupal_set_message(t('Component %name cloned.', array('%name' => $form_state['values']['name'])));

  }

  elseif (!empty($form_state['values']['cid'])) {

    webform_component_update($form_state['values']);

    drupal_set_message(t('Component %name updated.', array('%name' => $form_state['values']['name'])));

  }

  else {

    $cid = webform_component_insert($form_state['values']);

    drupal_set_message(t('New component %name added.', array('%name' => $form_state['values']['name'])));

  }

  // Since Webform components have been updated but the node itself has not

  // been saved, it is necessary to explicitly clear the cache to make sure

  // the updated webform is visible to anonymous users. This resets the page

  // and block caches (only).

  cache_clear_all();

  // Refresh the entity cache, should it be cached in persistent storage.

  entity_get_controller('node')->resetCache(array($node->nid));

  $form_state['redirect'] = array('node/' . $node->nid . '/webform/components', isset($cid) ? array('query' => array('cid' => $cid)) : array());

}

/**

 * Form to confirm deletion of a component.

 */

function webform_component_delete_form($form, $form_state, $node, $component) {

  $cid = $component['cid'];

  $form = array();

  $form['node'] = array(

    '#type' => 'value',

    '#value' => $node,

  );

  $form['component'] = array(

    '#type' => 'value',

    '#value' => $component,

  );

  $component_type = $node->webform['components'][$cid]['type'];

  if (webform_component_feature($component_type, 'group')) {

    $question = t('Delete the %name fieldset?', array('%name' => $node->webform['components'][$cid]['name']));

    $description = t('This will immediately delete the %name @type component and all nested components within %name from the %webform webform. This cannot be undone.',

      array(

        '%name' => $node->webform['components'][$cid]['name'],

        '@type' => webform_component_property($component_type, 'label'),

        '%webform' => $node->title,

      ));

  }

  else {

    $question = t('Delete the %name component?', array('%name' => $node->webform['components'][$cid]['name']));

    $description = t('This will immediately delete the %name component from the %webform webform. This cannot be undone.', array('%name' => $node->webform['components'][$cid]['name'], '%webform' => $node->title));

  }

  return confirm_form($form, $question, 'node/' . $node->nid . '/webform/components', $description, t('Delete'));

}

/**

 * Submit handler for webform_component_delete_form().

 */

function webform_component_delete_form_submit($form, &$form_state) {

  // Delete the component.

  $node = $form_state['values']['node'];

  $component = $form_state['values']['component'];

  webform_component_delete($node, $component);

  drupal_set_message(t('Component %name deleted.', array('%name' => $component['name'])));

  // Check if this webform still contains any information.

  unset($node->webform['components'][$component['cid']]);

  webform_check_record($node);

  // Since Webform components have been updated but the node itself has not

  // been saved, it is necessary to explicitly clear the cache to make sure

  // the updated webform is visible to anonymous users. This resets the page

  // and block caches (only).

  cache_clear_all();

  // Refresh the entity cache, should it be cached in persistent storage.

  entity_get_controller('node')->resetCache(array($node->nid));

  $form_state['redirect'] = 'node/' . $node->nid . '/webform/components';

}

/**

 * Insert a new component into the database.

 *

 * @param $component

 *   A full component containing fields from the component form.

 *

 * @return false|int

 *   On success return identifier for the components within node.

 *   FALSE on failure

 */

function webform_component_insert(&$component) {

  // Allow modules to modify the component before saving.

  foreach (module_implements('webform_component_presave') as $module) {

    $function = $module . '_webform_component_presave';

    $function($component);

  }

  $component['value'] = isset($component['value']) ? $component['value'] : NULL;

  $component['required'] = isset($component['required']) ? $component['required'] : 0;

  $component['extra']['private'] = isset($component['extra']['private']) ? $component['extra']['private'] : 0;

  if (!isset($component['cid'])) {

    if (lock_acquire('webform_component_insert_' . $component['nid'], 5)) {

      $next_id_query = db_select('webform_component')->condition('nid', $component['nid']);

      $next_id_query->addExpression('MAX(cid) + 1', 'cid');

      $component['cid'] = $next_id_query->execute()->fetchField();

      if ($component['cid'] == NULL) {

        $component['cid'] = 1;

      }

      lock_release('webform_component_insert_' . $component['nid']);

    }

    else {

      watchdog('webform', 'A Webform component could not be saved because a timeout occurred while trying to acquire a lock for the node. Details: <pre>@component</pre>', array('@component' => print_r($component, TRUE)));

      return FALSE;

    }

  }

  db_insert('webform_component')

    ->fields(array(

      'nid' => $component['nid'],

      'cid' => $component['cid'],

      'pid' => $component['pid'],

      'form_key' => $component['form_key'],

      'name' => $component['name'],

      'type' => $component['type'],

      'value' => (string) $component['value'],

      'extra' => serialize($component['extra']),

      'required' => $component['required'],

      'weight' => $component['weight'],

    ))

    ->execute();

  // Post-insert actions.

  module_invoke_all('webform_component_insert', $component);

  return $component['cid'];

}

/**

 * Update an existing component with new values.

 *

 * @param $component

 *   A full component containing a nid, cid, and all other fields from the

 *   component form. Additional properties are stored in the extra array.

 */

function webform_component_update($component) {

  // Allow modules to modify the component before saving.

  foreach (module_implements('webform_component_presave') as $module) {

    $function = $module . '_webform_component_presave';

    $function($component);

  }

  $component['value'] = isset($component['value']) ? $component['value'] : NULL;

  $component['required'] = isset($component['required']) ? $component['required'] : 0;

  $component['extra']['private'] = isset($component['extra']['private']) ? $component['extra']['private'] : 0;

  db_update('webform_component')

    ->fields(array(

      'pid' => $component['pid'],

      'form_key' => $component['form_key'],

      'name' => $component['name'],

      'type' => $component['type'],

      'value' => isset($component['value']) ? $component['value'] : '',

      'extra' => serialize($component['extra']),

      'required' => $component['required'],

      'weight' => $component['weight'],

    ))

    ->condition('nid', $component['nid'])

    ->condition('cid', $component['cid'])

    ->execute();

  // Post-update actions.

  module_invoke_all('webform_component_update', $component);

}

/**

 * Delete a Webform component.

 */

function webform_component_delete($node, $component) {

  // Check if a delete function is available for this component. If so,

  // load all submissions and allow the component to delete each one.

  webform_component_include($component['type']);

  $delete_function = '_webform_delete_' . $component['type'];

  if (function_exists($delete_function)) {

    module_load_include('inc', 'webform', 'includes/webform.submissions');

    $submissions = webform_get_submissions($node->nid);

    foreach ($submissions as $submission) {

      if (isset($submission->data[$component['cid']])) {

        webform_component_invoke($component['type'], 'delete', $component, $submission->data[$component['cid']]);

      }

    }

  }

  // Remove database entries.

  db_delete('webform_component')

    ->condition('nid', $node->nid)

    ->condition('cid', $component['cid'])

    ->execute();

  db_delete('webform_submitted_data')

    ->condition('nid', $node->nid)

    ->condition('cid', $component['cid'])

    ->execute();

  // Delete any conditionals dependent on this component.

  module_load_include('inc', 'webform', 'includes/webform.conditionals');

  foreach ($node->webform['conditionals'] as $rgid => &$conditional) {

    $specs = array(

      array(

        'field' => 'rules',

        'table' => 'webform_conditional_rules',

        'component' => 'source',

        'component_type' => 'source_type',

        'index' => 'rid',

      ),

      array(

        'field' => 'actions',

        'table' => 'webform_conditional_actions',

        'component' => 'target',

        'component_type' => 'target_type',

        'index' => 'aid',

      ),

    );

    foreach ($specs as $spec) {

      $deleted = array();

      $field = $spec['field'];

      foreach ($conditional[$field] as $key => $thing) {

        if ($thing[$spec['component_type']] === 'component' && $thing[$spec['component']] == $component['cid']) {

          $deleted[$key] = $key;

          unset($conditional[$field][$key]);

        }

      }

      if ($spec['field'] == 'rules') {

        // Rules deleted because of the source component being deleted may have left

        // empty sub-conditionals. Delete them, and then the entire rule group if

        // there aren't any rules left.

        $deleted += webform_delete_empty_subconditionals($conditional);

      }

      // Delete the conditional if this component is the only source / target.

      if (empty($conditional[$field])) {

        webform_conditional_delete($node, $conditional);

        // Also delete the conditional from the $node so it is not re-created

        // later on in webform_node_update().

        unset($node->webform['conditionals'][$conditional['rgid']]);

        // Loop exit.

        break;

      }

      // Remove the deleted rules / actions from the database.

      foreach ($deleted as $key) {

        db_delete($spec['table'])

          ->condition('nid', $node->nid)

          ->condition('rgid', $rgid)

          ->condition($spec['index'], $key)

          ->execute();

      }

    }

  }

  // Delete all elements under this element.

  $result = db_select('webform_component', 'c')

    ->fields('c')

    ->condition('nid', $node->nid)

    ->condition('pid', $component['cid'])

    ->execute();

  foreach ($result as $row) {

    $child_component = $node->webform['components'][$row->cid];

    webform_component_delete($node, $child_component);

  }

  // Post-delete actions.

  module_invoke_all('webform_component_delete', $component);

}

/**

 * Recursively insert components into the database.

 *

 * @param $node

 *   The node object containing the current webform.

 * @param $component

 *   A full component containing fields from the component form.

 *

 * @return false|int

 *   On success return identifier for the components within node.

 *   FALSE on failure

 */

function webform_component_clone(&$node, &$component) {

  $original_cid = $component['cid'];

  $component['cid'] = NULL;

  $new_cid = webform_component_insert($component);

  $component['cid'] = $new_cid;

  if (webform_component_feature($component['type'], 'group')) {

    foreach ($node->webform['components'] as $cid => $child_component) {

      if ($child_component['pid'] == $original_cid) {

        $child_component['pid'] = $new_cid;

        webform_component_clone($node, $child_component);

      }

    }

  }

  return $new_cid;

}

/**

 * Check if a component has a particular feature.

 *

 * @see hook_webform_component_info()

 */

function webform_component_feature($type, $feature) {

  $components = webform_components();

  $defaults = array(

    'analysis' => TRUE,

    'csv' => TRUE,

    'default_value' => TRUE,

    'description' => TRUE,

    'email' => TRUE,

    'email_address' => FALSE,

    'email_name' => FALSE,

    'required' => TRUE,

    'title' => TRUE,

    'title_display' => TRUE,

    'title_inline' => TRUE,

    'title_internal' => FALSE,

    'conditional' => TRUE,

    'conditional_action_set' => FALSE,

    'spam_analysis' => FALSE,

    'group' => FALSE,

    'attachment' => FALSE,

    'private' => TRUE,

    'placeholder' => FALSE,

    'wrapper_classes' => TRUE,

    'css_classes' => TRUE,

    'views_range' => FALSE,

  );

  return isset($components[$type]['features'][$feature]) ? $components[$type]['features'][$feature] : !empty($defaults[$feature]);

}

/**

 * Get a component property from the component definition.

 *

 * @see hook_webform_component_info()

 */

function webform_component_property($type, $property) {

  $components = webform_components();

  $defaults = array(

    'conditional_type' => 'string',

  );

  return isset($components[$type][$property]) ? $components[$type][$property] : $defaults[$property];

}

/**

 * Create a list of components suitable for a select list.

 *

 * @param $node

 *   The webform node.

 * @param $component_filter

 *   Either an array of components, or a string containing a feature name (csv,

 *   email, required, conditional) on which this list of components will be

 *   restricted.

 * @param $prefix_group

 *   TRUE to indent with a hyphen, or 'path" to Prepend enclosing group (for example,

 *   fieldset) name(s)

 * @param $pagebreak_groups

 *   Determine if pagebreaks should be converted to option groups in the

 *   returned list of options.

 *

 * @return array

 *   An array of options.

 */

function webform_component_list($node, $component_filter = NULL, $prepend_group = TRUE, $pagebreak_groups = FALSE) {

  $options = array();

  $page_names = array();

  $parent_names = array();

  $components = is_array($component_filter) ? $component_filter : $node->webform['components'];

  $feature = is_string($component_filter) ? $component_filter : NULL;

  foreach ($components as $cid => $component) {

    // If this component is a group (for example, fieldset), then remember its name, including any parents.

    if ($prepend_group && webform_component_feature($component['type'], 'group')) {

      $parent_names[$cid] = ($component['pid'] ? $parent_names[$component['pid']] : '') .

                            ($prepend_group === 'path' ? $component['name'] . ': ' : '-');

    }

    $page_num = $component['page_num'];

    // If this component is a pagebreak, then generate an option group, ensuring a unique name.

    if ($pagebreak_groups && $component['type'] == 'pagebreak') {

      $page_name = $component['name'];

      // When a $page_name consists only of digits, append a space to ensure it

      // is never the same as a $cid.

      if ((string) $page_name === (string) (int) $page_name) {

        $page_name .= ' ';

      }

      $copy = 1;

      while (in_array($page_name, $page_names)) {

        $page_name = $component['name'] . '_' . ++$copy;

      }

      $page_names[$page_num] = $page_name;

    }

    // If this component should be included in the options, add it with any prefix, in a page group, as needed.

    if (!isset($feature) || webform_component_feature($component['type'], $feature) || $prepend_group === TRUE) {

      $prefix = ($prepend_group && $component['pid']) ? $parent_names[$component['pid']] : '';

      if ($pagebreak_groups && $page_num > 1) {

        $options[$page_names[$page_num]][$cid] = $prefix . $component['name'];

      }

      else {

        $options[$cid] = $prefix . $component['name'];

      }

    }

  }

  return $options;

}

/**

 * A Form API process function to expand a component list into checkboxes.

 */

function webform_component_select($element) {

  // Split the select list into checkboxes.

  foreach ($element['#options'] as $key => $label) {

    $label_length = strlen($label);

    $label = preg_replace('/^(\-)+/', '', $label);

    $indents = $label_length - strlen($label);

    $element[$key] = array(

      '#title' => $label,

      '#type' => 'checkbox',

      '#default_value' => array_search($key, $element['#value']) !== FALSE,

      '#return_value' => $key,

      '#parents' => array_merge($element['#parents'], array($key)),

      '#indent' => $indents,

    );

  }

  $element['#theme_wrappers'] = array();

  $element['#type'] = 'webform_component_select';

  $element['#theme'] = 'webform_component_select';

  $element['#attached'] = array(

    'library' => array(

      array('webform', 'admin'),

      array('system', 'drupal.collapse'),

    ),

    'js' => array(

      'misc/tableselect.js' => array(),

    ),

  );

  return $element;

}

/**

 * Theme the contents of a Webform component select element.

 */

function theme_webform_component_select($variables) {

  $element = $variables['element'];

  $rows = array();

  $header = array();

  if (!isset($element['#all_checkbox']) || $element['#all_checkbox']) {

    $header = array(array('class' => array('select-all'), 'data' => ' ' . t('Include all components')));

  }

  foreach (element_children($element) as $key) {

    if ($key != 'suffix') {

      $rows[] = array(

        theme('indentation', array('size' => $element[$key]['#indent'])) . drupal_render($element[$key]),

      );

    }

  }

  $element['#type'] = 'fieldset';

  $element['#value'] = NULL;

  $element['#attributes']['class'] = array('webform-component-select-table');

  if (!isset($element['#collapsible']) || $element['#collapsible']) {

    $element['#attributes']['class'][] = 'collapsible';

  }

  if (!isset($element['#collapsed']) || $element['#collapsed']) {

    $element['#attributes']['class'][] = 'collapsed';

  }

  if (empty($rows)) {

    $element['#children'] = t('No available components.');

  }

  else {

    $element['#children'] = '<div class="webform-component-select-wrapper">' . theme('table', array('header' => $header, 'rows' => $rows, 'sticky' => FALSE)) . '</div>';

  }

  if (isset($element['suffix'])) {

    $element['#children'] .= '<div class="webform-component-select-suffix">' . drupal_render($element['suffix']) . '</div>';

  }

  return theme('fieldset', array('element' => $element));

}

/**

 * Find a component's parents within a node.

 *

 * @param object $node

 *   The webform node.

 * @param array $component

 *   The component to start with.

 * @param string|true $what_to_return

 *   If TRUE, return complete component arrays. Otherwise, return the property

 *   of each component named in this parametre.

 *

 * @return array

 *   An array with a value for each parent and for the start component, in order

 *   ending with start component. What the value is is controlled by

 *   $what_to_return.

 */

function webform_component_parent_keys($node, array $component, $what_to_return = 'form_key') {

  $parents = array(($what_to_return === TRUE) ? $component : $component[$what_to_return]);

  $pid = $component['pid'];

  while ($pid) {

    $parents[] = ($what_to_return === TRUE) ? $node->webform['components'][$pid] : $node->webform['components'][$pid][$what_to_return];

    $pid = $node->webform['components'][$pid]['pid'];

  }

  return array_reverse($parents);

}

/**

 * Populate a component with the defaults for that type.

 */

function webform_component_defaults(&$component) {

  $defaults = webform_component_invoke($component['type'], 'defaults');

  drupal_alter('webform_component_defaults', $defaults, $component['type']);

  if (!empty($defaults)) {

    foreach ($defaults as $key => $default) {

      if (!isset($component[$key])) {

        $component[$key] = $default;

      }

    }

    foreach ($defaults['extra'] as $extra => $default) {

      if (!isset($component['extra'][$extra])) {

        $component['extra'][$extra] = $default;

      }

    }

  }

}

/**

 * Validate an element value is unique with no duplicates in the database.

 */

function webform_validate_unique($element, $form_state) {

  if ($element['#value'] !== '') {

    $nid = $form_state['values']['details']['nid'];

    $sid = $form_state['values']['details']['sid'];

    $query = db_select('webform_submitted_data')

      ->fields('webform_submitted_data', array('sid'))

      ->condition('nid', $nid)

      ->condition('cid', $element['#webform_component']['cid'])

      ->condition('data', $element['#value'])

      // More efficient than using countQuery() for data checks.

      ->range(0, 1);

    if ($sid) {

      $query->condition('sid', $sid, '<>');

    }

    $count = $query->execute()->fetchField();

    if ($count) {

      form_error($element, t('The value %value has already been submitted once for the %title field. You may have already submitted this form, or you need to use a different value.', array('%value' => $element['#value'], '%title' => $element['#title'])));

    }

  }

}