link.module 42.5 KB
Newer Older
Nathan Haug's avatar
Nathan Haug committed
1
2
3
4
5
6
7
<?php

/**
 * @file
 * Defines simple link field types.
 */

8
9
10
11
define('LINK_EXTERNAL', 'external');
define('LINK_INTERNAL', 'internal');
define('LINK_FRONT', 'front');
define('LINK_EMAIL', 'email');
12
define('LINK_NEWS', 'news');
13
14
15
16
17
18
define('LINK_DOMAINS', 'aero|arpa|asia|biz|com|cat|coop|edu|gov|info|int|jobs|mil|museum|name|nato|net|org|pro|travel|mobi|local');

define('LINK_TARGET_DEFAULT', 'default');
define('LINK_TARGET_NEW_WINDOW', '_blank');
define('LINK_TARGET_TOP', '_top');
define('LINK_TARGET_USER', 'user');
19

Nathan Haug's avatar
Nathan Haug committed
20
/**
21
 * Maximum URLs length - needs to match value in link.install.
22
23
24
25
26
 */
define('LINK_URL_MAX_LENGTH', 2048);

/**
 * Implements hook_field_info().
Nathan Haug's avatar
Nathan Haug committed
27
28
29
 */
function link_field_info() {
  return array(
30
    'link_field' => array(
31
32
      'label' => t('Link'),
      'description' => t('Store a title, href, and attributes in the database to assemble a link.'),
33
      'settings' => array(
34
35
36
37
        'attributes' => _link_default_attributes(),
        'url' => 0,
        'title' => 'optional',
        'title_value' => '',
38
        'title_maxlength' => 128, //patch #1307788 from nmc
39
40
41
42
43
44
45
46
47
48
        'enable_tokens' => 1,
        'display' => array(
          'url_cutoff' => 80,
        ),
      ),
      'instance_settings' => array(
        'attributes' => _link_default_attributes(),
        'url' => 0,
        'title' => 'optional',
        'title_value' => '',
49
        'title_maxlength' => 128, // patch #1307788 from nmc
50
51
52
53
        'enable_tokens' => 1,
        'display' => array(
          'url_cutoff' => 80,
        ),
54
        'validate_url' => 1,
55
      ),
56
      'default_widget' => 'link_field',
57
      'default_formatter' => 'link_default',
58
59
60
      // Support hook_entity_property_info() from contrib "Entity API".
      'property_type' => 'field_item_link',
      'property_callbacks' => array('link_field_property_info_callback'),
61
    ),
Nathan Haug's avatar
Nathan Haug committed
62
63
64
  );
}

65
/**
66
 * Implements hook_field_instance_settings_form().
67
 */
68
function link_field_instance_settings_form($field, $instance) {
69
70
71
  $form = array(
    '#element_validate' => array('link_field_settings_form_validate'),
  );
72

73
74
75
76
77
78
  $form['validate_url'] = array(
    '#type' => 'checkbox',
    '#title' => t('Validate URL'),
    '#default_value' => isset($instance['settings']['validate_url']) && ($instance['settings']['validate_url'] !== '') ? $instance['settings']['validate_url'] : TRUE,
    '#description' => t('If checked, the URL field will be verified as a valid URL during validation.'),
  );
79

80
81
82
  $form['url'] = array(
    '#type' => 'checkbox',
    '#title' => t('Optional URL'),
83
    '#default_value' => isset($instance['settings']['url']) ? $instance['settings']['url'] : '',
84
85
86
    '#return_value' => 'optional',
    '#description' => t('If checked, the URL field is optional and submitting a title alone will be acceptable. If the URL is omitted, the title will be displayed as plain text.'),
  );
87

88
89
90
91
92
93
  $title_options = array(
    'optional' => t('Optional Title'),
    'required' => t('Required Title'),
    'value' => t('Static Title'),
    'none' => t('No Title'),
  );
94

95
96
97
  $form['title'] = array(
    '#type' => 'radios',
    '#title' => t('Link Title'),
98
    '#default_value' => isset($instance['settings']['title']) ? $instance['settings']['title'] : 'optional',
99
100
101
    '#options' => $title_options,
    '#description' => t('If the link title is optional or required, a field will be displayed to the end user. If the link title is static, the link will always use the same title. If <a href="http://drupal.org/project/token">token module</a> is installed, the static title value may use any other node field as its value. Static and token-based titles may include most inline XHTML tags such as <em>strong</em>, <em>em</em>, <em>img</em>, <em>span</em>, etc.'),
  );
102

103
104
105
  $form['title_value'] = array(
    '#type' => 'textfield',
    '#title' => t('Static title'),
106
    '#default_value' => isset($instance['settings']['title_value']) ? $instance['settings']['title_value'] : '',
107
108
    '#description' => t('This title will always be used if &ldquo;Static Title&rdquo; is selected above.'),
  );
109

110
111
112
113
114
115
116
117
118
  $form['title_maxlength'] = array( // patch #1307788 from nmc
    '#type' => 'textfield',
    '#title' => t('Max length of title field'),
    '#default_value' => isset($instance['settings']['title_maxlength']) ? $instance['settings']['title_maxlength'] : '128',
    '#description' => t('Set a maximum length on the title field (applies only if Link Title is optional or required).  The maximum limit is 255 characters.'),
    '#maxlength' => 3,
    '#size' => 3,
    );

119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
  if (module_exists('token')) {
    // Add token module replacements fields
    $form['tokens'] = array(
      '#type' => 'fieldset',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#title' => t('Placeholder tokens'),
      '#description' => t("The following placeholder tokens can be used in both paths and titles. When used in a path or title, they will be replaced with the appropriate values."),
    );
    $token_type = array(
      'theme' => 'token_tree',
      'token_types' => array($instance['entity_type']),
      'global_types' => TRUE,
      'click_insert' => TRUE,
      'recursion_limit' => 2,
    );
    $form['tokens']['help'] = array(
      '#type' => 'markup',
      '#markup' => theme('token_tree', $token_type),
    );

    $form['enable_tokens'] = array(
      '#type' => 'checkbox',
      '#title' => t('Allow user-entered tokens'),
      '#default_value' => isset($instance['settings']['enable_tokens']) ? $instance['settings']['enable_tokens'] : 1,
      '#description' => t('Checking will allow users to enter tokens in URLs and Titles on the node edit form. This does not affect the field settings on this page.'),
    );
  }
147

148
149
150
151
152
153
  $form['display'] = array(
    '#tree' => TRUE,
  );
  $form['display']['url_cutoff'] = array(
    '#type' => 'textfield',
    '#title' => t('URL Display Cutoff'),
154
    '#default_value' => isset($instance['settings']['display']['url_cutoff']) ? $instance['settings']['display']['url_cutoff'] : '80',
155
156
157
158
    '#description' => t('If the user does not include a title for this link, the URL will be used as the title. When should the link title be trimmed and finished with an elipsis (&hellip;)? Leave blank for no limit.'),
    '#maxlength' => 3,
   '#size' => 3,
  );
159

160
161
162
163
164
165
166
167
168
169
170
171
  $target_options = array(
    LINK_TARGET_DEFAULT => t('Default (no target attribute)'),
    LINK_TARGET_TOP => t('Open link in window root'),
    LINK_TARGET_NEW_WINDOW => t('Open link in new window'),
    LINK_TARGET_USER => t('Allow the user to choose'),
  );
  $form['attributes'] = array(
    '#tree' => TRUE,
  );
  $form['attributes']['target'] = array(
    '#type' => 'radios',
    '#title' => t('Link Target'),
172
    '#default_value' => empty($instance['settings']['attributes']['target']) ? LINK_TARGET_DEFAULT : $instance['settings']['attributes']['target'],
173
174
175
176
177
178
    '#options' => $target_options,
  );
  $form['attributes']['rel'] = array(
    '#type' => 'textfield',
    '#title' => t('Rel Attribute'),
    '#description' => t('When output, this link will have this rel attribute. The most common usage is <a href="http://en.wikipedia.org/wiki/Nofollow">rel=&quot;nofollow&quot;</a> which prevents some search engines from spidering entered links.'),
179
    '#default_value' => empty($instance['settings']['attributes']['rel']) ? '' : $instance['settings']['attributes']['rel'],
180
181
182
183
    '#field_prefix' => 'rel = "',
    '#field_suffix' => '"',
    '#size' => 20,
  );
184
185
186
187
188
189
190
191
192
193
194
195
  $rel_remove_options = array(
    'default' => t('Keep rel as set up above (untouched/default)'),
    'rel_remove_external' => t('Remove rel if given link is external'),
    'rel_remove_internal' => t('Remove rel if given link is internal'),
  );
  $form['rel_remove'] = array(
    '#type' => 'radios',
    '#title' => t('Remove rel attribute automaticly'),
    '#default_value' => !isset($instance['settings']['rel_remove']) ? 'default' : $instance['settings']['rel_remove'],
    '#description' => t('Turn on/off if rel attribute should be removed automaticly, if user given link is internal/external'),
    '#options' => $rel_remove_options,
  );
196
197
198
  $form['attributes']['class'] = array(
    '#type' => 'textfield',
    '#title' => t('Additional CSS Class'),
199
    '#description' => t('When output, this link will have this class attribute. Multiple classes should be separated by spaces.'),
200
    '#default_value' => empty($instance['settings']['attributes']['class']) ? '' : $instance['settings']['attributes']['class'],
201
  );
202
203
204
205
206
207
208
209
210
211
212
213
214
215
  $form['attributes']['configurable_title'] = array(
    '#title' => t("Allow the user to enter a link 'title' attribute"),
    '#type' => 'checkbox',
    '#default_value' => empty($instance['settings']['attributes']['configurable_title']) ? '' : $instance['settings']['attributes']['configurable_title'],
  );
  $form['attributes']['title'] = array(
    '#title' => t("Default link 'title' Attribute"),
    '#type' => 'textfield',
    '#description' => t('When output, links will use this "title" attribute if the user does not provide one and when different from the link text. Read <a href="http://www.w3.org/TR/WCAG10-HTML-TECHS/#links">WCAG 1.0 Guidelines</a> for links comformances. Tokens values will be evaluated.'),
    '#default_value' => empty($instance['settings']['attributes']['title']) ? '' : $instance['settings']['attributes']['title'],
    '#field_prefix' => 'title = "',
    '#field_suffix' => '"',
    '#size' => 20,
  );
216
217
218
219
220
221
222
  return $form;
}

/**
 * Validate the field settings form.
 */
function link_field_settings_form_validate($element, &$form_state, $complete_form) {
223
224
  if ($form_state['values']['instance']['settings']['title'] === 'value'
      && empty($form_state['values']['instance']['settings']['title_value'])) {
225
226
    form_set_error('title_value', t('A default title must be provided if the title is a static value.'));
  }
227
228
229
230
231
232
233
234
235
236
237
238
  if (!empty($form_state['values']['instance']['settings']['display']['url_cutoff'])  // patch #1307788 from nmc
      && !is_numeric($form_state['values']['instance']['settings']['display']['url_cutoff'])) {
    form_set_error('display', t('URL Display Cutoff value must be numeric.'));
  }
  if (empty($form_state['values']['instance']['settings']['title_maxlength'])) {     // patch #1307788 from nmc
    form_set_value($element['title_maxlength'], '128', $form_state);
  } elseif (!is_numeric($form_state['values']['instance']['settings']['title_maxlength'])) {
    form_set_error('title_maxlength', t('The max length of the link title must be numeric.'));
  } elseif ($form_state['values']['instance']['settings']['title_maxlength'] > 255) {
    form_set_error('title_maxlength', t('The max length of the link title cannot be greater than 255 characters.'));
  }

239
240
}

241
/**
242
 * Implement hook_field_is_empty().
243
 */
244
function link_field_is_empty($item, $field) {
245
246
247
  return empty($item['title']) && empty($item['url']);
}

248
249
250
/**
 * Implements hook_field_load().
 */
251
252
253
function link_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {
  foreach ($entities as $id => $entity) {
    foreach ($items[$id] as $delta => $item) {
254
      $items[$id][$delta]['attributes'] = _link_load($field, $item, $instances[$id]);
255
    }
256
257
258
  }
}

Nathan Haug's avatar
Nathan Haug committed
259
/**
260
 * Implements hook_field_validate().
Nathan Haug's avatar
Nathan Haug committed
261
 */
262
263
function link_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
  $optional_field_found = FALSE;
264
265
  if ($instance['settings']['validate_url'] !== 0 || is_null($instance['settings']['validate_url']) || !isset($instance['settings']['validate_url'])) {
    foreach ($items as $delta => $value) {
266
      _link_validate($items[$delta], $delta, $field, $entity, $instance, $langcode, $optional_field_found);
267
268
269
    }
  }

270
  if ($instance['settings']['url'] === 'optional' && $instance['settings']['title'] === 'optional' && $instance['required'] && !$optional_field_found) {
271
    form_set_error($field['field_name'] . '][' . $langcode . '][0][title', t('At least one title or URL must be entered.'));
272
273
  }
}
274

275
276
277
278
279
280
/**
 * Implements hook_field_presave().
 */
function link_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {
  foreach ($items as $delta => $value) {
    _link_process($items[$delta], $delta, $field, $entity);
Nathan Haug's avatar
Nathan Haug committed
281
282
283
  }
}

284
285
286
287
288
289
290
291
292
293
294
/**
 * Implements hook_field_prepare_view().
 */
function link_field_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items) {
  foreach ($items as $entity_id => $entity_items) {
    foreach ($entity_items as $delta => $value) {
      _link_sanitize($items[$entity_id][$delta], $delta, $field, $instances[$entity_id], $entities[$entity_id]);
    }
  }
}

Nathan Haug's avatar
Nathan Haug committed
295
/**
296
 * Implements hook_field_widget_info().
Nathan Haug's avatar
Nathan Haug committed
297
 */
298
function link_field_widget_info() {
Nathan Haug's avatar
Nathan Haug committed
299
  return array(
300
    'link_field' => array(
301
      'label' => 'Link',
302
303
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
Nathan Haug's avatar
Nathan Haug committed
304
305
306
307
308
    ),
  );
}

/**
309
 * Implements hook_field_widget_form().
Nathan Haug's avatar
Nathan Haug committed
310
 */
311
312
313
function link_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
  $element += array(
    '#type' => $instance['widget']['type'],
314
    '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
315
  );
316
  return $element;
317
318
}

319
/**
320
 * Unpacks the item attributes for use.
321
 */
322
323
324
325
326
function _link_load($field, $item, $instance) {
  /*return $item['attributes'] = isset($item['attributes']) ?
                                unserialize($item['attributes']) :
                                $instance['settings']['attributes'];*/
  if (isset($item['attributes'])) {
327
328
329
330
    if (!is_array($item['attributes'])) {
      $item['attributes'] = unserialize($item['attributes']);
    }
    return $item['attributes'];
331
332
333
334
335
336
  }
  else if (isset($instance['settings']['attributes'])) {
    return $instance['settings']['attributes'];
  }
  else {
    return $field['settings']['attributes'];
337
  }
338
339
}

340
341
342
/**
 * Prepares the item attributes and url for storage.
 */
343
function _link_process(&$item, $delta = 0, $field, $entity) {
344
  // Trim whitespace from URL.
345
  $item['url'] = trim($item['url']);
346
347
348

  // if no attributes are set then make sure $item['attributes'] is an empty array - this lets $field['attributes'] override it.
  if (empty($item['attributes'])) {
349
    $item['attributes'] = array();
350
351
  }

352
  // Serialize the attributes array.
353
354
355
  if (!is_string($item['attributes'])) {
    $item['attributes'] = serialize($item['attributes']);
  }
356
357

  // Don't save an invalid default value (e.g. 'http://').
358
359
  if ((isset($field['widget']['default_value'][$delta]['url']) && $item['url'] == $field['widget']['default_value'][$delta]['url'])
      && is_object($node)) {
360
361
    if (!link_validate_url($item['url'])) {
      unset($item['url']);
362
363
    }
  }
364
365
366
367
368
369
370
371
  
  // token from the patch http://drupal.org/files/link_query_fragment.patch @ Issue #1321482
  if (!empty($item['query'])) {
    $item['url'] .= '?' . http_build_query($item['query']);
  }
  if (!empty($item['fragment'])) {
    $item['url'] .= '#' . $item['fragment'];
  }
372
373
}

374
375
376
/**
 * Validates that the link field has been entered properly.
 */
377
function _link_validate(&$item, $delta, $field, $node, $instance, $langcode, &$optional_field_found) {
378
  if ($item['url']
379
380
381
      && !(isset($instance['default_value'][$delta]['url'])
      && $item['url'] === $instance['default_value'][$delta]['url']
      && !$instance['required'])) {
382
383
    // Validate the link.
    if (link_validate_url(trim($item['url'])) == FALSE) {
384
      form_set_error($field['field_name'] . '][' . $langcode . ']['. $delta .'][url', t('Not a valid URL.'));
385
386
    }
    // Require a title for the link if necessary.
387
    if ($instance['settings']['title'] == 'required' && strlen(trim($item['title'])) == 0) {
388
      form_set_error($field['field_name'] . '][' . $langcode . ']['. $delta .'][title', t('Titles are required for all links.'));
389
    }
390
  }
391
  // Require a link if we have a title.
392
393
394
  if ($instance['settings']['url'] !== 'optional'
      && strlen(isset($item['title']) ? $item['title'] : NULL) > 0
      && strlen(trim($item['url'])) == 0) {
395
    form_set_error($field['field_name'] . '][' . $langcode . ']['. $delta .'][url', t('You cannot enter a title without a link url.'));
396
397
  }
  // In a totally bizzaro case, where URLs and titles are optional but the field is required, ensure there is at least one link.
398
399
400
  if ($instance['settings']['url'] === 'optional'
      && $instance['settings']['title'] === 'optional'
      && (strlen(trim($item['url'])) !== 0 || strlen(trim($item['title'])) !== 0)) {
401
    $optional_field_found = TRUE;
402
  }
403
  // Require entire field
404
405
406
407
408
  if ($instance['settings']['url'] === 'optional'
    && $instance['settings']['title'] === 'optional'
    && $instance['required'] == 1
    && !$optional_field_found
    && isset($instance['id'])) {
409
    form_set_error($instance['field_name'] . '][' . $langcode . '][0][title',
410
411
                   t('At least one title or URL must be entered.'));
  }
412
413
414
}

/**
415
 * Cleanup user-entered values for a link field according to field settings.
416
 *
417
418
419
420
421
422
423
424
 * @param $item
 *   A single link item, usually containing url, title, and attributes.
 * @param $delta
 *   The delta value if this field is one of multiple fields.
 * @param $field
 *   The CCK field definition.
 * @param $node
 *   The node containing this link.
425
 */
426
function _link_sanitize(&$item, $delta, &$field, $instance, &$node) {
427
428
429
430
431
  // Don't try to process empty links.
  if (empty($item['url']) && empty($item['title'])) {
    return;
  }

432
  // Replace URL tokens.
433
  if (isset($instance['settings']['enable_tokens']) && $instance['settings']['enable_tokens']) {
434
    global $user;
435
436
    // Load the node if necessary for nodes in views.
    $token_node = isset($node->nid) ? node_load($node->nid) : $node;
437
    $item['url'] = token_replace($item['url'], array('node' => $token_node));
438
439
440
  }

  $type = link_validate_url($item['url']);
441
442
443
444
445
  // If we can't determine the type of url, and we've been told not to validate it,
  // then we assume it's a LINK_EXTERNAL type for later processing. #357604
  if ($type == FALSE && $instance['settings']['validate_url'] === 0) {
    $type = LINK_EXTERNAL;
  }
446
  $url = link_cleanup_url($item['url']);
447

448
  // Separate out the anchor if any.
449
450
451
  if (strpos($url, '#') !== FALSE) {
    $item['fragment'] = substr($url, strpos($url, '#') + 1);
    $url = substr($url, 0, strpos($url, '#'));
452
  }
453
  // Separate out the query string if any.
454
  if (strpos($url, '?') !== FALSE) {
455
456
457
    $query = substr($url, strpos($url, '?') + 1);
    parse_str($query, $query_array);
    $item['query'] = $query_array;
458
459
    $url = substr($url, 0, strpos($url, '?'));
  }
460

461
  $item['url'] = check_plain($url);
462
463

  // Create a shortened URL for display.
464
465
466
467
468
469
470
471
472
473
474
  $display_url = $type == LINK_EMAIL ?
                  str_replace('mailto:', '', $url) :
                  url($url, array('query' => isset($item['query']) ?
                                              $item['query'] :
                                              NULL,
                                  'fragment' => isset($item['fragment']) ?
                                                $item['fragment'] :
                                                NULL,
                                  'absolute' => TRUE));
  if ($instance['settings']['display']['url_cutoff'] && strlen($display_url) > $instance['settings']['display']['url_cutoff']) {
    $display_url = substr($display_url, 0, $instance['settings']['display']['url_cutoff']) ."...";
475
476
477
  }
  $item['display_url'] = $display_url;

478
479
480
  // Use the title defined at the instance level.
  if ($instance['settings']['title'] == 'value' && strlen(trim($instance['settings']['title_value']))) {
    $title = $instance['settings']['title_value'];
481
482
  }
  // Use the title defined by the user at the widget level.
483
  else if (isset($item['title'])) {
484
485
    $title = $item['title'];
  }
486
487
488
  else {
    $title = '';
  }
489

490
  // Replace tokens.
491
  if ($title && ($instance['settings']['title'] == 'value' || $instance['settings']['enable_tokens'])) {
492
493
    // Load the node if necessary for nodes in views.
    $token_node = isset($node->nid) ? node_load($node->nid) : $node;
494
495
    $title = filter_xss(token_replace($title, array('node' => $token_node)),
                        array('b', 'br', 'code', 'em', 'i', 'img', 'span', 'strong', 'sub', 'sup', 'tt', 'u'));
496
    $item['html'] = TRUE;
497
  }
498
  $item['title'] = empty($title) ? $item['display_url'] : $title;
499

500
501
502
503
504
505
506
507
508
509
  if (!isset($item['attributes'])) {
    $item['attributes'] = array();
  }

  // Unserialize attributtes array if it has not been unserialized yet.
  if (!is_array($item['attributes'])) {
    $item['attributes'] = (array)unserialize($item['attributes']);
  }

  // Add default attributes.
510
511
512
513
514
515
  if (!is_array($instance['settings']['attributes'])){
    $instance['settings']['attributes'] = _link_default_attributes();
  }
  else {
    $instance['settings']['attributes'] += _link_default_attributes();
  }
516
517

  // Merge item attributes with attributes defined at the field level.
518
  $item['attributes'] += $instance['settings']['attributes'];
519
520
521

  // If user is not allowed to choose target attribute, use default defined at
  // field level.
522
523
  if ($instance['settings']['attributes']['target'] != LINK_TARGET_USER) {
    $item['attributes']['target'] = $instance['settings']['attributes']['target'];
524
525
526
527
528
529
530
  }

  // Remove the target attribute if the default (no target) is selected.
  if (empty($item['attributes']) || $item['attributes']['target'] == LINK_TARGET_DEFAULT) {
    unset($item['attributes']['target']);
  }

531
532
533
534
535
536
  // Remove rel attribute for internal or external links if selected.
  if (isset($item['attributes']['rel']) && isset($instance['settings']['rel_remove']) && $instance['settings']['rel_remove'] != 'default') {
    if (($instance['settings']['rel_remove'] != 'rel_remove_internal' && $type != LINK_INTERNAL) ||
            ($instance['settings']['rel_remove'] != 'rel_remove_external' && $type != LINK_EXTERNAL)) {
    unset($item['attributes']['rel']);
    }
537
  }
538

539
540
541
542
543
544
545
546
  // Handle "title" link attribute.
  if (!empty($item['attributes']['title']) && module_exists('token')) {
    // Load the node (necessary for nodes in views).
    $token_node = isset($node->nid) ? node_load($node->nid) : $node;
    $item['attributes']['title'] = filter_xss(token_replace($item['attributes']['title'], array('node' => $token_node)),
                        array('b', 'br', 'code', 'em', 'i', 'img', 'span', 'strong', 'sub', 'sup', 'tt', 'u'));
  }
  // Remove title attribute if it's equal to link text.
547
  if (isset($item['attributes']['title']) && $item['attributes']['title'] == $item['title']) {
548
549
550
551
    unset($item['attributes']['title']);
  }
  unset($item['attributes']['configurable_title']);

552
553
  // Remove empty attributes.
  $item['attributes'] = array_filter($item['attributes']);
554

555
  // Sets title to trimmed url if one exists
556
  // @TODO: Do we need this?  It seems not.
557
  /*if(!empty($item['display_url']) && empty($item['title'])) {
558
559
560
561
    $item['title'] = $item['display_url'];
  }
  elseif(!isset($item['title'])) {
    $item['title'] = $item['url'];
562
  }*/
563

564
565
566
}

/**
567
 * Implements hook_theme().
568
 */
569
570
function link_theme() {
  return array(
571
572
573
    /*'link_field_settings' => array(
      'variables' => array('element' => NULL),
    ),*/
574
    'link_formatter_link_default' => array(
575
      'variables' => array('element' => NULL),
576
    ),
577
    'link_formatter_link_plain' => array(
578
      'variables' => array('element' => NULL),
579
    ),
580
581
582
    'link_formatter_link_absolute' => array(
      'variables' => array('element' => NULL),
    ),
583
584
585
    'link_formatter_link_title_plain' => array(
      'variables' => array('element' => NULL),
    ),
586
    'link_formatter_link_url' => array(
587
      'variables' => array('element' => NULL),
588
    ),
589
    'link_formatter_link_short' => array(
590
      'variables' => array('element' => NULL),
591
    ),
592
    'link_formatter_link_label' => array(
593
      'variables' => array('element' => NULL),
594
    ),
595
    'link_formatter_link_separate' => array(
596
      'variables' => array('element' => NULL),
597
    ),
598
    'link_field' => array(
599
      'render element' => 'element',
600
601
602
603
604
605
606
    ),
  );
}

/**
 * FAPI theme for an individual text elements.
 */
607
function theme_link_field($vars) {
608
609
  drupal_add_css(drupal_get_path('module', 'link') .'/link.css');

610
  $element = $vars['element'];
611
612
  // Prefix single value link fields with the name of the field.
  if (empty($element['#field']['multiple'])) {
613
614
    if (isset($element['url']) && !isset($element['title'])) {
      unset($element['url']['#title']);
615
    }
616
617
  }

618
  $output = '';
619
  $output .= '<div class="link-field-subrow clearfix">';
620
  if (isset($element['title'])) {
621
    $output .= '<div class="link-field-title link-field-column">'. drupal_render($element['title']) .'</div>';
622
  }
623
  $output .= '<div class="link-field-url'. (isset($element['title']) ? ' link-field-column' : '') .'">'. drupal_render($element['url']) .'</div>';
624
  $output .= '</div>';
625
  if (!empty($element['attributes']['target'])) {
626
    $output .= '<div class="link-attributes">'. drupal_render($element['attributes']['target']) .'</div>';
627
  }
628
629
630
  if (!empty($element['attributes']['title'])) {
    $output .= '<div class="link-attributes">'. drupal_render($element['attributes']['title']) .'</div>';
  }
631
  return $output;
632
633
}

634
/**
635
 * Implements hook_element_info().
636
 */
637
function link_element_info() {
638
  $elements = array();
639
  $elements['link_field'] =  array(
640
    '#input' => TRUE,
641
    '#process' => array('link_field_process'),
642
643
    '#theme' => 'link_field',
    '#theme_wrappers' => array('form_element'),
644
645
646
647
  );
  return $elements;
}

648
649
650
651
652
653
654
655
function _link_default_attributes() {
  return array(
    'target' => LINK_TARGET_DEFAULT,
    'class' => '',
    'rel' => '',
  );
}

656
657
658
659
660
661
/**
 * Process the link type element before displaying the field.
 *
 * Build the form element. When creating a form using FAPI #process,
 * note that $element['#value'] is already set.
 *
662
 * The $fields array is in $complete_form['#field_info'][$element['#field_name']].
663
 */
664
function link_field_process($element, $form_state, $complete_form) {
665
666
  $instance = field_widget_instance($element, $form_state);
  $settings = $instance['settings'];
667
668
669
670
671
672
673
674
675
676
  $element['url'] = array(
    '#type' => 'textfield',
    '#maxlength' => LINK_URL_MAX_LENGTH,
    '#title' => t('URL'),
    '#required' => ($element['#delta'] == 0 && $settings['url'] !== 'optional') ? $element['#required'] : FALSE,
    '#default_value' => isset($element['#value']['url']) ? $element['#value']['url'] : NULL,
  );
  if ($settings['title'] !== 'none' && $settings['title'] !== 'value') {
    $element['title'] = array(
      '#type' => 'textfield',
677
      '#maxlength' => $settings['title_maxlength'],  // patch #1307788 from nmc
678
      '#title' => t('Title'),
679
      '#description' => t('The link title is limited to @maxlength characters maximum.', array('@maxlength' => $settings['title_maxlength'])),
680
      '#required' => ($settings['title'] == 'required' && (($element['#delta'] == 0 && $element['#required']) || !empty($element['#value']['url']))) ? TRUE : FALSE, // davereids patch from jan 2011
681
682
683
684
685
686
687
688
      '#default_value' => isset($element['#value']['title']) ? $element['#value']['title'] : NULL,
    );
  }

  // Initialize field attributes as an array if it is not an array yet.
  if (!is_array($settings['attributes'])) {
    $settings['attributes'] = array();
  }
689
  // Add default attributes.
690
691
692
693
694
695
696
  $settings['attributes'] += _link_default_attributes();
  $attributes = isset($element['#value']['attributes']) ? $element['#value']['attributes'] : $settings['attributes'];
  if (!empty($settings['attributes']['target']) && $settings['attributes']['target'] == LINK_TARGET_USER) {
    $element['attributes']['target'] = array(
      '#type' => 'checkbox',
      '#title' => t('Open URL in a New Window'),
      '#return_value' => LINK_TARGET_NEW_WINDOW,
697
      '#default_value' => isset($attributes['target']) ? $attributes['target'] : FALSE,
698
699
    );
  }
700
701
702
703
704
705
706
707
708
  if (!empty($settings['attributes']['configurable_title']) && $settings['attributes']['configurable_title'] == 1) {
    $element['attributes']['title'] = array(
      '#type' => 'textfield',
      '#title' => t('Link "title" attribute'),
      '#default_value' => isset($attributes['title']) ? $attributes['title'] : '',
      '#field_prefix' => 'title = "',
      '#field_suffix' => '"',
    );
  }
709
710
711
712
713

  // To prevent an extra required indicator, disable the required flag on the
  // base element since all the sub-fields are already required if desired.
  $element['#required'] = FALSE; // davereids patch from jan 2011

714
  return $element;
715
716
}

Nathan Haug's avatar
Nathan Haug committed
717
/**
718
719
720
721
 * Implementation of hook_field_formatter_info().
 */
function link_field_formatter_info() {
  return array(
722
    'link_default' => array(
723
      'label' => t('Title, as link (default)'),
724
725
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
726
    ),
727
728
729
730
731
    'link_title_plain' => array(
      'label' => t('Title, as plain text'),
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
    ),
732
    'link_url' => array(
733
      'label' => t('URL, as link'),
734
735
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
736
    ),
737
    'link_plain' => array(
738
      'label' => t('URL, as plain text'),
739
740
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
741
    ),
742
743
744
745
746
    'link_absolute' => array(
      'label' => t('URL, absolute'),
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
    ),
747
    'link_short' => array(
748
      'label' => t('Short, as link with title "Link"'),
749
750
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
751
    ),
752
    'link_label' => array(
753
      'label' => t('Label, as link with label as title'),
754
755
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
756
    ),
757
    'link_separate' => array(
758
      'label' => t('Separate title and URL'),
759
760
      'field types' => array('link_field'),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
761
    ),
762
763
764
  );
}

765
766
767
/**
 * Implements hook_field_formatter_view().
 */
768
769
770
771
function link_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
  $elements = array();
  foreach ($items as $delta => $item) {
    $elements[$delta] = array(
772
      '#markup' => theme('link_formatter_'. $display['type'], array('element' => $item, 'field' => $instance)),
773
774
775
776
777
    );
  }
  return $elements;
}

778
/**
779
 * Theme function for 'default' text field formatter.
Nathan Haug's avatar
Nathan Haug committed
780
 */
781
function theme_link_formatter_link_default($vars) {
782
783
784
  $link_options = $vars['element'];
  unset($link_options['element']['title']);
  unset($link_options['element']['url']);
785

786
787
788
789
  // Issue #1199806 by ss81: Fixes fatal error when the link URl is equal to page URL
  if (isset($link_options['attributes']['class'])) {
    $link_options['attributes']['class'] = array($link_options['attributes']['class']);
  }
790

791
  // Display a normal link if both title and URL are available.
792
  if (!empty($vars['element']['title']) && !empty($vars['element']['url'])) {
793
    return l($vars['element']['title'], $vars['element']['url'], $link_options);
Nathan Haug's avatar
Nathan Haug committed
794
  }
795
  // If only a title, display the title.
796
797
  elseif (!empty($vars['element']['title'])) {
    return check_plain($vars['element']['title']);
798
  }
799
  elseif (!empty($vars['element']['url'])) {
800
    return l($vars['element']['title'], $vars['element']['url'], $link_options);
801
  }
802
}
803

804
805
806
/**
 * Theme function for 'plain' text field formatter.
 */
807
function theme_link_formatter_link_plain($vars) {
808
809
810
811
812
813
  $link_options = $vars['element'];
  unset($link_options['element']['title']);
  unset($link_options['element']['url']);
  return empty($vars['element']['url']) ?
    check_plain($vars['element']['title']) :
    url($vars['element']['url'], $link_options);
814
815
}

816
817
818
819
820
821
822
823
/**
 * Theme function for 'absolute' text field formatter.
 */
function theme_link_formatter_link_absolute($vars) {
  $absolute = array('absolute' => TRUE);
  return empty($vars['element']['url']) ? '' : url($vars['element']['url'], $absolute + $vars['element']);
}

824
825
826
827
828
829
830
/**
 * Theme function for 'title_plain' text field formatter.
 */
function theme_link_formatter_link_title_plain($vars) {
  return empty($vars['element']['title']) ? '' : check_plain($vars['element']['title']);
}

831
832
833
/**
 * Theme function for 'url' text field formatter.
 */
834
function theme_link_formatter_link_url($vars) {
835
836
837
838
  $link_options = $vars['element'];
  unset($link_options['element']['title']);
  unset($link_options['element']['url']);
  return $vars['element']['url'] ? l($vars['element']['display_url'], $vars['element']['url'], $link_options) : '';
839
}
840

841
842
843
/**
 * Theme function for 'short' text field formatter.
 */
844
function theme_link_formatter_link_short($vars) {
845
846
847
848
  $link_options = $vars['element'];
  unset($link_options['element']['title']);
  unset($link_options['element']['url']);
  return $vars['element']['url'] ? l(t('Link'), $vars['element']['url'], $link_options) : '';
Nathan Haug's avatar
Nathan Haug committed
849
850
}

851
/**
852
 * Theme function for 'label' text field formatter.
853
 */
854
function theme_link_formatter_link_label($vars) {
855
856
857
858
  $link_options = $vars['element'];
  unset($link_options['element']['title']);
  unset($link_options['element']['url']);
  return $vars['element']['url'] ? l($vars['field']['label'], $vars['element']['url'], $link_options) : '';
859
}
860

861
/**
862
 * Theme function for 'separate' text field formatter.
863
 */
864

865
function theme_link_formatter_link_separate($vars) {
866
867
  $class = empty($vars['element']['attributes']['class']) ? '' : ' '. $vars['element']['attributes']['class'];
  unset($vars['element']['attributes']['class']);
868
869
870
  $link_options = $vars['element'];
  unset($link_options['element']['title']);
  unset($link_options['element']['url']);
871
  $title = empty($vars['element']['title']) ? '' : check_plain($vars['element']['title']);
872
873

  /**
874
875
   * @TODO static html markup looks not very elegant
   * needs smarter output solution and an optional title/url seperator
876
   */
877
878
879
880
  $output = '';
  $output .= '<div class="link-item '. $class .'">';
  if (!empty($title)) {
    $output .= '<div class="link-title">'. $title .'</div>';
881
  }
882
  $output .= '<div class="link-url">'. l($vars['element']['url'], $vars['element']['url'], $link_options) .'</div>';
883
884
885
  $output .= '</div>';
  return $output;
}
886

887

888
function link_token_list($type = 'all') {
889
  if ($type === 'field' || $type === 'all') {
890
    $tokens = array();
891

892
893
894
    $tokens['link']['url'] = t("Link URL");
    $tokens['link']['title'] = t("Link title");
    $tokens['link']['view'] = t("Formatted html link");
895

896
897
898
    return $tokens;
  }
}
899

900
function link_token_values($type, $object = NULL) {
901
  if ($type === 'field') {
902
    $item = $object[0];
903

904
905
906
    $tokens['url'] = $item['url'];
    $tokens['title'] = $item['title'];
    $tokens['view'] = isset($item['view']) ? $item['view'] : '';
907

908
    return $tokens;
909
910
911
912
  }
}

/**
913
 * Implements hook_views_api().
914
 */
915
916
917
918
919
function link_views_api() {
  return array(
    'api' => 2,
    'path' => drupal_get_path('module', 'link') .'/views',
  );
920
921
}

922
923
924
925
926
927
928
/**
 * Implements hook_migrate_api().
 */
function link_migrate_api() {
  return array('api' => 2);
}

929
930
931
932
/**
 * Forms a valid URL if possible from an entered address.
 * Trims whitespace and automatically adds an http:// to addresses without a protocol specified
 *
933
934
 * @param string $url
 * @param string $protocol The protocol to be prepended to the url if one is not specified
935
 */
936
function link_cleanup_url($url, $protocol = "http") {
937
  $url = trim($url);