danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * This file includes helper functions for creating reports for webform.module
danielebarchiesi@0:  *
danielebarchiesi@0:  * @author Nathan Haug <nate@lullabot.com>
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: // All functions within this file need the webform.submissions.inc.
danielebarchiesi@0: module_load_include('inc', 'webform', 'includes/webform.submissions');
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Retrieve lists of submissions for a given webform.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_submissions($node, $user_filter, $pager_count) {
danielebarchiesi@0:   global $user;
danielebarchiesi@0: 
danielebarchiesi@0:   if (isset($_GET['results']) && is_numeric($_GET['results'])) {
danielebarchiesi@0:     $pager_count = $_GET['results'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $header = theme('webform_results_submissions_header', array('node' => $node));
danielebarchiesi@0:   if ($user_filter) {
danielebarchiesi@0:     if ($user->uid) {
danielebarchiesi@0:       drupal_set_title(t('Submissions for %user', array('%user' => $user->name)), PASS_THROUGH);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       drupal_set_title(t('Your submissions'));
danielebarchiesi@0:       webform_disable_page_cache();
danielebarchiesi@0:     }
danielebarchiesi@0:     webform_set_breadcrumb($node);
danielebarchiesi@0:     $submissions = webform_get_submissions(array('nid' => $node->nid, 'uid' => $user->uid), $header, $pager_count);
danielebarchiesi@0:     $count = webform_get_submission_count($node->nid, $user->uid);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $submissions = webform_get_submissions($node->nid, $header, $pager_count);
danielebarchiesi@0:     $count = webform_get_submission_count($node->nid);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $operation_column = end($header);
danielebarchiesi@0:   $operation_total = $operation_column['colspan'];
danielebarchiesi@0: 
danielebarchiesi@0:   $rows = array();
danielebarchiesi@0:   foreach ($submissions as $sid => $submission) {
danielebarchiesi@0:     $row = array(
danielebarchiesi@0:       $submission->is_draft ? t('@sid (draft)', array('@sid' => $sid)) : $sid,
danielebarchiesi@0:       format_date($submission->submitted, 'short'),
danielebarchiesi@0:     );
danielebarchiesi@0:     if (webform_results_access($node, $user)) {
danielebarchiesi@0:       $row[] = theme('username', array('account' => $submission));
danielebarchiesi@0:       $row[] = $submission->remote_addr;
danielebarchiesi@0:     }
danielebarchiesi@0:     $row[] = l(t('View'), "node/$node->nid/submission/$sid");
danielebarchiesi@0:     $operation_count = 1;
danielebarchiesi@0:     // No need to call this multiple times, just reference this in a variable.
danielebarchiesi@0:     $destination = drupal_get_destination();
danielebarchiesi@0:     if (webform_submission_access($node, $submission, 'edit', $user)) {
danielebarchiesi@0:       $row[] = l(t('Edit'), "node/$node->nid/submission/$sid/edit", array('query' => $destination));
danielebarchiesi@0:       $operation_count++;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (webform_submission_access($node, $submission, 'delete', $user)) {
danielebarchiesi@0:       $row[] = l(t('Delete'), "node/$node->nid/submission/$sid/delete", array('query' => $destination));
danielebarchiesi@0:       $operation_count++;
danielebarchiesi@0:     }
danielebarchiesi@0:     if ($operation_count < $operation_total) {
danielebarchiesi@0:       $row[count($row) - 1] = array('data' => $row[count($row) - 1], 'colspan' => $operation_total - $operation_count + 1);
danielebarchiesi@0:     }
danielebarchiesi@0:     $rows[] = $row;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $element['#theme'] = 'webform_results_submissions';
danielebarchiesi@0:   $element['#node'] = $node;
danielebarchiesi@0:   $element['#submissions'] = $submissions;
danielebarchiesi@0:   $element['#total_count'] = $count;
danielebarchiesi@0:   $element['#pager_count'] = $pager_count;
danielebarchiesi@0:   $element['#attached']['library'][] = array('webform', 'admin');
danielebarchiesi@0: 
danielebarchiesi@0:   $element['table']['#theme'] = 'table';
danielebarchiesi@0:   $element['table']['#header'] = $header;
danielebarchiesi@0:   $element['table']['#rows'] = $rows;
danielebarchiesi@0:   $element['table']['#operation_total'] = $operation_total;
danielebarchiesi@0: 
danielebarchiesi@0:   return drupal_render($element);
danielebarchiesi@0: 
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Theme the list of links for selecting the number of results per page.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $total_count
danielebarchiesi@0:  *   The total number of results available.
danielebarchiesi@0:  * @param $pager_count
danielebarchiesi@0:  *   The current number of results displayed per page.
danielebarchiesi@0:  */
danielebarchiesi@0: function theme_webform_results_per_page($variables) {
danielebarchiesi@0:   $total_count = $variables['total_count'];
danielebarchiesi@0:   $pager_count = $variables['pager_count'];
danielebarchiesi@0:   $output = '';
danielebarchiesi@0: 
danielebarchiesi@0:   // Create a list of results-per-page options.
danielebarchiesi@0:   $counts = array(
danielebarchiesi@0:     '20' => '20',
danielebarchiesi@0:     '50' => '50',
danielebarchiesi@0:     '100' => '100',
danielebarchiesi@0:     '200' => '200',
danielebarchiesi@0:     '500' => '500',
danielebarchiesi@0:     '1000' => '1000',
danielebarchiesi@0:     '0' => t('All'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $count_links = array();
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($counts as $number => $text) {
danielebarchiesi@0:     if ($number < $total_count) {
danielebarchiesi@0:       $count_links[] = l($text, $_GET['q'], array('query' => array('results' => $number), 'attributes' => array('class' => array($pager_count == $number ? 'selected' : ''))));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $output .= '<div class="webform-results-per-page">';
danielebarchiesi@0:   if (count($count_links) > 1) {
danielebarchiesi@0:     $output .= t('Show !count results per page.', array('!count' => implode(' | ', $count_links)));
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $output .= t('Showing all results.');
danielebarchiesi@0:   }
danielebarchiesi@0:   if ($total_count > 1) {
danielebarchiesi@0:     $output .= ' ' . t('@total results total.', array('@total' => $total_count));
danielebarchiesi@0:   }
danielebarchiesi@0:   $output .= '</div>';
danielebarchiesi@0: 
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Theme the header of the submissions table.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This is done in it's own function so that webform can retrieve the header and
danielebarchiesi@0:  * use it for sorting the results.
danielebarchiesi@0:  */
danielebarchiesi@0: function theme_webform_results_submissions_header($variables) {
danielebarchiesi@0:   $node = $variables['node'];
danielebarchiesi@0: 
danielebarchiesi@0:   $columns = array(
danielebarchiesi@0:     array('data' => t('#'), 'field' => 'sid', 'sort' => 'desc'),
danielebarchiesi@0:     array('data' => t('Submitted'), 'field' => 'submitted'),
danielebarchiesi@0:   );
danielebarchiesi@0:   if (webform_results_access($node)) {
danielebarchiesi@0:     $columns[] = array('data' => t('User'), 'field' => 'name');
danielebarchiesi@0:     $columns[] = array('data' => t('IP Address'), 'field' => 'remote_addr');
danielebarchiesi@0:   }
danielebarchiesi@0:   $columns[] = array('data' => t('Operations'), 'colspan' => module_exists('print') ? 5 : 3);
danielebarchiesi@0: 
danielebarchiesi@0:   return $columns;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Preprocess function for webform-results-submissions.tpl.php
danielebarchiesi@0:  */
danielebarchiesi@0: function template_preprocess_webform_results_submissions(&$vars) {
danielebarchiesi@0:   $vars['node'] = $vars['element']['#node'];
danielebarchiesi@0:   $vars['submissions'] = $vars['element']['#submissions'];
danielebarchiesi@0:   $vars['table'] = $vars['element']['table'];
danielebarchiesi@0:   $vars['total_count'] = $vars['element']['#total_count'];
danielebarchiesi@0:   $vars['pager_count'] = $vars['element']['#pager_count'];
danielebarchiesi@0:   $vars['is_submissions'] = (arg(2) == 'submissions')? 1 : 0;
danielebarchiesi@0: 
danielebarchiesi@0:   unset($vars['element']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create a table containing all submitted values for a webform node.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_table($node, $pager_count = 0) {
danielebarchiesi@0:   if (isset($_GET['results']) && is_numeric($_GET['results'])) {
danielebarchiesi@0:     $pager_count = $_GET['results'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Get all the submissions for the node.
danielebarchiesi@0:   $header = theme('webform_results_table_header', array('node' => $node));
danielebarchiesi@0:   $submissions = webform_get_submissions($node->nid, $header, $pager_count);
danielebarchiesi@0:   $total_count = webform_get_submission_count($node->nid);
danielebarchiesi@0: 
danielebarchiesi@0:   $output = theme('webform_results_table', array('node' => $node, 'components' => $node->webform['components'], 'submissions' => $submissions, 'total_count' => $total_count, 'pager_count' => $pager_count));
danielebarchiesi@0:   if ($pager_count) {
danielebarchiesi@0:     $output .= theme('pager');
danielebarchiesi@0:   }
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function theme_webform_results_table_header($variables) {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     array('data' => t('#'), 'field' => 'sid', 'sort' => 'desc'),
danielebarchiesi@0:     array('data' => t('Submitted'), 'field' => 'submitted'),
danielebarchiesi@0:     array('data' => t('User'), 'field' => 'name'),
danielebarchiesi@0:     array('data' => t('IP Address'), 'field' => 'remote_addr'),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Theme the results table displaying all the submissions for a particular node.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $node
danielebarchiesi@0:  *   The node whose results are being displayed.
danielebarchiesi@0:  * @param $components
danielebarchiesi@0:  *   An associative array of the components for this webform.
danielebarchiesi@0:  * @param $submissions
danielebarchiesi@0:  *   An array of all submissions for this webform.
danielebarchiesi@0:  * @param $total_count
danielebarchiesi@0:  *   The total number of submissions to this webform.
danielebarchiesi@0:  * @param $pager_count
danielebarchiesi@0:  *   The number of results to be shown per page.
danielebarchiesi@0:  */
danielebarchiesi@0: function theme_webform_results_table($variables) {
danielebarchiesi@0:   drupal_add_library('webform', 'admin');
danielebarchiesi@0: 
danielebarchiesi@0:   $node = $variables['node'];
danielebarchiesi@0:   $components = $variables['components'];
danielebarchiesi@0:   $submissions = $variables['submissions'];
danielebarchiesi@0:   $total_count = $variables['total_count'];
danielebarchiesi@0:   $pager_count = $variables['pager_count'];
danielebarchiesi@0: 
danielebarchiesi@0:   $header = array();
danielebarchiesi@0:   $rows = array();
danielebarchiesi@0:   $cell = array();
danielebarchiesi@0: 
danielebarchiesi@0:   // This header has to be generated separately so we can add the SQL necessary.
danielebarchiesi@0:   // to sort the results.
danielebarchiesi@0:   $header = theme('webform_results_table_header', array('node' => $node));
danielebarchiesi@0: 
danielebarchiesi@0:   // Generate a row for each submission.
danielebarchiesi@0:   foreach ($submissions as $sid => $submission) {
danielebarchiesi@0:     $cell[] = l($sid, 'node/' . $node->nid . '/submission/' . $sid);
danielebarchiesi@0:     $cell[] = format_date($submission->submitted, 'short');
danielebarchiesi@0:     $cell[] = theme('username', array('account' => $submission));
danielebarchiesi@0:     $cell[] = $submission->remote_addr;
danielebarchiesi@0:     $component_headers = array();
danielebarchiesi@0: 
danielebarchiesi@0:     // Generate a cell for each component.
danielebarchiesi@0:     foreach ($node->webform['components'] as $component) {
danielebarchiesi@0:       $data = isset($submission->data[$component['cid']]['value']) ? $submission->data[$component['cid']]['value'] : NULL;
danielebarchiesi@0:       $submission_output = webform_component_invoke($component['type'], 'table', $component, $data);
danielebarchiesi@0:       if ($submission_output !== NULL) {
danielebarchiesi@0:         $component_headers[] = check_plain($component['name']);
danielebarchiesi@0:         $cell[] = $submission_output;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $rows[] = $cell;
danielebarchiesi@0:     unset($cell);
danielebarchiesi@0:   }
danielebarchiesi@0:   if (!empty($component_headers)) {
danielebarchiesi@0:     $header = array_merge($header, $component_headers);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (count($rows) == 0) {
danielebarchiesi@0:     $rows[] = array(array('data' => t('There are no submissions for this form. <a href="!url">View this form</a>.', array('!url' => url('node/' . $node->nid))), 'colspan' => 4));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0: 
danielebarchiesi@0:   $output = '';
danielebarchiesi@0:   $output .= theme('webform_results_per_page', array('total_count' => $total_count, 'pager_count' => $pager_count));
danielebarchiesi@0:   $output .= theme('table', array('header' => $header, 'rows' => $rows));
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Delete all submissions for a node.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $nid
danielebarchiesi@0:  *   The node id whose submissions will be deleted.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_clear($nid) {
danielebarchiesi@0:   $node = node_load($nid);
danielebarchiesi@0:   $submissions = webform_get_submissions($nid);
danielebarchiesi@0:   foreach ($submissions as $submission) {
danielebarchiesi@0:     webform_submission_delete($node, $submission);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Confirmation form to delete all submissions for a node.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $nid
danielebarchiesi@0:  *   ID of node for which to clear submissions.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_clear_form($form, $form_state, $node) {
danielebarchiesi@0:   drupal_set_title(t('Clear Form Submissions'));
danielebarchiesi@0: 
danielebarchiesi@0:   $form = array();
danielebarchiesi@0:   $form['nid'] = array('#type' => 'value', '#value' => $node->nid);
danielebarchiesi@0:   $question = t('Are you sure you want to delete all submissions for this form?');
danielebarchiesi@0: 
danielebarchiesi@0:   return confirm_form($form, $question, 'node/' . $node->nid . '/webform-results', NULL, t('Clear'), t('Cancel'));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function webform_results_clear_form_submit($form, &$form_state) {
danielebarchiesi@0:   webform_results_clear($form_state['values']['nid']);
danielebarchiesi@0:   $node = node_load($form_state['values']['nid']);
danielebarchiesi@0:   $title = $node->title;
danielebarchiesi@0:   $message = t('Webform %title entries cleared.', array('%title' => $title));
danielebarchiesi@0:   drupal_set_message($message);
danielebarchiesi@0:   watchdog('webform', $message);
danielebarchiesi@0:   $form_state['redirect'] = 'node/' . $form_state['values']['nid'] . '/webform-results';
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Form to configure the download of CSV files.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_download_form($form, &$form_state, $node) {
danielebarchiesi@0:   module_load_include('inc', 'webform', 'includes/webform.export');
danielebarchiesi@0:   module_load_include('inc', 'webform', 'includes/webform.components');
danielebarchiesi@0: 
danielebarchiesi@0:   $form = array();
danielebarchiesi@0: 
danielebarchiesi@0:   $form['node'] = array(
danielebarchiesi@0:     '#type' => 'value',
danielebarchiesi@0:     '#value' => $node,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['format'] = array(
danielebarchiesi@0:     '#type' => 'radios',
danielebarchiesi@0:     '#title' => t('Export format'),
danielebarchiesi@0:     '#options' => webform_export_list(),
danielebarchiesi@0:     '#default_value' => isset($form_state['values']['format']) ? $form_state['values']['format'] : variable_get('webform_export_format', 'delimited'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['delimiter'] = array(
danielebarchiesi@0:     '#type' => 'select',
danielebarchiesi@0:     '#title' => t('Delimited text format'),
danielebarchiesi@0:     '#description' => t('This is the delimiter used in the CSV/TSV file when downloading Webform results. Using tabs in the export is the most reliable method for preserving non-latin characters. You may want to change this to another character depending on the program with which you anticipate importing results.'),
danielebarchiesi@0:     '#default_value' => isset($form_state['values']['delimiter']) ? $form_state['values']['delimiter'] : variable_get('webform_csv_delimiter', '\t'),
danielebarchiesi@0:     '#options' => array(
danielebarchiesi@0:       ','  => t('Comma (,)'),
danielebarchiesi@0:       '\t' => t('Tab (\t)'),
danielebarchiesi@0:       ';'  => t('Semicolon (;)'),
danielebarchiesi@0:       ':'  => t('Colon (:)'),
danielebarchiesi@0:       '|'  => t('Pipe (|)'),
danielebarchiesi@0:       '.'  => t('Period (.)'),
danielebarchiesi@0:       ' '  => t('Space ( )'),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['select_options'] = array(
danielebarchiesi@0:     '#type' => 'fieldset',
danielebarchiesi@0:     '#title' => t('Select list options'),
danielebarchiesi@0:     '#collapsible' => TRUE,
danielebarchiesi@0:     '#collapsed' => TRUE,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['select_options']['select_keys'] = array(
danielebarchiesi@0:     '#type' => 'radios',
danielebarchiesi@0:     '#title' => t('Select keys'),
danielebarchiesi@0:     '#options' => array(
danielebarchiesi@0:       0 => t('Full, human-readable options (values)'),
danielebarchiesi@0:       1 => t('Short, raw options (keys)'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     '#default_value' => isset($form_state['values']['select_options']['select_keys']) ? $form_state['values']['select_options']['select_keys'] : 0,
danielebarchiesi@0:     '#description' => t('Choose which part of options should be displayed from key|value pairs.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['select_options']['select_format'] = array(
danielebarchiesi@0:     '#type' => 'radios',
danielebarchiesi@0:     '#title' => t('Select list format'),
danielebarchiesi@0:     '#options' => array(
danielebarchiesi@0:       'separate' => t('Separate'),
danielebarchiesi@0:       'compact' => t('Compact'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     '#default_value' => isset($form_state['values']['select_options']['select_format']) ? $form_state['values']['select_options']['select_format'] : 'separate',
danielebarchiesi@0:     '#attributes' => array('class' => array('webform-select-list-format')),
danielebarchiesi@0:     '#theme' => 'webform_results_download_select_format',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $csv_components = array(
danielebarchiesi@0:     'info' => t('Submission information'),
danielebarchiesi@0:     'serial' => '-' . t('Submission Number'),
danielebarchiesi@0:     'sid' => '-' . t('Submission ID'),
danielebarchiesi@0:     'time' => '-' . t('Time'),
danielebarchiesi@0:     'draft' => '-' . t('Draft'),
danielebarchiesi@0:     'ip_address' => '-' . t('IP Address'),
danielebarchiesi@0:     'uid' => '-' . t('User ID'),
danielebarchiesi@0:     'username' => '-' . t('Username'),
danielebarchiesi@0:   );
danielebarchiesi@0:   $csv_components += webform_component_list($node, 'csv', TRUE);
danielebarchiesi@0: 
danielebarchiesi@0:   $form['components'] = array(
danielebarchiesi@0:     '#type' => 'select',
danielebarchiesi@0:     '#title' => t('Included export components'),
danielebarchiesi@0:     '#options' => $csv_components,
danielebarchiesi@0:     '#default_value' => isset($form_state['values']['components']) ? $form_state['values']['components'] : array_keys($csv_components),
danielebarchiesi@0:     '#multiple' => TRUE,
danielebarchiesi@0:     '#size' => 10,
danielebarchiesi@0:     '#description' => t('The selected components will be included in the export.'),
danielebarchiesi@0:     '#process' => array('webform_component_select'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['range'] = array(
danielebarchiesi@0:     '#type' => 'fieldset',
danielebarchiesi@0:     '#title' => t('Download range options'),
danielebarchiesi@0:     '#collapsible' => TRUE,
danielebarchiesi@0:     '#collapsed' => TRUE,
danielebarchiesi@0:     '#tree' => TRUE,
danielebarchiesi@0:     '#theme' => 'webform_results_download_range',
danielebarchiesi@0:     '#element_validate' => array('webform_results_download_range_validate'),
danielebarchiesi@0:     '#after_build' => array('webform_results_download_range_after_build'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['range']['range_type'] = array(
danielebarchiesi@0:     '#type' => 'radios',
danielebarchiesi@0:     '#options' => array(
danielebarchiesi@0:       'all' => t('All submissions'),
danielebarchiesi@0:       'new' => t('Only new submissions since your last download'),
danielebarchiesi@0:       'latest' => t('Only the latest'),
danielebarchiesi@0:       'range' => t('All submissions starting from'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     '#default_value' => 'all',
danielebarchiesi@0:   );
danielebarchiesi@0:   $form['range']['latest'] = array(
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#size' => 5,
danielebarchiesi@0:     '#maxlength' => 8,
danielebarchiesi@0:     '#default_value' => isset($form_state['values']['latest']) ? $form_state['values']['latest'] : '',
danielebarchiesi@0:   );
danielebarchiesi@0:   $form['range']['start'] = array(
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#size' => 5,
danielebarchiesi@0:     '#maxlength' => 8,
danielebarchiesi@0:     '#default_value' => '',
danielebarchiesi@0:   );
danielebarchiesi@0:   $form['range']['end'] = array(
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#size' => 5,
danielebarchiesi@0:     '#maxlength' => 8,
danielebarchiesi@0:     '#default_value' => '',
danielebarchiesi@0:     '#description' => '',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // By default results are downloaded. User can override this value if
danielebarchiesi@0:   // programmatically submitting this form.
danielebarchiesi@0:   $form['download'] = array(
danielebarchiesi@0:     '#type' => 'value',
danielebarchiesi@0:     '#default_value' => TRUE
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['actions'] = array('#type' => 'actions');
danielebarchiesi@0:   $form['actions']['submit'] = array(
danielebarchiesi@0:     '#type' => 'submit',
danielebarchiesi@0:     '#value' => t('Download'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * FormAPI element validate function for the range fieldset.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_download_range_validate($element, $form_state) {
danielebarchiesi@0:   switch ($element['range_type']['#value']) {
danielebarchiesi@0:     case 'latest':
danielebarchiesi@0:       // Download latest x submissions.
danielebarchiesi@0:       if ($element['latest']['#value'] == '') {
danielebarchiesi@0:         form_error($element['latest'], t('Latest number of submissions field is required.'));
danielebarchiesi@0:       }
danielebarchiesi@0:       else{
danielebarchiesi@0:         if (!is_numeric($element['latest']['#value'])) {
danielebarchiesi@0:           form_error($element['latest'], t('Latest number of submissions must be numeric.'));
danielebarchiesi@0:         }
danielebarchiesi@0:         else{
danielebarchiesi@0:           if ($element['latest']['#value'] <= 0) {
danielebarchiesi@0:             form_error($element['latest'], t('Latest number of submissions must be greater than 0.'));
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       break;
danielebarchiesi@0:     case 'range':
danielebarchiesi@0:       // Download Start-End range of submissions.
danielebarchiesi@0:       // Start submission number.
danielebarchiesi@0:       if ($element['start']['#value'] == '') {
danielebarchiesi@0:         form_error($element['start'], t('Start submission number is required.'));
danielebarchiesi@0:       }
danielebarchiesi@0:       else{
danielebarchiesi@0:         if (!is_numeric($element['start']['#value'])) {
danielebarchiesi@0:           form_error($element['start'], t('Start submission number must be numeric.'));
danielebarchiesi@0:         }
danielebarchiesi@0:         else{
danielebarchiesi@0:           if ($element['start']['#value'] <= 0) {
danielebarchiesi@0:             form_error($element['start'], t('Start submission number must be greater than 0.'));
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       // End submission number.
danielebarchiesi@0:       if ($element['end']['#value'] != '') {
danielebarchiesi@0:         if (!is_numeric($element['end']['#value'])) {
danielebarchiesi@0:           form_error($element['end'], t('End submission number must be numeric.'));
danielebarchiesi@0:         }
danielebarchiesi@0:         else{
danielebarchiesi@0:           if ($element['end']['#value'] <= 0) {
danielebarchiesi@0:             form_error($element['end'], t('End submission number must be greater than 0.'));
danielebarchiesi@0:           }
danielebarchiesi@0:           else{
danielebarchiesi@0:             if ($element['end']['#value'] < $element['start']['#value']) {
danielebarchiesi@0:               form_error($element['end'], t('End submission number may not be less than Start submission number.'));
danielebarchiesi@0:             }
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       break;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Validate handler for webform_results_download_form().
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_download_form_submit(&$form, &$form_state) {
danielebarchiesi@0:   $options = array(
danielebarchiesi@0:     'delimiter' => $form_state['values']['delimiter'],
danielebarchiesi@0:     'components' => array_keys(array_filter($form_state['values']['components'])),
danielebarchiesi@0:     'select_keys' => $form_state['values']['select_keys'],
danielebarchiesi@0:     'select_format' => $form_state['values']['select_format'],
danielebarchiesi@0:     'range_type' => $form_state['values']['range']['range_type'],
danielebarchiesi@0:     'download' => $form_state['values']['download'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Retrieve the list of required SIDs.
danielebarchiesi@0:   if ($options['range_type'] != 'all') {
danielebarchiesi@0:     $options['sids'] = webform_download_sids($form_state['values']['node']->nid, $form_state['values']['range']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $export_info = webform_results_export($form_state['values']['node'], $form_state['values']['format'], $options);
danielebarchiesi@0: 
danielebarchiesi@0:   // If webform result file should be downloaded, send the file to the browser,
danielebarchiesi@0:   // otherwise save information about the created file in $form_state.
danielebarchiesi@0:   if ($options['download']) {
danielebarchiesi@0:     webform_results_download($form_state['values']['node'], $export_info);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $form_state['export_info'] = $export_info;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * FormAPI after build function for the download range fieldset.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_download_range_after_build($element, &$form_state) {
danielebarchiesi@0:   $node = $form_state['values']['node'];
danielebarchiesi@0: 
danielebarchiesi@0:   // Build a list of counts of new and total submissions.
danielebarchiesi@0:   $count = webform_get_submission_count($node->nid);
danielebarchiesi@0:   $sids = webform_download_sids($node->nid, array('range_type' => 'new'));
danielebarchiesi@0: 
danielebarchiesi@0:   $last_download = webform_download_last_download_info($node->nid);
danielebarchiesi@0: 
danielebarchiesi@0:   $element['#webform_download_info']['sid'] = $last_download ? $last_download['sid'] : 0;
danielebarchiesi@0:   $element['#webform_download_info']['requested'] = $last_download ? $last_download['requested'] : $node->created;
danielebarchiesi@0:   $element['#webform_download_info']['total'] = $count;
danielebarchiesi@0:   $element['#webform_download_info']['new'] = count($sids);
danielebarchiesi@0: 
danielebarchiesi@0:   return $element;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Theme the output of the export range fieldset.
danielebarchiesi@0:  */
danielebarchiesi@0: function theme_webform_results_download_range($variables) {
danielebarchiesi@0:   drupal_add_library('webform', 'admin');
danielebarchiesi@0: 
danielebarchiesi@0:   $element = $variables['element'];
danielebarchiesi@0:   $download_info = $element['#webform_download_info'];
danielebarchiesi@0: 
danielebarchiesi@0:   // Set description for total of all submissions.
danielebarchiesi@0:   $element['range_type']['all']['#theme_wrappers'] = array('webform_inline_radio');
danielebarchiesi@0:   $element['range_type']['all']['#description'] = '(' . t('@count total', array('@count' => $download_info['total'])) . ')';
danielebarchiesi@0: 
danielebarchiesi@0:   // Set description for "New submissions since last download".
danielebarchiesi@0:   $format = webform_date_format('short');
danielebarchiesi@0:   $requested_date = format_date($download_info['requested'], 'custom', $format);
danielebarchiesi@0:   $element['range_type']['new']['#theme_wrappers'] = array('webform_inline_radio');
danielebarchiesi@0:   $element['range_type']['new']['#description'] = '(' . t('@count new since @date', array('@count' => $download_info['new'], '@date' => $requested_date)) . ')';
danielebarchiesi@0: 
danielebarchiesi@0: 
danielebarchiesi@0:   // Disable option if there are no new submissions.
danielebarchiesi@0:   if ($download_info['new'] == 0) {
danielebarchiesi@0:     $element['range_type']['new']['#attributes']['disabled'] = 'disabled';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Render latest x submissions option.
danielebarchiesi@0:   $element['latest']['#attributes']['class'] = array('webform-set-active');
danielebarchiesi@0:   $element['range_type']['latest']['#theme_wrappers'] = array('webform_inline_radio');
danielebarchiesi@0:   $element['range_type']['latest']['#inline_element'] = t('Only the latest !number submissions', array('!number' => drupal_render($element['latest'])));
danielebarchiesi@0:   $element['range_type']['latest']['#title'] = NULL;
danielebarchiesi@0: 
danielebarchiesi@0:   // Render Start-End submissions option.
danielebarchiesi@0:   $element['start']['#attributes']['class'] = array('webform-set-active');
danielebarchiesi@0:   $element['end']['#attributes']['class'] = array('webform-set-active');
danielebarchiesi@0:   $element['range_type']['range']['#theme_wrappers'] = array('webform_inline_radio');
danielebarchiesi@0:   $element['range_type']['range']['#inline_element'] = t('All submissions starting from: !start and optionally to: !end', array('!start' => drupal_render($element['start']), '!end' => drupal_render($element['end'])));
danielebarchiesi@0:   $element['range_type']['range']['#title'] = NULL;
danielebarchiesi@0: 
danielebarchiesi@0:   $last_sid = $download_info['sid'] ? $download_info['sid'] : drupal_placeholder(t('none'));
danielebarchiesi@0:   $element['range_type']['range']['#description'] = '(' . t('Use submission IDs for the range. Last downloaded end SID: !sid.', array('!sid' => $last_sid)) . ')';
danielebarchiesi@0: 
danielebarchiesi@0:   return drupal_render_children($element);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Theme the output of the select list format radio buttons.
danielebarchiesi@0:  */
danielebarchiesi@0: function theme_webform_results_download_select_format($variables) {
danielebarchiesi@0:   drupal_add_library('webform', 'admin');
danielebarchiesi@0: 
danielebarchiesi@0:   $element = $variables['element'];
danielebarchiesi@0:   $output = '';
danielebarchiesi@0: 
danielebarchiesi@0:   // Build an example table for the separate option.
danielebarchiesi@0:   $header = array(t('Option A'), t('Option B'), t('Option C'));
danielebarchiesi@0:   $rows = array(
danielebarchiesi@0:     array('X', '', ''),
danielebarchiesi@0:     array('X', '', 'X'),
danielebarchiesi@0:     array('', 'X', 'X'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $element['separate']['#attributes']['class'] = array();
danielebarchiesi@0:   $element['separate']['#description'] = theme('table', array('header' => $header, 'rows' => $rows));
danielebarchiesi@0:   $element['separate']['#description'] .= t('Separate options are more suitable for building reports, graphs, and statistics in a spreadsheet application.');
danielebarchiesi@0:   $output .= drupal_render($element['separate']);
danielebarchiesi@0: 
danielebarchiesi@0:   // Build an example table for the compact option.
danielebarchiesi@0:   $header = array(t('My select list'));
danielebarchiesi@0:   $rows = array(
danielebarchiesi@0:     array('Option A'),
danielebarchiesi@0:     array('Option A,Option C'),
danielebarchiesi@0:     array('Option B,Option C'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $element['compact']['#attributes']['class'] = array();
danielebarchiesi@0:   $element['compact']['#description'] = theme('table', array('header' => $header, 'rows' => $rows));
danielebarchiesi@0:   $element['compact']['#description'] .= t('Compact options are more suitable for importing data into other systems.');
danielebarchiesi@0:   $output .= drupal_render($element['compact']);
danielebarchiesi@0: 
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Generate a Excel-readable CSV file containing all submissions for a Webform.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The CSV requires that the data be presented in a flat file.  In order
danielebarchiesi@0:  * to maximize usability to the Excel community and minimize subsequent
danielebarchiesi@0:  * stats or spreadsheet programming this program extracts data from the
danielebarchiesi@0:  * various records for a given session and presents them as a single file
danielebarchiesi@0:  * where each row represents a single record.
danielebarchiesi@0:  * The structure of the file is:
danielebarchiesi@0:  *   Heading Line 1: Gives group overviews padded by empty cells to the
danielebarchiesi@0:  *                   next group.  A group may be a question and corresponds
danielebarchiesi@0:  *                   to a component in the webform philosophy. Each group
danielebarchiesi@0:  *                   overview will have a fixed number of columns beneath it.
danielebarchiesi@0:  *   Heading line 2: gives column headings
danielebarchiesi@0:  *   Data line 1 .....
danielebarchiesi@0:  *   Data line 2 .....
danielebarchiesi@0:  *
danielebarchiesi@0:  * An example of this format is given below.  Note the columns have had spaces
danielebarchiesi@0:  * added so the columns line up.  This is not the case with actual file where
danielebarchiesi@0:  * a column may be null.  Note also, that multiple choice questions as produced
danielebarchiesi@0:  * by checkboxes or radio buttons have been presented as "yes" or "no" and the
danielebarchiesi@0:  * actual choice text is retained only in the header line 2.
danielebarchiesi@0:  * Data from text boxes and input fields are written out in the body of the table.
danielebarchiesi@0:  *
danielebarchiesi@0:  *   Submission Details,    ,   ,      ,Question 1,        ,        ,..,        ,Question 2,        ,        ,..,        ,Question n
danielebarchiesi@0:  *   timestamp         ,time,SID,userid,Choice 1  ,Choice 2,Choice 3,..,Choice n,Choice 1  ,Choice 2,Choice 3,..,Choice n,Comment
danielebarchiesi@0:  *   21 Feb 2005       ,1835,23 ,34    ,X         ,        ,        ,..,       ,X          ,X       ,X       ,..,X       ,My comment
danielebarchiesi@0:  *   23 Feb 2005       ,1125,24 ,89    ,X         ,X       ,        ,..,       ,X          ,X       ,X       ,..,X       ,Hello
danielebarchiesi@0:  *   .................................................................................................................................
danielebarchiesi@0:  *   27 Feb 2005       ,1035,56 ,212   ,X         ,        ,        ,..,       ,X          ,X       ,X       ,..,X       ,How is this?
danielebarchiesi@0:  *
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_export($node, $format = 'delimited', $options = array()) {
danielebarchiesi@0:   global $user;
danielebarchiesi@0:   module_load_include('inc', 'webform', 'includes/webform.export');
danielebarchiesi@0:   module_load_include('inc', 'webform', 'includes/webform.components');
danielebarchiesi@0: 
danielebarchiesi@0:   $submission_information = array(
danielebarchiesi@0:     'serial' => t('Serial'),
danielebarchiesi@0:     'sid' => t('SID'),
danielebarchiesi@0:     'time' => t('Time'),
danielebarchiesi@0:     'draft' => t('Draft'),
danielebarchiesi@0:     'ip_address' => t('IP Address'),
danielebarchiesi@0:     'uid' => t('UID'),
danielebarchiesi@0:     'username' => t('Username'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($options)) {
danielebarchiesi@0:     $options = array(
danielebarchiesi@0:       'delimiter' => variable_get('webform_csv_delimiter', '\t'),
danielebarchiesi@0:       'components' => array_merge(array_keys($submission_information), array_keys(webform_component_list($node, 'csv', TRUE))),
danielebarchiesi@0:       'select_keys' => 0,
danielebarchiesi@0:       'select_format' => 'separate',
danielebarchiesi@0:       'range_type' => 'all',
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     foreach ($submission_information as $key => $label) {
danielebarchiesi@0:       if (!in_array($key, $options['components'])) {
danielebarchiesi@0:         unset($submission_information[$key]);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Open a new Webform exporter object.
danielebarchiesi@0:   $exporter = webform_export_create_handler($format, $options);
danielebarchiesi@0: 
danielebarchiesi@0:   $file_name = drupal_tempnam('temporary://', 'webform_');
danielebarchiesi@0:   $handle = @fopen($file_name, 'w'); // The @ suppresses errors.
danielebarchiesi@0:   $exporter->bof($handle);
danielebarchiesi@0: 
danielebarchiesi@0:   // Fill in the header for the submission information (if any).
danielebarchiesi@0:   $header[2] = $header[1] = $header[0] = count($submission_information) ? array_fill(0, count($submission_information), '') : array();
danielebarchiesi@0:   if (count($submission_information)) {
danielebarchiesi@0:     $header[0][0] = $node->title;
danielebarchiesi@0:     $header[1][0] = t('Submission Details');
danielebarchiesi@0:     foreach (array_values($submission_information) as $column => $label) {
danielebarchiesi@0:       $header[2][$column] = $label;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Compile header information for components.
danielebarchiesi@0:   foreach ($options['components'] as $cid) {
danielebarchiesi@0:     if (isset($node->webform['components'][$cid])) {
danielebarchiesi@0:       $component = $node->webform['components'][$cid];
danielebarchiesi@0: 
danielebarchiesi@0:       // Let each component determine its headers.
danielebarchiesi@0:       if (webform_component_feature($component['type'], 'csv')) {
danielebarchiesi@0:         $component_header = (array) webform_component_invoke($component['type'], 'csv_headers', $component, $options);
danielebarchiesi@0:         $header[0] = array_merge($header[0], (array) $component_header[0]);
danielebarchiesi@0:         $header[1] = array_merge($header[1], (array) $component_header[1]);
danielebarchiesi@0:         $header[2] = array_merge($header[2], (array) $component_header[2]);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Add headers to the file.
danielebarchiesi@0:   foreach ($header as $row) {
danielebarchiesi@0:     $exporter->add_row($handle, $row);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Get all the required submissions for the download.
danielebarchiesi@0:   $filters['nid'] = $node->nid;
danielebarchiesi@0:   if (!empty($options['sids'])){
danielebarchiesi@0:     $filters['sid'] = $options['sids'];
danielebarchiesi@0:   }
danielebarchiesi@0:   $submissions = webform_get_submissions($filters);
danielebarchiesi@0: 
danielebarchiesi@0:   // Generate a row for each submission.
danielebarchiesi@0:   $row_count = 0;
danielebarchiesi@0:   foreach ($submissions as $sid => $submission) {
danielebarchiesi@0:     $row_count++;
danielebarchiesi@0: 
danielebarchiesi@0:     $row = array();
danielebarchiesi@0:     if (isset($submission_information['serial'])) {
danielebarchiesi@0:       $row[] = $row_count;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (isset($submission_information['sid'])) {
danielebarchiesi@0:       $row[] = $sid;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (isset($submission_information['time'])) {
danielebarchiesi@0:       $row[] = format_date($submission->submitted, 'short');
danielebarchiesi@0:     }
danielebarchiesi@0:     if (isset($submission_information['draft'])) {
danielebarchiesi@0:       $row[] = $submission->is_draft;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (isset($submission_information['ip_address'])) {
danielebarchiesi@0:       $row[] =  $submission->remote_addr;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (isset($submission_information['uid'])) {
danielebarchiesi@0:       $row[] = $submission->uid;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (isset($submission_information['username'])) {
danielebarchiesi@0:       $row[] = $submission->name;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     foreach ($options['components'] as $cid) {
danielebarchiesi@0:       if (isset($node->webform['components'][$cid])) {
danielebarchiesi@0:         $component = $node->webform['components'][$cid];
danielebarchiesi@0:         // Let each component add its data.
danielebarchiesi@0:         $raw_data = isset($submission->data[$cid]['value']) ? $submission->data[$cid]['value'] : NULL;
danielebarchiesi@0:         if (webform_component_feature($component['type'], 'csv')) {
danielebarchiesi@0:           $data = webform_component_invoke($component['type'], 'csv_data', $component, $options, $raw_data);
danielebarchiesi@0:           if (is_array($data)) {
danielebarchiesi@0:             $row = array_merge($row, array_values($data));
danielebarchiesi@0:           }
danielebarchiesi@0:           else {
danielebarchiesi@0:             $row[] = isset($data) ? $data : '';
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Write data from submissions.
danielebarchiesi@0:     $data = $exporter->add_row($handle, $row);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Add the closing bytes.
danielebarchiesi@0:   $exporter->eof($handle);
danielebarchiesi@0: 
danielebarchiesi@0:   // Close the file.
danielebarchiesi@0:   @fclose($handle);
danielebarchiesi@0: 
danielebarchiesi@0:   $export_info['options'] = $options;
danielebarchiesi@0:   $export_info['file_name'] = $file_name;
danielebarchiesi@0:   $export_info['exporter'] = $exporter;
danielebarchiesi@0:   $export_info['row_count'] = $row_count;
danielebarchiesi@0:   $export_info['last_sid'] = $sid;
danielebarchiesi@0: 
danielebarchiesi@0:   return $export_info;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Send a generated webform results file to the user's browser.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $node
danielebarchiesi@0:  *   The webform node.
danielebarchiesi@0:  * @param $export_info
danielebarchiesi@0:  *   Export information array retrieved from webform_results_export().
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_download($node, $export_info) {
danielebarchiesi@0:   global $user;
danielebarchiesi@0: 
danielebarchiesi@0:   // $exporter, $file_name, $row_count
danielebarchiesi@0:   $export_name = _webform_safe_name($node->title);
danielebarchiesi@0:   $export_info['exporter']->set_headers($export_name);
danielebarchiesi@0:   @readfile($export_info['file_name']);  // The @ makes it silent.
danielebarchiesi@0:   @unlink($export_info['file_name']);  // Clean up, the @ makes it silent.
danielebarchiesi@0: 
danielebarchiesi@0:   // Update user last downloaded sid if required.
danielebarchiesi@0:   if ($export_info['options']['range_type'] != 'range' && $export_info['row_count'] > 0) {
danielebarchiesi@0:     // Delete existing record.
danielebarchiesi@0:     db_delete('webform_last_download')
danielebarchiesi@0:       ->condition('nid', $node->nid)
danielebarchiesi@0:       ->condition('uid', $user->uid)
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:     // Write new record.
danielebarchiesi@0:     db_insert('webform_last_download')
danielebarchiesi@0:       ->fields(array(
danielebarchiesi@0:         'nid' => $node->nid,
danielebarchiesi@0:         'uid' => $user->uid,
danielebarchiesi@0:         'sid' => $export_info['last_sid'],
danielebarchiesi@0:         'requested' => REQUEST_TIME,
danielebarchiesi@0:       ))
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   exit();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provides a simple analysis of all submissions to a webform.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $node
danielebarchiesi@0:  *   The webform node on which to generate the analysis.
danielebarchiesi@0:  * @param $sids
danielebarchiesi@0:  *   An array of submission IDs to which this analysis may be filtered. May be
danielebarchiesi@0:  *   used to generate results that are per-user or other groups of submissions.
danielebarchiesi@0:  * @param $analysis_component
danielebarchiesi@0:  *   A webform component. If passed in, additional information may be returned
danielebarchiesi@0:  *   relating specifically to that component's analysis, such as a list of
danielebarchiesi@0:  *   "Other" values within a select list.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_results_analysis($node, $sids = array(), $analysis_component = NULL) {
danielebarchiesi@0:   if (!is_array($sids)) {
danielebarchiesi@0:     $sids = array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // If showing a component's details, we don't want to loose the menu tabs.
danielebarchiesi@0:   if ($analysis_component) {
danielebarchiesi@0:     $item = menu_get_item('node/' . $node->nid . '/webform-results/analysis');
danielebarchiesi@0:     menu_set_item(NULL, $item);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $components = isset($analysis_component) ? array($analysis_component['cid'] => $analysis_component) : $node->webform['components'];
danielebarchiesi@0:   $data = array();
danielebarchiesi@0:   foreach ($components as $cid => $component) {
danielebarchiesi@0:     // Do component specific call.
danielebarchiesi@0:     if ($row_data = webform_component_invoke($component['type'], 'analysis', $component, $sids, isset($analysis_component))) {
danielebarchiesi@0:       $data[$cid] = $row_data;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return theme('webform_results_analysis', array('node' => $node, 'data' => $data, 'sids' => $sids, 'component' => $analysis_component));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Output the content of the Analysis page.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see webform_results_analysis()
danielebarchiesi@0:  */
danielebarchiesi@0: function theme_webform_results_analysis($variables) {
danielebarchiesi@0:   $node = $variables['node'];
danielebarchiesi@0:   $data = $variables['data'];
danielebarchiesi@0:   $sids = $variables['sids'];
danielebarchiesi@0:   $analysis_component = $variables['component'];
danielebarchiesi@0: 
danielebarchiesi@0:   $rows = array();
danielebarchiesi@0:   $question_number = 0;
danielebarchiesi@0:   $single = isset($analysis_component);
danielebarchiesi@0: 
danielebarchiesi@0:   $header = array(
danielebarchiesi@0:     $single ? $analysis_component['name'] : t('Q'),
danielebarchiesi@0:     array('data' => $single ? '&nbsp;' : t('responses'), 'colspan' => '10')
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($data as $cid => $row_data) {
danielebarchiesi@0:     $question_number++;
danielebarchiesi@0: 
danielebarchiesi@0:     if (is_array($row_data)) {
danielebarchiesi@0:       $row = array();
danielebarchiesi@0:       if (!$single) {
danielebarchiesi@0:         $row['data'][] = array('data' => '<strong>' . $question_number . '</strong>', 'rowspan' => count($row_data) + 1, 'valign' => 'top');
danielebarchiesi@0:         $row['data'][] = array('data' => '<strong>' . check_plain($node->webform['components'][$cid]['name']) . '</strong>', 'colspan' => '10');
danielebarchiesi@0:         $row['class'][] = 'webform-results-question';
danielebarchiesi@0:       }
danielebarchiesi@0:       $rows = array_merge($rows, array_merge(array($row), $row_data));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (count($rows) == 0) {
danielebarchiesi@0:     $rows[] = array(array('data' => t('There are no submissions for this form. <a href="!url">View this form</a>.', array('!url' => url('node/' . $node->nid))), 'colspan' => 20));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('class' => array('webform-results-analysis'))));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Given a set of range options, retrieve a set of SIDs for a webform node.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_download_sids($nid, $range_options, $uid = NULL) {
danielebarchiesi@0:   $query = db_select('webform_submissions', 'ws')
danielebarchiesi@0:     ->fields('ws', array('sid'))
danielebarchiesi@0:     ->condition('nid', $nid);
danielebarchiesi@0: 
danielebarchiesi@0:   switch ($range_options['range_type']) {
danielebarchiesi@0:     case 'all':
danielebarchiesi@0:       // All Submissions.
danielebarchiesi@0:       $query->orderBy('sid', 'ASC');
danielebarchiesi@0:       break;
danielebarchiesi@0:     case 'new':
danielebarchiesi@0:       // All Since Last Download.
danielebarchiesi@0:       $download_info = webform_download_last_download_info($nid, $uid);
danielebarchiesi@0:       $last_sid = $download_info ? $download_info['sid'] : 0;
danielebarchiesi@0:       $query
danielebarchiesi@0:         ->condition('sid', $last_sid, '>')
danielebarchiesi@0:         ->orderBy('sid', 'ASC');
danielebarchiesi@0:       break;
danielebarchiesi@0:     case 'latest':
danielebarchiesi@0:       // Last x Submissions.
danielebarchiesi@0:       $query
danielebarchiesi@0:         ->orderBy('sid', 'DESC')
danielebarchiesi@0:         ->range(0, $range_options['latest']);
danielebarchiesi@0:       break;
danielebarchiesi@0:     case 'range':
danielebarchiesi@0:       // Submissions Start-End.
danielebarchiesi@0:       $query->condition('sid', $range_options['start'], '>=');
danielebarchiesi@0:       if ($range_options['end']){
danielebarchiesi@0:         $query->condition('sid', $range_options['end'], '<=');
danielebarchiesi@0:       }
danielebarchiesi@0:       $query->orderBy('sid', 'ASC');
danielebarchiesi@0:       break;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $sids = $query->execute()->fetchCol();
danielebarchiesi@0: 
danielebarchiesi@0:   // The last x submissions option has SIDs that are in reverse order.
danielebarchiesi@0:   if ($range_options['range_type'] == 'latest') {
danielebarchiesi@0:     $sids = array_reverse($sids);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $sids;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get this user's last download information, including the SID and timestamp.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function provides an array of information about the last download that
danielebarchiesi@0:  * a user had for a particular Webform node. Currently it only returns an array
danielebarchiesi@0:  * with two keys:
danielebarchiesi@0:  *  - sid: The last submission ID that was downloaded.
danielebarchiesi@0:  *  - requested: The timestamp of the last download request.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $nid
danielebarchiesi@0:  *   The Webform NID.
danielebarchiesi@0:  * @param $uid
danielebarchiesi@0:  *   The user account ID for which to retrieve download information.
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of download information or FALSE if this user has never downloaded
danielebarchiesi@0:  *   results for this particular node.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_download_last_download_info($nid, $uid = NULL) {
danielebarchiesi@0:   $uid = isset($uid) ? $uid : $GLOBALS['user']->uid;
danielebarchiesi@0: 
danielebarchiesi@0:   $info = db_select('webform_last_download', 'wld')
danielebarchiesi@0:     ->fields('wld')
danielebarchiesi@0:     ->condition('nid', $nid)
danielebarchiesi@0:     ->condition('uid', $uid)
danielebarchiesi@0:     ->execute()
danielebarchiesi@0:     ->fetchAssoc();
danielebarchiesi@0: 
danielebarchiesi@0:   return $info;
danielebarchiesi@0: }