-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlink.module
1797 lines (1667 loc) · 62.4 KB
/
link.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @file
* Defines simple link field types.
*/
define('LINK_EXTERNAL', 'external');
define('LINK_INTERNAL', 'internal');
define('LINK_FRONT', 'front');
define('LINK_EMAIL', 'email');
define('LINK_NEWS', 'news');
define('LINK_FILE', 'file');
define('LINK_TARGET_DEFAULT', 'default');
define('LINK_TARGET_NEW_WINDOW', '_blank');
define('LINK_TARGET_TOP', '_top');
define('LINK_TARGET_USER', 'user');
/**
* Maximum URLs length - needs to match value in link.install.
*/
define('LINK_URL_MAX_LENGTH', 2048);
/**
* Implements hook_help().
*/
function link_help($path, $arg) {
switch ($path) {
case 'admin/help#link':
$output = '<p><strong>' . t('About') . '</strong></p>';
$output .= '<p>' . t('The link provides a standard custom content field for links. Links can be easily added to any content types and profiles and include advanced validating and different ways of storing internal or external links and URLs. It also supports additional link text title, site wide tokens for titles and title attributes, target attributes, css class attribution, static repeating values, input conversion, and many more.') . '</p>';
$output .= '<p><strong>' . t('Requirements / Dependencies') . '</strong></p>';
$output .= '<p>' . 'Fields API is provided already by core [no dependencies].' . '</p>';
$output .= '<p><strong>Configuration</strong></p>';
$output .= '<p>' . 'Configuration is only slightly more complicated than a text field. Link text titles for URLs can be made required, set as instead of URL, optional (default), or left out entirely. If no link text title is provided, the trimmed version of the complete URL will be displayed. The target attribute should be set to "_blank", "top", or left out completely (checkboxes provide info). The rel=nofollow attribute prevents the link from being followed by certain search engines.' . '</p>';
return $output;
}
}
/**
* Implements hook_field_info().
*/
function link_field_info() {
return array(
'link_field' => array(
'label' => t('Link'),
'description' => t('Store a title, href, and attributes in the database to assemble a link.'),
'settings' => array(
'attributes' => _link_default_attributes(),
'url' => 0,
'title' => 'optional',
'title_value' => '',
'title_maxlength' => 128,
'enable_tokens' => 1,
'display' => array(
'url_cutoff' => 80,
),
),
'instance_settings' => array(
'attributes' => _link_default_attributes(),
'url' => 0,
'title' => 'optional',
'title_value' => '',
'title_label_use_field_label' => FALSE,
'title_maxlength' => 128,
'enable_tokens' => 1,
'display' => array(
'url_cutoff' => 80,
),
'validate_url' => 1,
'absolute_url' => 1,
),
'default_widget' => 'link_field',
'default_formatter' => 'link_default',
// Support hook_entity_property_info() from contrib "Entity API".
'property_type' => 'field_item_link',
'property_callbacks' => array('link_field_property_info_callback'),
),
);
}
/**
* Implements hook_field_instance_settings_form().
*/
function link_field_instance_settings_form($field, $instance) {
$form = array(
'#element_validate' => array('link_field_settings_form_validate'),
);
$form['absolute_url'] = array(
'#type' => 'checkbox',
'#title' => t('Absolute URL'),
'#default_value' => isset($instance['settings']['absolute_url']) && ($instance['settings']['absolute_url'] !== '') ? $instance['settings']['absolute_url'] : TRUE,
'#description' => t('If checked, the URL will always render as an absolute URL.'),
);
$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.'),
);
$form['url'] = array(
'#type' => 'checkbox',
'#title' => t('Optional URL'),
'#default_value' => isset($instance['settings']['url']) ? $instance['settings']['url'] : '',
'#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.'),
);
$title_options = array(
'optional' => t('Optional Title'),
'required' => t('Required Title'),
'value' => t('Static Title'),
'select' => t('Selected Title'),
'none' => t('No Title'),
);
$form['title'] = array(
'#type' => 'radios',
'#title' => t('Link Title'),
'#default_value' => isset($instance['settings']['title']) ? $instance['settings']['title'] : 'optional',
'#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 entity 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.'),
);
$form['title_value'] = array(
'#type' => 'textfield',
'#title' => t('Static or default title'),
'#default_value' => isset($instance['settings']['title_value']) ? $instance['settings']['title_value'] : '',
'#description' => t('This title will 1) always be used if "Static Title" is selected above, or 2) used if "Optional title" is selected above and no title is entered when creating content.'),
'#states' => array(
'visible' => array(
':input[name="instance[settings][title]"]' => array('value' => 'value'),
),
),
);
$form['title_allowed_values'] = array(
'#type' => 'textarea',
'#title' => t('Title allowed values'),
'#default_value' => isset($instance['settings']['title_allowed_values']) ? $instance['settings']['title_allowed_values'] : '',
'#description' => t('When using "Selected Title", you can allow users to select the title from a limited set of values (eg. Home, Office, Other). Enter here all possible values that title can take, one value per line.'),
'#states' => array(
'visible' => array(
':input[name="instance[settings][title]"]' => array('value' => 'select'),
),
),
);
$form['title_label_use_field_label'] = array(
'#type' => 'checkbox',
'#title' => t('Use field label as the label for the title field'),
'#default_value' => isset($instance['settings']['title_label_use_field_label']) ? $instance['settings']['title_label_use_field_label'] : FALSE,
'#description' => t('If this is checked the field label will be hidden.'),
);
$form['title_maxlength'] = array(
'#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,
);
if (module_exists('token')) {
// Add token module replacements fields.
$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 entity edit form. This does not affect the field settings on this page.'),
);
$entity_info = entity_get_info($instance['entity_type']);
$form['tokens_help'] = array(
'#theme' => 'token_tree',
'#token_types' => array($entity_info['token type']),
'#global_types' => TRUE,
'#click_insert' => TRUE,
'#dialog' => TRUE,
);
}
$form['display'] = array(
'#tree' => TRUE,
);
$form['display']['url_cutoff'] = array(
'#type' => 'textfield',
'#title' => t('URL Display Cutoff'),
'#default_value' => isset($instance['settings']['display']['url_cutoff']) ? $instance['settings']['display']['url_cutoff'] : '80',
'#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 (…)? Leave blank for no limit.'),
'#maxlength' => 3,
'#size' => 3,
);
// Target options. E.g. New window = target="_blank".
$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'),
'#default_value' => empty($instance['settings']['attributes']['target']) ? LINK_TARGET_DEFAULT : $instance['settings']['attributes']['target'],
'#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" target="blank">rel="nofollow"</a> which prevents some search engines from spidering entered links.'),
'#default_value' => empty($instance['settings']['attributes']['rel']) ? '' : $instance['settings']['attributes']['rel'],
'#field_prefix' => 'rel = "',
'#field_suffix' => '"',
'#size' => 20,
);
$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 automatically'),
'#default_value' => !isset($instance['settings']['rel_remove']) ? 'default' : $instance['settings']['rel_remove'],
'#description' => t('Turn on/off if rel attribute should be removed automatically, if user given link is internal/external'),
'#options' => $rel_remove_options,
);
$form['attributes']['configurable_class'] = array(
'#title' => t("Allow the user to enter a custom link class per link"),
'#type' => 'checkbox',
'#default_value' => empty($instance['settings']['attributes']['configurable_class']) ? '' : $instance['settings']['attributes']['configurable_class'],
);
$form['attributes']['class'] = array(
'#type' => 'textfield',
'#title' => t('Additional CSS Class'),
'#description' => t('When output, this link will have this class attribute. Multiple classes should be separated by spaces. Only alphanumeric characters and hyphens are allowed'),
'#default_value' => empty($instance['settings']['attributes']['class']) ? '' : $instance['settings']['attributes']['class'],
);
$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" target="blank">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,
);
return $form;
}
/**
* Form validate.
*
* #element_validate handler for link_field_instance_settings_form().
*/
function link_field_settings_form_validate($element, &$form_state, $complete_form) {
if ($form_state['values']['instance']['settings']['title'] === 'value' && empty($form_state['values']['instance']['settings']['title_value'])) {
form_set_error('instance][settings][title_value', t('A default title must be provided if the title is a static value.'));
}
if ($form_state['values']['instance']['settings']['title'] === 'select'
&& empty($form_state['values']['instance']['settings']['title_allowed_values'])) {
form_set_error('instance][settings][title_allowed_values', t('You must enter one or more allowed values for link Title, the title is a selected value.'));
}
if (!empty($form_state['values']['instance']['settings']['display']['url_cutoff']) && !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'])) {
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.'));
}
}
/**
* Implements hook_field_is_empty().
*/
function link_field_is_empty($item, $field) {
return empty($item['title']) && empty($item['url']);
}
/**
* Implements hook_field_load().
*/
function link_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {
foreach ($entities as $id => $entity) {
foreach ($items[$id] as $delta => $item) {
$items[$id][$delta]['attributes'] = _link_load($field, $item, $instances[$id]);
}
}
}
/**
* Implements hook_field_validate().
*/
function link_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
$optional_field_found = FALSE;
if ($instance['settings']['validate_url'] !== 0 || is_null($instance['settings']['validate_url']) || !isset($instance['settings']['validate_url'])) {
foreach ($items as $delta => $value) {
_link_validate($items[$delta], $delta, $field, $entity, $instance, $langcode, $optional_field_found, $errors);
}
}
if ($instance['settings']['url'] === 'optional' && $instance['settings']['title'] === 'optional' && $instance['required'] && !$optional_field_found) {
$errors[$field['field_name']][$langcode][0][] = array(
'error' => 'link_required',
'message' => t('At least one title or URL must be entered.'),
'error_element' => array('url' => FALSE, 'title' => TRUE),
);
}
}
/**
* Implements hook_field_insert().
*/
function link_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {
foreach ($items as $delta => $value) {
_link_process($items[$delta], $delta, $field, $entity, $instance);
}
}
/**
* Implements hook_field_update().
*/
function link_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {
foreach ($items as $delta => $value) {
_link_process($items[$delta], $delta, $field, $entity, $instance);
}
}
/**
* Implements hook_field_prepare_view().
*/
function link_field_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items) {
foreach ($items as $entity_id => $entity_items) {
$settings = $instances[$entity_id]['settings'];
$trimTitle = trim($settings['title_value']);
if (empty($entity_items) && !empty($trimTitle) && $settings['title'] == 'value') {
$token_value = token_replace($settings['title_value'], array($entity_type => $entities[$entity_id]));
$display_title = htmlspecialchars_decode($token_value, ENT_QUOTES);
$items[$entity_id][0]['url'] = NULL;
$items[$entity_id][0]['title'] = $display_title;
$items[$entity_id][0]['attributes'] = array();
}
else {
foreach ($entity_items as $delta => $value) {
_link_sanitize($items[$entity_id][$delta], $delta, $field, $instances[$entity_id], $entities[$entity_id]);
}
}
}
}
/**
* Implements hook_field_widget_info().
*/
function link_field_widget_info() {
return array(
'link_field' => array(
'label' => 'Link',
'field types' => array('link_field'),
'multiple values' => FIELD_BEHAVIOR_DEFAULT,
),
);
}
/**
* Implements hook_field_widget_form().
*/
function link_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
$element += array(
'#type' => $instance['widget']['type'],
'#default_value' => isset($items[$delta]) ? $items[$delta] : '',
);
return $element;
}
/**
* Implements hook_field_widget_error().
*/
function link_field_widget_error($element, $error, $form, &$form_state) {
if (!empty($error['error_element']['title'])) {
form_error($element['title'], $error['message']);
}
elseif (!empty($error['error_element']['url'])) {
form_error($element['url'], $error['message']);
}
}
/**
* Unpacks the item attributes for use.
*/
function _link_load($field, $item, $instance) {
if (isset($item['attributes'])) {
if (!is_array($item['attributes'])) {
$item['attributes'] = unserialize($item['attributes']);
}
return $item['attributes'];
}
elseif (isset($instance['settings']['attributes'])) {
return $instance['settings']['attributes'];
}
else {
return $field['settings']['attributes'];
}
}
/**
* Prepares the item attributes and url for storage.
*
* @param array $item
* Link field values.
* @param array $delta
* The sequence number for current values.
* @param array $field
* The field structure array.
* @param object $entity
* Entity object.
* @param array $instance
* The instance structure for $field on $entity's bundle.
*
* @codingStandardsIgnoreStart
*/
function _link_process(&$item, $delta, $field, $entity, $instance) {
// @codingStandardsIgnoreEnd
// Trim whitespace from URL.
if (!empty($item['url'])) {
$item['url'] = trim($item['url']);
}
// If no attributes are set then make sure $item['attributes'] is an empty
// array, so $field['attributes'] can override it.
if (empty($item['attributes'])) {
$item['attributes'] = array();
}
// Serialize the attributes array.
if (!is_string($item['attributes'])) {
$item['attributes'] = serialize($item['attributes']);
}
// Don't save an invalid default value (e.g. 'http://').
if ((isset($field['widget']['default_value'][$delta]['url']) && $item['url'] == $field['widget']['default_value'][$delta]['url']) && is_object($entity)) {
$langcode = !empty($entity) ? field_language($instance['entity_type'], $entity, $instance['field_name']) : LANGUAGE_NONE;
if (!link_validate_url($item['url'], $langcode)) {
unset($item['url']);
}
}
}
/**
* Validates that the link field has been entered properly.
*/
function _link_validate(&$item, $delta, $field, $entity, $instance, $langcode, &$optional_field_found, &$errors) {
if ($item['url'] && !(isset($instance['default_value'][$delta]['url']) && $item['url'] === $instance['default_value'][$delta]['url'] && !$instance['required'])) {
// Validate the link.
if (!link_validate_url(trim($item['url']), $langcode)) {
$errors[$field['field_name']][$langcode][$delta][] = array(
'error' => 'link_required',
'message' => t('The value %value provided for %field is not a valid URL.', array(
'%value' => trim($item['url']),
'%field' => $instance['label'],
)),
'error_element' => array('url' => TRUE, 'title' => FALSE),
);
}
// Require a title for the link if necessary.
if ($instance['settings']['title'] == 'required' && strlen(trim($item['title'])) == 0) {
$errors[$field['field_name']][$langcode][$delta][] = array(
'error' => 'link_required',
'message' => t('Titles are required for all links.'),
'error_element' => array('url' => FALSE, 'title' => TRUE),
);
}
}
// Require a link if we have a title.
if ($instance['settings']['url'] !== 'optional' && strlen(isset($item['title']) ? $item['title'] : NULL) > 0 && strlen(trim($item['url'])) == 0) {
$errors[$field['field_name']][$langcode][$delta][] = array(
'error' => 'link_required',
'message' => t('You cannot enter a title without a link url.'),
'error_element' => array('url' => TRUE, 'title' => FALSE),
);
}
// In a totally bizzaro case, where URLs and titles are optional but the field
// is required, ensure there is at least one link.
if ($instance['settings']['url'] === 'optional' && $instance['settings']['title'] === 'optional'
&& (strlen(trim($item['url'])) !== 0 || strlen(trim($item['title'])) !== 0)) {
$optional_field_found = TRUE;
}
// Require entire field.
if ($instance['settings']['url'] === 'optional' && $instance['settings']['title'] === 'optional' && $instance['required'] == 1 && !$optional_field_found && isset($instance['id'])) {
$errors[$field['field_name']][$langcode][$delta][] = array(
'error' => 'link_required',
'message' => t('At least one title or URL must be entered.'),
'error_element' => array('url' => FALSE, 'title' => TRUE),
);
}
}
/**
* Clean up user-entered values for a link field according to field settings.
*
* @param array $item
* A single link item, usually containing url, title, and attributes.
* @param int $delta
* The delta value if this field is one of multiple fields.
* @param array $field
* The CCK field definition.
* @param object $entity
* The entity containing this link.
*
* @codingStandardsIgnoreStart
*/
function _link_sanitize(&$item, $delta, &$field, $instance, &$entity) {
// @codingStandardsIgnoreEnd
// As this function can be called multiple times and the item is changed by
// reference we need to ensure that there's always the original data to
// process otherwise processed data are processed again which might leads to
// unexpected results.
if (isset($item['_link_sanitized'])) {
return;
}
// Store a flag to check in case of a second call.
$item['_link_sanitized'] = TRUE;
// Don't try to process empty links.
if (empty($item['url']) && empty($item['title'])) {
return;
}
if (empty($item['html'])) {
$item['html'] = FALSE;
}
// Replace URL tokens.
$entity_type = $instance['entity_type'];
$entity_info = entity_get_info($entity_type);
$property_id = $entity_info['entity keys']['id'];
$entity_token_type = isset($entity_info['token type']) ? $entity_info['token type'] : (
$entity_type == 'taxonomy_term' || $entity_type == 'taxonomy_vocabulary' ? str_replace('taxonomy_', '', $entity_type) : $entity_type
);
if (isset($instance['settings']['enable_tokens']) && $instance['settings']['enable_tokens']) {
$text_tokens = token_scan($item['url']);
if (!empty($text_tokens)) {
// Load the entity if necessary for entities in views.
if (isset($entity->{$property_id})) {
$entity_loaded = entity_load($entity_type, array($entity->{$property_id}));
$entity_loaded = array_pop($entity_loaded);
}
else {
$entity_loaded = $entity;
}
$item['url'] = token_replace($item['url'], array($entity_token_type => $entity_loaded));
}
}
$type = link_url_type($item['url']);
// If the type of the URL cannot be determined and URL validation is disabled,
// then assume LINK_EXTERNAL for later processing.
if ($type == FALSE && $instance['settings']['validate_url'] === 0) {
$type = LINK_EXTERNAL;
}
$url = link_cleanup_url($item['url']);
$url_parts = _link_parse_url($url);
if (!empty($url_parts['url'])) {
$item = array(
'url' => $url_parts['url'],
'query' => isset($url_parts['query']) ? $url_parts['query'] : NULL,
'fragment' => isset($url_parts['fragment']) ? $url_parts['fragment'] : NULL,
'absolute' => !empty($instance['settings']['absolute_url']),
'html' => TRUE,
) + $item;
}
// Create a shortened URL for display.
if ($type == LINK_EMAIL) {
$display_url = str_replace('mailto:', '', $url);
}
else {
$display_url = url($url_parts['url'],
array(
'query' => isset($url_parts['query']) ? $url_parts['query'] : NULL,
'fragment' => isset($url_parts['fragment']) ? $url_parts['fragment'] : NULL,
'absolute' => !empty($instance['settings']['absolute_url']),
)
);
}
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']) . "…";
}
$item['display_url'] = $display_url;
// Use the title defined at the instance level.
if ($instance['settings']['title'] == 'value' && strlen(trim($instance['settings']['title_value']))) {
$title = $instance['settings']['title_value'];
if (function_exists('i18n_string_translate')) {
$i18n_string_name = "field:{$instance['field_name']}:{$instance['bundle']}:title_value";
$title = i18n_string_translate($i18n_string_name, $title);
}
}
// Use the title defined by the user at the widget level.
elseif (isset($item['title']) && drupal_strlen(trim($item['title']))) {
$title = $item['title'];
}
// Use the static title if a user-defined title is optional and a static title
// has been defined.
elseif ($instance['settings']['title'] == 'optional' && drupal_strlen(trim($instance['settings']['title_value']))) {
$title = $instance['settings']['title_value'];
}
else {
$title = '';
}
// Replace title tokens.
if ($title && $instance['settings']['enable_tokens']) {
$text_tokens = token_scan($title);
if (!empty($text_tokens)) {
// Load the entity if necessary for entities in views.
if (isset($entity->{$property_id})) {
$entity_loaded = entity_load($entity_type, array($entity->{$property_id}));
$entity_loaded = array_pop($entity_loaded);
}
else {
$entity_loaded = $entity;
}
$title = token_replace($title, array($entity_token_type => $entity_loaded));
}
}
if ($title && ($instance['settings']['title'] == 'value' || $instance['settings']['enable_tokens'])) {
$title = filter_xss($title, array(
'b',
'br',
'code',
'em',
'i',
'img',
'span',
'strong',
'sub',
'sup',
'tt',
'u',
));
$item['html'] = TRUE;
}
$item['title'] = empty($title) && $title !== '0' ? $item['display_url'] : $title;
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.
if (!is_array($instance['settings']['attributes'])) {
$instance['settings']['attributes'] = _link_default_attributes();
}
else {
$instance['settings']['attributes'] += _link_default_attributes();
}
// Merge item attributes with attributes defined at the field level.
$item['attributes'] += $instance['settings']['attributes'];
// If user is not allowed to choose target attribute, use default defined at
// field level.
if ($instance['settings']['attributes']['target'] != LINK_TARGET_USER) {
$item['attributes']['target'] = $instance['settings']['attributes']['target'];
}
elseif ($item['attributes']['target'] == LINK_TARGET_USER) {
$item['attributes']['target'] = LINK_TARGET_DEFAULT;
}
// Remove the target attribute if the default (no target) is selected.
if (empty($item['attributes']) || (isset($item['attributes']['target']) && $item['attributes']['target'] == LINK_TARGET_DEFAULT)) {
unset($item['attributes']['target']);
}
// 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']);
}
}
// Handle "title" link attribute.
if (!empty($item['attributes']['title']) && module_exists('token')) {
$text_tokens = token_scan($item['attributes']['title']);
if (!empty($text_tokens)) {
// Load the entity (necessary for entities in views).
if (isset($entity->{$property_id})) {
$entity_loaded = entity_load($entity_type, array($entity->{$property_id}));
$entity_loaded = array_pop($entity_loaded);
}
else {
$entity_loaded = $entity;
}
$item['attributes']['title'] = token_replace($item['attributes']['title'], array($entity_token_type => $entity_loaded), array('clear' => TRUE));
}
$item['attributes']['title'] = filter_xss($item['attributes']['title'], array(
'b',
'br',
'code',
'em',
'i',
'img',
'span',
'strong',
'sub',
'sup',
'tt',
'u',
));
}
// Handle attribute classes.
if (!empty($item['attributes']['class'])) {
$classes = explode(' ', $item['attributes']['class']);
foreach ($classes as &$class) {
$class = drupal_clean_css_identifier($class);
}
$item['attributes']['class'] = implode(' ', $classes);
}
unset($item['attributes']['configurable_class']);
// Remove title attribute if it's equal to link text.
if (isset($item['attributes']['title']) && $item['attributes']['title'] == $item['title']) {
unset($item['attributes']['title']);
}
unset($item['attributes']['configurable_title']);
// Remove empty attributes.
$item['attributes'] = array_filter($item['attributes']);
}
/**
* Because parse_url doesn't work with relative urls.
*
* @param string $url
* URL to parse.
*
* @return array
* Array of url pieces - only 'url', 'query', and 'fragment'.
*/
function _link_parse_url($url) {
$url_parts = array();
// Separate out the anchor, if any.
if (strpos($url, '#') !== FALSE) {
$url_parts['fragment'] = substr($url, strpos($url, '#') + 1);
$url = substr($url, 0, strpos($url, '#'));
}
// Separate out the query string, if any.
if (strpos($url, '?') !== FALSE) {
$query = substr($url, strpos($url, '?') + 1);
$url_parts['query'] = _link_parse_str($query);
$url = substr($url, 0, strpos($url, '?'));
}
$url_parts['url'] = $url;
return $url_parts;
}
/**
* Replaces the PHP parse_str() function.
*
* Because parse_str replaces the following characters in query parameters name
* in order to maintain compatibility with deprecated register_globals
* directive:
*
* - chr(32) ( ) (space)
* - chr(46) (.) (dot)
* - chr(91) ([) (open square bracket)
* - chr(128) - chr(159) (various)
*
* @param string $query
* Query to parse.
*
* @return array
* Array of query parameters.
*
* @see http://php.net/manual/en/language.variables.external.php#81080
*/
function _link_parse_str($query) {
$query_array = array();
$pairs = explode('&', $query);
foreach ($pairs as $pair) {
$name_value = explode('=', $pair, 2);
$name = urldecode($name_value[0]);
$value = isset($name_value[1]) ? urldecode($name_value[1]) : NULL;
$query_array[$name] = $value;
}
return $query_array;
}
/**
* Implements hook_theme().
*/
function link_theme() {
return array(
'link_formatter_link_default' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_plain' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_host' => array(
'variables' => array('element' => NULL),
),
'link_formatter_link_absolute' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_domain' => array(
'variables' => array(
'element' => NULL,
'display' => NULL,
'field' => NULL,
),
),
'link_formatter_link_no_protocol' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_title_plain' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_url' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_short' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_label' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_formatter_link_separate' => array(
'variables' => array('element' => NULL, 'field' => NULL),
),
'link_field' => array(
'render element' => 'element',
),
);
}
/**
* Formats a link field widget.
*/
function theme_link_field($vars) {
drupal_add_css(drupal_get_path('module', 'link') . '/css/link.css');
$element = $vars['element'];
// Prefix single value link fields with the name of the field.
if (empty($element['#field']['multiple'])) {
if (isset($element['url']) && !isset($element['title'])) {
$element['url']['#title_display'] = 'invisible';
}
}
$output = '';
$output .= '<div class="link-field-subrow clearfix">';
if (isset($element['title'])) {
$output .= '<div class="link-field-title link-field-column">' . drupal_render($element['title']) . '</div>';
}
$output .= '<div class="link-field-url' . (isset($element['title']) ? ' link-field-column' : '') . '">' . drupal_render($element['url']) . '</div>';
$output .= '</div>';
if (!empty($element['attributes']['target'])) {
$output .= '<div class="link-attributes">' . drupal_render($element['attributes']['target']) . '</div>';
}
if (!empty($element['attributes']['title'])) {
$output .= '<div class="link-attributes">' . drupal_render($element['attributes']['title']) . '</div>';
}
if (!empty($element['attributes']['class'])) {
$output .= '<div class="link-attributes">' . drupal_render($element['attributes']['class']) . '</div>';
}
$output .= drupal_render_children($element);
return $output;
}
/**
* Implements hook_element_info().
*/
function link_element_info() {
$elements = array();
$elements['link_field'] = array(
'#input' => TRUE,
'#process' => array('link_field_process'),
'#theme' => 'link_field',
'#theme_wrappers' => array('form_element'),
);
return $elements;
}
/**
* Returns the default attributes and their values.
*/
function _link_default_attributes() {
return array(
'target' => LINK_TARGET_DEFAULT,
'class' => '',
'rel' => '',
);
}
/**
* Processes 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.
*
* The $fields array is in
* $complete_form['#field_info'][$element['#field_name']].
*/
function link_field_process($element, $form_state, $complete_form) {
$instance = field_widget_instance($element, $form_state);
$settings = $instance['settings'];
$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 (in_array($settings['title'], array('optional', 'required'))) {
// Figure out the label of the title field.
if (!empty($settings['title_label_use_field_label'])) {
// Use the element label as the title field label.
$title_label = $element['#title'];
// Hide the field label because there is no need for the duplicate labels.
$element['#title_display'] = 'invisible';
}
else {
$title_label = t('Title');
}
// Default value.
$title_maxlength = 128;
if (!empty($settings['title_maxlength'])) {
$title_maxlength = $settings['title_maxlength'];
}
$element['title'] = array(
'#type' => 'textfield',
'#maxlength' => $title_maxlength,
'#title' => $title_label,
'#description' => t('The link title is limited to @maxlength characters maximum.', array('@maxlength' => $title_maxlength)),
'#required' => ($settings['title'] == 'required' && (($element['#delta'] == 0 && $element['#required']) || !empty($element['#value']['url']))) ? TRUE : FALSE,
'#default_value' => isset($element['#value']['title']) ? $element['#value']['title'] : NULL,
);
}
elseif ($settings['title'] == 'select') {
$options = drupal_map_assoc(array_filter(explode("\n", str_replace("\r", "\n", trim($settings['title_allowed_values'])))));
$element['title'] = array(
'#type' => 'select',
'#title' => t('Title'),
'#description' => t('Select the a title for this link.'),
'#default_value' => isset($element['#value']['title']) ? $element['#value']['title'] : NULL,
'#options' => $options,
);
}
// Initialize field attributes as an array if it is not an array yet.
if (!is_array($settings['attributes'])) {
$settings['attributes'] = array();
}
// Add default attributes.
$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,
'#default_value' => isset($attributes['target']) ? $attributes['target'] : FALSE,
);
}
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 = "',