Fix for issue #2721 append to a field (#3395)

* Add append button (no functionality) to the user interface under Quality -> set/clear/rename fields

* Add functionality to append button under Quality -> Set/clear/append/rename fields

* Update Localization for set/clear/append/rename fields dialog

* Update CHANGELOG.md

* Rename variables (ce -> compoundEdit, oldVal -> oldValue, text -> textToAppend / Set etc.) for review and rename some variables from old code to match.

* Prevent re-assignment of parameter in massAppend method

* Rename TextField variables for clarity

* Revert localisation for set/clear/appen/rename_fields to original from set/clear/rename_fields

Author: ethanwharris

CHANGELOG.md

@@ -30,6 +30,7 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 - Late initialization of the context menus in the entry editor. This improves performance and memory footprint further [#3340](https://github.com/JabRef/jabref/pull/3340)
 - Integrity check "Abbreviation Detection" detects abbreviated names for journals and booktitles based on the internal list instead of only looking for "." signs. Fixes [#3144](https://github.com/JabRef/jabref/issues/3144).
 - We added a dialog to show that JabRef is working on checking integrity. [#3358](https://github.com/JabRef/jabref/issues/3358)
+- We added an option to mass append to fields via the Quality -> set/clear/append/rename fields dialog. [#2721](https://github.com/JabRef/jabref/issues/2721)
 
 ### Fixed
  - We fixed the translation of \textendash in the entry preview [#3307](https://github.com/JabRef/jabref/issues/3307)

src/main/java/org/jabref/gui/actions/MassSetFieldAction.java

@@ -53,28 +53,32 @@ public class MassSetFieldAction extends MnemonicAwareAction {
     private JRadioButton selected;
     private JRadioButton clear;
     private JRadioButton set;
+    private JRadioButton append;
     private JRadioButton rename;
     private JComboBox<String> field;
-    private JTextField text;
-    private JTextField renameTo;
+    private JTextField textFieldSet;
+    private JTextField textFieldAppend;
+    private JTextField textFieldRename;
     private boolean canceled = true;
     private JCheckBox overwrite;
 
 
     public MassSetFieldAction(JabRefFrame frame) {
-        putValue(Action.NAME, Localization.menuTitle("Set/clear/rename fields") + "...");
+        putValue(Action.NAME, Localization.menuTitle("Set/clear/append/rename fields") + "...");
         this.frame = frame;
     }
 
     private void createDialog() {
-        diag = new JDialog(frame, Localization.lang("Set/clear/rename fields"), true);
+        diag = new JDialog(frame, Localization.lang("Set/clear/append/rename fields"), true);
 
         field = new JComboBox<>();
         field.setEditable(true);
-        text = new JTextField();
-        text.setEnabled(false);
-        renameTo = new JTextField();
-        renameTo.setEnabled(false);
+        textFieldSet = new JTextField();
+        textFieldSet.setEnabled(false);
+        textFieldAppend = new JTextField();
+        textFieldAppend.setEnabled(false);
+        textFieldRename = new JTextField();
+        textFieldRename.setEnabled(false);
 
         JButton ok = new JButton(Localization.lang("OK"));
         JButton cancel = new JButton(Localization.lang("Cancel"));
@@ -83,6 +87,7 @@ private void createDialog() {
         selected = new JRadioButton(Localization.lang("Selected entries"));
         clear = new JRadioButton(Localization.lang("Clear fields"));
         set = new JRadioButton(Localization.lang("Set fields"));
+        append = new JRadioButton(Localization.lang("Append to fields"));
         rename = new JRadioButton(Localization.lang("Rename field to") + ":");
         rename.setToolTipText(Localization.lang("Move contents of a field into a field with a different name"));
 
@@ -93,16 +98,23 @@ private void createDialog() {
         }
 
         set.addChangeListener(e ->
-        // Entering a text is only relevant if we are setting, not clearing:
-        text.setEnabled(set.isSelected()));
+                // Entering a setText is only relevant if we are setting, not clearing:
+                textFieldSet.setEnabled(set.isSelected()));
+
+        append.addChangeListener(e -> {
+            // Text to append is only required if we are appending:
+            textFieldAppend.setEnabled(append.isSelected());
+            // Overwrite protection makes no sense if we are appending to a field:
+            overwrite.setEnabled(!clear.isSelected() && !append.isSelected());
+        });
 
         clear.addChangeListener(e ->
-        // Overwrite protection makes no sense if we are clearing the field:
-        overwrite.setEnabled(!clear.isSelected()));
+                // Overwrite protection makes no sense if we are clearing the field:
+                overwrite.setEnabled(!clear.isSelected() && !append.isSelected()));
 
         rename.addChangeListener(e ->
-        // Entering a text is only relevant if we are renaming
-        renameTo.setEnabled(rename.isSelected()));
+                // Entering a setText is only relevant if we are renaming
+                textFieldRename.setEnabled(rename.isSelected()));
 
         overwrite = new JCheckBox(Localization.lang("Overwrite existing field values"), true);
         ButtonGroup bg = new ButtonGroup();
@@ -111,9 +123,10 @@ private void createDialog() {
         bg = new ButtonGroup();
         bg.add(clear);
         bg.add(set);
+        bg.add(append);
         bg.add(rename);
         FormBuilder builder = FormBuilder.create().layout(new FormLayout(
-                "left:pref, 4dlu, fill:100dlu:grow", "pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref"));
+                "left:pref, 4dlu, fill:100dlu:grow", "pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref, 2dlu, pref"));
         builder.addSeparator(Localization.lang("Field name")).xyw(1, 1, 3);
         builder.add(Localization.lang("Field name")).xy(1, 3);
         builder.add(field).xy(3, 3);
@@ -122,11 +135,13 @@ private void createDialog() {
         builder.add(selected).xyw(1, 9, 3);
         builder.addSeparator(Localization.lang("New field value")).xyw(1, 11, 3);
         builder.add(set).xy(1, 13);
-        builder.add(text).xy(3, 13);
+        builder.add(textFieldSet).xy(3, 13);
         builder.add(clear).xyw(1, 15, 3);
-        builder.add(rename).xy(1, 17);
-        builder.add(renameTo).xy(3, 17);
-        builder.add(overwrite).xyw(1, 19, 3);
+        builder.add(append).xy(1, 17);
+        builder.add(textFieldAppend).xy(3, 17);
+        builder.add(rename).xy(1, 19);
+        builder.add(textFieldRename).xy(3, 19);
+        builder.add(overwrite).xyw(1, 21, 3);
 
         ButtonBarBuilder bb = new ButtonBarBuilder();
         bb.addGlue();
@@ -219,31 +234,36 @@ public void actionPerformed(ActionEvent e) {
         } else {
             entryList = entries;
         }
-        String toSet = text.getText();
+
+        String toSet = textFieldSet.getText();
         if (toSet.isEmpty()) {
             toSet = null;
         }
 
         String[] fields = getFieldNames(((String) field.getSelectedItem()).trim().toLowerCase(Locale.ROOT));
-        NamedCompound ce = new NamedCompound(Localization.lang("Set field"));
+        NamedCompound compoundEdit = new NamedCompound(Localization.lang("Set field"));
         if (rename.isSelected()) {
             if (fields.length > 1) {
                 JOptionPane.showMessageDialog(diag, Localization.lang("You can only rename one field at a time"), "",
                         JOptionPane.ERROR_MESSAGE);
                 return; // Do not close the dialog.
             } else {
-                ce.addEdit(MassSetFieldAction.massRenameField(entryList, fields[0], renameTo.getText(),
+                compoundEdit.addEdit(MassSetFieldAction.massRenameField(entryList, fields[0], textFieldRename.getText(),
                         overwrite.isSelected()));
             }
+        } else if (append.isSelected()) {
+            for (String field : fields) {
+                compoundEdit.addEdit(MassSetFieldAction.massAppendField(entryList, field, textFieldAppend.getText()));
+            }
         } else {
-            for (String field1 : fields) {
-                ce.addEdit(MassSetFieldAction.massSetField(entryList, field1,
+            for (String field : fields) {
+                compoundEdit.addEdit(MassSetFieldAction.massSetField(entryList, field,
                         set.isSelected() ? toSet : null,
                                 overwrite.isSelected()));
             }
         }
-        ce.end();
-        bp.getUndoManager().addEdit(ce);
+        compoundEdit.end();
+        bp.getUndoManager().addEdit(compoundEdit);
         bp.markBaseChanged();
     }
 
@@ -253,31 +273,58 @@ public void actionPerformed(ActionEvent e) {
      *
      * @param entries         The entries to set the field for.
      * @param field           The name of the field to set.
-     * @param text            The value to set. This value can be null, indicating that the field should be cleared.
+     * @param textToSet            The value to set. This value can be null, indicating that the field should be cleared.
      * @param overwriteValues Indicate whether the value should be set even if an entry already has the field set.
      * @return A CompoundEdit for the entire operation.
      */
-    private static UndoableEdit massSetField(Collection<BibEntry> entries, String field, String text,
+    private static UndoableEdit massSetField(Collection<BibEntry> entries, String field, String textToSet,
             boolean overwriteValues) {
 
-        NamedCompound ce = new NamedCompound(Localization.lang("Set field"));
+        NamedCompound compoundEdit = new NamedCompound(Localization.lang("Set field"));
         for (BibEntry entry : entries) {
-            Optional<String> oldVal = entry.getField(field);
+            Optional<String> oldValue = entry.getField(field);
             // If we are not allowed to overwrite values, check if there is a
             // nonempty
             // value already for this entry:
-            if (!overwriteValues && (oldVal.isPresent()) && !oldVal.get().isEmpty()) {
+            if (!overwriteValues && (oldValue.isPresent()) && !oldValue.get().isEmpty()) {
                 continue;
             }
-            if (text == null) {
+            if (textToSet == null) {
                 entry.clearField(field);
             } else {
-                entry.setField(field, text);
+                entry.setField(field, textToSet);
             }
-            ce.addEdit(new UndoableFieldChange(entry, field, oldVal.orElse(null), text));
+            compoundEdit.addEdit(new UndoableFieldChange(entry, field, oldValue.orElse(null), textToSet));
+        }
+        compoundEdit.end();
+        return compoundEdit;
+    }
+
+    /**
+     * Append a given value to a given field for all entries in a Collection. This method DOES NOT update any UndoManager,
+     * but returns a relevant CompoundEdit that should be registered by the caller.
+     *
+     * @param entries         The entries to process the operation for.
+     * @param field           The name of the field to append to.
+     * @param textToAppend            The value to set. A null in this case will simply preserve the current field state.
+     * @return A CompoundEdit for the entire operation.
+     */
+    private static UndoableEdit massAppendField(Collection<BibEntry> entries, String field, String textToAppend) {
+
+        String newValue = "";
+
+        if (textToAppend != null) {
+            newValue = textToAppend;
+        }
+
+        NamedCompound compoundEdit = new NamedCompound(Localization.lang("Append field"));
+        for (BibEntry entry : entries) {
+            Optional<String> oldValue = entry.getField(field);
+            entry.setField(field, oldValue.orElse("") + newValue);
+            compoundEdit.addEdit(new UndoableFieldChange(entry, field, oldValue.orElse(null), newValue));
         }
-        ce.end();
-        return ce;
+        compoundEdit.end();
+        return compoundEdit;
     }
 
     /**
@@ -292,7 +339,7 @@ private static UndoableEdit massSetField(Collection<BibEntry> entries, String fi
      */
     private static UndoableEdit massRenameField(Collection<BibEntry> entries, String field, String newField,
             boolean overwriteValues) {
-        NamedCompound ce = new NamedCompound(Localization.lang("Rename field"));
+        NamedCompound compoundEdit = new NamedCompound(Localization.lang("Rename field"));
         for (BibEntry entry : entries) {
             Optional<String> valToMove = entry.getField(field);
             // If there is no value, do nothing:
@@ -307,12 +354,12 @@ private static UndoableEdit massRenameField(Collection<BibEntry> entries, String
             }
 
             entry.setField(newField, valToMove.get());
-            ce.addEdit(new UndoableFieldChange(entry, newField, valInNewField.orElse(null), valToMove.get()));
+            compoundEdit.addEdit(new UndoableFieldChange(entry, newField, valInNewField.orElse(null), valToMove.get()));
             entry.clearField(field);
-            ce.addEdit(new UndoableFieldChange(entry, field, valToMove.get(), null));
+            compoundEdit.addEdit(new UndoableFieldChange(entry, field, valToMove.get(), null));
         }
-        ce.end();
-        return ce;
+        compoundEdit.end();
+        return compoundEdit;
     }
 
     private static String[] getFieldNames(String s) {

src/main/resources/l10n/JabRef_da.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=Download_af_fuldtekst-dokument_mislykkedes
 Update_to_current_column_order=Brug_nuværende_kolonnerækkefølge
 Download_from_URL=
 Rename_field=Omdøb_felt
-Set/clear/rename_fields=Sæt/ryd/omdøb_felter
+Set/clear/append/rename_fields=Sæt/ryd/omdøb_felter
+Append_field=
+Append_to_fields=
 Rename_field_to=Omdøb_felt_til
 Move_contents_of_a_field_into_a_field_with_a_different_name=Flyt_indhold_af_et_felt_til_et_felt_med_et_andet_navn
 You_can_only_rename_one_field_at_a_time=Du_kan_kun_omdøbe_et_felt_ad_gangen

src/main/resources/l10n/JabRef_de.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=Herunterladen_des_Volltext-Beitrags_fehlgesch
 Update_to_current_column_order=Aktuelle_Spaltenanordnung_verwenden
 Download_from_URL=Download_von_URL
 Rename_field=Feld_umbenennen
-Set/clear/rename_fields=Felder_setzen/löschen/umbenennen
+Set/clear/append/rename_fields=Felder_setzen/löschen/umbenennen
+Append_field=
+Append_to_fields=
 Rename_field_to=Feld_umbenennen
 Move_contents_of_a_field_into_a_field_with_a_different_name=Inhalt_eines_Felds_in_ein_Feld_mit_anderem_Namen_verschieben
 You_can_only_rename_one_field_at_a_time=Sie_können_nur_eine_Datei_auf_einmal_umbenennen

src/main/resources/l10n/JabRef_el.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=
 Update_to_current_column_order=
 Download_from_URL=
 Rename_field=
-Set/clear/rename_fields=
+Set/clear/append/rename_fields=Ρύθμιση/καθαρισμός/μετονομασία_πεδίων
+Append_field=
+Append_to_fields=
 Rename_field_to=
 Move_contents_of_a_field_into_a_field_with_a_different_name=
 You_can_only_rename_one_field_at_a_time=

src/main/resources/l10n/JabRef_en.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=Full_text_document_download_failed
 Update_to_current_column_order=Update_to_current_column_order
 Download_from_URL=Download_from_URL
 Rename_field=Rename_field
-Set/clear/rename_fields=Set/clear/rename_fields
+Set/clear/append/rename_fields=Set/clear/append/rename_fields
+Append_field=Append_field
+Append_to_fields=Append_to_fields
 Rename_field_to=Rename_field_to
 Move_contents_of_a_field_into_a_field_with_a_different_name=Move_contents_of_a_field_into_a_field_with_a_different_name
 You_can_only_rename_one_field_at_a_time=You_can_only_rename_one_field_at_a_time

src/main/resources/l10n/JabRef_es.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=Falló_la_descarga_del_texto_completo_del_art
 Update_to_current_column_order=Actualizar_al_orden_de_columnas_actual
 Download_from_URL=Descargar_desde_URL
 Rename_field=Renombrar_campo
-Set/clear/rename_fields=Establecer/limpiar/renombrar_campos
+Set/clear/append/rename_fields=Establecer/limpiar/renombrar_campos
+Append_field=
+Append_to_fields=
 Rename_field_to=Renombrar_campo_a
 Move_contents_of_a_field_into_a_field_with_a_different_name=Mover_contenidos_de_un_campo_en_un_campo_con_nombre_diferente
 You_can_only_rename_one_field_at_a_time=Sólo_puede_renombrar_un_campo_a_la_vez

src/main/resources/l10n/JabRef_fa.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=
 Update_to_current_column_order=
 Download_from_URL=
 Rename_field=
-Set/clear/rename_fields=
+Set/clear/append/rename_fields=تنظیم/حذف/تغییرنام_حوزه‌ها
+Append_field=
+Append_to_fields=
 Rename_field_to=
 Move_contents_of_a_field_into_a_field_with_a_different_name=
 You_can_only_rename_one_field_at_a_time=

src/main/resources/l10n/JabRef_fr.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=Echec_du_téléchargement_du_document_cité
 Update_to_current_column_order=Enregistrer_l'ordre_actuel_des_colonnes
 Download_from_URL=Télécharger_depuis_l'URL
 Rename_field=Renommer_le_champ
-Set/clear/rename_fields=Définir/vider/renommer_les_champs
+Set/clear/append/rename_fields=Définir/vider/renommer_les_champs
+Append_field=
+Append_to_fields=
 Rename_field_to=Renommer_le_champ_en
 Move_contents_of_a_field_into_a_field_with_a_different_name=Déplacer_le_contenu_d'un_champ_vers_un_champ_d'un_nom_différent
 You_can_only_rename_one_field_at_a_time=Vou_pouvez_supprimer_uniquement_un_champ_à_la_fois
@@ -2341,7 +2343,6 @@ Copying_file_%0_of_entry_%1=
 Finished_copying=
 Could_not_copy_file=
 Copied_%0_files_of_%1_sucessfully_to_%2==
-
 Rename_failed=Échec_du_renommage
 JabRef_cannot_access_the_file_because_it_is_being_used_by_another_process.=JabRef_ne_peut_pas_accéder_au_fichier_parce_qu'il_est_utilisé_par_un_autre_processus.
 Show_console_output_(only_necessary_when_the_launcher_is_used)=Afficher_la_sortie_de_la_console_(uniquement_nécessaire_quand_le_lanceur_est_utilisé)

src/main/resources/l10n/JabRef_in.properties

@@ -1375,7 +1375,9 @@ Full_text_document_download_failed=Gagal_muaturun_artikel_teks_lengkap
 Update_to_current_column_order=Perbarui_sebuai_urutan_kolom_sekarang
 Download_from_URL=
 Rename_field=Ganti_nama_bidang
-Set/clear/rename_fields=Pilih/hapus/namai_ulang_bidang
+Set/clear/append/rename_fields=Pilih/hapus/namai_ulang_bidang
+Append_field=
+Append_to_fields=
 Rename_field_to=Ganti_nama_bidang_menjadi
 Move_contents_of_a_field_into_a_field_with_a_different_name=Pindah_isi_dari_bidang_ke_bidang_lain_dengan_nama_lain
 You_can_only_rename_one_field_at_a_time=Anda_bisa_mengganti_nama_satu_bidang_dalam_satu_waktu