*/ /** * 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. db_update('webform_submissions') ->fields(array( 'uid' => $submission->uid, 'submitted' => $submission->submitted, 'remote_addr' => $submission->remote_addr, 'is_draft' => $submission->is_draft, )) ->condition('sid', $submission->sid) ->execute(); // 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) { db_delete('webform_submitted_data') ->condition('sid', $submission->sid) ->condition('cid', array_keys($submission->data), 'IN') ->execute(); } else { db_delete('webform_submitted_data') ->condition('sid', $submission->sid) ->execute(); } // 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->sid = db_insert('webform_submissions') ->fields(array( 'nid' => $node->nid, 'uid' => $submission->uid, 'submitted' => $submission->submitted, 'remote_addr' => $submission->remote_addr, 'is_draft' => $submission->is_draft, )) ->execute(); $is_new = TRUE; } foreach ($submission->data as $cid => $values) { foreach ($values['value'] as $delta => $value) { db_insert('webform_submitted_data') ->fields(array( 'nid' => $node->nid, 'sid' => $submission->sid, 'cid' => $cid, 'no' => $delta, 'data' => is_null($value) ? '' : $value, )) ->execute(); } } // 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_delete('webform_submitted_data') ->condition('nid', $node->nid) ->condition('sid', $submission->sid) ->execute(); db_delete('webform_submissions') ->condition('nid', $node->nid) ->condition('sid', $submission->sid) ->execute(); 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'] && module_exists('mimemail')); // 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'), array('node' => $node, 'submission' => $submission, 'email' => $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'), array('node' => $node, 'submission' => $submission, 'email' => $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' . "
\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, ); if (module_exists('mimemail')) { // 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])) { $file = webform_get_file($submission->data[$component['cid']]['value'][0]); if ($file) { $file->list = 1; // Needed to include in attachments. $attachments[] = $file; } } } } // Add the attachments to the mail parameters. $mail_params['attachments'] = $attachments; // TODO: Perform any other modifications necessary to get MIME Mail // sending e-mail properly as HTML and attachments. } // Mail the submission. $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 * The new form array. * @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, $form_state, $node, $submission) { webform_set_breadcrumb($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', array('group' => CSS_DEFAULT)); // Render the admin UI breadcrumb. webform_set_breadcrumb($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 (preg_match("!^q=print/!", $_SERVER['QUERY_STRING'])) { $mode = 'print'; } if (preg_match("!^q=printpdf/!", $_SERVER['QUERY_STRING'])) { $mode = 'pdf'; } // Add navigation for administrators. if (webform_results_access($node)) { $navigation = in_array($mode, array('display', 'form')) ? theme('webform_submission_navigation', array('node' => $node, 'submission' => $submission, 'mode' => $mode)) : NULL; $information = theme('webform_submission_information', array('node' => $node, 'submission' => $submission, 'mode' => $mode)); } else { $navigation = NULL; $information = NULL; } // Actions may be shown to all users. $actions = theme('links', array('links' => module_invoke_all('webform_submission_actions', $node, $submission), 'attributes' => array('class' => array('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', array('node' => $node, 'submission' => $submission, 'submission_content' => $output, 'submission_navigation' => $navigation, 'submission_information' => $information, 'submission_actions' => $actions)); } /** * Form to resend specific e-mails associated with a submission. */ function webform_submission_resend($form, $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( '#markup' => implode('
', $email_addresses), ); if (!$valid_email) { $form['emails'][$eid]['email']['#value'] .= ' (' . t('empty') . ')'; } $form['emails'][$eid]['subject'] = array( '#markup' => check_plain(webform_format_email_subject($email['subject'], $node, $submission)), ); $form['actions'] = array('#type' => 'actions'); $form['actions']['resend'] = array( '#type' => 'submit', '#value' => 'Resend e-mails', ); $form['actions']['cancel'] = array( '#type' => 'markup', '#markup' => 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($variables) { $form = $variables['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', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'webform-emails'))); $output .= drupal_render_children($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'); _webform_components_tree_build($node->webform['components'], $component_tree, 0, $page_count); // Recursively add components to the form. foreach ($component_tree['children'] as $cid => $component) { if (!in_array($cid, $excluded_components) && _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); } // No need to find SIDs if it was given to us. if (isset($filters['sid'])) { $sids = array($filters['sid']); } // Build the list of SIDs that need to be retrieved. else { $pager_query = db_select('webform_submissions', 'ws')->fields('ws', array('sid')); foreach ($filters as $column => $value) { $pager_query->condition($column, $value); } if (isset($filters['uid']) && $filters['uid'] === 0) { if (!empty($_SESSION['webform_submission'])) { $anonymous_sids = array_keys($_SESSION['webform_submission']); $pager_query->condition('sid', $anonymous_sids, 'IN'); } else { $pager_query->condition('sid', 0); } } if (is_array($header)) { // Join to the users table for sorting by user name. $pager_query->leftJoin('users', 'u', 'u.uid = ws.uid'); // Extending the query instatiates a new query object. $pager_query = $pager_query->extend('TableSort'); $pager_query->orderByHeader($header); } else { $pager_query->orderBy('sid', 'ASC'); } if ($pager_count) { // Extending the query instatiates a new query object. $pager_query = $pager_query->extend('PagerDefault'); $pager_query->limit($pager_count); } $result = $pager_query->execute(); $sids = array(); foreach ($result as $row) { $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 = db_select('webform_submissions', 's'); $query->leftJoin('webform_submitted_data', 'sd', 'sd.sid = s.sid'); $query->leftJoin('users', 'u', 'u.uid = s.uid'); $query ->fields('s') ->fields('sd') ->fields('u', array('name')) ->condition('s.sid', $sids, 'IN') ->orderBy('sd.sid', 'ASC') ->orderBy('sd.cid', 'ASC') ->orderBy('sd.no', 'ASC'); $result = $query->execute(); // Convert the queried rows into submissions. $previous = 0; foreach ($result as $row) { 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[$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 = db_select('webform_submissions') ->condition('nid', $nid) ->condition('is_draft', 0); $arguments = array($nid); if ($uid !== NULL) { $query->condition('uid', $uid); } if ($uid === 0) { $submissions = isset($_SESSION['webform_submission']) ? $_SESSION['webform_submission'] : array(); $query->condition('sid', $submissions, 'IN'); } $counts[$nid][$uid] = $query->countQuery()->execute()->fetchField(); } 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('sid' => $sid)); $submissions[$sid] = $new_submissions[$sid]; } // Ensure that the requested NID matches the submission NID. if ($submissions[$sid]->nid != $nid) { return 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_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 = db_select('webform_submissions') ->condition('nid', $node->nid) ->condition('is_draft', 0); if ($node->webform['submit_interval'] != -1) { $query->condition('submitted', REQUEST_TIME - $node->webform['submit_interval'], '>'); } if ($user->uid) { $query->condition('uid', $user->uid); } else { $query->condition('remote_addr', ip_address()); } // Fetch all the entries from the database within the submit interval with this username and IP. $num_submissions_database = $query->countQuery()->execute()->fetchField(); // 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 <= REQUEST_TIME - $node->webform['submit_interval']) { // Remove the cookie if past the required time interval. setcookie($cookie_name . '[' . $key . ']', '', 0); } } // 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; } /** * 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/'; $previous_query = db_select('webform_submissions') ->condition('nid', $vars['node']->nid) ->condition('sid', $vars['submission']->sid, '<'); $previous_query->addExpression('MAX(sid)'); $next_query = db_select('webform_submissions') ->condition('nid', $vars['node']->nid) ->condition('sid', $vars['submission']->sid, '>'); $next_query->addExpression('MIN(sid)'); $vars['previous'] = $previous_query->execute()->fetchField(); $vars['next'] = $next_query->execute()->fetchField(); $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); $vars['actions'] = theme('links', module_invoke_all('webform_submission_actions', $vars['node'], $vars['submission'])); }