webform.submissions.inc in Webform 6.3
Same filename and directory in other branches
This file is loaded when handling submissions, either submitting new, editing, or viewing. It also contains all CRUD functions for submissions.
@author Nathan Haug <nate@lullabot.com>
File
includes/webform.submissions.incView source
<?php
/**
* @file
* This file is loaded when handling submissions, either submitting new,
* editing, or viewing. It also contains all CRUD functions for submissions.
*
* @author Nathan Haug <nate@lullabot.com>
*/
/**
* Given an array of submitted values, flatten it into data for a submission.
*
* @param $node
* The node object containing the current webform.
* @param $submitted
* The submitted user values from the webform.
* @return
* An array suitable for use in the 'data' property of a $submission object.
*/
function webform_submission_data($node, $submitted) {
$data = array();
foreach ($submitted as $cid => $values) {
// Don't save pagebreaks as submitted data.
if ($node->webform['components'][$cid]['type'] == 'pagebreak') {
continue;
}
if (is_array($values)) {
$data[$cid]['value'] = $values;
}
else {
$data[$cid]['value'][0] = $values;
}
}
return $data;
}
/**
* Update a webform submission entry in the database.
*
* @param $node
* The node object containing the current webform.
* @param $submission
* The webform submission object to be saved into the database.
* @return
* The existing submission SID.
*/
function webform_submission_update($node, $submission) {
// Allow other modules to modify the submission before saving.
foreach (module_implements('webform_submission_presave') as $module) {
$function = $module . '_webform_submission_presave';
$function($node, $submission);
}
// Update the main submission info.
drupal_write_record('webform_submissions', $submission, 'sid');
// If is draft, only delete data for components submitted, to
// preserve any data from form pages not visited in this submission.
if ($submission->is_draft) {
$submitted_cids = array_keys($submission->data);
if ($submitted_cids) {
$placeholders = db_placeholders($submitted_cids);
$arguments = array_merge(array(
$submission->sid,
), $submitted_cids);
db_query("DELETE FROM {webform_submitted_data} WHERE sid = %d AND cid IN (" . $placeholders . ")", $arguments);
}
}
else {
db_query("DELETE FROM {webform_submitted_data} WHERE sid = %d", $submission->sid);
}
// Then re-add submission data to the database.
$submission->is_new = FALSE;
webform_submission_insert($node, $submission);
module_invoke_all('webform_submission_update', $node, $submission);
return $submission->sid;
}
/**
* Insert a webform submission entry in the database.
*
* @param $node
* The node object containing the current webform.
* @param $submission
* The webform submission object to be saved into the database.
* @return
* The new submission SID.
*/
function webform_submission_insert($node, $submission) {
// The submission ID may already be set if being called as an update.
if (!isset($submission->sid) && (!isset($submission->is_new) || $submission->is_new == FALSE)) {
// Allow other modules to modify the submission before saving.
foreach (module_implements('webform_submission_presave') as $module) {
$function = $module . '_webform_submission_presave';
$function($node, $submission);
}
$submission->nid = $node->webform['nid'];
drupal_write_record('webform_submissions', $submission);
$is_new = TRUE;
}
foreach ($submission->data as $cid => $values) {
foreach ($values['value'] as $delta => $value) {
$data = array(
'nid' => $node->webform['nid'],
'sid' => $submission->sid,
'cid' => $cid,
'no' => $delta,
'data' => is_null($value) ? '' : $value,
);
drupal_write_record('webform_submitted_data', $data);
}
}
// Invoke the insert hook after saving all the data.
if (isset($is_new)) {
module_invoke_all('webform_submission_insert', $node, $submission);
}
return $submission->sid;
}
/**
* Delete a single submission.
*
* @param $nid
* ID of node for which this webform was submitted.
* @param $sid
* ID of submission to be deleted (from webform_submitted_data).
*/
function webform_submission_delete($node, $submission) {
// Iterate through all components and let each do cleanup if necessary.
foreach ($node->webform['components'] as $cid => $component) {
if (isset($submission->data[$cid])) {
webform_component_invoke($component['type'], 'delete', $component, $submission->data[$cid]['value']);
}
}
// Delete any anonymous session information.
if (isset($_SESSION['webform_submission'][$submission->sid])) {
unset($_SESSION['webform_submission'][$submission->sid]);
}
db_query('DELETE FROM {webform_submitted_data} WHERE nid = %d AND sid = %d', $node->nid, $submission->sid);
db_query('DELETE FROM {webform_submissions} WHERE nid = %d AND sid = %d', $node->nid, $submission->sid);
module_invoke_all('webform_submission_delete', $node, $submission);
}
/**
* Send related e-mails related to a submission.
*
* This function is usually invoked when a submission is completed, but may be
* called any time e-mails should be redelivered.
*
* @param $node
* The node object containing the current webform.
* @param $submission
* The webform submission object to be used in sending e-mails.
* @param $emails
* (optional) An array of specific e-mail settings to be used. If omitted, all
* e-mails in $node->webform['emails'] will be sent.
*/
function webform_submission_send_mail($node, $submission, $emails = NULL) {
global $user;
// Get the list of e-mails we'll be sending.
$emails = isset($emails) ? $emails : $node->webform['emails'];
// Create a themed message for mailing.
$send_count = 0;
foreach ($emails as $eid => $email) {
// Set the HTML property based on availablity of MIME Mail.
$email['html'] = $email['html'] && webform_email_html_capable();
// Pass through the theme layer if using the default template.
if ($email['template'] == 'default') {
$email['message'] = theme(array(
'webform_mail_' . $node->nid,
'webform_mail',
'webform_mail_message',
), $node, $submission, $email);
}
else {
$email['message'] = $email['template'];
}
// Replace tokens in the message.
$email['message'] = _webform_filter_values($email['message'], $node, $submission, $email, FALSE, TRUE);
// Build the e-mail headers.
$email['headers'] = theme(array(
'webform_mail_headers_' . $node->nid,
'webform_mail_headers',
), $node, $submission, $email);
// Assemble the From string.
if (isset($email['headers']['From'])) {
// If a header From is already set, don't override it.
$email['from'] = $email['headers']['From'];
unset($email['headers']['From']);
}
else {
$email['from'] = webform_format_email_address($email['from_address'], $email['from_name'], $node, $submission);
}
// Update the subject if set in the themed headers.
if (isset($email['headers']['Subject'])) {
$email['subject'] = $email['headers']['Subject'];
unset($email['headers']['Subject']);
}
else {
$email['subject'] = webform_format_email_subject($email['subject'], $node, $submission);
}
// Update the to e-mail if set in the themed headers.
if (isset($email['headers']['To'])) {
$email['email'] = $email['headers']['To'];
unset($email['headers']['To']);
}
// Generate the list of addresses that this e-mail will be sent to.
$addresses = array_filter(explode(',', $email['email']));
$addresses_final = array();
foreach ($addresses as $address) {
$address = trim($address);
// After filtering e-mail addresses with component values, a single value
// might contain multiple addresses (such as from checkboxes or selects).
$address = webform_format_email_address($address, NULL, $node, $submission, TRUE, FALSE, 'short');
if (is_array($address)) {
foreach ($address as $new_address) {
$new_address = trim($new_address);
if (valid_email_address($new_address)) {
$addresses_final[] = $new_address;
}
}
}
elseif (valid_email_address($address)) {
$addresses_final[] = $address;
}
}
// Mail the webform results.
foreach ($addresses_final as $address) {
// Verify that this submission is not attempting to send any spam hacks.
if (_webform_submission_spam_check($address, $email['subject'], $email['from'], $email['headers'])) {
watchdog('webform', 'Possible spam attempt from @remote_addr' . "<br />\n" . nl2br(htmlentities($email['message'])), array(
'@remote_add' => ip_address(),
));
drupal_set_message(t('Illegal information. Data not submitted.'), 'error');
return FALSE;
}
$language = $user->uid ? user_preferred_language($user) : language_default();
$mail_params = array(
'message' => $email['message'],
'subject' => $email['subject'],
'headers' => $email['headers'],
'node' => $node,
'submission' => $submission,
'email' => $email,
);
if (webform_email_html_capable()) {
// Load attachments for the e-mail.
$attachments = array();
if ($email['attachments']) {
webform_component_include('file');
foreach ($node->webform['components'] as $component) {
if (webform_component_feature($component['type'], 'attachment') && !empty($submission->data[$component['cid']]['value'][0])) {
if (webform_component_implements($component['type'], 'attachments')) {
$files = webform_component_invoke($component['type'], 'attachments', $component, $submission->data[$component['cid']]['value']);
if ($files) {
$attachments = array_merge($attachments, $files);
}
}
}
}
}
// Enable drupal_mail_alter() to alter attachments.
$mail_params['attachments'] = $attachments;
// Prepare (but don't send) the e-mail normally.
$message = drupal_mail('webform', 'submission', $address, $language, $mail_params, $email['from'], FALSE);
// Send the e-mail via MIME mail.
$message = mimemail($message['from'], $message['to'], $message['subject'], $message['body'], !$email['html'], $message['headers'], $email['html'] ? NULL : $message['body'], $message['params']['attachments'], 'webform');
// Support boolean (older) or array-based return values from MIME Mail.
if (is_array($message) && $message['result'] || !is_array($message) && $message) {
$send_count++;
}
}
else {
// Normal Drupal mailer.
$message = drupal_mail('webform', 'submission', $address, $language, $mail_params, $email['from']);
if ($message['result']) {
$send_count++;
}
}
}
}
return $send_count;
}
/**
* Confirm form to delete a single form submission.
*
* @param $form_state
* The current form state.
* @param $node
* The node for which this webform was submitted.
* @param $submission
* The submission to be deleted (from webform_submitted_data).
*/
function webform_submission_delete_form($form_state, $node, $submission) {
webform_set_breadcrumb($node, $submission);
// Set the correct page title.
drupal_set_title(webform_submission_title($node, $submission));
// Keep the NID and SID in the same location as the webform_client_form().
// This helps mollom identify the same fields when deleting a submission.
$form['#tree'] = TRUE;
$form['details']['nid'] = array(
'#type' => 'value',
'#value' => $node->nid,
);
$form['details']['sid'] = array(
'#type' => 'value',
'#value' => $submission->sid,
);
$question = t('Are you sure you want to delete this submission?');
if (isset($_GET['destination'])) {
$destination = $_GET['destination'];
}
elseif (webform_results_access($node)) {
$destination = 'node/' . $node->nid . '/webform-results';
}
else {
$destination = 'node/' . $node->nid . '/submissions';
}
return confirm_form($form, NULL, $destination, $question, t('Delete'), t('Cancel'));
}
function webform_submission_delete_form_submit($form, &$form_state) {
$node = node_load($form_state['values']['details']['nid']);
$submission = webform_get_submission($form_state['values']['details']['nid'], $form_state['values']['details']['sid']);
webform_submission_delete($node, $submission);
drupal_set_message(t('Submission deleted.'));
$form_state['redirect'] = 'node/' . $node->nid . '/webform-results';
}
/**
* Menu title callback; Return the submission number as a title.
*/
function webform_submission_title($node, $submission) {
return t('Submission #@sid', array(
'@sid' => $submission->sid,
));
}
/**
* Menu callback; Present a Webform submission page for display or editing.
*/
function webform_submission_page($node, $submission, $format) {
global $user;
// Add admin CSS.
drupal_add_css(drupal_get_path('module', 'webform') . '/css/webform-admin.css', 'module', 'all', FALSE);
// Render the admin UI breadcrumb.
webform_set_breadcrumb($node, $submission);
// Set the correct page title.
drupal_set_title(webform_submission_title($node, $submission));
if ($format == 'form') {
$output = drupal_get_form('webform_client_form_' . $node->nid, $node, $submission);
}
else {
$output = webform_submission_render($node, $submission, NULL, $format);
}
// Determine the mode in which we're displaying this submission.
$mode = $format != 'form' ? 'display' : 'form';
if (strpos(request_uri(), 'print/') !== FALSE) {
$mode = 'print';
}
if (strpos(request_uri(), 'printpdf/') !== FALSE) {
$mode = 'pdf';
}
// Add navigation for administrators.
if (webform_results_access($node)) {
$navigation = theme('webform_submission_navigation', $node, $submission, $mode);
$information = theme('webform_submission_information', $node, $submission, $mode);
}
else {
$navigation = NULL;
$information = NULL;
}
// Actions may be shown to all users.
$actions = theme('links', module_invoke_all('webform_submission_actions', $node, $submission), array(
'class' => 'links inline webform-submission-actions',
));
// Disable the page cache for anonymous users viewing or editing submissions.
if (!$user->uid) {
webform_disable_page_cache();
}
return theme('webform_submission_page', $node, $submission, $output, $navigation, $information, $actions, $mode);
}
/**
* Form to resend specific e-mails associated with a submission.
*/
function webform_submission_resend($form_state, $node, $submission) {
// Render the admin UI breadcrumb.
webform_set_breadcrumb($node, $submission);
$form['#tree'] = TRUE;
$form['#node'] = $node;
$form['#submission'] = $submission;
foreach ($node->webform['emails'] as $eid => $email) {
$email_addresses = array_filter(explode(',', check_plain($email['email'])));
foreach ($email_addresses as $key => $email_address) {
$email_addresses[$key] = webform_format_email_address($email_address, NULL, $node, $submission, FALSE);
}
$valid_email = !empty($email_addresses[0]) && valid_email_address($email_addresses[0]);
$form['resend'][$eid] = array(
'#type' => 'checkbox',
'#default_value' => $valid_email ? TRUE : FALSE,
'#disabled' => $valid_email ? FALSE : TRUE,
);
$form['emails'][$eid]['email'] = array(
'#value' => implode('<br />', $email_addresses),
);
if (!$valid_email) {
$form['emails'][$eid]['email']['#value'] .= ' (' . t('empty') . ')';
}
$form['emails'][$eid]['subject'] = array(
'#value' => check_plain(webform_format_email_subject($email['subject'], $node, $submission)),
);
$form['actions'] = array(
'#type' => 'markup',
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Resend e-mails'),
);
$form['actions']['cancel'] = array(
'#type' => 'markup',
'#value' => l(t('Cancel'), isset($_GET['destination']) ? $_GET['destination'] : 'node/' . $node->nid . '/submission/' . $submission->sid),
);
}
return $form;
}
/**
* Validate handler for webform_submission_resend().
*/
function webform_submission_resend_validate($form, &$form_state) {
if (count(array_filter($form_state['values']['resend'])) == 0) {
form_set_error('emails', t('You must select at least one email address to resend submission.'));
}
}
/**
* Submit handler for webform_submission_resend().
*/
function webform_submission_resend_submit($form, &$form_state) {
$node = $form['#node'];
$submission = $form['#submission'];
$emails = array();
foreach ($form_state['values']['resend'] as $eid => $checked) {
if ($checked) {
$emails[] = $form['#node']->webform['emails'][$eid];
}
}
$sent_count = webform_submission_send_mail($node, $submission, $emails);
if ($sent_count) {
drupal_set_message(format_plural($sent_count, 'Successfully re-sent submission #@sid to 1 recipient.', 'Successfully re-sent submission #@sid to @count recipients.', array(
'@sid' => $submission->sid,
)));
}
else {
drupal_set_message(t('No e-mails were able to be sent due to a server error.'), 'error');
}
}
/**
* Theme the node components form. Use a table to organize the components.
*
* @param $form
* The form array.
* @return
* Formatted HTML form, ready for display.
*/
function theme_webform_submission_resend($form) {
$header = array(
'',
t('E-mail to'),
t('Subject'),
);
$rows = array();
if (!empty($form['emails'])) {
foreach (element_children($form['emails']) as $eid) {
// Add each component to a table row.
$rows[] = array(
drupal_render($form['resend'][$eid]),
drupal_render($form['emails'][$eid]['email']),
drupal_render($form['emails'][$eid]['subject']),
);
}
}
else {
$rows[] = array(
array(
'data' => t('This webform is currently not setup to send emails.'),
'colspan' => 3,
),
);
}
$output = '';
$output .= theme('table', $header, $rows, array(
'id' => 'webform-emails',
));
$output .= drupal_render($form);
return $output;
}
/**
* Print a Webform submission for display on a page or in an e-mail.
*/
function webform_submission_render($node, $submission, $email, $format) {
$component_tree = array();
$renderable = array();
$page_count = 1;
$excluded_components = isset($email) ? $email['excluded_components'] : array();
// Meta data that may be useful for modules implementing
// hook_webform_submission_render_alter().
$renderable['#node'] = $node;
$renderable['#submission'] = $submission;
$renderable['#email'] = $email;
$renderable['#format'] = $format;
// Set the theme function for submissions.
$renderable['#theme'] = array(
'webform_submission_' . $node->nid,
'webform_submission',
);
// Remove excluded components.
$components = $node->webform['components'];
foreach ($excluded_components as $cid) {
unset($components[$cid]);
}
_webform_components_tree_build($components, $component_tree, 0, $page_count);
// Make sure at least one field is available
if (isset($component_tree['children'])) {
// Recursively add components to the form.
foreach ($component_tree['children'] as $cid => $component) {
if (_webform_client_form_rule_check($node, $component, $component['page_num'], NULL, $submission)) {
_webform_client_form_add_component($node, $component, NULL, $renderable, $renderable, NULL, $submission, $format);
}
}
}
drupal_alter('webform_submission_render', $renderable);
return drupal_render($renderable);
}
/**
* Return all the submissions for a particular node.
*
* @param $filters
* An array of filters to apply to this query. Usually in the format
* array('nid' => $nid, 'uid' => $uid). A single integer may also be passed
* in, which will be equivalent to specifying a $nid filter.
* @param $header
* If the results of this fetch will be used in a sortable
* table, pass the array header of the table.
* @param $pager_count
* Optional. The number of submissions to include in the results.
*/
function webform_get_submissions($filters = array(), $header = NULL, $pager_count = 0) {
$submissions = array();
if (!is_array($filters)) {
$filters = array(
'nid' => $filters,
);
}
// UID filters need to be against a specific table.
if (isset($filters['uid'])) {
$filters['u.uid'] = $filters['uid'];
unset($filters['uid']);
}
// No need to find SIDs if it was given to us.
if (isset($filters['sid'])) {
if (is_array($filters['sid'])) {
$sids = $filters['sid'];
}
else {
$sids = array(
$filters['sid'],
);
}
}
else {
$arguments = array_values($filters);
$where = array();
foreach ($filters as $column => $value) {
$where[] = $column . ' = ' . (is_numeric($value) ? '%d' : "'%s'");
}
if (isset($filters['u.uid']) && $filters['u.uid'] === 0) {
if (!empty($_SESSION['webform_submission'])) {
$anonymous_sids = array_keys($_SESSION['webform_submission']);
$where[] = 'sid IN (' . db_placeholders($anonymous_sids) . ')';
$arguments = array_merge($arguments, $anonymous_sids);
}
else {
$where[] = 'sid = 0';
}
}
$where_clause = implode(' AND ', $where);
$pager_query = 'SELECT sid FROM {webform_submissions} s LEFT JOIN {users} u ON u.uid = s.uid WHERE ' . $where_clause;
if (is_array($header)) {
$pager_query .= tablesort_sql($header);
}
else {
$pager_query .= ' ORDER BY sid ASC';
}
if ($pager_count) {
$result = pager_query($pager_query, $pager_count, 0, NULL, $arguments);
}
else {
$result = db_query($pager_query, $arguments);
}
$sids = array();
while ($row = db_fetch_object($result)) {
$sids[] = $row->sid;
$submissions[$row->sid] = FALSE;
}
}
// If there are no submissions being retrieved, return an empty array.
if (empty($sids)) {
return $submissions;
}
// Query the required submission data.
$query = 'SELECT s.*, sd.cid, sd.no, sd.data, u.name, u.mail, u.status ' . 'FROM {webform_submitted_data} sd ' . 'LEFT JOIN {webform_submissions} s ON s.sid = sd.sid ' . 'LEFT JOIN {users} u ON u.uid = s.uid ' . 'WHERE sd.sid IN (' . db_placeholders($sids) . ') ' . (isset($filters['nid']) ? 'AND sd.nid = %d ' : '') . 'ORDER BY sd.sid ASC, sd.cid ASC, sd.no ASC';
$args = $sids;
if (isset($filters['nid'])) {
$args[] = $filters['nid'];
}
$result = db_query($query, $args);
// Convert the queried rows into submissions.
$previous = array();
while ($row = db_fetch_object($result)) {
if ($row->sid != $previous) {
$submissions[$row->sid] = new stdClass();
$submissions[$row->sid]->sid = $row->sid;
$submissions[$row->sid]->nid = $row->nid;
$submissions[$row->sid]->submitted = $row->submitted;
$submissions[$row->sid]->remote_addr = $row->remote_addr;
$submissions[$row->sid]->uid = $row->uid;
$submissions[$row->sid]->name = $row->name;
$submissions[$row->sid]->is_draft = $row->is_draft;
$submissions[$row->sid]->data = array();
}
// CID may be NULL if this submission does not actually contain any data.
if ($row->cid) {
$submissions[$row->sid]->data[$row->cid]['value'][$row->no] = $row->data;
}
$previous = $row->sid;
}
foreach (module_implements('webform_submission_load') as $module) {
$function = $module . '_webform_submission_load';
$function($submissions);
}
return $submissions;
}
/**
* Return a count of the total number of submissions for a node.
*
* @param $nid
* The node ID for which submissions are being fetched.
* @param $uid
* Optional; the user ID to filter the submissions by.
* @return
* An integer value of the number of submissions.
*/
function webform_get_submission_count($nid, $uid = NULL, $reset = FALSE) {
static $counts;
if (!isset($counts[$nid][$uid]) || $reset) {
$query = 'SELECT count(*) FROM {webform_submissions} WHERE nid = %d AND is_draft = 0';
$arguments = array(
$nid,
);
if ($uid !== NULL) {
$query .= ' AND uid = %d';
$arguments[] = $uid;
}
if ($uid === 0) {
$submissions = isset($_SESSION['webform_submission']) ? $_SESSION['webform_submission'] : array();
$query .= count($submissions) ? ' AND sid IN (' . db_placeholders($submissions) . ')' : ' AND sid = 0';
$arguments = array_merge($arguments, array_keys($submissions));
}
$counts[$nid][$uid] = db_result(db_query($query, $arguments));
}
return $counts[$nid][$uid];
}
/**
* Fetch a specified submission for a webform node.
*/
function webform_get_submission($nid, $sid, $reset = FALSE) {
static $submissions = array();
if ($reset) {
$submissions = array();
if (!isset($sid)) {
return;
}
}
// Load the submission if needed.
if (!isset($submissions[$sid])) {
$new_submissions = webform_get_submissions(array(
'nid' => $nid,
'sid' => $sid,
));
$submissions[$sid] = isset($new_submissions[$sid]) ? $new_submissions[$sid] : FALSE;
}
return $submissions[$sid];
}
function _webform_submission_spam_check($to, $subject, $from, $headers = array()) {
$headers = implode('\\n', (array) $headers);
// Check if they are attempting to spam using a bcc or content type hack.
if (preg_match('/(b?cc\\s?:)|(content\\-type:)/i', $to . "\n" . $subject . "\n" . $from . "\n" . $headers)) {
return TRUE;
// Possible spam attempt.
}
return FALSE;
// Not spam.
}
/**
* Check if the current user has exceeded the limit on this form.
*
* @param $node
* The webform node to be checked.
* @return
* Boolean TRUE if the user has exceeded their limit. FALSE otherwise.
*/
function _webform_submission_user_limit_check($node) {
global $user;
// Check if submission limiting is enabled.
if ($node->webform['submit_limit'] == '-1') {
return FALSE;
// No check enabled.
}
// Retrieve submission data for this IP address or username from the database.
$query = 'SELECT count(*) ' . 'FROM {webform_submissions} ' . "WHERE (( 0 = %d AND remote_addr = '%s') OR (uid > 0 AND uid = %d)) " . 'AND submitted > %d AND nid = %d AND is_draft = 0';
// Fetch all the entries from the database within the submit interval with this username and IP.
$num_submissions_database = db_result(db_query($query, $user->uid, ip_address(), $user->uid, $node->webform['submit_interval'] != -1 ? time() - $node->webform['submit_interval'] : $node->webform['submit_interval'], $node->nid));
// Double check the submission history from the users machine using cookies.
$num_submissions_cookie = 0;
if ($user->uid == 0 && variable_get('webform_use_cookies', 0)) {
$cookie_name = 'webform-' . $node->nid;
if (isset($_COOKIE[$cookie_name]) && is_array($_COOKIE[$cookie_name])) {
foreach ($_COOKIE[$cookie_name] as $key => $timestamp) {
if ($node->webform['submit_interval'] != -1 && $timestamp <= time() - $node->webform['submit_interval']) {
// Remove the cookie if past the required time interval.
$params = session_get_cookie_params();
setcookie($cookie_name . '[' . $key . ']', '', 0, $params['path'], $params['domain'], $params['secure']);
}
}
// Count the number of submissions recorded in cookies.
$num_submissions_cookie = count($_COOKIE[$cookie_name]);
}
else {
$num_submissions_cookie = 0;
}
}
if ($num_submissions_database >= $node->webform['submit_limit'] || $num_submissions_cookie >= $node->webform['submit_limit']) {
// Limit exceeded.
return TRUE;
}
// Limit not exceeded.
return FALSE;
}
/**
* Check if the total number of submissions has exceeded the limit on this form.
*
* @param $node
* The webform node to be checked.
* @return
* Boolean TRUE if the form has exceeded it's limit. FALSE otherwise.
*/
function _webform_submission_total_limit_check($node) {
// Check if submission limiting is enabled.
if ($node->webform['total_submit_limit'] == '-1') {
return FALSE;
// No check enabled.
}
// Retrieve submission data from the database.
$query = 'SELECT count(*) ' . 'FROM {webform_submissions} ' . 'WHERE submitted > %d AND nid = %d AND is_draft = 0';
// Fetch all the entries from the database within the submit interval.
$num_submissions_database = db_result(db_query($query, $node->webform['total_submit_interval'] != -1 ? time() - $node->webform['total_submit_interval'] : $node->webform['total_submit_interval'], $node->nid));
if ($num_submissions_database >= $node->webform['total_submit_limit']) {
// Limit exceeded.
return TRUE;
}
// Limit not exceeded.
return FALSE;
}
/**
* Preprocess function for webform-submission.tpl.php.
*/
function template_preprocess_webform_submission(&$vars) {
$vars['node'] = $vars['renderable']['#node'];
$vars['submission'] = $vars['renderable']['#submission'];
$vars['email'] = $vars['renderable']['#email'];
$vars['format'] = $vars['renderable']['#format'];
}
/**
* Preprocess function for webform-submission-navigation.tpl.php.
*/
function template_preprocess_webform_submission_navigation(&$vars) {
$start_path = $vars['mode'] == 'print' ? 'print/' : 'node/';
$vars['previous'] = db_result(db_query('SELECT MAX(sid) FROM {webform_submissions} WHERE nid = %d AND sid < %d', array(
$vars['node']->nid,
$vars['submission']->sid,
)));
$vars['next'] = db_result(db_query('SELECT MIN(sid) FROM {webform_submissions} WHERE nid = %d AND sid > %d', array(
$vars['node']->nid,
$vars['submission']->sid,
)));
$vars['previous_url'] = $start_path . $vars['node']->nid . '/submission/' . $vars['previous'] . ($vars['mode'] == 'form' ? '/edit' : '');
$vars['next_url'] = $start_path . $vars['node']->nid . '/submission/' . $vars['next'] . ($vars['mode'] == 'form' ? '/edit' : '');
}
/**
* Preprocess function for webform-submission-navigation.tpl.php.
*/
function template_preprocess_webform_submission_information(&$vars) {
$vars['account'] = user_load($vars['submission']->uid);
}Functions
Name |
Description |
|---|---|
| template_preprocess_webform_submission | Preprocess function for webform-submission.tpl.php. |
| template_preprocess_webform_submission_information | Preprocess function for webform-submission-navigation.tpl.php. |
| template_preprocess_webform_submission_navigation | Preprocess function for webform-submission-navigation.tpl.php. |
| theme_webform_submission_resend | Theme the node components form. Use a table to organize the components. |
| webform_get_submission | Fetch a specified submission for a webform node. |
| webform_get_submissions | Return all the submissions for a particular node. |
| webform_get_submission_count | Return a count of the total number of submissions for a node. |
| webform_submission_data | Given an array of submitted values, flatten it into data for a submission. |
| webform_submission_delete | Delete a single submission. |
| webform_submission_delete_form | Confirm form to delete a single form submission. |
| webform_submission_delete_form_submit | |
| webform_submission_insert | Insert a webform submission entry in the database. |
| webform_submission_page | Menu callback; Present a Webform submission page for display or editing. |
| webform_submission_render | Print a Webform submission for display on a page or in an e-mail. |
| webform_submission_resend | Form to resend specific e-mails associated with a submission. |
| webform_submission_resend_submit | Submit handler for webform_submission_resend(). |
| webform_submission_resend_validate | Validate handler for webform_submission_resend(). |
| webform_submission_send_mail | Send related e-mails related to a submission. |
| webform_submission_title | Menu title callback; Return the submission number as a title. |
| webform_submission_update | Update a webform submission entry in the database. |
| _webform_submission_spam_check | |
| _webform_submission_total_limit_check | Check if the total number of submissions has exceeded the limit on this form. |
| _webform_submission_user_limit_check | Check if the current user has exceeded the limit on this form. |