IpAddressWidgetBase.php in IP address fields 2.0.x

Namespace

Drupal\field_ipaddress\Plugin\Field\FieldWidget

File

src/Plugin/Field/FieldWidget/IpAddressWidgetBase.php

<?php

namespace Drupal\field_ipaddress\Plugin\Field\FieldWidget;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\WidgetBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\field_ipaddress\IpAddress;

/**
 * Base class for the 'ipaddress_*' widgets.
 */
class IpAddressWidgetBase extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = [
      'value' => $element + [
        '#type' => 'textfield',
      ],
    ];
    $element['#element_validate'] = [
      [
        $this,
        'validateIpAddressElement',
      ],
    ];
    $value = $items[$delta]
      ->getValue();
    if (!empty($value['ip_start'])) {
      $element['value']['#default_value'] = inet_ntop($value['ip_start']);
      if ($value['ip_start'] != $value['ip_end']) {
        $element['value']['#default_value'] .= '-' . inet_ntop($value['ip_end']);
      }
    }
    return $element;
  }

  /**
   * Custom validator.
   *
   * @param array $element
   *   The element being validated.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current form state.
   * @param array $form
   *   Current form.
   */
  public function validateIpAddressElement(array &$element, FormStateInterface $form_state, array $form) {
    $settings = $this->fieldDefinition
      ->getSettings();
    $value = trim($element['value']['#value']);
    if ($value === '') {
      return;
    }

    // Instantiate our IP, will throw \Exception if invalid.
    try {
      $ip_address = new IpAddress($value);
    } catch (\Exception $e) {

      // Make error messages a bit more relevant.
      if ($settings['allow_range']) {
        $form_state
          ->setError($element, t('Invalid IP or range.'));
      }
      else {
        $form_state
          ->setError($element, t('Invalid IP.'));
      }
      return;
    }
    if (!$settings['allow_range'] && $ip_address
      ->start() != $ip_address
      ->end()) {
      $form_state
        ->setError($element, t('Ranges not allowed, single IP only.'));
    }
    if ($settings['allow_family'] != IpAddress::IP_FAMILY_ALL && $settings['allow_family'] != $ip_address
      ->family()) {
      if ($settings['allow_family'] == IpAddress::IP_FAMILY_4) {
        $form_state
          ->setError($element, t('Only IPv4 addresses allowed.'));
      }
      else {
        $form_state
          ->setError($element, t('Only IPv6 addresses allowed.'));
      }
    }
    if ($settings['ip4_range'] && $ip_address
      ->family() == IpAddress::IP_FAMILY_4) {

      // No validation for $ip4_range here, it should have already been done
      // on field settings form.
      $range = new IpAddress($settings['ip4_range']);
      if (!$ip_address
        ->inRange($range
        ->start(), $range
        ->end())) {
        $form_state
          ->setError($element, t('IP must be within the range @min-@max', [
          '@min' => $range
            ->start(),
          '@max' => $range
            ->end(),
        ]));
      }
    }
    if ($settings['ip6_range'] && $ip_address
      ->family() == IpAddress::IP_FAMILY_6) {

      // No validation for $ip6_range here, it should have already been done
      // on field settings form.
      $range = new IpAddress($settings['ip6_range']);
      if (!$ip_address
        ->inRange($range
        ->start(), $range
        ->end())) {
        $form_state
          ->setError($element, t('IP must be within the range @min-@max', [
          '@min' => $range
            ->start(),
          '@max' => $range
            ->end(),
        ]));
      }
    }
  }

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

    // Convert to storage format.
    foreach ($values as &$item) {
      if (!empty($value = trim($item['value']))) {
        $value = new IpAddress($value);
        $item['ip_start'] = inet_pton($value
          ->start());
        $item['ip_end'] = inet_pton($value
          ->end());
      }
    }
    return $values;
  }

}

Classes

Name	Description
IpAddressWidgetBase	Base class for the 'ipaddress_*' widgets.