globallink_webform_active_submissions.inc in GlobalLink Connect for Drupal 7.5

File

globallink_webform/globallink_webform_active_submissions.inc

<?php

/**
 * Builds forms on webform active submissions dashboard.
 *
 * @param string $type
 *   The type of task we are working on.
 *
 * @return array
 *   Array of forms for the webform active submissions dashboard.
 */
function globallink_webform_active_submissions($type) {
  $_SESSION['transpefect_webform_active_type'] = $type;
  $array = array();
  $array[] = drupal_get_form('globallink_webform_active_select_form');
  $array[] = drupal_get_form('globallink_webform_active_pager_form');
  $array[] = drupal_get_form('globallink_webform_active_form');
  return $array;
}

/**
 * Builds form to allow selection of specific webform submission by ID.
 */
function globallink_webform_active_select_form() {
  module_load_include('inc', 'globallink_webform', 'globallink_webform');
  $form = array();
  globallink_webform_get_pd_submission_status();
  $redirect_submission = isset($_GET['submission']) ? urldecode($_GET['submission']) : '';
  $selected_value = '';
  $options = globallink_webform_get_active_submission_names();
  if (empty($redirect_submission) && !empty($_SESSION['globallink_webform_selected_submission'])) {
    $selected_value = $_SESSION['globallink_webform_selected_submission'];
  }
  elseif (!empty($redirect_submission)) {
    $selected_value = array_search($redirect_submission, $options);
  }
  $form['#attributes']['class'][] = 'globallink-webform-active-select-form';
  $form['select_submission'] = array(
    '#type' => 'container',
    '#attributes' => array(
      'class' => array(
        'container-inline',
      ),
    ),
  );
  $form['select_submission']['submission'] = array(
    '#type' => 'select',
    '#title' => t('Active Submission Name:'),
    '#options' => $options,
    '#default_value' => $selected_value,
    '#attributes' => array(
      'class' => array(
        'globallink-webform-select-active-submission',
      ),
    ),
    '#field_suffix' => '&nbsp;&nbsp;&nbsp;&nbsp;',
  );
  $form['select_submission']['go'] = array(
    '#type' => 'submit',
    '#value' => t('Go'),
    '#attributes' => array(
      'style' => 'display: none;',
    ),
  );
  if ($selected_value != '') {
    $form['select_submission']['submit_cancel_submission'] = array(
      '#type' => 'submit',
      '#value' => t('Cancel Submission'),
    );
  }
  else {
    $form['select_submission']['br_markup'] = array(
      '#type' => 'markup',
      '#markup' => '<BR/><BR/>',
    );
  }
  return $form;
}

/**
 * Handles submission of active select form.
 */
function globallink_webform_active_select_form_submit($form, &$form_state) {
  if (isset($_GET['submission'])) {
    unset($_GET['submission']);
  }
  $op = isset($form_state['values']['op']) ? $form_state['values']['op'] : '';
  switch ($op) {
    case t('Go'):
      $_SESSION['globallink_webform_selected_submission'] = $form_state['values']['submission'];
      break;
    case t('Cancel Submission'):
      try {
        $selected_submission = $form_state['values']['submission'];
        $_SESSION['globallink_webform_selected_submission'] = '';
        globallink_webform_cancel_submission($selected_submission);
        $_SESSION['globallink_webform_globalLink_arr'] = array();
        drupal_set_message(t('Submission has been cancelled successfully.'));
      } catch (SoapFault $se) {
        watchdog('GlobalLink', 'SOAP Exception - %function - Code[%faultcode], Message[%faultstring]', array(
          '%function' => __FUNCTION__,
          '%faultcode' => $se->faultcode,
          '%faultstring' => $se->faultstring,
        ), WATCHDOG_ERROR);
        form_set_error('', t('Web Services Error: @faultcode - @faultstring', array(
          '@faultcode' => $se->faultcode,
          '@faultstring' => $se->faultstring,
        )));
      } catch (Exception $e) {
        watchdog('GlobalLink', 'Exception - %function - File[%file], Line[%line], Code[%code], Message[%message]', array(
          '%function' => __FUNCTION__,
          '%file' => $e
            ->getFile(),
          '%line' => $e
            ->getLine(),
          '%code' => $e
            ->getCode(),
          '%message' => $e
            ->getMessage(),
        ), WATCHDOG_ERROR);
        form_set_error('', t('Error: @message', array(
          '@message' => $e
            ->getMessage(),
        )));
      }
      break;
  }
}

/**
 * Builds form to add pagination to webform send dashboard.
 */
function globallink_webform_active_pager_form() {
  $form = array();
  $form['page_counter']['markup'] = array(
    '#type' => 'container',
    '#attributes' => array(
      'class' => array(
        'tpt-center',
      ),
    ),
  );
  $form['page_counter']['markup']['p_count'] = array(
    '#type' => 'textfield',
    '#size' => 5,
    '#default_value' => isset($_SESSION['globallink_webform_active_page_count']) ? $_SESSION['globallink_webform_active_page_count'][0] : TPT_PAGER_LIMIT,
    '#field_prefix' => t('Show') . '&nbsp;&nbsp;',
    '#field_suffix' => '&nbsp;&nbsp;' . t('records') . '&nbsp;&nbsp;&nbsp;&nbsp;',
    '#prefix' => '<div class="container-inline">',
  );
  $form['page_counter']['markup']['action'] = array(
    '#type' => 'submit',
    '#value' => t('Go'),
    '#suffix' => '</div>',
    '#limit_validation_errors' => array(),
    '#submit' => array(
      'globallink_webform_active_pager_form_submit',
    ),
    '#access' => TRUE,
  );
  return $form;
}

/**
 * Handles submission of pager form.
 */
function globallink_webform_active_pager_form_submit($form, &$form_state) {
  $op = $form_state['values']['op'];
  if ($op == t('Go')) {
    $page_count = $form_state['input']['p_count'];
    if (!is_numeric($page_count) || $page_count < 1) {
      form_set_error('', t('Invalid Page Count.'));
    }
    else {
      $_SESSION['globallink_webform_active_page_count'] = array(
        $page_count,
      );
      return;
    }
  }
}

/**
 * Builds form to show all active webform submissions.
 */
function globallink_webform_active_form() {
  module_load_include('inc', 'globallink', 'globallink');
  $form = array();
  $module_path = drupal_get_path('module', 'globallink');
  drupal_add_css($module_path . '/css/globallink.css');
  $redirect_submission = isset($_GET['submission']) ? urldecode($_GET['submission']) : '';
  $selected_value = '';
  if (empty($redirect_submission) && !empty($_SESSION['globallink_webform_selected_submission'])) {
    $selected_value = $_SESSION['globallink_webform_selected_submission'];
  }
  elseif (!empty($redirect_submission)) {
    $options = globallink_webform_get_active_submission_names();
    $selected_value = array_search($redirect_submission, $options);
  }
  $page_count = TPT_PAGER_LIMIT;
  if (isset($_SESSION['globallink_webform_active_page_count'])) {
    $page_count = $_SESSION['globallink_webform_active_page_count'][0];
  }
  $projects = globallink_get_pd_projects();
  $header = array(
    'submission' => array(
      'field' => 'submission',
      'data' => t('Submission Name'),
    ),
    'source' => array(
      'field' => 'source',
      'data' => t('Webform Source'),
    ),
    'project_code' => array(
      'field' => 'project_code',
      'data' => t('Project'),
    ),
    'source_name' => array(
      'field' => 'source_name',
      'data' => t('Source Language'),
    ),
    'target_name' => array(
      'field' => 'target_name',
      'data' => t('Target Language'),
    ),
    'status' => array(
      'field' => 'status',
      'data' => t('Status'),
    ),
    'timestamp' => array(
      'field' => 'timestamp',
      'data' => t('Last Updated'),
    ),
  );
  $query = db_select('globallink_core_webform', 'tc')
    ->extend('PagerDefault')
    ->limit($page_count)
    ->extend('TableSort')
    ->orderByHeader($header);
  $query
    ->condition('status', array(
    'Sent for Translations',
    'Error',
    'Cancelled',
  ), 'IN');
  if ($selected_value != '') {
    $query
      ->condition('submission_ticket', $selected_value, '=');
  }
  $query
    ->join('globallink_locale', 'tl1', 'tc.source = tl1.locale_code');
  $query
    ->join('globallink_locale', 'tl2', 'tc.target = tl2.locale_code');
  $query
    ->fields('tc');
  $query
    ->addField('tl1', 'drupal_locale_desc', 'source_name');
  $query
    ->addField('tl2', 'drupal_locale_desc', 'target_name');
  $results = $query
    ->execute();
  $count = 0;
  $rows = array();
  foreach ($results as $item) {
    $count++;
    $webform_info = globallink_load_source_data($item->object_id);
    $rows[$item->rid] = array(
      'submission' => $item->submission,
      'source' => $webform_info[0]->source,
      'project_code' => isset($projects[$item->project_code]) ? $projects[$item->project_code] : '',
      'source_name' => $item->source_name,
      'target_name' => $item->target_name,
      'status' => $item->status,
      'timestamp' => format_date($item->timestamp, 'custom', 'Y-m-d H:i:s'),
    );
  }
  $form['table'] = array(
    '#type' => 'tableselect',
    '#header' => $header,
    '#options' => $rows,
    '#empty' => t('No items available'),
  );
  $form['pager'] = array(
    '#markup' => theme('pager'),
  );
  if ($count > 0) {
    if (user_access(TPT_ROLE_MANAGE_TRANSLATIONS)) {
      $form['submit_cancel_document'] = array(
        '#type' => 'submit',
        '#value' => t('Cancel Selected Documents'),
      );
      $form['submit_clear_cancelled_documents'] = array(
        '#type' => 'submit',
        '#value' => t('Clear Cancelled Documents'),
      );
    }
  }
  return $form;
}

/**
 * Validates form actions for active webform submissions.
 */
function globallink_webform_active_form_validate($form, &$form_state) {
  $pd4 = globallink_get_project_director_details();
  globallink_validate_project_director_details($pd4);
  $op = isset($form_state['values']['op']) ? $form_state['values']['op'] : '';
  if ($op == t('Cancel Selected Documents')) {
    $rids = array_filter($form_state['values']['table']);
    if (!isset($rids) || empty($rids)) {
      form_set_error('', t('No items selected.'));
    }
  }
}

/**
 * Handles submission of active webform form.
 */
function globallink_webform_active_form_submit($form, &$form_state) {
  $op = isset($form_state['values']['op']) ? $form_state['values']['op'] : '';
  $pd4 = globallink_get_project_director_details();
  switch ($op) {
    case t('Cancel Selected Documents'):
      try {
        $rids_arr = array_filter($form_state['values']['table']);
        $rids = globallink_webform_check_status($rids_arr);
        if (count($rids) == 0) {
          drupal_set_message(t('No document(s) cancelled.'), 'warning', NULL);
          return;
        }
        $_SESSION['globallink_webform_selected_submission'] = '';
        globallink_webform_cancel_records($rids, $pd4);
        $_SESSION['globallink_webform_globalLink_arr'] = array();
        drupal_set_message(t('Selected document(s) has been cancelled successfully.'));
      } catch (SoapFault $se) {
        watchdog('GlobalLink', 'SOAP Exception - %function - Code[%faultcode], Message[%faultstring]', array(
          '%function' => __FUNCTION__,
          '%faultcode' => $se->faultcode,
          '%faultstring' => $se->faultstring,
        ), WATCHDOG_ERROR);
        form_set_error('', t('Web Services Error: @faultcode - @faultstring', array(
          '@faultcode' => $se->faultcode,
          '@faultstring' => $se->faultstring,
        )));
      } catch (Exception $e) {
        watchdog('GlobalLink', 'Exception - %function - File[%file], Line[%line], Code[%code], Message[%message]', array(
          '%function' => __FUNCTION__,
          '%file' => $e
            ->getFile(),
          '%line' => $e
            ->getLine(),
          '%code' => $e
            ->getCode(),
          '%message' => $e
            ->getMessage(),
        ), WATCHDOG_ERROR);
        form_set_error('', t('Error: @message', array(
          '@message' => $e
            ->getMessage(),
        )));
      }
      break;
    case t('Clear Cancelled Documents'):
      try {
        $count = globallink_webform_clear_cancelled_documents();
        $_SESSION['globallink_selected_submission'] = '';
        $_SESSION['globallink_globalLink_arr'] = array();
        if ($count > 0) {
          drupal_set_message(t('Cancelled document(s) has been cleared successfully.'));
        }
        else {
          drupal_set_message(t('No document(s) to clear.'), 'warning', NULL);
        }
      } catch (Exception $e) {
        watchdog('GlobalLink', 'Exception - %function - File[%file], Line[%line], Code[%code], Message[%message]', array(
          '%function' => __FUNCTION__,
          '%file' => $e
            ->getFile(),
          '%line' => $e
            ->getLine(),
          '%code' => $e
            ->getCode(),
          '%message' => $e
            ->getMessage(),
        ), WATCHDOG_ERROR);
        form_set_error('', t('Error: @message', array(
          '@message' => $e
            ->getMessage(),
        )));
      }
      break;
  }
}

Functions

Name	Description
globallink_webform_active_form	Builds form to show all active webform submissions.
globallink_webform_active_form_submit	Handles submission of active webform form.
globallink_webform_active_form_validate	Validates form actions for active webform submissions.
globallink_webform_active_pager_form	Builds form to add pagination to webform send dashboard.
globallink_webform_active_pager_form_submit	Handles submission of pager form.
globallink_webform_active_select_form	Builds form to allow selection of specific webform submission by ID.
globallink_webform_active_select_form_submit	Handles submission of active select form.
globallink_webform_active_submissions	Builds forms on webform active submissions dashboard.