finder.form.inc in Finder 7
Same filename and directory in other branches
The finder form.
File
includes/finder.form.incView source
<?php
/**
* @file
* The finder form.
*/
/**
* FAPI definition for the finder form.
*
* @param &$form
* The Forms API form array.
* @param &$form_state
* The Forms API form state.
* @param $finder
* The finder object.
* @see finder_form_submit()
*/
function finder_form($form, &$form_state, $finder) {
// Make sure drupal core loads this file when handling this form.
form_load_include($form_state, 'inc', 'finder', 'includes/finder.form');
// see if there is already a form state we should be using.
$finder_form_state = finder_form_state($finder->finder_id);
if (is_array($finder_form_state)) {
$form_state = array_merge($form_state, $finder_form_state);
}
finder_invoke_finderapi($finder, 'finder_form', $form, $form_state);
$form['finder_id'] = array(
'#type' => 'value',
'#value' => $finder->finder_id,
);
$form['#action'] = url($finder->path);
$form['finder_form'] = array(
'#weight' => 0,
'#prefix' => '<div class="finder-form finder-' . $finder->finder_id . '">',
'#suffix' => '</div>',
);
if ($finder->settings['form']['prefix']) {
$form['finder_form']['#prefix'] .= '<div class="prefix">' . check_markup($finder->settings['form']['prefix']['value'], $finder->settings['form']['prefix']['format'], FALSE) . '</div>';
}
$max_weight = 0;
foreach ((array) $finder->elements as $element) {
$max_weight = max($max_weight, $element->weight);
if (isset($form_state['values'][$element->finder_element_id])) {
$element_default = $form_state['values'][$element->finder_element_id];
}
else {
$element_default = $element->settings['form']['default_value'];
}
$form['finder_form'][$element->finder_element_id] = array(
'#title' => check_plain($element->title),
'#weight' => $element->weight,
'#description' => check_markup($element->settings['form']['description']),
'#prefix' => check_markup($element->settings['form']['prefix']['value'], $element->settings['form']['prefix']['format'], FALSE),
'#suffix' => check_markup($element->settings['form']['suffix']['value'], $element->settings['form']['suffix']['format'], FALSE),
'#default_value' => $element_default,
'#required' => $element->settings['form']['required'],
'#executes_submit_callback' => TRUE,
);
$module =& $element->element_handler['#module'];
// module_invoke doesn't seem to handle references.
$handler_function = $module . '_finder_element';
if (function_exists($handler_function)) {
$handler_function($element, $form['finder_form'][$element->finder_element_id]);
}
}
if ($finder->settings['advanced']['submission']) {
$form['finder_form']['submit'] = array(
'#type' => 'submit',
'#name' => 'find',
'#value' => $finder->settings['form']['button_text'],
'#weight' => $max_weight + 1000,
);
if ($finder->settings['advanced']['ajax']) {
$wrapper = $finder->finder_view_build_id;
$ajax_display = 'block';
// Check if the 'ajax_remote' setting is on, that we are on the finder page, and that we are in a block.
if ($finder->settings['advanced']['ajax_remote'] && strpos($_GET['q'], $finder->path) === 0 && $finder->finder_view_build_display === 'block') {
// We are using the block as a remote control for the page. Change the wrapper for Ajax purposes.
$wrapper = 'finder-page-' . $finder->finder_id . '-wrapper';
$ajax_display = 'page';
}
$form['finder_form']['submit']['#ajax'] = array(
'path' => 'finder_ajax/' . $finder->finder_id . '/' . $ajax_display . '/' . $_GET['q'],
'wrapper' => $wrapper,
'method' => 'replace',
'effect' => $finder->settings['advanced']['ajax_effect'],
);
}
if ($finder->settings['advanced']['goto'] == 'go') {
$form['finder_form']['submit']['#prefix'] = '<div class="finder-buttons">';
$form['finder_form']['go'] = array(
'#type' => 'submit',
'#name' => 'go',
'#value' => $finder->settings['form']['go_text'],
'#weight' => $max_weight + 1010,
'#suffix' => '<br class="finder-clear" style="clear:both;" /></div>',
);
}
}
if ($finder->settings['form']['suffix']) {
$form['finder_form']['#suffix'] = '<div class="suffix">' . check_markup($finder->settings['form']['suffix']['value'], $finder->settings['form']['suffix']['format'], FALSE) . '</div>' . $form['finder_form']['#suffix'];
}
$form['#submit'] = array(
'finder_form_submit',
);
$form['#validate'] = array(
'finder_form_validate',
);
return $form;
}
/**
* Validate function for finder form.
*
* Implements the 'validate_empty' functionality.
*
* @see finder_form()
*/
function finder_form_validate($form, &$form_state) {
$finder_id = $form_state['values']['finder_id'];
$finder = finder_load($finder_id);
if ($finder->settings['advanced']['validate_empty']) {
$all_empty = TRUE;
foreach ($finder->elements as $finder_element) {
if (!empty($form_state['values'][$finder_element->finder_element_id])) {
$all_empty = FALSE;
break;
}
}
if ($all_empty) {
form_set_error('form', t('Please complete the %finder form.', array(
'%finder' => $finder->title,
)));
}
}
}
/**
* Submit function for finder form.
*
* Adds some needed data to $form_state and calls finder_form_state().
*
* @see finder_form()
*/
function finder_form_submit($form, &$form_state) {
$finder_id = $form_state['values']['finder_id'];
$finder = finder_load($finder_id);
$form_state['storage']['finder'] = $finder;
$form_state['storage']['values'] = $form_state['values'];
$form_state['storage']['finished'] = TRUE;
finder_form_state($finder->finder_id, $form_state);
}
/**
* Statically 'get' or 'set' the FAPI form state in a per-finder cache.
*
* When used to 'set' the form state it will also check to see if a redirect
* is required to go to the results path with arguments. When used to 'get'
* the form state it will check the static cache for a stored form state, then
* it will check the session for a form state carried over from another page,
* and finally it will attempt to build a form state out of the path arguments.
*
* @param $finder_id
* The finder's ID.
* @param $form_state
* The Forms API form state (if supplied, will 'set' the form state).
* @return
* A copy of the Forms API form state.
*/
function finder_form_state($finder_id, $form_state = NULL) {
static $finder_form_state = NULL;
if ($form_state) {
// we are setting the form_state in a submit.
// last chance for modules to intefere before potential redirect.
drupal_alter('finder_form_state', $form_state, $finder_id);
$finder_form_state[$finder_id] = $form_state;
// handle URL stuff.
$finder = finder_load($finder_id);
if (!$finder->settings['advanced']['hide_args']) {
$sep =& $finder->settings['advanced']['arg_sep'];
$empty_symbol = !empty($finder->settings['advanced']['empty_symbol']) ? $finder->settings['advanced']['empty_symbol'] : ' ';
$query = array();
foreach ($finder->elements as $element) {
$keyword = (array) $form_state['values'][$element->finder_element_id];
foreach ($keyword as $k => $v) {
// Handle forward slashes in input.
$v = str_replace("/", "%2f%2f", $v);
// Handle new lines in input.
$v = str_replace("\r\n", "\n", $v);
$v = str_replace("\n", urlencode("***BREAK***"), $v);
if (strpos($v, $sep) !== FALSE) {
$v = '"' . $v . '"';
}
$keyword[$k] = $v ? trim($v) : $empty_symbol;
}
$keywords[$element->finder_element_id] = implode(',', $keyword);
}
if (!$form_state['storage']['finished']) {
$query['finished'] = '0';
}
if ($form_state['clicked_button']['#name'] == 'go' && $form_state['storage']['finished']) {
$query['go'] = '1';
}
finder_form_goto($sep, $finder->path . '/' . implode('/', $keywords), $query);
}
}
elseif (!isset($finder_form_state[$finder_id])) {
$finder = finder_load($finder_id);
if ($finder->settings['advanced']['hide_args'] && isset($_GET['finder'])) {
// check the session
$finder_form_state[$finder_id] = $_SESSION['finder'][$_GET['finder']];
}
elseif (!isset($_GET['finder']) && strlen($finder->path) < strlen($_GET['q']) && stripos($_GET['q'], $finder->path) === 0) {
// check the URL
// Get the seperator for element values - this is usually a comma.
$sep =& $finder->settings['advanced']['arg_sep'];
// Get the finder arguments.
$args = str_replace($finder->path . '/', '', $_GET['q']);
// Handle new lines from input.
$args = str_replace("***BREAK***", "\n", $args);
// Forward slashes were encoded as double forward slashes. We must temporarily replace those here to prevent the explode() affecting this.
// Rawurlencode() doesn't work but can be fixed using Apache's AllowEncodedSlashes Directive, but how do you tell people to switch that on?
$args = str_replace('//', '[-finder-forward-slash-]', $args);
// Double seperators break the $csv_regex below, and I'm not clever enough to fix the regex.
$args = str_replace($sep . $sep, '[-finder-double-sep-]', $args);
// Break arguments apart into a string for each element.
$args = explode('/', $args);
$form_state['storage']['finished'] = TRUE;
$empty_symbol = !empty($finder->settings['advanced']['empty_symbol']) ? $finder->settings['advanced']['empty_symbol'] : ' ';
$csv_regex = "/" . $sep . "(?!(?:[^\\\"" . $sep . "]|[^\\\"]" . $sep . "[^\\\"])+\\\")/";
foreach ($finder->elements as $key => $element) {
$keywords = preg_split($csv_regex, $args[$key]);
foreach ($keywords as $k => $v) {
$v = str_replace('[-finder-double-sep-]', $sep . $sep, $v);
$v = str_replace('[-finder-forward-slash-]', '/', $v);
$v = str_replace(urlencode($sep), $sep, trim($v));
if (trim($v) == trim($empty_symbol)) {
$v = NULL;
}
if (strpos($v, $sep) !== FALSE && $v[0] == '"' && $v[strlen($v) - 1] == '"') {
$v = substr($v, 1, strlen($v) - 2);
}
unset($keywords[$k]);
if ($v) {
$keywords[$v] = $v;
}
}
if (count($keywords) === 1) {
$keywords = current($keywords);
}
elseif (!count($keywords)) {
$keywords = NULL;
}
$form_state['values'][$element->finder_element_id] = $keywords;
}
$finder_form_state[$finder_id] = $form_state;
}
}
return $finder_form_state[$finder_id];
}
/**
* Redirect from a finder form.
*
* The difference between this and drupal_goto() is that this undoes the
* encoding of the arguments seperator, as such encoding inteferes with finder.
*
* @param $sep
* The arguments seperator string.
* @param $path
* A Drupal path or a full URL.
* @param $query
* A query string component, if any.
* @param $fragment
* A destination fragment identifier (named anchor).
* @param $http_response_code
* Valid values for an actual "goto" as per RFC 2616 section 10.3 are:
* - 301 Moved Permanently (the recommended value for most redirects)
* - 302 Found (default in Drupal and PHP, sometimes used for spamming search
* engines)
* - 303 See Other
* - 304 Not Modified
* - 305 Use Proxy
* - 307 Temporary Redirect (alternative to "503 Site Down for Maintenance")
* Note: Other values are defined by RFC 2616, but are rarely used and poorly
* supported.
* @see drupal_goto()
*/
function finder_form_goto($sep, $path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) {
if (isset($_REQUEST['destination'])) {
extract(parse_url(urldecode($_REQUEST['destination'])));
}
elseif (isset($_REQUEST['edit']['destination'])) {
extract(parse_url(urldecode($_REQUEST['edit']['destination'])));
}
$url = url($path, array(
'query' => $query,
'fragment' => $fragment,
'absolute' => TRUE,
));
// custom changes - undo separator encoding
$url = str_replace(urlencode($sep), $sep, $url);
// Remove newlines from the URL to avoid header injection attacks.
$url = str_replace(array(
"\n",
"\r",
), '', $url);
// Allow modules to react to the end of the page request before redirecting.
// We do not want this while running update.php.
if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
module_invoke_all('exit', $url);
}
// Even though session_write_close() is registered as a shutdown function, we
// need all session data written to the database before redirecting.
session_write_close();
header('Location: ' . $url, TRUE, $http_response_code);
// The "Location" header sends a redirect status code to the HTTP daemon. In
// some cases this can be wrong, so we make sure none of the code below the
// drupal_goto() call gets executed upon redirection.
exit;
}Functions
Name |
Description |
|---|---|
| finder_form | FAPI definition for the finder form. |
| finder_form_goto | Redirect from a finder form. |
| finder_form_state | Statically 'get' or 'set' the FAPI form state in a per-finder cache. |
| finder_form_submit | Submit function for finder form. |
| finder_form_validate | Validate function for finder form. |