From f01ecaae11653e9f1ec5b87449eac32a71e8b665 Mon Sep 17 00:00:00 2001
From: Paul Dale Smith <p.smith@ctidigital.com>
Date: Wed, 7 Oct 2015 10:14:39 +0100
Subject: [PATCH] Added fields to duplicates output.

---
 term_merge.pages.inc | 126 ++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 109 insertions(+), 17 deletions(-)

diff --git a/term_merge.pages.inc b/term_merge.pages.inc
index ec1d6f2..be2082f 100644
--- a/term_merge.pages.inc
+++ b/term_merge.pages.inc
@@ -466,34 +466,50 @@ function term_merge_duplicates_form($form, &$form_state, $vocabulary = NULL, $pa
     '#markup' => '<p>' . t('Here you can merge terms with the same names. It is a useful tool against term-duplicates. If this tool is invoked on a term (not on the entire vocabulary), duplicate terms will be sought only among children of that term. The terms are grouped by names. Term into which the merging will occur is selected manually by user, however you must know that it is impossible to merge a parent term into any of its children.') . '</p>',
   );
 
-  $form['scaling'] = array(
+  $form['settings'] = array(
     '#type' => 'fieldset',
-    '#title' => t('Scaling for large vocabularies'),
-    '#description' => t('Adjust these settings if your vocabulary is very large.'),
+    '#title' => t('Advanced settings'),
+    '#description' => t('Fine tune the duplicate search tool. You can adjust these settings if your vocabulary is very large. Also, you can control within these settings how the potential duplicates are presented below.'),
     '#tree' => TRUE,
     '#collapsible' => TRUE,
   );
 
-  $form['scaling']['help'] = array(
+  $form['settings']['help'] = array(
     '#markup' => '<p>' . format_plural(count($tree), 'Vocabulary %vocabulary has only 1 term. It is very unlikely you will merge anything here.', 'Vocabulary %vocabulary has @count terms. If this tool works slow, you may instruct the duplicate finder tool to terminate its work after it has found a specific number of possible duplicates.', array(
       '%vocabulary' => $vocabulary->name,
     )) . '</p>',
   );
 
-  $form['scaling']['max_duplicates'] = array(
+  $form['settings']['max_duplicates'] = array(
     '#type' => 'textfield',
     '#title' => t('Show N duplicates'),
     '#description' => t('Input an integer here - this many duplicates will be show on the form. Once this amount of possible duplicates is found, the search process terminates.'),
     '#required' => TRUE,
-    '#default_value' => isset($form_state['values']['scaling']['max_duplicates']) ? $form_state['values']['scaling']['max_duplicates'] : 300,
+    '#default_value' => isset($form_state['values']['settings']['max_duplicates']) ? $form_state['values']['settings']['max_duplicates'] : 300,
     '#element_validate' => array('element_validate_integer_positive'),
   );
 
-  $form['scaling']['update'] = array(
+  $options = array();
+  $bundle = field_extract_bundle('taxonomy_term', $vocabulary);
+  foreach (field_info_instances('taxonomy_term', $bundle) as $instance) {
+    $options[$instance['field_name']] = $instance['label'];
+  }
+
+  if (!empty($options)) {
+    $form['settings']['fields'] = array(
+      '#type' => 'checkboxes',
+      '#title' => t('Display fields'),
+      '#description' => t('Check which fields you wish to display in the results below for each possible duplicate term.'),
+      '#options' => $options,
+      '#default_value' => isset($form_state['values']['settings']['fields']) ? array_values(array_filter($form_state['values']['settings']['fields'])) : array(),
+    );
+  }
+
+  $form['settings']['update'] = array(
     '#type' => 'button',
     '#value' => t('Re-run duplicate search'),
     '#ajax' => array(
-      'callback' => 'term_merge_duplicates_form_scaling',
+      'callback' => 'term_merge_duplicates_form_settings',
       'wrapper' => 'term-merge-duplicate-wrapper',
       'method' => 'replace',
       'effect' => 'fade',
@@ -508,7 +524,7 @@ function term_merge_duplicates_form($form, &$form_state, $vocabulary = NULL, $pa
   $groups = array();
 
   foreach ($tree as $term) {
-    if ($count >= $form['scaling']['max_duplicates']['#default_value']) {
+    if ($count >= $form['settings']['max_duplicates']['#default_value']) {
       // We have reached the limit of possible duplicates to be found.
       break;
     }
@@ -548,6 +564,21 @@ function term_merge_duplicates_form($form, &$form_state, $vocabulary = NULL, $pa
     '#tree' => TRUE,
   );
 
+  $groups = array_filter($groups, 'term_merge_duplicates_form_filter');
+
+  if (!empty($form['settings']['fields']['#default_value'])) {
+    // We need to load full term entities, because we are requested to show
+    // fields.
+    $tids = array();
+    foreach ($groups as $group) {
+      $tids = array_merge($tids, array_keys($group));
+    }
+    $tids = taxonomy_term_load_multiple($tids);
+    foreach ($groups as $i => $group) {
+      $groups[$i] = array_intersect_key($tids, $group);
+    }
+  }
+
   foreach ($groups as $i => $group) {
     if (count($group) > 1) {
       // Sorting terms by tid for better usage experience.
@@ -578,6 +609,19 @@ function term_merge_duplicates_form($form, &$form_state, $vocabulary = NULL, $pa
           'description' => check_markup($term->description, $term->format),
           'parents' => implode(' &raquo; ', $parents),
         );
+
+        if (array_key_exists('fields', $form['settings'])) {
+          $wrapper = entity_metadata_wrapper('taxonomy_term', $term);
+          foreach ($form['settings']['fields']['#default_value'] as $instance) {
+            $value = $wrapper->{$instance}->raw(array('sanitize' => TRUE));
+            $options[$term->tid][$instance] = term_merge_duplicates_field_value_process($value);
+            if (is_array($options[$term->tid][$instance])) {
+              $options[$term->tid][$instance] = theme('item_list', array(
+                'items' => array_map('filter_xss', $options[$term->tid][$instance]),
+              ));
+            }
+          }
+        }
       }
 
       $form['wrapper']['group'][$i] = array(
@@ -588,16 +632,22 @@ function term_merge_duplicates_form($form, &$form_state, $vocabulary = NULL, $pa
         '#element_validate' => array('term_merge_duplicates_fieldset_validate'),
       );
 
+      $header = array(
+        'id' => t('ID'),
+        'title' => t('Title'),
+        'description' => t('Description'),
+        'language' => t('Language'),
+        'parents' => t('Parents'),
+      );
+
+      if (array_key_exists('fields', $form['settings'])) {
+        $header += array_intersect_key($form['settings']['fields']['#options'], drupal_map_assoc($form['settings']['fields']['#default_value']));
+      }
+
       $form['wrapper']['group'][$i]['duplicates'] = array(
         '#type' => 'tableselect',
         '#title' => 'Duplicates',
-        '#header' => array(
-          'id' => t('ID'),
-          'title' => t('Title'),
-          'description' => t('Description'),
-          'language' => t('Language'),
-          'parents' => t('Parents'),
-        ),
+        '#header' => $header,
         '#options' => $options,
       );
 
@@ -759,6 +809,48 @@ function term_merge_duplicates_fieldset_validate($element, &$form_state, $form)
  * Used in term_merge_duplicates_form() to replace the duplicates tables with
  * new data per current scaling settings.
  */
-function term_merge_duplicates_form_scaling($form, &$form_state) {
+function term_merge_duplicates_form_settings($form, &$form_state) {
   return $form['wrapper'];
 }
+
+/**
+ * Supportive array_filter() callback function.
+ *
+ * Eliminate all array elements, whose dimension is less than 1.
+ */
+function term_merge_duplicates_form_filter($array_element) {
+  return count($array_element) > 1;
+}
+
+/**
+ * Proccess a value return from an entity metadata wrapper into a string.
+ *
+ * @param mixed $value
+ *   The result of $wrapper->{field}->raw();
+ *
+ * @return string
+ *   A reformated string, or the $value param if already a string.
+ */
+function term_merge_duplicates_field_value_process($value) {
+  if (is_array($value)) {
+    if (array_key_exists('filename', $value)) {
+      $image_array = array(
+        'uri' => NULL,
+        'width' => NULL,
+        'height' => NULL,
+        'alt' => NULL,
+        'title' => NULL,
+      );
+
+      $image = array_intersect_key($value, $image_array);
+
+      if ($image['uri']) {
+        $image['path'] = $image['uri'];
+        $image['style_name'] = 'thumbnail';
+        $value = theme_image_style($image);
+      }
+    }
+  }
+
+  return $value;
+}
-- 
2.3.8 (Apple Git-58)

