You are here

Home » API reference » ClamAV 8 » ClamAVConfigForm.php

class ClamAVConfigForm in ClamAV 8

Same name and namespace in other branches
  1. 2.x src/Form/ClamAVConfigForm.php \Drupal\clamav\Form\ClamAVConfigForm

Configure file system settings for this site.

Hierarchy

Expanded class hierarchy of ClamAVConfigForm

1 string reference to 'ClamAVConfigForm'
clamav.routing.yml in ./clamav.routing.yml
clamav.routing.yml

File

src/Form/ClamAVConfigForm.php, line 17

Namespace

Drupal\clamav\Form
View source 
class ClamAVConfigForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'clamav_system_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'clamav.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('clamav.settings');
    $form['enabled'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable ClamAV integration'),
      '#default_value' => $config
        ->get('enabled'),
    );
    $form['scan_mechanism_wrapper'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Scan mechanism'),
      '#open' => TRUE,
    );
    $form['scan_mechanism_wrapper']['scan_mode'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Scan mechanism'),
      '#options' => array(
        Config::MODE_EXECUTABLE => $this
          ->t('Executable'),
        Config::MODE_DAEMON => $this
          ->t('Daemon mode (over TCP/IP)'),
        Config::MODE_UNIX_SOCKET => $this
          ->t('Daemon mode (over Unix socket)'),
      ),
      '#default_value' => $config
        ->get('scan_mode'),
      '#description' => $this
        ->t("Control how Drupal connects to ClamAV.<br />Daemon mode is recommended if the ClamAV service is capable of running as a daemon."),
    );

    // Configuration if ClamAV is set to Executable mode.
    $form['scan_mechanism_wrapper']['mode_executable'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Executable mode configuration'),
      '#open' => TRUE,
      '#states' => array(
        'visible' => array(
          ':input[name="scan_mode"]' => array(
            'value' => Config::MODE_EXECUTABLE,
          ),
        ),
      ),
    );
    $form['scan_mechanism_wrapper']['mode_executable']['executable_path'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Executable path'),
      '#default_value' => $config
        ->get('mode_executable.executable_path'),
      '#maxlength' => 255,
    );
    $form['scan_mechanism_wrapper']['mode_executable']['executable_parameters'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Executable parameters'),
      '#default_value' => $config
        ->get('mode_executable.executable_parameters') ?: '',
      '#maxlength' => 255,
      '#description' => $this
        ->t('Optional parameters to pass to the clamscan executable, e.g. %example.', array(
        '%example' => '--max-recursion=10',
      )),
    );

    // Configuration if ClamAV is set to Daemon mode.
    $form['scan_mechanism_wrapper']['mode_daemon_tcpip'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Daemon mode configuration (over TCP/IP)'),
      '#open' => TRUE,
      '#states' => array(
        'visible' => array(
          ':input[name="scan_mode"]' => array(
            'value' => Config::MODE_DAEMON,
          ),
        ),
      ),
    );
    $form['scan_mechanism_wrapper']['mode_daemon_tcpip']['hostname'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Hostname'),
      '#default_value' => $config
        ->get('mode_daemon_tcpip.hostname'),
      '#maxlength' => 255,
    );
    $form['scan_mechanism_wrapper']['mode_daemon_tcpip']['port'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Port'),
      '#default_value' => $config
        ->get('mode_daemon_tcpip.port'),
      '#size' => 6,
      '#maxlength' => 8,
    );

    // Configuration if ClamAV is set to Daemon mode over Unix socket.
    $form['scan_mechanism_wrapper']['mode_daemon_unixsocket'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Daemon mode configuration (over Unix socket)'),
      '#open' => TRUE,
      '#states' => array(
        'visible' => array(
          ':input[name="scan_mode"]' => array(
            'value' => Config::MODE_UNIX_SOCKET,
          ),
        ),
      ),
    );
    $form['scan_mechanism_wrapper']['mode_daemon_unixsocket']['unixsocket'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Socket path'),
      '#default_value' => $config
        ->get('mode_daemon_unixsocket.unixsocket'),
      '#maxlength' => 255,
    );
    $form['outage_actions_wrapper'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Outage behaviour'),
      '#open' => TRUE,
    );
    $form['outage_actions_wrapper']['outage_action'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Behaviour when ClamAV is unavailable'),
      '#options' => array(
        Config::OUTAGE_BLOCK_UNCHECKED => $this
          ->t('Block unchecked files'),
        Config::OUTAGE_ALLOW_UNCHECKED => $this
          ->t('Allow unchecked files'),
      ),
      '#default_value' => $config
        ->get('outage_action'),
    );

    // Allow scanning according to scheme-wrapper.
    $form['schemes'] = array(
      '#type' => 'details',
      '#title' => 'Scannable schemes / stream wrappers',
      '#open' => TRUE,
      '#description' => $this
        ->t('By default only @local schemes are scannable.', array(
        '@local' => Link::fromTextAndUrl(t('local file-systems'), Url::fromUri('https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21StreamWrapper%21LocalStream.php/class/LocalStream/8.2.x'))
          ->toString(),
      )),
    );
    $local_schemes = $this
      ->scheme_wrappers_available('local');
    $remote_schemes = $this
      ->scheme_wrappers_available('remote');
    if (count($local_schemes)) {
      $form['schemes']['clamav_local_schemes'] = array(
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Local schemes'),
        '#options' => $local_schemes,
        '#default_value' => $this
          ->scheme_wrappers_to_scan('local'),
      );
    }
    if (count($remote_schemes)) {
      $form['schemes']['clamav_remote_schemes'] = array(
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Remote schemes'),
        '#options' => $remote_schemes,
        '#default_value' => $this
          ->scheme_wrappers_to_scan('remote'),
      );
    }
    $form['verbosity_wrapper'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Verbosity'),
      '#open' => TRUE,
    );
    $form['verbosity_wrapper']['verbosity'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Verbose'),
      '#description' => $this
        ->t('Verbose mode will log all scanned files, including files which pass the ClamAV scan.'),
      '#default_value' => $config
        ->get('verbosity'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    // Check that:
    // - the executable path exists
    // - the unix socket exists
    // - Drupal can connect to the hostname/port (warn but don't fail)
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Configure the stream-wrapper schemes that are overridden.
    // Local schemes behave differently to remote schemes.
    $local_schemes_to_scan = is_array($form_state
      ->getValue('clamav_local_schemes')) ? array_filter($form_state
      ->getValue('clamav_local_schemes')) : array();
    $remote_schemes_to_scan = is_array($form_state
      ->getValue('clamav_remote_schemes')) ? array_filter($form_state
      ->getValue('clamav_remote_schemes')) : array();
    $overridden_schemes = array_merge($this
      ->get_overridden_schemes('local', $local_schemes_to_scan), $this
      ->get_overridden_schemes('remote', $remote_schemes_to_scan));
    $this
      ->config('clamav.settings')
      ->set('enabled', $form_state
      ->getValue('enabled'))
      ->set('outage_action', $form_state
      ->getValue('outage_action'))
      ->set('overridden_schemes', $overridden_schemes)
      ->set('scan_mode', $form_state
      ->getValue('scan_mode'))
      ->set('verbosity', $form_state
      ->getValue('verbosity'))
      ->set('mode_executable.executable_path', $form_state
      ->getValue('executable_path'))
      ->set('mode_executable.executable_parameters', $form_state
      ->getValue('executable_parameters'))
      ->set('mode_daemon_tcpip.hostname', $form_state
      ->getValue('hostname'))
      ->set('mode_daemon_tcpip.port', $form_state
      ->getValue('port'))
      ->set('mode_daemon_unixsocket.unixsocket', $form_state
      ->getValue('unixsocket'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * List the available stream-wrappers, according to whether the
   * stream-wrapper is local or remote.
   *
   * @param string $type
   *   Either 'local' (for local stream-wrappers), or 'remote'.
   *
   * @return array
   *   Array of the names of scheme-wrappers, indexed by the machine-name of
   *   the scheme-wrapper.
   *   For example: array('public' => 'public://').
   */
  public function scheme_wrappers_available($type) {
    $mgr = \Drupal::service('stream_wrapper_manager');
    switch ($type) {
      case 'local':
        $schemes = array_keys($mgr
          ->getWrappers(StreamWrapperInterface::LOCAL));
        break;
      case 'remote':
        $schemes = array_keys(array_diff_key($mgr
          ->getWrappers(StreamWrapperInterface::ALL), $mgr
          ->getWrappers(StreamWrapperInterface::LOCAL)));
        break;
    }
    $options = array();
    foreach ($schemes as $scheme) {
      $options[$scheme] = $scheme . '://';
    }
    return $options;
  }

  /**
   * List the stream-wrapper schemes that are configured to be scannable,
   * according to whether the scheme is local or remote.
   *
   * @param string $type
   *   Either 'local' (for local stream-wrappers), or 'remote'.
   *
   * @return array
   *   Unindexed array of the machine-names of stream-wrappers that should be
   *   scanned.
   *   For example: array('public', 'private').
   */
  public function scheme_wrappers_to_scan($type) {
    switch ($type) {
      case 'local':
        $schemes = array_keys($this
          ->scheme_wrappers_available('local'));
        break;
      case 'remote':
        $schemes = array_keys($this
          ->scheme_wrappers_available('remote'));
        break;
    }
    return array_filter($schemes, array(
      '\\Drupal\\clamav\\Scanner',
      'isSchemeScannable',
    ));
  }

  /**
   * List which schemes have been overridden.
   *
   * @param string $type
   *   Type of stream-wrapper: either 'local' or 'remote'.
   * @param array $schemes_to_scan
   *   Unindexed array, listing the schemes that should be scanned.
   *
   * @return array
   *   List of the schemes that have been overridden for this particular
   *   stream-wrapper type.
   */
  public function get_overridden_schemes($type, $schemes_to_scan) {
    $available_schemes = $this
      ->scheme_wrappers_available($type);
    switch ($type) {
      case 'local':
        $overridden = array_diff_key($available_schemes, $schemes_to_scan);
        return array_keys($overridden);
      case 'remote':
        $overridden = array_intersect_key($available_schemes, $schemes_to_scan);
        return array_keys($overridden);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ClamAVConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ClamAVConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ClamAVConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ClamAVConfigForm::get_overridden_schemes public function List which schemes have been overridden.
ClamAVConfigForm::scheme_wrappers_available public function List the available stream-wrappers, according to whether the stream-wrapper is local or remote.
ClamAVConfigForm::scheme_wrappers_to_scan public function List the stream-wrapper schemes that are configured to be scannable, according to whether the scheme is local or remote.
ClamAVConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ClamAVConfigForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.