webform.report.inc in Webform 7.4
Same filename and directory in other branches
This file includes helper functions for creating reports for webform.module.
@author Nathan Haug <nate@lullabot.com>
File
includes/webform.report.incView source
<?php
/**
* @file
* This file includes helper functions for creating reports for webform.module.
*
* @author Nathan Haug <nate@lullabot.com>
*/
// All functions within this file need the webform.submissions.inc.
module_load_include('inc', 'webform', 'includes/webform.submissions');
/**
* Retrieve lists of submissions for a given webform.
*/
function webform_results_submissions($node, $user_filter, $pager_count) {
global $user;
// Determine whether views or hard-coded tables should be used for the
// submissions table.
if (!webform_variable_get('webform_table')) {
// Load the submissions view.
$view = webform_get_view($node, 'webform_submissions');
if ($user_filter) {
if ($user->uid) {
drupal_set_title(t('Submissions for %user', array(
'%user' => $user->name,
)), PASS_THROUGH);
}
else {
drupal_set_title(t('Your submissions'));
webform_disable_page_cache();
}
return $view
->preview('default', array(
$node->nid,
$user->uid,
));
}
else {
return $view
->preview('default', array(
$node->nid,
));
}
}
if (isset($_GET['results']) && is_numeric($_GET['results'])) {
$pager_count = $_GET['results'];
}
$header = theme('webform_results_submissions_header', array(
'node' => $node,
));
if ($user_filter) {
if ($user->uid) {
drupal_set_title(t('Submissions for %user', array(
'%user' => $user->name,
)), PASS_THROUGH);
}
else {
drupal_set_title(t('Your submissions'));
webform_disable_page_cache();
}
$submissions = webform_get_submissions(array(
'nid' => $node->nid,
'uid' => $user->uid,
), $header, $pager_count);
$count = webform_get_submission_count($node->nid, $user->uid, NULL);
}
else {
$submissions = webform_get_submissions($node->nid, $header, $pager_count);
$count = webform_get_submission_count($node->nid, NULL, NULL);
}
$operation_column = end($header);
$operation_total = $operation_column['colspan'];
$rows = array();
foreach ($submissions as $sid => $submission) {
$row = array(
$submission->is_draft ? t('@serial (draft)', array(
'@serial' => $submission->serial,
)) : $submission->serial,
format_date($submission->submitted, 'short'),
);
if (webform_results_access($node, $user)) {
$row[] = theme('username', array(
'account' => $submission,
));
$row[] = $submission->remote_addr;
}
$row[] = l(t('View'), "node/{$node->nid}/submission/{$sid}");
$operation_count = 1;
// No need to call this multiple times, just reference this in a variable.
$destination = drupal_get_destination();
if (webform_submission_access($node, $submission, 'edit', $user)) {
$row[] = l(t('Edit'), "node/{$node->nid}/submission/{$sid}/edit", array(
'query' => $destination,
));
$operation_count++;
}
if (webform_submission_access($node, $submission, 'delete', $user)) {
$row[] = l(t('Delete'), "node/{$node->nid}/submission/{$sid}/delete", array(
'query' => $destination,
));
$operation_count++;
}
if ($operation_count < $operation_total) {
$row[count($row) - 1] = array(
'data' => $row[count($row) - 1],
'colspan' => $operation_total - $operation_count + 1,
);
}
$rows[] = $row;
}
$element['#theme'] = 'webform_results_submissions';
$element['#node'] = $node;
$element['#submissions'] = $submissions;
$element['#total_count'] = $count;
$element['#pager_count'] = $pager_count;
$element['#attached']['library'][] = array(
'webform',
'admin',
);
$element['table']['#theme'] = 'table';
$element['table']['#header'] = $header;
$element['table']['#rows'] = $rows;
$element['table']['#operation_total'] = $operation_total;
return $element;
}
/**
* Returns the most appropriate view for this webform node.
*
* Site builders can customize the view that webform uses by webform node id or
* by webform content type. For example, use webform_results_123 to for node
* id 123 or webform_results_my_content_type for a node of type my_content_type.
*
* @param object $node
* Loaded webform node.
* @param string $view_id
* The machine_id of the view, such as webform_results or webform_submissions.
*
* @return object|null
* The loaded view.
*/
function webform_get_view($node, $view_id) {
foreach (array(
"{$view_id}_{$node->nid}",
"{$view_id}_{$node->type}",
$view_id,
) as $id) {
$view = views_get_view($id);
if ($view) {
return $view;
}
}
}
/**
* Theme the list of links for selecting the number of results per page.
*
* @param array $variables
* Array with keys:
* - "total_count": The total number of results available.
* - "pager_count": The current number of results displayed per page.
*
* @return string
* Pager.
*/
function theme_webform_results_per_page(array $variables) {
$total_count = $variables['total_count'];
$pager_count = $variables['pager_count'];
$output = '';
// Create a list of results-per-page options.
$counts = array(
'20' => '20',
'50' => '50',
'100' => '100',
'200' => '200',
'500' => '500',
'1000' => '1000',
'0' => t('All'),
);
$count_links = array();
foreach ($counts as $number => $text) {
if ($number < $total_count) {
$count_links[] = l($text, $_GET['q'], array(
'query' => array(
'results' => $number,
),
'attributes' => array(
'class' => array(
$pager_count == $number ? 'selected' : '',
),
),
));
}
}
$output .= '<div class="webform-results-per-page">';
if (count($count_links) > 1) {
$output .= t('Show !count results per page.', array(
'!count' => implode(' | ', $count_links),
));
}
else {
$output .= t('Showing all results.');
}
if ($total_count > 1) {
$output .= ' ' . t('@total results total.', array(
'@total' => $total_count,
));
}
$output .= '</div>';
return $output;
}
/**
* Theme the header of the submissions table.
*
* This is done in it's own function so that webform can retrieve the header and
* use it for sorting the results.
*/
function theme_webform_results_submissions_header($variables) {
$node = $variables['node'];
$columns = array(
array(
'data' => t('#'),
'field' => 'sid',
'sort' => 'desc',
),
array(
'data' => t('Submitted'),
'field' => 'submitted',
),
);
if (webform_results_access($node)) {
$columns[] = array(
'data' => t('User'),
'field' => 'name',
);
$columns[] = array(
'data' => t('IP Address'),
'field' => 'remote_addr',
);
}
$columns[] = array(
'data' => t('Operations'),
'colspan' => module_exists('print') ? 5 : 3,
);
return $columns;
}
/**
* Preprocess function for webform-results-submissions.tpl.php.
*/
function template_preprocess_webform_results_submissions(&$vars) {
$vars['node'] = $vars['element']['#node'];
$vars['submissions'] = $vars['element']['#submissions'];
$vars['table'] = $vars['element']['table'];
$vars['total_count'] = $vars['element']['#total_count'];
$vars['pager_count'] = $vars['element']['#pager_count'];
$vars['is_submissions'] = arg(2) == 'submissions' ? 1 : 0;
unset($vars['element']);
}
/**
* Create a table containing all submitted values for a webform node.
*/
function webform_results_table($node, $pager_count = 0) {
// Determine whether views or hard-coded tables should be used for the
// submissions table.
if (!webform_variable_get('webform_table')) {
// Load and preview the results view with a node id argument.
$view = webform_get_view($node, 'webform_results');
return $view
->preview('default', array(
$node->nid,
));
}
// Get all the submissions for the node.
if (isset($_GET['results']) && is_numeric($_GET['results'])) {
$pager_count = $_GET['results'];
}
// Get all the submissions for the node.
$header = theme('webform_results_table_header', array(
'node' => $node,
));
$submissions = webform_get_submissions($node->nid, $header, $pager_count);
$total_count = webform_get_submission_count($node->nid, NULL, NULL);
$output[] = array(
'#theme' => 'webform_results_table',
'#node' => $node,
'#components' => $node->webform['components'],
'#submissions' => $submissions,
'#total_count' => $total_count,
'#pager_count' => $pager_count,
);
if ($pager_count) {
$output[] = array(
'#theme' => 'pager',
);
}
return $output;
}
/**
* Theme function for the Webform results table header.
*/
function theme_webform_results_table_header($variables) {
return array(
array(
'data' => t('#'),
'field' => 'sid',
'sort' => 'desc',
),
array(
'data' => t('Submitted'),
'field' => 'submitted',
),
array(
'data' => t('User'),
'field' => 'name',
),
array(
'data' => t('IP Address'),
'field' => 'remote_addr',
),
);
}
/**
* Theme the results table displaying all the submissions for a particular node.
*
* @param array $variables
* An array with keys:
* - node: The node whose results are being displayed.
* - components: An associative array of the components for this webform.
* - submissions: An array of all submissions for this webform.
* - total_count: The total number of submissions to this webform.
* - pager_count: The number of results to be shown per page.
*
* @return string
* HTML string with result data.
*/
function theme_webform_results_table(array $variables) {
drupal_add_library('webform', 'admin');
$node = $variables['node'];
$components = $variables['components'];
$submissions = $variables['submissions'];
$total_count = $variables['total_count'];
$pager_count = $variables['pager_count'];
$rows = array();
$cell = array();
// This header has to be generated separately so we can add the SQL necessary.
// to sort the results.
$header = theme('webform_results_table_header', array(
'node' => $node,
));
// Generate a row for each submission.
foreach ($submissions as $sid => $submission) {
$link_text = $submission->is_draft ? t('@serial (draft)', array(
'@serial' => $submission->serial,
)) : $submission->serial;
$cell[] = l($link_text, 'node/' . $node->nid . '/submission/' . $sid);
$cell[] = format_date($submission->submitted, 'short');
$cell[] = theme('username', array(
'account' => $submission,
));
$cell[] = $submission->remote_addr;
$component_headers = array();
// Generate a cell for each component.
foreach ($components as $component) {
$data = isset($submission->data[$component['cid']]) ? $submission->data[$component['cid']] : NULL;
$submission_output = webform_component_invoke($component['type'], 'table', $component, $data);
if ($submission_output !== NULL) {
$component_headers[] = array(
'data' => check_plain($component['name']),
'field' => $component['cid'],
);
$cell[] = $submission_output;
}
}
$rows[] = $cell;
unset($cell);
}
if (!empty($component_headers)) {
$header = array_merge($header, $component_headers);
}
if (count($rows) == 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,
),
);
}
$output = '';
$output .= theme('webform_results_per_page', array(
'total_count' => $total_count,
'pager_count' => $pager_count,
));
$output .= theme('table', array(
'header' => $header,
'rows' => $rows,
));
return $output;
}
/**
* Delete all submissions for a node.
*
* @param $nid
* The node id whose submissions will be deleted.
* @param $batch_size
* The number of submissions to be processed. NULL means all submissions.
*
* @return int
* The number of submissions processed.
*/
function webform_results_clear($nid, $batch_size = NULL) {
$node = node_load($nid);
$submissions = webform_get_submissions($nid, NULL, $batch_size);
$count = 0;
foreach ($submissions as $submission) {
webform_submission_delete($node, $submission);
$count++;
}
return $count;
}
/**
* Confirmation form to delete all submissions for a node.
*
* @param $nid
* ID of node for which to clear submissions.
*/
function webform_results_clear_form($form, $form_state, $node) {
drupal_set_title(t('Clear Form Submissions'));
$form = array();
$form['nid'] = array(
'#type' => 'value',
'#value' => $node->nid,
);
$question = t('Are you sure you want to delete all submissions for this form?');
return confirm_form($form, $question, 'node/' . $node->nid . '/webform-results', NULL, t('Clear'), t('Cancel'));
}
/**
* Form submit handler.
*/
function webform_results_clear_form_submit($form, &$form_state) {
$nid = $form_state['values']['nid'];
$node = node_load($nid);
// Set a modest batch size, due to the inefficiency of the hooks invoked when
// submissions are deleted.
$batch_size = min(webform_export_batch_size($node), 500);
// Set up a batch to clear the results.
$batch = array(
'operations' => array(
array(
'webform_clear_batch_rows',
array(
$node,
$batch_size,
),
),
),
'finished' => 'webform_clear_batch_finished',
'title' => t('Clear submissions'),
'init_message' => t('Clearing submission data'),
'error_message' => t('The submissions could not be cleared because an error occurred.'),
'file' => drupal_get_path('module', 'webform') . '/includes/webform.report.inc',
);
batch_set($batch);
$form_state['redirect'] = 'node/' . $nid . '/webform-results';
}
/**
* Batch API callback; Write the rows of the export to the export file.
*/
function webform_clear_batch_rows($node, $batch_size, &$context) {
// Initialize the results if this is the first execution of the batch
// operation.
if (!isset($context['results']['count'])) {
$context['results'] = array(
'count' => 0,
'total' => webform_get_submission_count($node->nid),
'node' => $node,
);
}
// Clear a batch of submissions.
$count = webform_results_clear($node->nid, $batch_size);
$context['results']['count'] += $count;
// Display status message.
$context['message'] = t('Cleared @count of @total submissions...', array(
'@count' => $context['results']['count'],
'@total' => $context['results']['total'],
));
$context['finished'] = $count > 0 ? $context['results']['count'] / $context['results']['total'] : 1.0;
}
/**
* Batch API completion callback; Finish clearing submissions.
*/
function webform_clear_batch_finished($success, $results, $operations) {
if ($success) {
$title = $results['node']->title;
drupal_set_message(t('Webform %title entries cleared.', array(
'%title' => $title,
)));
watchdog('webform', 'Webform %title entries cleared.', array(
'%title' => $title,
));
}
}
/**
* Form to configure the download of CSV files.
*/
function webform_results_download_form($form, &$form_state, $node) {
module_load_include('inc', 'webform', 'includes/webform.export');
module_load_include('inc', 'webform', 'includes/webform.components');
$form['#attached']['js'][] = drupal_get_path('module', 'webform') . '/js/webform-admin.js';
// If an export is waiting to be downloaded, redirect the user there after
// the page has finished loading.
if (isset($_SESSION['webform_export_info'])) {
$download_url = url('node/' . $node->nid . '/webform-results/download-file', array(
'absolute' => TRUE,
));
$form['#attached']['js'][] = array(
'data' => array(
'webformExport' => $download_url,
),
'type' => 'setting',
);
}
$form['node'] = array(
'#type' => 'value',
'#value' => $node,
);
$form['format'] = array(
'#type' => 'radios',
'#title' => t('Export format'),
'#options' => webform_export_list(),
'#default_value' => webform_variable_get('webform_export_format'),
);
$form['delimited_options'] = array(
'#type' => 'container',
'warning' => array(
'#markup' => '<p>' . t('<strong>Warning:</strong> Opening delimited text files with spreadsheet applications may expose you to <a href="!link">formula injection</a> or other security vulnerabilities. When the submissions contain data from untrusted users and the downloaded file will be used with spreadsheets, use Microsoft Excel format.', array(
'!link' => url('https://www.google.com/search?q=spreadsheet+formula+injection'),
)) . '</p>',
),
'delimiter' => array(
'#type' => 'select',
'#title' => t('Delimited text format'),
'#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.'),
'#default_value' => webform_variable_get('webform_csv_delimiter'),
'#options' => array(
',' => t('Comma (,)'),
'\\t' => t('Tab (\\t)'),
';' => t('Semicolon (;)'),
':' => t('Colon (:)'),
'|' => t('Pipe (|)'),
'.' => t('Period (.)'),
' ' => t('Space ( )'),
),
),
'#states' => array(
'visible' => array(
':input[name=format]' => array(
'value' => 'delimited',
),
),
),
);
$form['header_keys'] = array(
'#type' => 'radios',
'#title' => t('Column header format'),
'#options' => array(
-1 => t('None'),
0 => t('Label'),
1 => t('Form Key'),
),
'#default_value' => 0,
'#description' => t('Choose whether to show the label or form key in each column header.'),
);
$form['select_options'] = array(
'#type' => 'fieldset',
'#title' => t('Select list options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['select_options']['select_keys'] = array(
'#type' => 'radios',
'#title' => t('Select keys'),
'#options' => array(
0 => t('Full, human-readable options (values)'),
1 => t('Short, raw options (keys)'),
),
'#default_value' => 0,
'#description' => t('Choose which part of options should be displayed from key|value pairs.'),
);
$form['select_options']['select_format'] = array(
'#type' => 'radios',
'#title' => t('Select list format'),
'#options' => array(
'separate' => t('Separate'),
'compact' => t('Compact'),
),
'#default_value' => 'separate',
'#attributes' => array(
'class' => array(
'webform-select-list-format',
),
),
'#theme' => 'webform_results_download_select_format',
);
$csv_components = array(
'info' => t('Submission information'),
);
// Prepend information fields with "-" to indent.
foreach (webform_results_download_submission_information($node) as $key => $title) {
$csv_components[$key] = '-' . $title;
}
$csv_components += webform_component_list($node, 'csv', TRUE);
$form['components'] = array(
'#type' => 'select',
'#title' => t('Included export components'),
'#options' => $csv_components,
'#default_value' => array_keys($csv_components),
'#multiple' => TRUE,
'#size' => 10,
'#description' => t('The selected components will be included in the export.'),
'#process' => array(
'webform_component_select',
),
);
$form['range'] = array(
'#type' => 'fieldset',
'#title' => t('Download range options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#tree' => TRUE,
'#theme' => 'webform_results_download_range',
'#element_validate' => array(
'webform_results_download_range_validate',
),
'#after_build' => array(
'webform_results_download_range_after_build',
),
);
$form['range']['range_type'] = array(
'#type' => 'radios',
'#options' => array(
'all' => t('All submissions'),
'new' => t('Only new submissions since your last download'),
'latest' => t('Only the latest'),
'range_serial' => t('All submissions starting from'),
'range_date' => t('All submissions by date'),
),
'#default_value' => 'all',
);
$form['range']['latest'] = array(
'#type' => 'textfield',
'#size' => 5,
'#maxlength' => 8,
);
$form['range']['start'] = array(
'#type' => 'textfield',
'#size' => 5,
'#maxlength' => 8,
);
$form['range']['end'] = array(
'#type' => 'textfield',
'#size' => 5,
'#maxlength' => 8,
);
$date_attributes = array(
'placeholder' => format_date(REQUEST_TIME, 'custom', webform_date_format('short')),
);
$form['range']['start_date'] = array(
'#type' => 'textfield',
'#size' => 20,
'#attributes' => $date_attributes,
);
$form['range']['end_date'] = array(
'#type' => 'textfield',
'#size' => 20,
'#attributes' => $date_attributes,
);
// If drafts are allowed, provide options to filter download based on draft
// status.
$form['range']['completion_type'] = array(
'#type' => 'radios',
'#title' => t('Included submissions'),
'#default_value' => 'all',
'#options' => array(
'all' => t('Finished and draft submissions'),
'finished' => t('Finished submissions only'),
'draft' => t('Drafts only'),
),
'#access' => $node->webform['allow_draft'] || $node->webform['auto_save'],
);
// By default results are downloaded. User can override this value if
// programmatically submitting this form.
$form['download'] = array(
'#type' => 'value',
'#default_value' => TRUE,
);
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Download'),
);
return $form;
}
/**
* FormAPI element validate function for the range fieldset.
*/
function webform_results_download_range_validate($element, $form_state) {
switch ($element['range_type']['#value']) {
case 'latest':
// Download latest x submissions.
if ($element['latest']['#value'] == '') {
form_error($element['latest'], t('Latest number of submissions field is required.'));
}
else {
if (!is_numeric($element['latest']['#value'])) {
form_error($element['latest'], t('Latest number of submissions must be numeric.'));
}
else {
if ($element['latest']['#value'] <= 0) {
form_error($element['latest'], t('Latest number of submissions must be greater than 0.'));
}
}
}
break;
case 'range_serial':
// Download Start-End range of submissions.
// Start submission number.
if ($element['start']['#value'] == '') {
form_error($element['start'], t('Start submission number is required.'));
}
else {
if (!is_numeric($element['start']['#value'])) {
form_error($element['start'], t('Start submission number must be numeric.'));
}
else {
if ($element['start']['#value'] <= 0) {
form_error($element['start'], t('Start submission number must be greater than 0.'));
}
}
}
// End submission number.
if ($element['end']['#value'] != '') {
if (!is_numeric($element['end']['#value'])) {
form_error($element['end'], t('End submission number must be numeric.'));
}
else {
if ($element['end']['#value'] <= 0) {
form_error($element['end'], t('End submission number must be greater than 0.'));
}
else {
if ($element['end']['#value'] < $element['start']['#value']) {
form_error($element['end'], t('End submission number must not be less than Start submission number.'));
}
}
}
}
break;
case 'range_date':
// Download Start-end range of submissions.
// Start submission time.
$format = webform_date_format('short');
$start_date = DateTime::createFromFormat($format, $element['start_date']['#value']);
if ($element['start_date']['#value'] == '') {
form_error($element['start_date'], t('Start date range is required.'));
}
elseif ($start_date === FALSE) {
form_error($element['start_date'], t('Start date range is not in a valid format.'));
}
// End submission time.
$end_date = DateTime::createFromFormat($format, $element['end_date']['#value']);
if ($element['end_date']['#value'] != '') {
if ($end_date === FALSE) {
form_error($element['end_date'], t('End date range is not in a valid format.'));
}
elseif ($start_date !== FALSE && $start_date > $end_date) {
form_error($element['end_date'], t('End date range must not be before the Start date.'));
}
}
break;
}
// Check that the range will return something at all.
$range_options = array(
'range_type' => $element['range_type']['#value'],
'start' => $element['start']['#value'],
'end' => $element['end']['#value'],
'latest' => $element['latest']['#value'],
'start_date' => $element['start_date']['#value'],
'end_date' => $element['end_date']['#value'],
'completion_type' => $element['completion_type']['#value'],
'batch_size' => 1,
'batch_number' => 0,
);
if (!form_get_errors() && !webform_download_sids_count($form_state['values']['node']->nid, $range_options)) {
form_error($element['range_type'], t('The specified range will not return any results.'));
}
}
/**
* FormAPI after build function for the download range fieldset.
*/
function webform_results_download_range_after_build($element, &$form_state) {
$node = $form_state['values']['node'];
// Build a list of counts of new and total submissions.
$last_download = webform_download_last_download_info($node->nid);
$element['#webform_download_info']['sid'] = $last_download ? $last_download['sid'] : 0;
$element['#webform_download_info']['serial'] = $last_download ? $last_download['serial'] : NULL;
$element['#webform_download_info']['requested'] = $last_download ? $last_download['requested'] : $node->created;
$element['#webform_download_info']['total'] = webform_get_submission_count($node->nid, NULL, NULL);
$element['#webform_download_info']['new'] = webform_download_sids_count($node->nid, array(
'range_type' => 'new',
'completion_type' => 'finished',
));
if ($node->webform['allow_draft'] || $node->webform['auto_save']) {
$element['#webform_download_info']['new_draft'] = webform_download_sids_count($node->nid, array(
'range_type' => 'new',
'completion_type' => 'draft',
));
}
return $element;
}
/**
* Theme the output of the export range fieldset.
*/
function theme_webform_results_download_range($variables) {
drupal_add_library('webform', 'admin');
$element = $variables['element'];
$download_info = $element['#webform_download_info'];
// Set description for total of all submissions.
$element['range_type']['all']['#theme_wrappers'] = array(
'webform_inline_radio',
);
$element['range_type']['all']['#title'] .= ' (' . t('@count total', array(
'@count' => $download_info['total'],
)) . ')';
// Set description for "New submissions since last download".
$format = webform_date_format('short');
$requested_date = format_date($download_info['requested'], 'custom', $format);
$element['range_type']['new']['#theme_wrappers'] = array(
'webform_inline_radio',
);
if (isset($download_info['new_draft'])) {
$args = array(
'@new_draft' => $download_info['new_draft'],
'@new' => $download_info['new'],
'@date' => $requested_date,
);
$element['range_type']['new']['#title'] .= ' (' . t('@new_draft new drafts, @new new finished since @date', $args) . ')';
$total_count = $download_info['new_draft'] + $download_info['new'];
}
else {
$args = array(
'@count' => $download_info['new'],
'@date' => $requested_date,
);
$element['range_type']['new']['#title'] .= ' (' . t('@count new since @date', $args) . ')';
$total_count = $download_info['new'];
}
// Disable option if there are no new submissions.
if ($total_count == 0) {
$element['range_type']['new']['#attributes']['disabled'] = 'disabled';
}
// Render latest x submissions option.
$element['latest']['#attributes']['class'][] = 'webform-set-active';
$element['latest']['#theme_wrappers'] = array();
$element['range_type']['latest']['#theme_wrappers'] = array(
'webform_inline_radio',
);
$element['range_type']['latest']['#title'] = t('Only the latest !number submissions', array(
'!number' => drupal_render($element['latest']),
));
// Render Start-End submissions option.
$element['start']['#attributes']['class'][] = 'webform-set-active';
$element['end']['#attributes']['class'][] = 'webform-set-active';
$element['start']['#theme_wrappers'] = array();
$element['end']['#theme_wrappers'] = array();
$element['start_date']['#attributes']['class'] = array(
'webform-set-active',
);
$element['end_date']['#attributes']['class'] = array(
'webform-set-active',
);
$element['start_date']['#theme_wrappers'] = array();
$element['end_date']['#theme_wrappers'] = array();
$element['range_type']['range_serial']['#theme_wrappers'] = array(
'webform_inline_radio',
);
$last_serial = $download_info['serial'] ? $download_info['serial'] : drupal_placeholder(t('none'));
$element['range_type']['range_serial']['#title'] = t('Submissions by number from !start and optionally to: !end (Last downloaded: !serial)', array(
'!start' => drupal_render($element['start']),
'!end' => drupal_render($element['end']),
'!serial' => $last_serial,
));
// Date range.
$element['range_type']['range_date']['#theme_wrappers'] = array(
'webform_inline_radio',
);
$element['range_type']['range_date']['#title'] = t('Submissions by date from !start_date and optionally to: !end_date', array(
'!start_date' => drupal_render($element['start_date']),
'!end_date' => drupal_render($element['end_date']),
));
return drupal_render_children($element);
}
/**
* Theme the output of the select list format radio buttons.
*/
function theme_webform_results_download_select_format($variables) {
drupal_add_library('webform', 'admin');
$element = $variables['element'];
$output = '';
// Build an example table for the separate option.
$header = array(
t('Option A'),
t('Option B'),
t('Option C'),
);
$rows = array(
array(
'X',
'',
'',
),
array(
'X',
'',
'X',
),
array(
'',
'X',
'X',
),
);
$element['separate']['#attributes']['class'] = array();
$element['separate']['#description'] = theme('table', array(
'header' => $header,
'rows' => $rows,
'sticky' => FALSE,
));
$element['separate']['#description'] .= t('Separate options are more suitable for building reports, graphs, and statistics in a spreadsheet application.');
$output .= drupal_render($element['separate']);
// Build an example table for the compact option.
$header = array(
t('My select list'),
);
$rows = array(
array(
'Option A',
),
array(
'Option A,Option C',
),
array(
'Option B,Option C',
),
);
$element['compact']['#attributes']['class'] = array();
$element['compact']['#description'] = theme('table', array(
'header' => $header,
'rows' => $rows,
'sticky' => FALSE,
));
$element['compact']['#description'] .= t('Compact options are more suitable for importing data into other systems.');
$output .= drupal_render($element['compact']);
return $output;
}
/**
* Submit handler for webform_results_download_form().
*/
function webform_results_download_form_submit(&$form, &$form_state) {
$node = $form_state['values']['node'];
$format = $form_state['values']['format'];
$options = array(
'delimiter' => $form_state['values']['delimiter'],
'components' => array_keys(array_filter($form_state['values']['components'])),
'header_keys' => $form_state['values']['header_keys'],
'select_keys' => $form_state['values']['select_keys'],
'select_format' => $form_state['values']['select_format'],
'range' => $form_state['values']['range'],
'download' => $form_state['values']['download'],
);
$defaults = webform_results_download_default_options($node, $format);
$options += $defaults;
$options['range'] += $defaults['range'];
// Determine an appropriate batch size based on the form and server specs.
if (!isset($options['range']['batch_size'])) {
$options['range']['batch_size'] = webform_export_batch_size($node);
}
$options['file_name'] = _webform_export_tempname();
// Set up a batch to export the results.
$batch = webform_results_export_batch($node, $format, $options);
batch_set($batch);
// Disable progressive batch process.
if (!webform_variable_get('webform_export_use_progressive_batch')) {
$batch =& batch_get();
$batch['progressive'] = FALSE;
batch_process();
}
}
/**
* Calculate an appropriate batch size for bulk submission operations.
*
* @param object $node
* The webform node.
*
* @return int
* The number of submissions to be processed at once.
*/
function webform_export_batch_size($node) {
// Start the batch size at 50,000 per batch, but divide by number of
// components in the form. For example, if a form had 10 components, it would
// export 5,000 submissions at a time.
$batch_size = ceil(50000 / max(1, count($node->webform['components'])));
// Every 32MB of additional memory after 64MB adds a multiplier in size.
$memory_limit = parse_size(ini_get('memory_limit'));
$mb = 1048576;
$memory_modifier = max(1, ($memory_limit - 64 * $mb) / (32 * $mb));
$batch_size = ceil($batch_size * $memory_modifier);
// For time reasons, limit the batch size to 5,000.
$batch_size = min($batch_size, 5000);
// Allow a non-UI configuration to override the batch size.
$batch_size = variable_get('webform_export_batch_size', $batch_size);
return $batch_size;
}
/**
* Returns a temporary export filename.
*/
function _webform_export_tempname() {
$webform_export_path = variable_get('webform_export_path', 'temporary://');
// If the directory does not exist, create it.
file_prepare_directory($webform_export_path, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
return drupal_tempnam($webform_export_path, 'webform_');
}
/**
* Generate a Excel-readable CSV file containing all submissions for a Webform.
*
* @deprecated in webform:7.x-4.8 and is removed from webform:7.x-5.0. Use
* webform_results_export_batch().
* @see https://www.drupal.org/project/webform/issues/2465291
*
* @return array|null
* The array of export info or null if the file could not be opened.
*/
function webform_results_export($node, $format = 'delimited', $options = array()) {
module_load_include('inc', 'webform', 'includes/webform.export');
module_load_include('inc', 'webform', 'includes/webform.components');
$defaults = webform_results_download_default_options($node, $format);
$options += $defaults;
$options['range'] += $defaults['range'];
// Open a new Webform exporter object.
$exporter = webform_export_create_handler($format, $options);
$file_name = _webform_export_tempname();
$handle = fopen($file_name, 'w');
if (!$handle) {
return;
}
// Add the beginning of file marker (little-endian usually for MS Excel).
$exporter
->bof($handle);
// Add headers to the file.
$row_count = 0;
$col_count = 0;
$headers = webform_results_download_headers($node, $options);
foreach ($headers as $row) {
// Output header if header_keys is non-negative. -1 means no headers.
if ($options['header_keys'] >= 0) {
$exporter
->add_row($handle, $row, $row_count);
$row_count++;
}
$col_count = count($row) > $col_count ? count($row) : $col_count;
}
// Write data from submissions. $last_is is non_NULL to trigger returning it
// by reference.
$last_sid = TRUE;
$rows = webform_results_download_rows($node, $options, 0, $last_sid);
foreach ($rows as $row) {
$exporter
->add_row($handle, $row, $row_count);
$row_count++;
}
// Add the closing bytes.
$exporter
->eof($handle, $row_count, $col_count);
// Close the file.
@fclose($handle);
$export_info['format'] = $format;
$export_info['options'] = $options;
$export_info['file_name'] = $file_name;
$export_info['row_count'] = $row_count;
$export_info['col_count'] = $col_count;
$export_info['last_sid'] = $last_sid;
$export_info['exporter'] = $exporter;
return $export_info;
}
/**
* Return a Batch API array of commands that will generate an export.
*
* @param $node
* The webform node on which to generate the analysis.
* @param string $format
* (optional) Delimiter of the exported file.
* @param array $options
* (optional) An associative array of options that define the output format.
* These are generally passed through from the GUI interface. Possible options
* include:
* - sids: An array of submission IDs to which this export may be filtered.
* May be used to generate exports that are per-user or other groups of
* submissions.
*
* @return array
* A Batch API array suitable to pass to batch_set().
*/
function webform_results_export_batch($node, $format = 'delimited', array $options = array()) {
$defaults = webform_results_download_default_options($node, $format);
$options += $defaults;
$options['range'] += $defaults['range'];
return array(
'operations' => array(
array(
'webform_results_batch_bof',
array(
$node,
$format,
$options,
),
),
array(
'webform_results_batch_headers',
array(
$node,
$format,
$options,
),
),
array(
'webform_results_batch_rows',
array(
$node,
$format,
$options,
),
),
array(
'webform_results_batch_eof',
array(
$node,
$format,
$options,
),
),
array(
'webform_results_batch_post_process',
array(
$node,
$format,
$options,
),
),
array(
'webform_results_batch_results',
array(
$node,
$format,
$options,
),
),
),
'finished' => 'webform_results_batch_finished',
'title' => t('Exporting submissions'),
'init_message' => t('Creating export file'),
'error_message' => t('The export file could not be created because an error occurred.'),
'file' => drupal_get_path('module', 'webform') . '/includes/webform.report.inc',
);
}
/**
* Print the header rows for the downloadable webform data.
*
* @param $node
* The webform node on which to generate the analysis.
* @param array $options
* A list of options that define the output format. These are generally passed
* through from the GUI interface.
*/
function webform_results_download_headers($node, array $options) {
module_load_include('inc', 'webform', 'includes/webform.components');
$submission_information = webform_results_download_submission_information($node, $options);
// Fill in the header for the submission information (if any).
$header[2] = $header[1] = $header[0] = count($submission_information) ? array_fill(0, count($submission_information), '') : array();
if (count($submission_information)) {
$header[0][0] = $node->title;
if ($options['header_keys']) {
$header[1][0] = t('submission_details');
$submission_information_headers = array_keys($submission_information);
}
else {
$header[1][0] = t('Submission Details');
$submission_information_headers = array_values($submission_information);
}
foreach ($submission_information_headers as $column => $label) {
$header[2][$column] = $label;
}
}
// Compile header information for components.
foreach ($options['components'] as $cid) {
if (isset($node->webform['components'][$cid])) {
$component = $node->webform['components'][$cid];
// Let each component determine its headers.
if (webform_component_feature($component['type'], 'csv')) {
$component_header = (array) webform_component_invoke($component['type'], 'csv_headers', $component, $options);
// Allow modules to modify the component CSV header.
drupal_alter('webform_csv_header', $component_header, $component);
// Merge component CSV header to overall CSV header.
$header[0] = array_merge($header[0], (array) $component_header[0]);
$header[1] = array_merge($header[1], (array) $component_header[1]);
$header[2] = array_merge($header[2], (array) $component_header[2]);
}
}
}
return $header;
}
/**
* Returns rows of downloadable webform data.
*
* @param $node
* The webform node on which to generate the analysis.
* @param array $options
* A list of options that define the output format. These are generally passed
* through from the GUI interface.
* @param int $serial_start
* The starting position for the Serial column in the output.
* @param $last_sid
* If set to a non-NULL value, the last sid will be returned.
*
* @return array
* An array of rows built according to the provided $serial_start and
* $pager_count variables. Note that the current page number is determined
* by the super-global $_GET['page'] variable.
*
* @deprecated in webform:7.x-4.8 and is removed from webform:7.x-5.0. See
* webform_results_download_rows_process().
* @see https://www.drupal.org/project/webform/issues/2465291
*/
function webform_results_download_rows($node, array $options, $serial_start = 0, &$last_sid = NULL) {
// Get all the required submissions for the download.
$filters['nid'] = $node->nid;
if (isset($options['sids'])) {
$filters['sid'] = $options['sids'];
}
elseif (!empty($options['completion_type']) && $options['completion_type'] !== 'all') {
$filters['is_draft'] = (int) ($options['completion_type'] === 'draft');
}
$submissions = webform_get_submissions($filters, NULL);
if (isset($last_sid)) {
$last_sid = end($submissions) ? key($submissions) : NULL;
}
return webform_results_download_rows_process($node, $options, $serial_start, $submissions);
}
/**
* Processes the submissions to be downloaded into exported rows.
*
* This is an internal routine and not intended for use by other modules.
*
* @param $node
* The webform node on which to generate the analysis.
* @param array $options
* A list of options that define the output format. These are generally passed
* through from the GUI interface.
* @param $serial_start
* The starting position for the Serial column in the output.
* @param array $submissions
* An associative array of loaded submissions, indexed by sid.
*
* @return array
* An array of rows built according to the provided $serial_start and
* $pager_count variables. Note that the current page number is determined
* by the super-global $_GET['page'] variable.
*/
function webform_results_download_rows_process($node, array $options, $serial_start, array $submissions) {
module_load_include('inc', 'webform', 'includes/webform.components');
$submission_information = webform_results_download_submission_information($node, $options);
// Generate a row for each submission.
$row_count = 0;
$rows = array();
foreach ($submissions as $sid => $submission) {
$row_count++;
$row = array();
// Add submission information.
foreach (array_keys($submission_information) as $token) {
$cell = module_invoke_all('webform_results_download_submission_information_data', $token, $submission, $options, $serial_start, $row_count);
$context = array(
'token' => $token,
'submission' => $submission,
'options' => $options,
'serial_start' => $serial_start,
'row_count' => $row_count,
);
drupal_alter('webform_results_download_submission_information_data', $cell, $context);
// implode() to ensure everything from a single value goes into one
// column, even if more than one module responds to this item.
$row[] = implode(', ', $cell);
}
foreach ($options['components'] as $cid) {
if (isset($node->webform['components'][$cid])) {
$component = $node->webform['components'][$cid];
// Let each component add its data.
$raw_data = isset($submission->data[$cid]) ? $submission->data[$cid] : NULL;
if (webform_component_feature($component['type'], 'csv')) {
$data = webform_component_invoke($component['type'], 'csv_data', $component, $options, $raw_data);
// Allow modules to modify the CSV data.
drupal_alter('webform_csv_data', $data, $component, $submission);
if (is_array($data)) {
$row = array_merge($row, array_values($data));
}
else {
$row[] = isset($data) ? $data : '';
}
}
}
}
$rows[$serial_start + $row_count] = $row;
}
return $rows;
}
/**
* Default columns for submission information.
*
* By default all exports have several columns of generic information that
* applies to all submissions. This function returns the list of generic columns
* plus columns added by other modules.
*
* @param $options
* Filter down the list of columns based on a provided column list.
*
* @return array
* List of generic columns plus columns added by other modules
*/
function webform_results_download_submission_information($node, $options = array()) {
$submission_information = module_invoke_all('webform_results_download_submission_information_info');
drupal_alter('webform_results_download_submission_information_info', $submission_information);
if (isset($options['components'])) {
foreach ($submission_information as $key => $label) {
if (!in_array($key, $options['components'])) {
unset($submission_information[$key]);
}
}
}
return $submission_information;
}
/**
* Implements hook_webform_results_download_submission_information_info().
*/
function webform_webform_results_download_submission_information_info() {
return array(
'webform_serial' => t('Serial'),
'webform_sid' => t('SID'),
'webform_time' => t('Submitted Time'),
'webform_completed_time' => t('Completed Time'),
'webform_modified_time' => t('Modified Time'),
'webform_draft' => t('Draft'),
'webform_ip_address' => t('IP Address'),
'webform_uid' => t('UID'),
'webform_username' => t('Username'),
);
}
/**
* Implements hook_webform_results_download_submission_information_data().
*/
function webform_webform_results_download_submission_information_data($token, $submission, array $options, $serial_start, $row_count) {
switch ($token) {
case 'webform_serial':
return $submission->serial;
case 'webform_sid':
return $submission->sid;
case 'webform_time':
// Return timestamp in local time (not UTC).
if (!empty($options['iso8601_date'])) {
return format_date($submission->submitted, 'custom', 'Y-m-d\\TH:i:s');
}
else {
return format_date($submission->submitted, 'short');
}
case 'webform_completed_time':
if (!$submission->completed) {
return '';
}
elseif (!empty($options['iso8601_date'])) {
return format_date($submission->completed, 'custom', 'Y-m-d\\TH:i:s');
}
else {
return format_date($submission->completed, 'short');
}
case 'webform_modified_time':
// Return timestamp in local time (not UTC).
if (!empty($options['iso8601_date'])) {
return format_date($submission->modified, 'custom', 'Y-m-d\\TH:i:s');
}
else {
return format_date($submission->modified, 'short');
}
case 'webform_draft':
return $submission->is_draft;
case 'webform_ip_address':
return $submission->remote_addr;
case 'webform_uid':
return $submission->uid;
case 'webform_username':
return $submission->name;
}
}
/**
* Get options for creating downloadable versions of the webform data.
*
* @param $node
* The webform node on which to generate the analysis.
* @param string $format
* The export format being used.
*
* @return array
* Option for creating downloadable version of the webform data.
*/
function webform_results_download_default_options($node, $format) {
$submission_information = webform_results_download_submission_information($node);
$options = array(
'delimiter' => webform_variable_get('webform_csv_delimiter'),
'components' => array_merge(array_keys($submission_information), array_keys(webform_component_list($node, 'csv', TRUE))),
'header_keys' => 0,
'select_keys' => 0,
'select_format' => 'separate',
'range' => array(
'range_type' => 'all',
'completion_type' => 'all',
),
);
// Allow exporters to merge in additional options.
$exporter_information = webform_export_fetch_definition($format);
if (isset($exporter_information['options'])) {
$options = array_merge($options, $exporter_information['options']);
}
return $options;
}
/**
* Send a generated webform results file to the user's browser.
*
* @param $node
* The webform node.
* @param $export_info
* Export information array retrieved from webform_results_export().
*/
function webform_results_download($node, $export_info) {
// If the exporter provides a custom download method, use that.
if (method_exists($export_info['exporter'], 'download')) {
$export_info['exporter']
->download($node, $export_info);
}
else {
$export_name = _webform_safe_name($node->title);
if (!strlen($export_name)) {
$export_name = t('Untitled');
}
$export_info['exporter']
->set_headers($export_name);
ob_clean();
// The @ makes it silent.
@readfile($export_info['file_name']);
// Clean up, the @ makes it silent.
@unlink($export_info['file_name']);
}
// Save the last exported sid for new-only exports.
webform_results_export_success($node, $export_info);
exit;
}
/**
* Save the last-exported sid for new-only exports.
*
* @param $node
* The webform node.
* @param $export_info
* Export information array retrieved from webform_results_export().
*/
function webform_results_export_success($node, $export_info) {
if (!in_array($export_info['options']['range']['range_type'], array(
'range',
'range_serial',
'range_date',
)) && !empty($export_info['last_sid'])) {
webform_update_webform_last_download($node, $GLOBALS['user']->uid, $export_info['last_sid'], REQUEST_TIME);
}
}
/**
* Insert or update a download record in table {webform_last_download}.
*
* @param object $node
* The Webform node of the record to update.
* @param int $uid
* The user ID of the record to update.
* @param int $sid
* The last downloaded submission number.
* @param int $requested
* Timestamp of last download request.
*
* @return int
* MergeQuery::STATUS_INSERT or ::STATUS_UPDATE.
*/
function webform_update_webform_last_download(stdClass $node, $uid, $sid, $requested) {
return db_merge('webform_last_download')
->key(array(
'nid' => $node->nid,
'uid' => $uid,
))
->fields(array(
'sid' => $sid,
'requested' => $requested,
))
->execute();
}
/**
* Menu callback; Download an exported file.
*
* This callabck requires that an export file be already generated by a batch
* process. The $_SESSION settings are usually put in place by the
* webform_results_export_results() function.
*
* @param $node
* The webform $node whose export file is being downloaded.
*
* @return null|string
* Either an export file is downloaded with the appropriate HTTP headers set,
* or an error page is shown if now export is available to download.
*/
function webform_results_download_callback($node) {
if (isset($_SESSION['webform_export_info'])) {
module_load_include('inc', 'webform', 'includes/webform.export');
$export_info = $_SESSION['webform_export_info'];
$export_info['exporter'] = webform_export_create_handler($export_info['format'], $export_info['options']);
unset($_SESSION['webform_export_info']);
if (isset($_COOKIE['webform_export_info'])) {
unset($_COOKIE['webform_export_info']);
$params = session_get_cookie_params();
setcookie('webform_export_info', '', -1, $params['path'], $params['domain'], $params['secure'], $params['httponly']);
}
webform_results_download($node, $export_info);
}
else {
return t('No export file ready for download. The file may have already been downloaded by your browser. Visit the <a href="!href">download export form</a> to create a new export.', array(
'!href' => url('node/' . $node->nid . '/webform-results/download'),
));
}
}
/**
* Batch API callback; Write the opening byte in the export file.
*/
function webform_results_batch_bof($node, $format = 'delimited', $options = array(), &$context = NULL) {
module_load_include('inc', 'webform', 'includes/webform.export');
$exporter = webform_export_create_handler($format, $options);
$handle = fopen($options['file_name'], 'w');
if (!$handle) {
return;
}
$exporter
->bof($handle);
@fclose($handle);
}
/**
* Batch API callback; Write the headers of the export to the export file.
*/
function webform_results_batch_headers($node, $format = 'delimited', $options = array(), &$context = NULL) {
module_load_include('inc', 'webform', 'includes/webform.export');
$exporter = webform_export_create_handler($format, $options);
$handle = fopen($options['file_name'], 'a');
if (!$handle) {
return;
}
$headers = webform_results_download_headers($node, $options);
$row_count = 0;
$col_count = 0;
foreach ($headers as $row) {
// Output header if header_keys is non-negative. -1 means no headers.
if ($options['header_keys'] >= 0) {
$exporter
->add_row($handle, $row, $row_count);
$row_count++;
}
$col_count = count($row) > $col_count ? count($row) : $col_count;
}
$context['results']['row_count'] = $row_count;
$context['results']['col_count'] = $col_count;
@fclose($handle);
}
/**
* Batch API callback; Write the rows of the export to the export file.
*/
function webform_results_batch_rows($node, $format = 'delimited', $options = array(), &$context = NULL) {
module_load_include('inc', 'webform', 'includes/webform.export');
// Initialize the sandbox if this is the first execution of the batch
// operation.
if (!isset($context['sandbox']['batch_number'])) {
$context['sandbox']['batch_number'] = 0;
$context['sandbox']['sid_count'] = webform_download_sids_count($node->nid, $options['range']);
$context['sandbox']['batch_max'] = max(1, ceil($context['sandbox']['sid_count'] / $options['range']['batch_size']));
$context['sandbox']['serial'] = 0;
$context['sandbox']['last_sid'] = 0;
}
// Retrieve the submissions for this batch process.
$options['range']['batch_number'] = $context['sandbox']['batch_number'];
$query = webform_download_sids_query($node->nid, $options['range']);
// Join to the users table to include user name in results, as required by
// webform_results_download_rows_process.
$query
->leftJoin('users', 'u', 'u.uid = ws.uid');
$query
->fields('u', array(
'name',
));
$query
->fields('ws');
if (!empty($options['sids'])) {
$query
->condition('ws.sid', $options['sids'], 'IN');
}
$submissions = webform_get_submissions_load($query);
$rows = webform_results_download_rows_process($node, $options, $context['sandbox']['serial'], $submissions);
// Write these submissions to the file.
$exporter = webform_export_create_handler($format, $options);
$handle = fopen($options['file_name'], 'a');
if (!$handle) {
return;
}
foreach ($rows as $row) {
$exporter
->add_row($handle, $row, $context['results']['row_count']);
$context['results']['row_count']++;
}
$context['sandbox']['serial'] += count($submissions);
$context['sandbox']['last_sid'] = end($submissions) ? key($submissions) : NULL;
$context['sandbox']['batch_number']++;
@fclose($handle);
// Display status message.
$context['message'] = t('Exported @count of @total submissions...', array(
'@count' => $context['sandbox']['serial'],
'@total' => $context['sandbox']['sid_count'],
));
$context['finished'] = $context['sandbox']['batch_number'] < $context['sandbox']['batch_max'] ? $context['sandbox']['batch_number'] / $context['sandbox']['batch_max'] : 1.0;
$context['results']['last_sid'] = $context['sandbox']['last_sid'];
}
/**
* Batch API callback; Write the closing bytes in the export file.
*/
function webform_results_batch_eof($node, $format = 'delimited', $options = array(), &$context = NULL) {
module_load_include('inc', 'webform', 'includes/webform.export');
$exporter = webform_export_create_handler($format, $options);
// We open the file for reading and writing, rather than just appending for
// exporters that need to adjust the beginning of the files as well as the
// end, i.e. webform_exporter_excel_xlsx::eof().
$handle = fopen($options['file_name'], 'r+');
if (!$handle) {
return;
}
// Move pointer to the end of the file.
fseek($handle, 0, SEEK_END);
$exporter
->eof($handle, $context['results']['row_count'], $context['results']['col_count']);
@fclose($handle);
}
/**
* Batch API callback; Do any last processing on the finished export.
*/
function webform_results_batch_post_process($node, $format = 'delimited', $options = array(), &$context = NULL) {
module_load_include('inc', 'webform', 'includes/webform.export');
$context['results']['node'] = $node;
$context['results']['file_name'] = $options['file_name'];
$exporter = webform_export_create_handler($format, $options);
$exporter
->post_process($context['results']);
}
/**
* Batch API callback; Set the $_SESSION variables used to download the file.
*
* Because we want the user to be returned to the main form first, we have to
* temporarily store information about the created file, send the user to the
* form, then use JavaScript to request node/x/webform-results/download-file,
* which will execute webform_results_download_file().
*/
function webform_results_batch_results($node, $format, $options, &$context) {
$export_info = array(
'format' => $format,
'options' => $options,
'file_name' => $context['results']['file_name'],
'row_count' => $context['results']['row_count'],
'last_sid' => $context['results']['last_sid'],
);
if (isset($_SESSION)) {
// UI exection. Defer resetting last-downloaded sid until download page. Set
// a session variable containing the information referencing the exported
// file. A cookie is also set to allow the browser to ensure the redirect to
// the file only happens one time.
$_SESSION['webform_export_info'] = $export_info;
$params = session_get_cookie_params();
setcookie('webform_export_info', '1', REQUEST_TIME + 120, $params['path'], $params['domain'], $params['secure'], FALSE);
}
else {
// Drush execution of wfx command. Reset last-downloaded sid now. $_SESSION
// is not supported for command line execution.
webform_results_export_success($node, $export_info);
}
}
/**
* Batch API completion callback; Display completion message and cleanup.
*/
function webform_results_batch_finished($success, $results, $operations) {
if ($success) {
$download_url = url('node/' . $results['node']->nid . '/webform-results/download-file');
drupal_set_message(t('Export creation complete. Your download should begin now. If it does not start, <a href="!href">download the file here</a>. This file may only be downloaded once.', array(
'!href' => $download_url,
)));
}
else {
drupal_set_message(t('An error occurred while generating the export file.'));
if (isset($results['file_name']) && is_file($results['file_name'])) {
@unlink($results['file_name']);
}
}
}
/**
* Provides a simple analysis of all submissions to a webform.
*
* @param $node
* The webform node on which to generate the analysis.
* @param $sids
* An array of submission IDs to which this analysis may be filtered. May be
* used to generate results that are per-user or other groups of submissions.
* @param $analysis_component
* A webform component. If passed in, additional information may be returned
* relating specifically to that component's analysis, such as a list of
* "Other" values within a select list.
*
* @return array
* Renderable array: A simple analysis of all submissions to a webform.
*/
function webform_results_analysis($node, $sids = array(), $analysis_component = NULL) {
if (!is_array($sids)) {
$sids = array();
}
// Build a renderable for the content of this page.
$analysis = array(
'#theme' => array(
'webform_analysis__' . $node->nid,
'webform_analysis',
),
'#node' => $node,
'#component' => $analysis_component,
);
// See if a query (possibly with exposed filter) needs to restrict the
// submissions that are being analyzed.
$query = NULL;
if (empty($sids)) {
$view = webform_get_view($node, 'webform_analysis');
if ($view->type != t('Default') || $view->name != 'webform_analysis') {
// The view has been customized from the no-op built-in view. Use it.
$view
->set_display();
$view
->init_handlers();
$view->override_url = $_GET['q'];
$view->preview = TRUE;
$view
->pre_execute(array(
$node->nid,
));
$view
->build();
// Let modules modify the view just prior to executing it.
foreach (module_implements('views_pre_execute') as $module) {
$function = $module . '_views_pre_execute';
$function($view);
}
// If the view is already executed, there was an error in generating it.
$query = $view->executed ? NULL : $view->query
->query();
$view
->post_execute();
if (isset($view->exposed_widgets)) {
$analysis['exposed_filter']['#markup'] = $view->exposed_widgets;
}
}
}
// If showing all components, display selection form.
if (!$analysis_component) {
$analysis['form'] = drupal_get_form('webform_analysis_components_form', $node);
}
// Add all the components to the analysis renderable array.
$components = isset($analysis_component) ? array(
$analysis_component['cid'],
) : webform_analysis_enabled_components($node);
foreach ($components as $cid) {
// Do component specific call.
$component = $node->webform['components'][$cid];
if ($data = webform_component_invoke($component['type'], 'analysis', $component, $sids, isset($analysis_component), $query)) {
drupal_alter('webform_analysis_component_data', $data, $node, $component);
$analysis['data'][$cid] = array(
'#theme' => array(
'webform_analysis_component__' . $node->nid . '__' . $cid,
'webform_analysis_component__' . $node->nid,
'webform_analysis_component',
),
'#node' => $node,
'#component' => $component,
'#data' => $data,
);
$analysis['data'][$cid]['basic'] = array(
'#theme' => array(
'webform_analysis_component_basic__' . $node->nid . '__' . $cid,
'webform_analysis_component_basic__' . $node->nid,
'webform_analysis_component_basic',
),
'#component' => $component,
'#data' => $data,
);
}
}
drupal_alter('webform_analysis', $analysis);
return $analysis;
}
/**
* Prerender function for webform-analysis.tpl.php.
*/
function template_preprocess_webform_analysis(&$variables) {
$analysis = $variables['analysis'];
$variables['node'] = $analysis['#node'];
$variables['component'] = $analysis['#component'];
}
/**
* Prerender function for webform-analysis-component.tpl.php.
*/
function template_preprocess_webform_analysis_component(&$variables) {
$component_analysis = $variables['component_analysis'];
$variables['node'] = $component_analysis['#node'];
$variables['component'] = $component_analysis['#component'];
// Ensure defaults.
$variables['component_analysis']['#data'] += array(
'table_header' => NULL,
'table_rows' => array(),
'other_data' => array(),
);
$variables['classes_array'][] = 'webform-analysis-component-' . $variables['component']['type'];
$variables['classes_array'][] = 'webform-analysis-component--' . str_replace('_', '-', implode('--', webform_component_parent_keys($variables['node'], $variables['component'])));
}
/**
* Render an individual component's analysis data in a table.
*
* @param $variables
* An array of theming variables for this theme function. Included keys:
* - $component: The component whose analysis is being rendered.
* - $data: An array of array containing the analysis data. Contains the keys:
* - table_header: If this table has more than a single column, an array
* of header labels.
* - table_rows: If this component has a table that should be rendered, an
* array of values
*
* @return string
* The rendered table.
*/
function theme_webform_analysis_component_basic($variables) {
$data = $variables['data'];
// Ensure defaults.
$data += array(
'table_header' => NULL,
'table_rows' => array(),
'other_data' => array(),
);
// Combine the "other data" into the table rows by default.
if (is_array($data['other_data'])) {
foreach ($data['other_data'] as $other_data) {
if (is_array($other_data)) {
$data['table_rows'][] = $other_data;
}
else {
$data['table_rows'][] = array(
array(
'colspan' => 2,
'data' => $other_data,
),
);
}
}
}
elseif (strlen($data['other_data'])) {
$data['table_rows'][] = array(
'colspan' => 2,
'data' => $data['other_data'],
);
}
return theme('table', array(
'header' => $data['table_header'],
'rows' => $data['table_rows'],
'sticky' => FALSE,
'attributes' => array(
'class' => array(
'webform-analysis-table',
),
),
));
}
/**
* Return a list of components that should be displayed for analysis.
*
* @param $node
* The node whose components' data is being analyzed.
*
* @return array
* An array of component IDs.
*/
function webform_analysis_enabled_components($node) {
$cids = array();
foreach ($node->webform['components'] as $cid => $component) {
if (!empty($component['extra']['analysis'])) {
$cids[] = $cid;
}
}
return $cids;
}
/**
* Form for selecting which components should be shown on the analysis page.
*/
function webform_analysis_components_form($form, &$form_state, $node) {
form_load_include($form_state, 'inc', 'webform', 'includes/webform.components');
$form['#node'] = $node;
$component_list = webform_component_list($node, 'analysis', TRUE);
$enabled_components = webform_analysis_enabled_components($node);
if (empty($component_list)) {
$help = t('No components have added that support analysis. <a href="!url">Add components to your form</a> to see calculated data.', array(
'!url' => url('node/' . $node->nid . '/webform'),
));
}
elseif (empty($enabled_components)) {
$help = t('No components have analysis enabled in this form. Enable analysis under the "Add analysis components" fieldset.');
}
else {
$help = t('This page shows analysis of submitted data, such as the number of submissions per component value, calculations, and averages. Additional components may be added under the "Add analysis components" fieldset.');
}
$form['help'] = array(
'#markup' => '<p>' . $help . '</p>',
'#access' => !empty($help),
'#weight' => -100,
);
$form['components'] = array(
'#type' => 'select',
'#title' => t('Add analysis components'),
'#options' => $component_list,
'#default_value' => $enabled_components,
'#multiple' => TRUE,
'#size' => 10,
'#description' => t('The selected components will be included on the analysis page.'),
'#process' => array(
'webform_component_select',
),
'#access' => count($component_list),
);
$form['actions'] = array(
'#type' => 'actions',
'#access' => count($component_list),
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Update analysis display'),
);
return $form;
}
/**
* Submit handler for webform_analysis_components_form().
*/
function webform_analysis_components_form_submit($form, $form_state) {
$node = $form['#node'];
// Get a fresh copy of the node so that we are only saving these changes.
// Otherwise, changes to the Webform on another tab will be overwritten.
$node = node_load($node->nid, NULL, TRUE);
foreach ($form_state['values']['components'] as $cid => $enabled) {
$node->webform['components'][$cid]['extra']['analysis'] = (bool) $enabled;
}
node_save($node);
}
/**
* Output the content of the Analysis page.
*
* @see webform_results_analysis()
*/
function theme_webform_results_analysis($variables) {
$node = $variables['node'];
$data = $variables['data'];
$analysis_component = $variables['component'];
$rows = array();
$question_number = 0;
$single = isset($analysis_component);
$header = array(
$single ? $analysis_component['name'] : t('Q'),
array(
'data' => $single ? ' ' : t('responses'),
'colspan' => '10',
),
);
foreach ($data as $cid => $row_data) {
$question_number++;
if (is_array($row_data)) {
$row = array();
if (!$single) {
$row['data'][] = array(
'data' => '<strong>' . $question_number . '</strong>',
'rowspan' => count($row_data) + 1,
'valign' => 'top',
);
$row['data'][] = array(
'data' => '<strong>' . check_plain($node->webform['components'][$cid]['name']) . '</strong>',
'colspan' => '10',
);
$row['class'][] = 'webform-results-question';
}
$rows = array_merge($rows, array_merge(array(
$row,
), $row_data));
}
}
if (count($rows) == 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,
),
);
}
return theme('table', array(
'header' => $header,
'rows' => $rows,
'sticky' => FALSE,
'attributes' => array(
'class' => array(
'webform-results-analysis',
),
),
));
}
/**
* Given a set of range options, retrieve a set of SIDs for a webform node.
*
* @param int $nid
* The node id of the webform.
* @param array $range_options
* Associate array of range options.
* @param int $uid
* The user id of the user whose last download information should be used,
* or the current user if NULL. This is unrelated to which user submitted
* the submissions.
*
* @return array
* An array of submission IDs.
*/
function webform_download_sids($nid, array $range_options, $uid = NULL) {
return webform_download_sids_query($nid, $range_options, $uid)
->fields('ws', array(
'sid',
))
->execute()
->fetchCol();
}
/**
* Retrieves a count the number of matching submissions.
*
* @return int
* The number number of matching submissions.
*/
function webform_download_sids_count($nid, $range_options, $uid = NULL) {
return (int) webform_download_sids_query($nid, $range_options, $uid)
->countQuery()
->execute()
->fetchField();
}
/**
* Given a set of range options, return an unexecuted select query.
*
* The query will have no fields as they should be added by the caller as
* desired.
*
* @param int $nid
* The node id of the webform.
* @param array $range_options
* Associate array of range options.
* @param int $uid
* The user id of the user whose last download information should be used,
* or the current user if NULL. This is unrelated to which user submitted
* the submissions.
*
* @return QueryAlterableInterface
* The query object.
*/
function webform_download_sids_query($nid, array $range_options, $uid = NULL) {
$query = db_select('webform_submissions', 'ws')
->condition('ws.nid', $nid)
->addTag('webform_download_sids');
switch ($range_options['range_type']) {
case 'all':
// All Submissions.
$query
->orderBy('ws.sid', 'ASC');
break;
case 'latest':
// Last x Submissions.
$start_sid = webform_download_latest_start_sid($nid, $range_options['latest'], $range_options['completion_type']);
$query
->condition('ws.sid', $start_sid, '>=');
break;
case 'range':
// Submissions Start-End.
$query
->condition('ws.sid', $range_options['start'], '>=');
if ($range_options['end']) {
$query
->condition('ws.sid', $range_options['end'], '<=');
}
$query
->orderBy('ws.sid', 'ASC');
break;
case 'range_serial':
// Submissions Start-End, using serial numbers.
$query
->condition('ws.serial', $range_options['start'], '>=');
if ($range_options['end']) {
$query
->condition('ws.serial', $range_options['end'], '<=');
}
$query
->orderBy('ws.serial', 'ASC');
break;
case 'new':
// All since last download. This is the same as 'range_date' except that
// the start date is the date of the last download.
$download_info = webform_download_last_download_info($nid, $uid);
$start_date = (int) $download_info ? $download_info['requested'] : 0;
$end_time = NULL;
// Fall through.
case 'range_date':
// If the submission is completed, use the completed date, otherwise, the
// submitted date.
$date_field = 'COALESCE(NULLIF(ws.completed, 0), ws.submitted)';
// This is required because SQLite uses dynamic typing.
if (db_driver() === 'sqlite') {
$date_field = 'CAST(' . $date_field . ' AS INTEGER)';
}
if (!isset($start_date)) {
$format = webform_date_format('short');
$start_date = DateTime::createFromFormat($format, $range_options['start_date']);
$start_date
->setTime(0, 0, 0);
$start_date = $start_date
->getTimestamp();
$end_time = DateTime::createFromFormat($format, $range_options['end_date']);
}
$query
->where($date_field . ' >= :start_date', array(
':start_date' => $start_date,
));
if ($end_time) {
// Check for the full day's submissions.
$end_time
->setTime(23, 59, 59);
$end_time = $end_time
->getTimestamp();
$query
->where($date_field . ' <= :end_time', array(
':end_time' => $end_time,
));
}
$query
->orderBy($date_field, 'ASC');
break;
}
// Filter down to draft or finished submissions.
if (!empty($range_options['completion_type']) && $range_options['completion_type'] !== 'all') {
$query
->condition('is_draft', (int) ($range_options['completion_type'] === 'draft'));
}
if (isset($range_options['batch_number']) && !empty($range_options['batch_size'])) {
$query
->range($range_options['batch_number'] * $range_options['batch_size'], $range_options['batch_size']);
}
drupal_alter('webform_download_sids_query', $query);
return $query;
}
/**
* Get this user's last download information, including the SID and timestamp.
*
* This function provides an array of information about the last download that
* a user had for a particular Webform node. Currently it only returns an array
* with two keys:
* - sid: The last submission ID that was downloaded.
* - requested: The timestamp of the last download request.
*
* @param $nid
* The Webform NID.
* @param $uid
* The user account ID for which to retrieve download information.
*
* @return array|false
* An array of download information or FALSE if this user has never downloaded
* results for this particular node.
*/
function webform_download_last_download_info($nid, $uid = NULL) {
$uid = isset($uid) ? $uid : $GLOBALS['user']->uid;
$query = db_select('webform_last_download', 'wld');
$query
->leftJoin('webform_submissions', 'wfs', 'wld.sid = wfs.sid');
$info = $query
->fields('wld')
->fields('wfs', array(
'serial',
))
->condition('wld.nid', $nid)
->condition('wld.uid', $uid)
->execute()
->fetchAssoc();
return $info;
}
/**
* Get an SID based a requested latest count.
*
* @param int $nid
* The webform NID.
* @param int $latest_count
* The latest count on which the SID will be retrieved.
* @param string $completion_type
* The completion type, either "finished", "draft", or "all".
*
* @return int
* The submission ID that starts the latest sequence of submissions.
*/
function webform_download_latest_start_sid($nid, $latest_count, $completion_type = 'all') {
// @todo Find a more efficient DBTNG query to retrieve this number.
$query = db_select('webform_submissions', 'ws')
->fields('ws', array(
'sid',
))
->condition('nid', $nid)
->orderBy('ws.sid', 'DESC')
->range(0, $latest_count)
->addTag('webform_download_latest_start_sid');
if ($completion_type !== 'all') {
$query
->condition('is_draft', (int) ($completion_type === 'draft'));
}
$latest_sids = $query
->execute()
->fetchCol();
return $latest_sids ? min($latest_sids) : 1;
}Functions
Name |
Description |
|---|---|
| template_preprocess_webform_analysis | Prerender function for webform-analysis.tpl.php. |
| template_preprocess_webform_analysis_component | Prerender function for webform-analysis-component.tpl.php. |
| template_preprocess_webform_results_submissions | Preprocess function for webform-results-submissions.tpl.php. |
| theme_webform_analysis_component_basic | Render an individual component's analysis data in a table. |
| theme_webform_results_analysis | Output the content of the Analysis page. |
| theme_webform_results_download_range | Theme the output of the export range fieldset. |
| theme_webform_results_download_select_format | Theme the output of the select list format radio buttons. |
| theme_webform_results_per_page | Theme the list of links for selecting the number of results per page. |
| theme_webform_results_submissions_header | Theme the header of the submissions table. |
| theme_webform_results_table | Theme the results table displaying all the submissions for a particular node. |
| theme_webform_results_table_header | Theme function for the Webform results table header. |
| webform_analysis_components_form | Form for selecting which components should be shown on the analysis page. |
| webform_analysis_components_form_submit | Submit handler for webform_analysis_components_form(). |
| webform_analysis_enabled_components | Return a list of components that should be displayed for analysis. |
| webform_clear_batch_finished | Batch API completion callback; Finish clearing submissions. |
| webform_clear_batch_rows | Batch API callback; Write the rows of the export to the export file. |
| webform_download_last_download_info | Get this user's last download information, including the SID and timestamp. |
| webform_download_latest_start_sid | Get an SID based a requested latest count. |
| webform_download_sids | Given a set of range options, retrieve a set of SIDs for a webform node. |
| webform_download_sids_count | Retrieves a count the number of matching submissions. |
| webform_download_sids_query | Given a set of range options, return an unexecuted select query. |
| webform_export_batch_size | Calculate an appropriate batch size for bulk submission operations. |
| webform_get_view | Returns the most appropriate view for this webform node. |
| webform_results_analysis | Provides a simple analysis of all submissions to a webform. |
| webform_results_batch_bof | Batch API callback; Write the opening byte in the export file. |
| webform_results_batch_eof | Batch API callback; Write the closing bytes in the export file. |
| webform_results_batch_finished | Batch API completion callback; Display completion message and cleanup. |
| webform_results_batch_headers | Batch API callback; Write the headers of the export to the export file. |
| webform_results_batch_post_process | Batch API callback; Do any last processing on the finished export. |
| webform_results_batch_results | Batch API callback; Set the $_SESSION variables used to download the file. |
| webform_results_batch_rows | Batch API callback; Write the rows of the export to the export file. |
| webform_results_clear | Delete all submissions for a node. |
| webform_results_clear_form | Confirmation form to delete all submissions for a node. |
| webform_results_clear_form_submit | Form submit handler. |
| webform_results_download | Send a generated webform results file to the user's browser. |
| webform_results_download_callback | Menu callback; Download an exported file. |
| webform_results_download_default_options | Get options for creating downloadable versions of the webform data. |
| webform_results_download_form | Form to configure the download of CSV files. |
| webform_results_download_form_submit | Submit handler for webform_results_download_form(). |
| webform_results_download_headers | Print the header rows for the downloadable webform data. |
| webform_results_download_range_after_build | FormAPI after build function for the download range fieldset. |
| webform_results_download_range_validate | FormAPI element validate function for the range fieldset. |
| webform_results_download_rows Deprecated | Returns rows of downloadable webform data. |
| webform_results_download_rows_process | Processes the submissions to be downloaded into exported rows. |
| webform_results_download_submission_information | Default columns for submission information. |
| webform_results_export Deprecated | Generate a Excel-readable CSV file containing all submissions for a Webform. |
| webform_results_export_batch | Return a Batch API array of commands that will generate an export. |
| webform_results_export_success | Save the last-exported sid for new-only exports. |
| webform_results_submissions | Retrieve lists of submissions for a given webform. |
| webform_results_table | Create a table containing all submitted values for a webform node. |
| webform_update_webform_last_download | Insert or update a download record in table {webform_last_download}. |
| webform_webform_results_download_submission_information_data | Implements hook_webform_results_download_submission_information_data(). |
| webform_webform_results_download_submission_information_info | Implements hook_webform_results_download_submission_information_info(). |
| _webform_export_tempname | Returns a temporary export filename. |