taxonomy_csv.export.admin.inc in Taxonomy CSV import/export 6.5

Create taxonomy csv export form and validate user input.

File

export/taxonomy_csv.export.admin.inc

<?php

/**
 * @file
 * Create taxonomy csv export form and validate user input.
 */

/**
 * Invoke associated files.
 * taxonomy_csv.export.api.inc is invoked only when form is submitted.
 */

// Invoke taxonomy_csv api (defines and functions).
$module_dir = drupal_get_path('module', 'taxonomy_csv');
require_once "{$module_dir}/taxonomy_csv.api.inc";

/**
 * Generates the taxonomy CSV export form.
 *
 * Form contain three fieldsets:
 * - 1. Which vocabulary to export ?
 * - 2. How to export (format of csv file) ?
 *   - 1. Csv delimiter
 *   - 2. Csv enclosure
 *   - 3. Csv end of line
 * - 3. Order and specific options
 *
 * @ingroup forms
 * @see taxonomy_csv_form_export_validate()
 * @see taxonomy_csv_form_export_submit()
 * @see _taxonomy_csv_form_export_default_values_validate()
 * @see _taxonomy_csv_form_export_default_values_submit()
 */
function taxonomy_csv_form_export($form_state) {

  // Remember previous values to use in particular when reloading form.
  // If not reloading form, use saved values if exist, else recommended ones.
  $list_recommended_values = _taxonomy_csv_values('export_default_ui');
  $list_previous_values = array();
  foreach ($list_recommended_values as $key => $value) {
    $list_previous_values[$key] = isset($form_state['values'][$key]) ? $form_state['values'][$key] : variable_get("taxonomy_csv_{$key}", $value);
  }
  $list_export_format = _taxonomy_csv_values('export_format');
  $list_export_delimiter = array(
    'comma' => t('« , » (Comma)'),
    'semicolon' => t('« ; » (Semicolon)'),
    'tabulation' => t('«   » (Tabulation)'),
    'pipe' => t('« | » (Pipe)'),
    'space' => t('«   » (Space)'),
    'currency_sign' => t('« ¤ » (Currency sign)'),
    'custom_delimiter' => t('Custom delimiter'),
  );
  $list_export_enclosure = array(
    'none' => t('None'),
    'quotation' => t('« " » (Quotation mark)'),
    'quote' => t("« ' » (Quote)"),
    'custom_enclosure' => t('Custom enclosure'),
  );
  $list_export_line_ending = array(
    'Unix' => t('Unix / Linux'),
    'Mac' => t('Apple Mac'),
    'MS-DOS' => t('Microsoft DOS'),
  );
  $list_export_order = array(
    'name' => t('Alphabetic order'),
    'weight' => t('Weight'),
    'tid' => t('Internal order (tid)'),
  );

  // Build form.
  $form = array();
  $list_vocabularies = taxonomy_get_vocabularies();
  if (count($list_vocabularies) == 0) {
    $form['info'] = array(
      '#type' => 'item',
      '#value' => t("As there isn't any vocabulary, nothing can be exported..."),
    );
    return $form;
  }

  // Else there are vocabularies.
  // Advertise that javascript is not enabled. Presume it is set by default.
  if (isset($_COOKIE['has_js']) && !$_COOKIE['has_js']) {
    $form['javascript'] = array(
      '#type' => 'fieldset',
      '#title' => t('WARNING'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $form['javascript']['info'] = array(
      '#type' => 'item',
      '#title' => t('Javascript is not activated!'),
      '#description' => t("As you see this notice, javascript is disabled on your browser. All fields are shown, but only those matching your choices needs to be set. Others won't be used. If you want specific examples and options, activate javascript or see <a href=\"!more_help_link\"> advanced help</a>.", array(
        '!more_help_link' => url('admin/help/taxonomy_csv'),
      )),
      '#required' => TRUE,
    );
  }

  // Useless, but allows to keep closer Drupal 6 and Drupal 7 releases.
  $form['tab'] = array();
  $form['tab']['content'] = array(
    '#type' => 'fieldset',
    '#title' => t('1. What do you want to export?'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['tab']['content']['export_format'] = array(
    '#type' => 'select',
    '#title' => 'CSV format',
    '#options' => $list_export_format,
    '#default_value' => $list_previous_values['export_format'],
  );
  $form['tab']['content']['info'] = array(
    '#type' => 'item',
    '#description' => t('See <a href="!more_help_link">advanced help</a> for informations about formats.', array(
      '!more_help_link' => url('admin/help/taxonomy_csv'),
    )) . '<br />' . t('Only "fields and links" format manages duplicate term names. In all cases, you will be notified if a duplicate is found.'),
  );
  $form['tab']['content']['export_vocabulary_id'] = array(
    '#type' => 'select',
    '#title' => t('Vocabularies to export'),
    '#options' => array(
      0 => t('All vocabularies'),
    ),
    '#multiple' => TRUE,
    '#default_value' => $list_previous_values['export_vocabulary_id'],
    '#description' => t('The vocabularies you want to export.'),
    '#size' => min(12, count($list_vocabularies)) + 1,
  );
  foreach ($list_vocabularies as $vocabulary) {
    $form['tab']['content']['export_vocabulary_id']['#options'][$vocabulary->vid] = $vocabulary->name;
  }
  $form['tab']['csv_format'] = array(
    '#type' => 'fieldset',
    '#title' => t('2. How do you want to format your CSV file?'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#attributes' => array(
      'id' => 'csv_format',
    ),
  );
  $form['tab']['csv_format']['export_delimiter'] = array(
    '#type' => 'select',
    '#title' => t('CSV value delimiter'),
    '#options' => $list_export_delimiter,
    '#default_value' => $list_previous_values['export_delimiter'],
    '#description' => t('Choose the delimiter to use in the CSV file.'),
    '#attributes' => array(
      'id' => 'delimiter',
    ),
  );
  $form['tab']['csv_format']['export_delimiter_custom'] = array(
    '#type' => 'textfield',
    '#title' => 'Custom delimiter',
    '#default_value' => $list_previous_values['export_delimiter_custom'],
    '#size' => 2,
    '#maxlength' => 1,
    '#description' => t('Specify your custom delimiter.'),
  );
  $form['tab']['csv_format']['export_enclosure'] = array(
    '#type' => 'select',
    '#title' => t('CSV value enclosure'),
    '#options' => $list_export_enclosure,
    '#default_value' => $list_previous_values['export_enclosure'],
    '#description' => t('Choose the enclosure used in the CSV file you want to export. Warning: enclosure should not be used in term definitions, specially in descriptions. Furthermore, an enclosure is needed if a field contains a line ending character. Export process will stop in case of problem.'),
    '#attributes' => array(
      'id' => 'enclosure',
    ),
  );
  $form['tab']['csv_format']['export_enclosure_custom'] = array(
    '#type' => 'textfield',
    '#title' => 'Custom enclosure',
    '#default_value' => $list_previous_values['export_enclosure_custom'],
    '#size' => 2,
    '#maxlength' => 1,
    '#description' => t('Specify your custom enclosure.'),
  );
  $form['tab']['csv_format']['export_line_ending'] = array(
    '#type' => 'select',
    '#title' => t('Line ending'),
    '#options' => $list_export_line_ending,
    '#default_value' => $list_previous_values['export_line_ending'],
    '#description' => t('Choose the end of line to use.'),
  );
  $form['tab']['advanced_options'] = array(
    '#type' => 'fieldset',
    '#title' => t('3. Advanced and specific options'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#attributes' => array(
      'id' => 'advanced_options',
    ),
  );
  $form['tab']['advanced_options']['export_order'] = array(
    '#type' => 'select',
    '#title' => t('Terms order'),
    '#options' => $list_export_order,
    '#default_value' => $list_previous_values['export_order'],
    '#description' => t('Choose order of exported terms.'),
  );
  $form['tab']['advanced_options']['specific_info'] = array(
    '#type' => 'item',
    '#description' => t('Specific options are shown only if suitable.'),
    '#prefix' => '<div id="specific_info">',
    '#suffix' => '</div>',
  );

  // Specific options to export def_links.
  $form['tab']['advanced_options']['def_links'] = array(
    '#type' => 'fieldset',
    '#title' => t('Specific settings of:') . ' ' . t('Full term fields and links'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#description' => t('Set these options only if you export:') . ' ' . t('Full term fields and links') . '.',
    '#attributes' => array(
      'id' => 'edit-def-links',
    ),
  );
  $form['tab']['advanced_options']['def_links']['def_links_terms_ids'] = array(
    '#type' => 'select',
    '#title' => t('Which identifiant do you want to use for terms?'),
    '#options' => array(
      'name_if_needed' => t('Term name only when useful'),
      'name' => t('Term name'),
      'tid' => t('Serial number (internal term id)'),
    ),
    '#default_value' => $list_previous_values['def_links_terms_ids'],
    '#description' => t('Choose how terms will be exported. In first and second choices, duplicate terms are identified with name and a serial number. First choice is lighter, because main term tid is set only if it is a duplicate term. All options can manage duplicate term names. Third choice is more difficult to read.'),
  );
  $form['tab']['advanced_options']['def_links']['def_links_vocabularies_ids'] = array(
    '#type' => 'select',
    '#title' => t('Which identifiant do you want to use for vocabularies?'),
    '#options' => array(
      'none' => t('Nothing (unique vocabulary export)'),
      'name' => t('Vocabulary name'),
      'vid' => t('Serial number (internal vocabulary id)'),
    ),
    '#default_value' => $list_previous_values['def_links_vocabularies_ids'],
    '#description' => t('Choose how vocabularies will be identified.') . '<br />' . t('"Nothing" can be used only when a single vocabulary is exported (not all vocabularies in one time) and when there is no relation to terms of another vocabulary. In such a case, vocabulary name will be used instead.'),
  );
  $form['tab']['advanced_options']['result_duplicates'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show duplicate terms after export'),
    '#default_value' => $list_previous_values['result_duplicates'],
    '#description' => '',
  );
  $form['export_submit'] = array(
    '#type' => 'submit',
    '#value' => t('Export'),
  );
  $form['export_default_values'] = array(
    '#type' => 'submit',
    '#value' => t('Reset to defaults'),
    '#validate' => array(
      '_taxonomy_csv_form_export_default_values_validate',
    ),
    '#submit' => array(
      '_taxonomy_csv_form_export_default_values_submit',
    ),
  );
  return $form;
}

/**
 * Handles CSV export form validation.
 *
 * @see taxonomy_csv_form_export()
 */
function taxonomy_csv_form_export_validate($form, &$form_state) {

  // Invoke taxonomy_csv api (defines and functions).
  $module_dir = drupal_get_path('module', 'taxonomy_csv');
  require_once "{$module_dir}/export/taxonomy_csv.export.api.inc";
  $options =& $form_state['values'];

  // 1. Presave a file in order to check it.
  // Define vocabulary id (use simple api name of it).
  $options['vocabulary_id'] = $options['export_vocabulary_id'];
  $messages = _taxonomy_csv_export_output_presave($options);

  // 2, Simplify values to be compatible with api checks.
  // Define true delimiter.
  $delimiter = array(
    'comma' => ',',
    'semicolon' => ';',
    'tabulation' => "\t",
    'pipe' => '|',
    'space' => ' ',
    'currency_sign' => '¤',
    'custom_delimiter' => $options['export_delimiter_custom'],
  );
  $options['delimiter'] = $delimiter[$options['export_delimiter']];

  // Define true enclosure.
  $enclosure = array(
    'none' => '',
    'quotation' => '"',
    'quote' => "'",
    'custom_enclosure' => $options['export_enclosure_custom'],
  );
  $options['enclosure'] = $enclosure[$options['export_enclosure']];

  // Define true line ending and order.
  $options['line_ending'] = $options['export_line_ending'];
  $options['order'] = $options['export_order'];

  // 3, Make api checks and eventually update options by reference.
  $messages = array_merge($messages, _taxonomy_csv_export_check_options($options));

  // Use form set error for api errors.
  foreach (array(
    'vocabulary_id' => 'export_vocabulary_id',
    'delimiter' => 'export_delimiter',
    'enclosure' => 'export_enclosure',
    'line_ending' => 'export_line_ending',
    'order' => 'export_order',
  ) as $key => $value) {
    if (isset($message[$key])) {
      $message[$value] = $message[$key];
      unset($message[$key]);
    }
  }

  // 4. Make non api checks.
  if ($options['export_delimiter'] == 'custom_delimiter' && empty($options['export_delimiter_custom'])) {
    $messages['export_delimiter_custom'] = t('You choose to use a custom delimiter, but your delimiter is empty.');
  }
  if ($options['export_enclosure'] == 'custom_enclosure' && empty($options['export_enclosure_custom'])) {
    $messages['export_enclosure_custom'] = t('You choose to use a custom enclosure, but your enclosure is empty.');
  }
  if ($options['export_delimiter'] == 'custom_delimiter' && drupal_strlen($options['export_delimiter_custom']) > 1) {
    $messages['export_delimiter_custom'] = t('Delimiter should have only one character.');
  }
  if ($options['export_enclosure'] == 'custom_enclosure' && drupal_strlen($options['export_enclosure_custom']) > 1) {
    $messages['export_enclosure_custom'] = t('Enclosure should have only zero or one character.');
  }

  // 5. Finish validatation of form.
  foreach ($messages as $item => $message) {
    form_set_error(check_plain($item), filter_xss($message));
  }
}

/**
 * Validate options of exported vocabulary.
 *
 * @param $options
 *   An associative array of options.
 *
 * @return
 *   Array of messages errors if any.
 *   By reference options are cleaned and completed.
 */
function _taxonomy_csv_export_check_options(&$options) {
  $messages = array();
  $list_export_format = _taxonomy_csv_values('export_format');
  if (!array_key_exists($options['export_format'], $list_export_format)) {
    $messages['export_format'] = t('Export format "!export_format" is not managed.', array(
      '!export_format' => $list_export_format[$options['export_format']],
    ));
  }
  $list_vocabularies = taxonomy_get_vocabularies();
  if (!$list_vocabularies) {
    $messages['vocabulary_id'] = t('No vocabulary to export.');
  }
  elseif ($options['vocabulary_id']) {

    // Replace vocabulary_id by an array if only one item is selected.
    if (!is_array($options['vocabulary_id'])) {
      $options['vocabulary_id'] = array(
        $options['vocabulary_id'],
      );
    }
    if (count($options['vocabulary_id']) > 1 && in_array(0, $options['vocabulary_id'])) {
      $messages['vocabulary_id'] = t('You choose to export all vocabularies, but you select some individual vocabularies too.');
    }
    foreach ($options['vocabulary_id'] as $item) {
      if ($item != 0 && !isset($list_vocabularies[$item])) {
        $messages['vocabulary_id'] = t("You choose to export a vocabulary, but it doesn't exist.");
      }
    }
  }

  // Delimiter and enclosure greater than one character are forbidden.
  if (drupal_strlen($options['delimiter']) != 1) {
    $messages['delimiter'] = t('Delimiter should be a one character string.');
  }
  if (drupal_strlen($options['enclosure']) > 1) {
    $messages['enclosure'] = t('Enclosure lenght cannot be greater than one character.');
  }
  if ($options['delimiter'] == $options['enclosure']) {
    $messages['delimiter'] = t('Delimiter and enclosure cannot be same character.');
  }
  if (!in_array($options['line_ending'], array(
    'Unix',
    'Mac',
    'MS-DOS',
  ))) {
    $messages['line_ending'] = t('Line ending should be "Unix", "Mac" or "MS-DOS".');
  }
  if (!in_array($options['order'], array(
    'name',
    'tid',
    'weight',
  ))) {
    $messages['order'] = t('Order should be "name", "tid" or "weight".');
  }
  if (!in_array($options['def_links_terms_ids'], array(
    'name_if_needed',
    'name',
    'tid',
  ))) {
    $messages['def_links_terms_ids'] = t('Terms identifiants should be "name_if_needed", "name" or "tid".');
  }
  if (!in_array($options['def_links_vocabularies_ids'], array(
    'none',
    'name',
    'vid',
  ))) {
    $messages['def_links_vocabularies_ids'] = t('Vocabularies identifiants should be "none", "name" or "vid".');
  }

  // When multiple vocabularies are exported, names or tids are always needed.
  if ($options['def_links_vocabularies_ids'] == 'none') {
    if ($options['vocabulary_id'] == array(
      0,
    ) || count($options['vocabulary_id']) > 1) {
      $options['def_links_vocabularies_ids'] = 'name';
    }
    else {

      // Check if all related terms are related to main vocabulary.
      // @todo Currently, check is made for each term in line_export.
    }
  }

  // Calculates number of terms to be exported.
  $options['total_terms'] = taxonomy_csv_vocabulary_count_terms($options['vocabulary_id']);
  if (!$options['total_terms']) {
    $messages['vocabulary_id'] = t('Vocabulary has no term to export. Export finished.');
  }
  return $messages;
}

/**
 * Handles CSV export form submission and launch batch set.
 *
 * @see taxonomy_csv_form_export()
 */
function taxonomy_csv_form_export_submit($form, &$form_state) {

  // Remember last preferences and prepare only options to be sent to api.
  foreach (array(
    'export_format',
    'export_vocabulary_id',
    'export_delimiter',
    'export_delimiter_custom',
    'export_enclosure',
    'export_enclosure_custom',
    'export_line_ending',
    'export_order',
    'def_links_terms_ids',
    'def_links_vocabularies_ids',
    'result_duplicates',
  ) as $option) {
    variable_set('taxonomy_csv_' . $option, $form_state['values'][$option]);
    $options[$option] = $form_state['values'][$option];
  }

  // Finish to prepare $options. Unset useless options for api.
  unset($options['export_vocabulary_id']);
  unset($options['export_delimiter']);
  unset($options['export_delimiter_custom']);
  unset($options['export_enclosure']);
  unset($options['export_enclosure_custom']);
  unset($options['export_line_ending']);
  unset($options['export_order']);
  $options['delimiter'] = $form_state['values']['delimiter'];
  $options['enclosure'] = $form_state['values']['enclosure'];
  $options['line_ending'] = $form_state['values']['line_ending'];
  $options['order'] = $form_state['values']['order'];
  $options['file'] = $form_state['values']['file'];
  $options['vocabulary_id'] = $form_state['values']['vocabulary_id'];
  $options['check_options'] = FALSE;

  // Already done.
  $options['result_display'] = TRUE;

  // Prepares process batch (will be automatically processed when returns).
  taxonomy_csv_vocabulary_export($options);
}

/**
 * Restore recommended default values in the export form. Empty validate hook.
 */
function _taxonomy_csv_form_export_default_values_validate($form, &$form_state) {
}

/**
 * Restore recommended default values in the export form.
 */
function _taxonomy_csv_form_export_default_values_submit($form, &$form_state) {
  foreach (_taxonomy_csv_values('export_default_ui') as $option => $value) {
    variable_set("taxonomy_csv_{$option}", $value);
  }
  unset($form_state['values']);
  unset($form_state['storage']);
  drupal_set_message(t('Export options have been reset to default.'));
}

Functions

Name	Description
taxonomy_csv_form_export	Generates the taxonomy CSV export form.
taxonomy_csv_form_export_submit	Handles CSV export form submission and launch batch set.
taxonomy_csv_form_export_validate	Handles CSV export form validation.
_taxonomy_csv_export_check_options	Validate options of exported vocabulary.
_taxonomy_csv_form_export_default_values_submit	Restore recommended default values in the export form.
_taxonomy_csv_form_export_default_values_validate	Restore recommended default values in the export form. Empty validate hook.