function varnish_admin_settings_form in Varnish 7

Same name and namespace in other branches

1. 5 varnish.module \varnish_admin_settings_form()
2. 6 varnish.admin.inc \varnish_admin_settings_form()

Menu callback for varnish admin settings.

1 string reference to 'varnish_admin_settings_form'

varnish_menu in ./varnish.module

Implements hook_menu().

File

./varnish.admin.inc, line 11

Administrative functions for Varnish integration.

Code

function varnish_admin_settings_form() {
  $form = array();
  if (!extension_loaded('sockets')) {
    drupal_set_message(t('<a href="http://php.net/manual/en/sockets.installation.php">PHP Sockets extension</a> not enabled. Varnish terminal communication configuration skipped.'), 'error');
    return system_settings_form($form);
  }

  // Begin socket-dependent configuration.
  // Decide whether or not to flush caches on cron runs.
  $form['varnish_flush_cron'] = array(
    '#type' => 'radios',
    '#title' => t('Flush page cache on cron?'),
    '#options' => array(
      0 => t('Disabled'),
      1 => t('Enabled (with respect for cache_lifetime)'),
    ),
    '#default_value' => variable_get('varnish_flush_cron', 0),
    '#description' => t('Internally Drupal will attempt to flush its page cache every time cron.php runs. This can mean too-frequent cache flushes if you have cron running frequently. NOTE: this cache flush is global!'),
  );
  $form['varnish_version'] = array(
    '#type' => 'select',
    '#title' => t('Varnish version'),
    '#default_value' => variable_get('varnish_version', 2.1),
    '#description' => t('Select your varnish version.'),
    '#options' => array(
      '2' => '2.0.x',
      '2.1' => '2.1.x',
      '3' => '3.x',
      '4' => '4.x',
    ),
    '#ajax' => array(
      'callback' => 'varnish_admin_settings_control_key_callback',
      'wrapper' => 'wrapper-varnish-control-key',
      'method' => 'replace',
      'effect' => 'fade',
    ),
  );
  $form['varnish_control_terminal'] = array(
    '#type' => 'textfield',
    '#title' => t('Varnish Control Terminal'),
    '#default_value' => variable_get('varnish_control_terminal', '127.0.0.1:6082'),
    '#required' => TRUE,
    '#description' => t('Set this to the server IP or hostname that varnish runs on (e.g. 127.0.0.1:6082). This must be configured for Drupal to talk to Varnish. Separate multiple servers with spaces.'),
    '#maxlength' => 256,
  );
  $form['varnish_control_key'] = array(
    '#type' => 'textfield',
    '#title' => t('Varnish Control Key'),
    '#default_value' => variable_get('varnish_control_key', ''),
    '#description' => t('If you have established a secret key for control terminal access, please put it here.'),
    '#prefix' => '<div id="wrapper-varnish-control-key">',
    '#suffix' => '</div>',
    '#required' => variable_get('varnish_version', 2.1) == '4' ? TRUE : FALSE,
  );
  $form['varnish_control_key_appendnewline'] = array(
    '#type' => 'checkbox',
    '#title' => t('Append Newline (\\n)'),
    '#default_value' => variable_get('varnish_control_key_appendnewline', TRUE),
    '#description' => t('Most control keys have an embedded newline at the end. Uncheck this if you know it doesn\'t or if you are reading the file in direct with an fopen.'),
  );
  $form['varnish_socket_timeout'] = array(
    '#type' => 'textfield',
    '#title' => t('Varnish connection timeout (milliseconds)'),
    '#default_value' => variable_get('varnish_socket_timeout', VARNISH_DEFAULT_TIMEOUT),
    '#description' => t('If Varnish is running on a different server, you may need to increase this value.'),
    '#required' => TRUE,
  );
  $form['varnish_front_domains'] = array(
    '#type' => 'textfield',
    '#title' => t('Front domains list'),
    '#default_value' => variable_get('varnish_front_domains'),
    '#required' => FALSE,
    '#description' => t('If you have multiple front-end doamin to flush, each domain will be called when banning. Enter front domain names separated by spaces.'),
  );
  $form['varnish_cache_clear'] = array(
    '#type' => 'radios',
    '#title' => t('Varnish Cache Clearing'),
    '#options' => array(
      VARNISH_DEFAULT_CLEAR => t('Drupal Default'),
      VARNISH_NO_CLEAR => t('None'),
    ),
    '#default_value' => variable_get('varnish_cache_clear', VARNISH_DEFAULT_CLEAR),
    '#description' => t('What kind of cache clearing Varnish should utilize. Drupal default will clear all page caches on node updates and cache flush events. None will allow pages to persist for their full max-age; use this if you want to write your own cache-clearing logic.'),
  );

  // Detect expire module and add this option.
  if (module_exists('expire')) {
    $form['varnish_cache_clear']['#options'][VARNISH_SELECTIVE_CLEAR] = t('Selective (experimental; uses expire.module)');
    $form['varnish_cache_clear']['#description'] .= ' ' . t('Selective will clear a list of URLs you specify as well as any node urls themselves.');
  }
  else {
    $form['varnish_cache_clear']['#description'] .= ' ' . t('Installing the !link will enable "Selective" clearing.', array(
      '!link' => '<a href="http://drupal.org/project/expire" target="_blank">' . t('Expire module') . '</a>',
    ));
  }

  // Allow users to select Varnish ban type to use.
  $form['varnish_bantype'] = array(
    '#type' => 'select',
    '#title' => t('Varnish ban type'),
    '#default_value' => variable_get('varnish_bantype', VARNISH_DEFAULT_BANTYPE),
    '#description' => t('Select the type of varnish ban you wish to use. Ban lurker support requires you to add beresp.http.x-url and beresp.http.x-host entries to the response in vcl_fetch.'),
    '#options' => array(
      VARNISH_BANTYPE_NORMAL => 'Normal',
      VARNISH_BANTYPE_BANLURKER => 'Ban Lurker',
    ),
  );

  // Check status.
  $form['varnish_stats'] = array(
    '#type' => 'item',
    '#title' => t('Status'),
    '#markup' => theme('varnish_status', array(
      'status' => varnish_get_status(),
      'version' => floatval(variable_get('varnish_version', 2.1)),
    )),
  );
  return system_settings_form($form);
}