<?php

/**
 * @file
 * File administration menu items.
 */

/**
 * Form step values.
 */
define('UC_FILE_FORM_FILES' , NULL);
define('UC_FILE_FORM_ACTION', 1   );

/**
 * Form builder for file products admin.
 *
 * @see uc_file_admin_files_form_show_files()
 * @see uc_file_admin_files_form_action()
 *
 * @ingroup forms
 */
function uc_file_admin_files_form($form, &$form_state) {

  if (isset($form_state['storage']['step']) && $form_state['storage']['step'] == UC_FILE_FORM_ACTION) {
    return array(
      '#validate' => array('uc_file_admin_files_form_action_validate'),
      '#submit'   => array('uc_file_admin_files_form_action_submit'),
    ) + $form + uc_file_admin_files_form_action($form, $form_state);
  }
  else {
    // Refresh our file list before display.
    uc_file_refresh();

    return array(
      '#theme'  => 'uc_file_admin_files_form_show',
      '#validate' => array('uc_file_admin_files_form_show_validate'),
      '#submit' => array('uc_file_admin_files_form_show_submit'),
    ) + $form + uc_file_admin_files_form_show_files($form, $form_state);
  }
}

/**
 * Displays all files that may be purchased and downloaded for administration.
 *
 * @see uc_file_admin_files_form()
 * @see uc_file_admin_files_form_show_validate()
 * @see uc_file_admin_files_form_show_submit()
 * @see theme_uc_file_admin_files_form_show()
 *
 * @ingroup forms
 */
function uc_file_admin_files_form_show_files($form, &$form_state) {
  $form['#tree'] = TRUE;

  $header = array(
    'filename' => array('data' => t('File'), 'field' => 'f.filename', 'sort' => 'asc'),
    'title' => array('data' => t('Product'), 'field' => 'n.title'),
    'model' => array('data' => t('SKU'), 'field' => 'fp.model'),
  );

  // Create pager.
  $query = db_select('uc_files', 'f')->extend('PagerDefault')->extend('TableSort')
    ->orderByHeader($header)
    ->limit(UC_FILE_PAGER_SIZE);
  $query->leftJoin('uc_file_products', 'fp', 'f.fid = fp.fid');
  $query->leftJoin('uc_product_features', 'pf', 'fp.pfid = pf.pfid');
  $query->leftJoin('node', 'n', 'pf.nid = n.nid');
  $query->addField('n', 'nid');
  $query->addField('f', 'filename');
  $query->addField('n', 'title');
  $query->addField('fp', 'model');
  $query->addField('f', 'fid');
  $query->addField('pf', 'pfid');

  $count_query = db_select('uc_files');
  $count_query->addExpression('COUNT(*)');

  $query->setCountQuery($count_query);
  $result = $query->execute();

  $options = array();
  foreach ($result as $file) {
    $options[$file->fid] = array(
      'filename' => array(
        'data' => check_plain($file->filename),
        'class' => is_dir(uc_file_qualify_file($file->filename)) ? array('uc-file-directory-view') : array(),
      ),
      'title' => l($file->title, 'node/' . $file->nid),
      'model' => check_plain($file->model),
    );
  }

  // Create checkboxes for each file.
  $form['file_select'] = array(
    '#type' => 'tableselect',
    '#header' => $header,
    '#options' => $options,
    '#empty' => t('No file downloads available.'),
  );

  $form['uc_file_action'] = array(
    '#type' => 'fieldset',
    '#title' => t('File options'),
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
  );

  // Set our default actions.
  $file_actions = array(
    'uc_file_upload' => t('Upload file'),
    'uc_file_delete' => t('Delete file(s)'),
  );

  // Check if any hook_uc_file_action('info', $args) are implemented.
  foreach (module_implements('uc_file_action') as $module) {
    $name = $module . '_uc_file_action';
    $result = $name('info', NULL);
    if (is_array($result)) {
      foreach ($result as $key => $action) {
        if ($key != 'uc_file_delete' && $key != 'uc_file_upload') {
          $file_actions[$key] = $action;
        }
      }
    }
  }

  $form['uc_file_action']['action'] = array(
    '#type' => 'select',
    '#title' => t('Action'),
    '#options' => $file_actions,
    '#prefix' => '<div class="duration">',
    '#suffix' => '</div>',
  );

  $form['uc_file_actions']['actions'] = array('#type' => 'actions');
  $form['uc_file_action']['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Perform action'),
    '#prefix' => '<div class="duration">',
    '#suffix' => '</div>',
  );

  return $form;
}

/**
 * Ensures at least one file is selected when deleting.
 *
 * @see uc_file_admin_files_form_show_files()
 * @see uc_file_admin_files_form_show_submit()
 */
function uc_file_admin_files_form_show_validate($form, &$form_state) {

  switch ($form_state['values']['uc_file_action']['action']) {

    case 'uc_file_delete':
      $file_ids = array();
      if (is_array($form_state['values']['file_select'])) {
        foreach ($form_state['values']['file_select'] as $fid => $value) {
          if ($value) {
            $file_ids[] = $fid;
          }
        }
      }

      if (count($file_ids) == 0) {
        form_set_error('', t('You must select at least one file to delete.'));
      }

      break;
  }

}

/**
 * Moves to the next step of the administration form.
 *
 * @see uc_file_admin_files_form_show_files()
 * @see uc_file_admin_files_form_show_validate()
 */
function uc_file_admin_files_form_show_submit($form, &$form_state) {
  // Increment the form step.
  $form_state['storage']['step'] = UC_FILE_FORM_ACTION;
  $form_state['rebuild'] = TRUE;
}

/**
 * Returns HTML for uc_file_admin_files_form_show().
 *
 * @param $variables
 *   An associative array containing:
 *   - form: A render element representing the form.
 *
 * @see uc_file_admin_files_form_show_files()
 *
 * @ingroup themeable
 */
function theme_uc_file_admin_files_form_show($variables) {
  $form = $variables['form'];

  // Render everything.
  $output = '<p>' . t('File downloads can be attached to any Ubercart product as a product feature. For security reasons the <a href="!download_url">file downloads directory</a> is separated from the Drupal <a href="!file_url">file system</a>. Below is the list of files (and their associated Ubercart products, if any) that can be used for file downloads.', array('!download_url' => url('admin/store/settings/products', array('query' => array('destination' => 'admin/store/products/files'))), '!file_url' => url('admin/config/media/file-system'))) . '</p>';
  $output .= drupal_render($form['uc_file_action']);
  $output .= drupal_render($form['file_select']);
  $output .= theme('pager');
  $output .= drupal_render_children($form);

  return $output;
}

/**
 * Performs file action (upload, delete, hooked in actions).
 *
 * @see uc_file_admin_files_form()
 * @see uc_file_admin_files_form_action_validate()
 * @see uc_file_admin_files_form_action_submit()
 *
 * @ingroup forms
 */
function uc_file_admin_files_form_action($form, &$form_state) {
  $file_ids = array_filter($form_state['values']['file_select']);

  $form['file_ids'] = array('#type' => 'value', '#value' => $file_ids);
  $form['action'] = array('#type' => 'value', '#value' => $form_state['values']['uc_file_action']['action']);

  $file_ids = _uc_file_sort_names(_uc_file_get_dir_file_ids($file_ids, FALSE));

  switch ($form_state['values']['uc_file_action']['action']) {

    case 'uc_file_delete':
      $affected_list = _uc_file_build_js_file_display($file_ids);

      $has_directory = FALSE;
      foreach ($file_ids as $file_id) {

        // Gather a list of user-selected filenames.
        $file = uc_file_get_by_id($file_id);
        $filename = $file->filename;
        $file_list[] = (substr($filename, -1) == "/") ? $filename . ' (' . t('directory') . ')' : $filename;

        // Determine if there are any directories in this list.
        $path = uc_file_qualify_file($filename);
        if (is_dir($path)) {
          $has_directory = TRUE;
        }
      }

      // Base files/dirs the user selected.
      $form['selected_files'] = array(
        '#theme' => 'item_list',
        '#items' => $file_list,
        '#attributes' => array(
          'class' => array('selected-file-name'),
        ),
      );

      $form = confirm_form(
        $form, t('Delete file(s)'),
        'admin/store/products/files',
        t('Deleting a file will remove all its associated file downloads and product features. Removing a directory will remove any files it contains and their associated file downloads and product features.'),
        t('Delete affected files'), t('Cancel')
      );

      // Don't even show the recursion checkbox unless we have any directories.
      if ($has_directory && $affected_list[TRUE] !== FALSE) {
        $form['recurse_directories'] = array(
          '#type' => 'checkbox',
          '#title' => t('Delete selected directories and their sub directories'),
        );

        // Default to FALSE. Although we have the JS behavior to update with the
        // state of the checkbox on load, this should improve the experience of
        // users who don't have JS enabled over not defaulting to any info.
        $form['affected_files'] = array(
          '#theme' => 'item_list',
          '#items' => $affected_list[FALSE],
          '#title' => t('Affected files'),
          '#attributes' => array(
            'class' => array('affected-file-name'),
          ),
        );
      }
      break;

    case 'uc_file_upload':
      // Calculate the maximum size of uploaded files in bytes.
      $post_max_size = ini_get('post_max_size');
      if (is_numeric($post_max_size)) {
        // Handle the case where 'post_max_size' has no suffix.
        // An explicit cast is needed because floats are not allowed.
        $max_bytes = (int) $post_max_size;
      }
      else {
        // Handle the case where 'post_max_size' has a suffix of
        // 'M', 'K', or 'G' (case insensitive).
        $max_bytes = (int) substr($post_max_size, 0, -1);
        $suffix = strtolower(substr($post_max_size, -1));
        switch ($suffix) {
          case 'k':
            $max_bytes *= 1024;
            break;

          case 'm':
            $max_bytes *= 1048576;
            break;

          case 'g':
            $max_bytes *= 1073741824;
            break;
        }
      }

      // Gather list of directories under the selected one(s).
      // '/' is always available.
      $directories = array('' => '/');
      $files = db_query("SELECT * FROM {uc_files}");
      foreach ($files as $file) {
        if (is_dir(variable_get('uc_file_base_dir', NULL) . "/" . $file->filename)) {
          $directories[$file->filename] = $file->filename;
        }
      }

      $form['upload_dir'] = array(
        '#type' => 'select',
        '#title' => t('Directory'),
        '#description' => t('The directory on the server where the file should be put. The default directory is the root of the file downloads directory.'),
        '#options' => $directories,
      );
      $form['upload'] = array(
        '#type' => 'file',
        '#title' => t('File'),
        // Deliberately concatenate the strings to preserve backwards
        // compatibility with existing translations.
        '#description' => t('The maximum file size that can be uploaded is %size bytes. You will need to use a different method to upload the file to the directory (e.g. (S)FTP, SCP) if your file exceeds this size. Files you upload using one of these alternate methods will be automatically detected.', array('%size' => number_format($max_bytes))) . ' ' . t("Note: A value of '0' means there is no size limit."),
      );

      $form['#attributes']['class'][] = 'foo';
      $form = confirm_form(
        $form, t('Upload file'),
        'admin/store/products/files',
        '',
        t('Upload file'), t('Cancel')
      );

      // Must add this after confirm_form, as it runs over $form['#attributes'].
      // Issue logged at https://www.drupal.org/node/319723.
      $form['#attributes']['enctype'] = 'multipart/form-data';
      break;

    default:
      // This action isn't handled by us, so check if any
      // hook_uc_file_action('form', $args) are implemented.
      foreach (module_implements('uc_file_action') as $module) {
        $name = $module . '_uc_file_action';
        $result = $name('form', array('action' => $form_state['values']['uc_file_action']['action'], 'file_ids' => $file_ids));
        $form = (is_array($result)) ? array_merge($form, $result) : $form;
      }
      break;
  }

  return $form;
}

/**
 * Validation handler for uc_file_admin_files_form_action().
 *
 * @see uc_file_admin_files_form_action()
 * @see uc_file_admin_files_form_action_submit()
 */
function uc_file_admin_files_form_action_validate($form, &$form_state) {

  switch ($form_state['values']['action']) {

    case 'uc_file_upload':

      // Upload the file and get its object.
      if ($temp_file = file_save_upload('upload', array('file_validate_extensions' => array()))) {

        // Check if any hook_uc_file_action('upload_validate', $args)
        // are implemented.
        foreach (module_implements('uc_file_action') as $module) {
          $name = $module . '_uc_file_action';
          $result = $name('upload_validate', array('file_object' => $temp_file, 'form_id' => $form_id, 'form_state' => $form_state));
        }

        // Save the uploaded file for later processing.
        $form_state['storage']['temp_file'] = $temp_file;
      }
      else {
        form_set_error('', t('An error occurred while uploading the file'));
      }

      break;

    default:
      // This action isn't handled by us, so check if any
      // hook_uc_file_action('validate', $args) are implemented.
      foreach (module_implements('uc_file_action') as $module) {
        $name = $module . '_uc_file_action';
        $result = $name('validate', array('form_id' => $form_id, 'form_state' => $form_state));
      }

      break;
  }
}

/**
 * Submit handler for uc_file_admin_files_form_action().
 *
 * @see uc_file_admin_files_form_action()
 */
function uc_file_admin_files_form_action_submit($form, &$form_state) {

  switch ($form_state['values']['action']) {

    case 'uc_file_delete':
      // File deletion status.
      $status = TRUE;

      // Delete the selected file(s), with recursion if selected.
      $status = uc_file_remove_by_id($form_state['values']['file_ids'], !empty($form_state['values']['recurse_directories'])) && $status;

      if ($status) {
        drupal_set_message(t('The selected file(s) have been deleted.'));
      }
      else {
        drupal_set_message(t('One or more files could not be deleted.'), 'warning');
      }
      break;

    case 'uc_file_upload':
      // Build the destination location. We start with the base directory,
      // then add any directory which was explicitly selected.
      $dir = variable_get('uc_file_base_dir', NULL) . '/';
      $dir = (is_null($form_state['values']['upload_dir'])) ? $dir : $dir . $form_state['values']['upload_dir'];
      if (is_dir($dir)) {

        // Retrieve our uploaded file.
        $file_object = $form_state['storage']['temp_file'];

        // Copy the file to its final location.
        if (copy($file_object->uri, $dir . '/' . $file_object->filename)) {

          // Check if any hook_uc_file_action('upload', $args) are implemented.
          foreach (module_implements('uc_file_action') as $module) {
            $name = $module . '_uc_file_action';
            $result = $name('upload', array('file_object' => $file_object, 'form_id' => $form_id, 'form_state' => $form_state));
          }

          // Update the file list.
          uc_file_refresh();

          drupal_set_message(t('The file %file has been uploaded to %dir', array('%file' => $file_object->filename, '%dir' => $dir)));
        }
        else {
          drupal_set_message(t('An error occurred while copying the file to %dir', array('%dir' => $dir)), 'error');
        }
      }
      else {
        drupal_set_message(t('Can not move file to %dir', array('%dir' => $dir)), 'error');
      }
      break;

    default:
      // This action isn't handled by us, so check if any
      // hook_uc_file_action('submit', $args) are implemented.
      foreach (module_implements('uc_file_action') as $module) {
        $name = $module . '_uc_file_action';
        $result = $name('submit', array('form_id' => $form_id, 'form_state' => $form_state));
      }
      break;
  }

  // Return to the original form state.
  $form_state['rebuild'] = FALSE;
  drupal_goto('admin/store/products/files');
}

/**
 * TODO: Replace with == operator?
 */
function _uc_file_display_arrays_equivalent($recur, $no_recur) {

  // Different sizes.
  if (count($recur) != count($no_recur)) {
    return FALSE;
  }

  // Check the elements.
  for ($i = 0; $i < count($recur); $i++) {
    if ($recur[$i] != $no_recur[$i]) {
      return FALSE;
    }
  }

  return TRUE;
}

/**
 * Shows all possible files in selectable list.
 */
function _uc_file_build_js_file_display($file_ids) {

  // Gather the files if recursion IS selected.
  // Get 'em all ready to be punched into the file list.
  $recursion_file_ids = _uc_file_sort_names(_uc_file_get_dir_file_ids($file_ids, TRUE));
  foreach ($recursion_file_ids as $file_id) {
    $file = uc_file_get_by_id($file_id);
    $recursion[] = '<li>' . $file->filename . '</li>';
  }

  // Gather the files if recursion ISN'T selected.
  // Get 'em all ready to be punched into the file list.
  $no_recursion_file_ids = $file_ids;
  foreach ($no_recursion_file_ids as $file_id) {
    $file = uc_file_get_by_id($file_id);
    $no_recursion[] = '<li>' . $file->filename . '</li>';
  }

  // We'll disable the recursion checkbox if they're equal.
  $equivalent = _uc_file_display_arrays_equivalent($recursion_file_ids, $no_recursion_file_ids);

  // The list to show if the recursion checkbox is $key.
  $result[TRUE] = $equivalent ? FALSE : $recursion;
  $result[FALSE] = $no_recursion;

  // Set up some JS to dynamically update the list based on the
  // recursion checkbox state.
  drupal_add_js('uc_file_list[false] = ' . drupal_json_encode('<li>' . implode('</li><li>', $no_recursion) . '</li>') . ';', 'inline');
  drupal_add_js('uc_file_list[true] = ' . drupal_json_encode('<li>' . implode('</li><li>', $recursion) . '</li>') . ';', 'inline');

  return $result;
}
