www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php

   1 <?php
   2
   3 namespace Drupal\link\Plugin\Field\FieldWidget;
   4
   5 use Drupal\Core\Entity\Element\EntityAutocomplete;
   6 use Drupal\Core\Field\FieldItemListInterface;
   7 use Drupal\Core\Field\WidgetBase;
   8 use Drupal\Core\Form\FormStateInterface;
   9 use Drupal\link\LinkItemInterface;
  10 use Symfony\Component\Validator\ConstraintViolation;
  11 use Symfony\Component\Validator\ConstraintViolationListInterface;
  12
  13 /**
  14  * Plugin implementation of the 'link' widget.
  15  *
  16  * @FieldWidget(
  17  *   id = "link_default",
  18  *   label = @Translation("Link"),
  19  *   field_types = {
  20  *     "link"
  21  *   }
  22  * )
  23  */
  24 class LinkWidget extends WidgetBase {
  25
  26   /**
  27    * {@inheritdoc}
  28    */
  29   public static function defaultSettings() {
  30     return [
  31       'placeholder_url' => '',
  32       'placeholder_title' => '',
  33     ] + parent::defaultSettings();
  34   }
  35
  36   /**
  37    * Gets the URI without the 'internal:' or 'entity:' scheme.
  38    *
  39    * The following two forms of URIs are transformed:
  40    * - 'entity:' URIs: to entity autocomplete ("label (entity id)") strings;
  41    * - 'internal:' URIs: the scheme is stripped.
  42    *
  43    * This method is the inverse of ::getUserEnteredStringAsUri().
  44    *
  45    * @param string $uri
  46    *   The URI to get the displayable string for.
  47    *
  48    * @return string
  49    *
  50    * @see static::getUserEnteredStringAsUri()
  51    */
  52   protected static function getUriAsDisplayableString($uri) {
  53     $scheme = parse_url($uri, PHP_URL_SCHEME);
  54
  55     // By default, the displayable string is the URI.
  56     $displayable_string = $uri;
  57
  58     // A different displayable string may be chosen in case of the 'internal:'
  59     // or 'entity:' built-in schemes.
  60     if ($scheme === 'internal') {
  61       $uri_reference = explode(':', $uri, 2)[1];
  62
  63       // @todo '<front>' is valid input for BC reasons, may be removed by
  64       //   https://www.drupal.org/node/2421941
  65       $path = parse_url($uri, PHP_URL_PATH);
  66       if ($path === '/') {
  67         $uri_reference = '<front>' . substr($uri_reference, 1);
  68       }
  69
  70       $displayable_string = $uri_reference;
  71     }
  72     elseif ($scheme === 'entity') {
  73       list($entity_type, $entity_id) = explode('/', substr($uri, 7), 2);
  74       // Show the 'entity:' URI as the entity autocomplete would.
  75       // @todo Support entity types other than 'node'. Will be fixed in
  76       //    https://www.drupal.org/node/2423093.
  77       if ($entity_type == 'node' && $entity = \Drupal::entityTypeManager()->getStorage($entity_type)->load($entity_id)) {
  78         $displayable_string = EntityAutocomplete::getEntityLabels([$entity]);
  79       }
  80     }
  81
  82     return $displayable_string;
  83   }
  84
  85   /**
  86    * Gets the user-entered string as a URI.
  87    *
  88    * The following two forms of input are mapped to URIs:
  89    * - entity autocomplete ("label (entity id)") strings: to 'entity:' URIs;
  90    * - strings without a detectable scheme: to 'internal:' URIs.
  91    *
  92    * This method is the inverse of ::getUriAsDisplayableString().
  93    *
  94    * @param string $string
  95    *   The user-entered string.
  96    *
  97    * @return string
  98    *   The URI, if a non-empty $uri was passed.
  99    *
 100    * @see static::getUriAsDisplayableString()
 101    */
 102   protected static function getUserEnteredStringAsUri($string) {
 103     // By default, assume the entered string is an URI.
 104     $uri = $string;
 105
 106     // Detect entity autocomplete string, map to 'entity:' URI.
 107     $entity_id = EntityAutocomplete::extractEntityIdFromAutocompleteInput($string);
 108     if ($entity_id !== NULL) {
 109       // @todo Support entity types other than 'node'. Will be fixed in
 110       //    https://www.drupal.org/node/2423093.
 111       $uri = 'entity:node/' . $entity_id;
 112     }
 113     // Detect a schemeless string, map to 'internal:' URI.
 114     elseif (!empty($string) && parse_url($string, PHP_URL_SCHEME) === NULL) {
 115       // @todo '<front>' is valid input for BC reasons, may be removed by
 116       //   https://www.drupal.org/node/2421941
 117       // - '<front>' -> '/'
 118       // - '<front>#foo' -> '/#foo'
 119       if (strpos($string, '<front>') === 0) {
 120         $string = '/' . substr($string, strlen('<front>'));
 121       }
 122       $uri = 'internal:' . $string;
 123     }
 124
 125     return $uri;
 126   }
 127
 128   /**
 129    * Form element validation handler for the 'uri' element.
 130    *
 131    * Disallows saving inaccessible or untrusted URLs.
 132    */
 133   public static function validateUriElement($element, FormStateInterface $form_state, $form) {
 134     $uri = static::getUserEnteredStringAsUri($element['#value']);
 135     $form_state->setValueForElement($element, $uri);
 136
 137     // If getUserEnteredStringAsUri() mapped the entered value to a 'internal:'
 138     // URI , ensure the raw value begins with '/', '?' or '#'.
 139     // @todo '<front>' is valid input for BC reasons, may be removed by
 140     //   https://www.drupal.org/node/2421941
 141     if (parse_url($uri, PHP_URL_SCHEME) === 'internal' && !in_array($element['#value'][0], ['/', '?', '#'], TRUE) && substr($element['#value'], 0, 7) !== '<front>') {
 142       $form_state->setError($element, t('Manually entered paths should start with /, ? or #.'));
 143       return;
 144     }
 145   }
 146
 147   /**
 148    * Form element validation handler for the 'title' element.
 149    *
 150    * Conditionally requires the link title if a URL value was filled in.
 151    */
 152   public static function validateTitleElement(&$element, FormStateInterface $form_state, $form) {
 153     if ($element['uri']['#value'] !== '' && $element['title']['#value'] === '') {
 154       $element['title']['#required'] = TRUE;
 155       // We expect the field name placeholder value to be wrapped in t() here,
 156       // so it won't be escaped again as it's already marked safe.
 157       $form_state->setError($element['title'], t('@name field is required.', ['@name' => $element['title']['#title']]));
 158     }
 159   }
 160
 161   /**
 162    * {@inheritdoc}
 163    */
 164   public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
 165     /** @var \Drupal\link\LinkItemInterface $item */
 166     $item = $items[$delta];
 167
 168     $element['uri'] = [
 169       '#type' => 'url',
 170       '#title' => $this->t('URL'),
 171       '#placeholder' => $this->getSetting('placeholder_url'),
 172       // The current field value could have been entered by a different user.
 173       // However, if it is inaccessible to the current user, do not display it
 174       // to them.
 175       '#default_value' => (!$item->isEmpty() && (\Drupal::currentUser()->hasPermission('link to any page') || $item->getUrl()->access())) ? static::getUriAsDisplayableString($item->uri) : NULL,
 176       '#element_validate' => [[get_called_class(), 'validateUriElement']],
 177       '#maxlength' => 2048,
 178       '#required' => $element['#required'],
 179       '#link_type' => $this->getFieldSetting('link_type'),
 180     ];
 181
 182     // If the field is configured to support internal links, it cannot use the
 183     // 'url' form element and we have to do the validation ourselves.
 184     if ($this->supportsInternalLinks()) {
 185       $element['uri']['#type'] = 'entity_autocomplete';
 186       // @todo The user should be able to select an entity type. Will be fixed
 187       //    in https://www.drupal.org/node/2423093.
 188       $element['uri']['#target_type'] = 'node';
 189       // Disable autocompletion when the first character is '/', '#' or '?'.
 190       $element['uri']['#attributes']['data-autocomplete-first-character-blacklist'] = '/#?';
 191
 192       // The link widget is doing its own processing in
 193       // static::getUriAsDisplayableString().
 194       $element['uri']['#process_default_value'] = FALSE;
 195     }
 196
 197     // If the field is configured to allow only internal links, add a useful
 198     // element prefix and description.
 199     if (!$this->supportsExternalLinks()) {
 200       $element['uri']['#field_prefix'] = rtrim(\Drupal::url('<front>', [], ['absolute' => TRUE]), '/');
 201       $element['uri']['#description'] = $this->t('This must be an internal path such as %add-node. You can also start typing the title of a piece of content to select it. Enter %front to link to the front page.', ['%add-node' => '/node/add', '%front' => '<front>']);
 202     }
 203     // If the field is configured to allow both internal and external links,
 204     // show a useful description.
 205     elseif ($this->supportsExternalLinks() && $this->supportsInternalLinks()) {
 206       $element['uri']['#description'] = $this->t('Start typing the title of a piece of content to select it. You can also enter an internal path such as %add-node or an external URL such as %url. Enter %front to link to the front page.', ['%front' => '<front>', '%add-node' => '/node/add', '%url' => 'http://example.com']);
 207     }
 208     // If the field is configured to allow only external links, show a useful
 209     // description.
 210     elseif ($this->supportsExternalLinks() && !$this->supportsInternalLinks()) {
 211       $element['uri']['#description'] = $this->t('This must be an external URL such as %url.', ['%url' => 'http://example.com']);
 212     }
 213
 214     $element['title'] = [
 215       '#type' => 'textfield',
 216       '#title' => $this->t('Link text'),
 217       '#placeholder' => $this->getSetting('placeholder_title'),
 218       '#default_value' => isset($items[$delta]->title) ? $items[$delta]->title : NULL,
 219       '#maxlength' => 255,
 220       '#access' => $this->getFieldSetting('title') != DRUPAL_DISABLED,
 221     ];
 222     // Post-process the title field to make it conditionally required if URL is
 223     // non-empty. Omit the validation on the field edit form, since the field
 224     // settings cannot be saved otherwise.
 225     if (!$this->isDefaultValueWidget($form_state) && $this->getFieldSetting('title') == DRUPAL_REQUIRED) {
 226       $element['#element_validate'][] = [get_called_class(), 'validateTitleElement'];
 227     }
 228
 229     // Exposing the attributes array in the widget is left for alternate and more
 230     // advanced field widgets.
 231     $element['attributes'] = [
 232       '#type' => 'value',
 233       '#tree' => TRUE,
 234       '#value' => !empty($items[$delta]->options['attributes']) ? $items[$delta]->options['attributes'] : [],
 235       '#attributes' => ['class' => ['link-field-widget-attributes']],
 236     ];
 237
 238     // If cardinality is 1, ensure a proper label is output for the field.
 239     if ($this->fieldDefinition->getFieldStorageDefinition()->getCardinality() == 1) {
 240       // If the link title is disabled, use the field definition label as the
 241       // title of the 'uri' element.
 242       if ($this->getFieldSetting('title') == DRUPAL_DISABLED) {
 243         $element['uri']['#title'] = $element['#title'];
 244       }
 245       // Otherwise wrap everything in a details element.
 246       else {
 247         $element += [
 248           '#type' => 'fieldset',
 249         ];
 250       }
 251     }
 252
 253     return $element;
 254   }
 255
 256   /**
 257    * Indicates enabled support for link to routes.
 258    *
 259    * @return bool
 260    *   Returns TRUE if the LinkItem field is configured to support links to
 261    *   routes, otherwise FALSE.
 262    */
 263   protected function supportsInternalLinks() {
 264     $link_type = $this->getFieldSetting('link_type');
 265     return (bool) ($link_type & LinkItemInterface::LINK_INTERNAL);
 266   }
 267
 268   /**
 269    * Indicates enabled support for link to external URLs.
 270    *
 271    * @return bool
 272    *   Returns TRUE if the LinkItem field is configured to support links to
 273    *   external URLs, otherwise FALSE.
 274    */
 275   protected function supportsExternalLinks() {
 276     $link_type = $this->getFieldSetting('link_type');
 277     return (bool) ($link_type & LinkItemInterface::LINK_EXTERNAL);
 278   }
 279
 280   /**
 281    * {@inheritdoc}
 282    */
 283   public function settingsForm(array $form, FormStateInterface $form_state) {
 284     $elements = parent::settingsForm($form, $form_state);
 285
 286     $elements['placeholder_url'] = [
 287       '#type' => 'textfield',
 288       '#title' => $this->t('Placeholder for URL'),
 289       '#default_value' => $this->getSetting('placeholder_url'),
 290       '#description' => $this->t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
 291     ];
 292     $elements['placeholder_title'] = [
 293       '#type' => 'textfield',
 294       '#title' => $this->t('Placeholder for link text'),
 295       '#default_value' => $this->getSetting('placeholder_title'),
 296       '#description' => $this->t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
 297       '#states' => [
 298         'invisible' => [
 299           ':input[name="instance[settings][title]"]' => ['value' => DRUPAL_DISABLED],
 300         ],
 301       ],
 302     ];
 303
 304     return $elements;
 305   }
 306
 307   /**
 308    * {@inheritdoc}
 309    */
 310   public function settingsSummary() {
 311     $summary = [];
 312
 313     $placeholder_title = $this->getSetting('placeholder_title');
 314     $placeholder_url = $this->getSetting('placeholder_url');
 315     if (empty($placeholder_title) && empty($placeholder_url)) {
 316       $summary[] = $this->t('No placeholders');
 317     }
 318     else {
 319       if (!empty($placeholder_title)) {
 320         $summary[] = $this->t('Title placeholder: @placeholder_title', ['@placeholder_title' => $placeholder_title]);
 321       }
 322       if (!empty($placeholder_url)) {
 323         $summary[] = $this->t('URL placeholder: @placeholder_url', ['@placeholder_url' => $placeholder_url]);
 324       }
 325     }
 326
 327     return $summary;
 328   }
 329
 330   /**
 331    * {@inheritdoc}
 332    */
 333   public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
 334     foreach ($values as &$value) {
 335       $value['uri'] = static::getUserEnteredStringAsUri($value['uri']);
 336       $value += ['options' => []];
 337     }
 338     return $values;
 339   }
 340
 341
 342   /**
 343    * {@inheritdoc}
 344    *
 345    * Override the '%uri' message parameter, to ensure that 'internal:' URIs
 346    * show a validation error message that doesn't mention that scheme.
 347    */
 348   public function flagErrors(FieldItemListInterface $items, ConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
 349     /** @var \Symfony\Component\Validator\ConstraintViolationInterface $violation */
 350     foreach ($violations as $offset => $violation) {
 351       $parameters = $violation->getParameters();
 352       if (isset($parameters['@uri'])) {
 353         $parameters['@uri'] = static::getUriAsDisplayableString($parameters['@uri']);
 354         $violations->set($offset, new ConstraintViolation(
 355           $this->t($violation->getMessageTemplate(), $parameters),
 356           $violation->getMessageTemplate(),
 357           $parameters,
 358           $violation->getRoot(),
 359           $violation->getPropertyPath(),
 360           $violation->getInvalidValue(),
 361           $violation->getPlural(),
 362           $violation->getCode()
 363         ));
 364       }
 365     }
 366     parent::flagErrors($items, $violations, $form, $form_state);
 367   }
 368
 369 }