LinkWidget.php 14.1 KB
Newer Older
1
2
<?php

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
11
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationListInterface;
12
13
14
15

/**
 * Plugin implementation of the 'link' widget.
 *
16
 * @FieldWidget(
17
18
19
20
21
22
23
24
25
 *   id = "link_default",
 *   label = @Translation("Link"),
 *   field_types = {
 *     "link"
 *   }
 * )
 */
class LinkWidget extends WidgetBase {

26
27
28
29
  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
30
    return [
31
32
      'placeholder_url' => '',
      'placeholder_title' => '',
33
    ] + parent::defaultSettings();
34
35
  }

36
  /**
37
   * Gets the URI without the 'internal:' or 'entity:' scheme.
38
39
40
   *
   * The following two forms of URIs are transformed:
   * - '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
46
47
48
   *
   * @param string $uri
   *   The URI to get the displayable string for.
   *
   * @return string
49
50
   *
   * @see static::getUserEnteredStringAsUri()
51
   */
52
  protected static function getUriAsDisplayableString($uri) {
53
    $scheme = parse_url($uri, PHP_URL_SCHEME);
54
55
56
57

    // By default, the displayable string is the URI.
    $displayable_string = $uri;

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
64

      // @todo '<front>' is valid input for BC reasons, may be removed by
      //   https://www.drupal.org/node/2421941
65
66
67
68
      $path = parse_url($uri, PHP_URL_PATH);
      if ($path === '/') {
        $uri_reference = '<front>' . substr($uri_reference, 1);
      }
69
70

      $displayable_string = $uri_reference;
71
    }
72
73
    elseif ($scheme === 'entity') {
      list($entity_type, $entity_id) = explode('/', substr($uri, 7), 2);
74
      // Show the 'entity:' URI as the entity autocomplete would.
75
76
77
      // @todo Support entity types other than 'node'. Will be fixed in
      //    https://www.drupal.org/node/2423093.
      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
87
  /**
   * Gets the user-entered string as a URI.
   *
88
89
   * The following two forms of input are mapped to URIs:
   * - 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
96
97
   *   The user-entered string.
   *
   * @return string
98
99
100
   *   The URI, if a non-empty $uri was passed.
   *
   * @see static::getUriAsDisplayableString()
101
   */
102
  protected static function getUserEnteredStringAsUri($string) {
103
104
105
106
107
108
109
110
111
112
    // By default, assume the entered string is an URI.
    $uri = $string;

    // Detect entity autocomplete string, map to 'entity:' URI.
    $entity_id = EntityAutocomplete::extractEntityIdFromAutocompleteInput($string);
    if ($entity_id !== NULL) {
      // @todo Support entity types other than 'node'. Will be fixed in
      //    https://www.drupal.org/node/2423093.
      $uri = 'entity:node/' . $entity_id;
    }
113
    // Detect a schemeless string, map to 'internal:' URI.
114
115
116
117
118
119
120
    elseif (!empty($string) && parse_url($string, PHP_URL_SCHEME) === NULL) {
      // @todo '<front>' is valid input for BC reasons, may be removed by
      //   https://www.drupal.org/node/2421941
      // - '<front>' -> '/'
      // - '<front>#foo' -> '/#foo'
      if (strpos($string, '<front>') === 0) {
        $string = '/' . substr($string, strlen('<front>'));
121
      }
122
      $uri = 'internal:' . $string;
123
    }
124
125

    return $uri;
126
127
128
  }

  /**
129
130
   * Form element validation handler for the 'uri' element.
   *
131
132
133
134
   * Disallows saving inaccessible or untrusted URLs.
   */
  public static function validateUriElement($element, FormStateInterface $form_state, $form) {
    $uri = static::getUserEnteredStringAsUri($element['#value']);
135
136
    $form_state->setValueForElement($element, $uri);

137
    // If getUserEnteredStringAsUri() mapped the entered value to a 'internal:'
138
    // URI , ensure the raw value begins with '/', '?' or '#'.
139
140
    // @todo '<front>' is valid input for BC reasons, may be removed by
    //   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
149
150
151
152
153
154
  /**
   * Form element validation handler for the 'title' element.
   *
   * Conditionally requires the link title if a URL value was filled in.
   */
  public static function validateTitleElement(&$element, FormStateInterface $form_state, $form) {
    if ($element['uri']['#value'] !== '' && $element['title']['#value'] === '') {
      $element['title']['#required'] = TRUE;
155
156
      // We expect the field name placeholder value to be wrapped in t() here,
      // 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
163
  /**
   * {@inheritdoc}
   */
164
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
165
166
    /** @var \Drupal\link\LinkItemInterface $item */
    $item = $items[$delta];
167

168
    $element['uri'] = [
169
      '#type' => 'url',
170
      '#title' => $this->t('URL'),
171
      '#placeholder' => $this->getSetting('placeholder_url'),
172
173
174
      // The current field value could have been entered by a different user.
      // However, if it is inaccessible to the current user, do not display it
      // 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
178
      '#maxlength' => 2048,
      '#required' => $element['#required'],
179
      '#link_type' => $this->getFieldSetting('link_type'),
180
    ];
181
182
183
184

    // If the field is configured to support internal links, it cannot use the
    // 'url' form element and we have to do the validation ourselves.
    if ($this->supportsInternalLinks()) {
185
186
187
188
189
190
      $element['uri']['#type'] = 'entity_autocomplete';
      // @todo The user should be able to select an entity type. Will be fixed
      //    in https://www.drupal.org/node/2423093.
      $element['uri']['#target_type'] = 'node';
      // Disable autocompletion when the first character is '/', '#' or '?'.
      $element['uri']['#attributes']['data-autocomplete-first-character-blacklist'] = '/#?';
191
192
193
194

      // The link widget is doing its own processing in
      // static::getUriAsDisplayableString().
      $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
201
      $element['uri']['#field_prefix'] = rtrim(\Drupal::url('<front>', [], ['absolute' => TRUE]), '/');
      $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
204
205
    }
    // If the field is configured to allow both internal and external links,
    // show a useful description.
    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
209
210
    // If the field is configured to allow only external links, show a useful
    // description.
    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
223
224
    // Post-process the title field to make it conditionally required if URL is
    // non-empty. Omit the validation on the field edit form, since the field
    // 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
230
    }

    // Exposing the attributes array in the widget is left for alternate and more
    // advanced field widgets.
231
    $element['attributes'] = [
232
233
      '#type' => 'value',
      '#tree' => TRUE,
234
235
236
      '#value' => !empty($items[$delta]->options['attributes']) ? $items[$delta]->options['attributes'] : [],
      '#attributes' => ['class' => ['link-field-widget-attributes']],
    ];
237

238
    // If cardinality is 1, ensure a proper label is output for the field.
239
    if ($this->fieldDefinition->getFieldStorageDefinition()->getCardinality() == 1) {
240
241
242
243
244
245
246
      // If the link title is disabled, use the field definition label as the
      // title of the 'uri' element.
      if ($this->getFieldSetting('title') == DRUPAL_DISABLED) {
        $element['uri']['#title'] = $element['#title'];
      }
      // Otherwise wrap everything in a details element.
      else {
247
        $element += [
248
          '#type' => 'fieldset',
249
        ];
250
      }
251
252
253
254
255
    }

    return $element;
  }

256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
  /**
   * Indicates enabled support for link to routes.
   *
   * @return bool
   *   Returns TRUE if the LinkItem field is configured to support links to
   *   routes, otherwise FALSE.
   */
  protected function supportsInternalLinks() {
    $link_type = $this->getFieldSetting('link_type');
    return (bool) ($link_type & LinkItemInterface::LINK_INTERNAL);
  }

  /**
   * Indicates enabled support for link to external URLs.
   *
   * @return bool
   *   Returns TRUE if the LinkItem field is configured to support links to
   *   external URLs, otherwise FALSE.
   */
  protected function supportsExternalLinks() {
    $link_type = $this->getFieldSetting('link_type');
    return (bool) ($link_type & LinkItemInterface::LINK_EXTERNAL);
  }

280
281
282
  /**
   * {@inheritdoc}
   */
283
  public function settingsForm(array $form, FormStateInterface $form_state) {
284
285
    $elements = parent::settingsForm($form, $form_state);

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
298
299
300
301
302
      '#states' => [
        'invisible' => [
          ':input[name="instance[settings][title]"]' => ['value' => DRUPAL_DISABLED],
        ],
      ],
    ];
303
304
305
306

    return $elements;
  }

307
308
309
310
  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
311
    $summary = [];
312
313
314
315

    $placeholder_title = $this->getSetting('placeholder_title');
    $placeholder_url = $this->getSetting('placeholder_url');
    if (empty($placeholder_title) && empty($placeholder_url)) {
316
      $summary[] = $this->t('No placeholders');
317
318
319
    }
    else {
      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
328
329
      }
    }

    return $summary;
  }

330
331
332
  /**
   * {@inheritdoc}
   */
333
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
334
    foreach ($values as &$value) {
335
336
      $value['uri'] = static::getUserEnteredStringAsUri($value['uri']);
      $value += ['options' => []];
337
338
339
340
    }
    return $values;
  }

341
342
343
344

  /**
   * {@inheritdoc}
   *
345
   * Override the '%uri' message parameter, to ensure that 'internal:' URIs
346
347
348
349
350
   * show a validation error message that doesn't mention that scheme.
   */
  public function flagErrors(FieldItemListInterface $items, ConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
    /** @var \Symfony\Component\Validator\ConstraintViolationInterface $violation */
    foreach ($violations as $offset => $violation) {
351
      $parameters = $violation->getParameters();
352
353
      if (isset($parameters['@uri'])) {
        $parameters['@uri'] = static::getUriAsDisplayableString($parameters['@uri']);
354
355
356
357
358
359
360
        $violations->set($offset, new ConstraintViolation(
          $this->t($violation->getMessageTemplate(), $parameters),
          $violation->getMessageTemplate(),
          $parameters,
          $violation->getRoot(),
          $violation->getPropertyPath(),
          $violation->getInvalidValue(),
361
          $violation->getPlural(),
362
363
364
365
366
367
368
          $violation->getCode()
        ));
      }
    }
    parent::flagErrors($items, $violations, $form, $form_state);
  }

369
}