User specific comment

CHANGELOG.md

@@ -12,6 +12,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 ### Added
 
 - We added a field showing the BibTeX/biblatex source for added and deleted entries in the "External Changes Resolver" dialog. [#9509](https://github.com/JabRef/jabref/issues/9509)
+- We added user specific comment field so that user can make comments with username suffix.[#543](https://github.com/koppor/jabref/issues/543)
 - We added a search history list in the search field's right click menu. [#7906](https://github.com/JabRef/jabref/issues/7906)
 - We added a full text fetcher for IACR eprints. [#9651](https://github.com/JabRef/jabref/pull/9651)
 - We added "Attach file from URL" to right-click context menu to download and store a file with the reference library. [#9646](https://github.com/JabRef/jabref/issues/9646)

src/main/java/org/jabref/gui/entryeditor/CommentsTab.java

@@ -0,0 +1,88 @@
+package org.jabref.gui.entryeditor;
+
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.Optional;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import javax.swing.undo.UndoManager;
+
+import javafx.scene.control.Tooltip;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.StateManager;
+import org.jabref.gui.autocompleter.SuggestionProviders;
+import org.jabref.gui.icon.IconTheme;
+import org.jabref.gui.theme.ThemeManager;
+import org.jabref.gui.util.TaskExecutor;
+import org.jabref.logic.journals.JournalAbbreviationRepository;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.pdf.search.indexing.IndexingTaskManager;
+import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.database.BibDatabaseMode;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibEntryType;
+import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.entry.field.Field;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.model.entry.field.UserSpecificCommentField;
+import org.jabref.preferences.PreferencesService;
+
+public class CommentsTab extends FieldsEditorTab {
+
+    private final BibEntryTypesManager entryTypesManager;
+
+    private final String name;
+    public CommentsTab(String name,
+                       BibDatabaseContext databaseContext,
+                       SuggestionProviders suggestionProviders,
+                       UndoManager undoManager,
+                       DialogService dialogService,
+                       PreferencesService preferences,
+                       StateManager stateManager,
+                       ThemeManager themeManager,
+                       IndexingTaskManager indexingTaskManager,
+                       BibEntryTypesManager entryTypesManager,
+                       TaskExecutor taskExecutor,
+                       JournalAbbreviationRepository journalAbbreviationRepository) {
+        super(
+                false,
+                databaseContext,
+                suggestionProviders,
+                undoManager,
+                dialogService,
+                preferences,
+                stateManager,
+                themeManager,
+                taskExecutor,
+                journalAbbreviationRepository,
+                indexingTaskManager
+        );
+        this.entryTypesManager = entryTypesManager;
+        this.name = name;
+        setText(Localization.lang("All comments"));
+        setTooltip(new Tooltip(Localization.lang("Display all comments")));
+        setGraphic(IconTheme.JabRefIcons.REQUIRED.getGraphicNode());
+    }
+
+    protected Set<Field> determineFieldsToShow(BibEntry entry) {
+        BibDatabaseMode mode = databaseContext.getMode();
+        Optional<BibEntryType> entryType = entryTypesManager.enrich(entry.getType(), mode);
+
+        if (entryType.isPresent()) {
+            UserSpecificCommentField defaultCommentField = new UserSpecificCommentField(name);
+            Set<Field> comments = new LinkedHashSet<>();
+            comments.add(defaultCommentField);
+
+            comments.addAll(entry.getFields().stream()
+                                 .filter(field -> field.equals(StandardField.COMMENT) || field instanceof UserSpecificCommentField || field.getName().toLowerCase().contains("comment"))
+                                 .collect(Collectors.toSet()));
+
+            return comments;
+        } else {
+            // Entry type unknown -> treat all fields as required
+            return Collections.emptySet();
+        }
+    }
+}

src/main/java/org/jabref/gui/entryeditor/EntryEditor.java

@@ -259,6 +259,9 @@ private List<EntryEditorTab> createTabs() {
         // Other fields
         entryEditorTabs.add(new OtherFieldsTab(databaseContext, libraryTab.getSuggestionProviders(), undoManager, dialogService, preferencesService, stateManager, themeManager, libraryTab.getIndexingTaskManager(), bibEntryTypesManager, taskExecutor, journalAbbreviationRepository));
 
+        // Comment Tab
+        entryEditorTabs.add(new CommentsTab(preferencesService.getOwnerPreferences().getDefaultOwner(), databaseContext, libraryTab.getSuggestionProviders(), undoManager, dialogService, preferencesService, stateManager, themeManager, libraryTab.getIndexingTaskManager(), bibEntryTypesManager, taskExecutor, journalAbbreviationRepository));
+
         // General fields from preferences
         for (Map.Entry<String, Set<Field>> tab : entryEditorPreferences.getEntryEditorTabList().entrySet()) {
             entryEditorTabs.add(new UserDefinedFieldsTab(tab.getKey(), tab.getValue(), databaseContext, libraryTab.getSuggestionProviders(), undoManager, dialogService, preferencesService, stateManager, themeManager, libraryTab.getIndexingTaskManager(), taskExecutor, journalAbbreviationRepository));

src/main/java/org/jabref/gui/entryeditor/OtherFieldsTab.java

@@ -27,7 +27,9 @@
 import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.model.entry.field.BibField;
 import org.jabref.model.entry.field.Field;
+import org.jabref.model.entry.field.FieldProperty;
 import org.jabref.model.entry.field.InternalField;
+import org.jabref.model.entry.field.UserSpecificCommentField;
 import org.jabref.preferences.PreferencesService;
 
 public class OtherFieldsTab extends FieldsEditorTab {
@@ -72,8 +74,9 @@ protected Set<Field> determineFieldsToShow(BibEntry entry) {
         Optional<BibEntryType> entryType = entryTypesManager.enrich(entry.getType(), mode);
         if (entryType.isPresent()) {
             Set<Field> allKnownFields = entryType.get().getAllFields();
-            Set<Field> otherFields = entry.getFields().stream().filter(field -> !allKnownFields.contains(field)).collect(Collectors.toCollection(LinkedHashSet::new));
-
+            Set<Field> otherFields = entry.getFields().stream()
+                                          .filter(field -> !allKnownFields.contains(field) && !field.getName().toLowerCase().contains("comment"))
+                                          .collect(Collectors.toCollection(LinkedHashSet::new));
             otherFields.removeAll(entryType.get().getDeprecatedFields(mode));
             otherFields.removeAll(entryType.get().getOptionalFields().stream().map(BibField::field).collect(Collectors.toSet()));
             otherFields.remove(InternalField.KEY_FIELD);

src/main/java/org/jabref/model/entry/field/FieldFactory.java

@@ -156,6 +156,7 @@ private static Set<Field> getAllFields() {
         fields.addAll(EnumSet.allOf(InternalField.class));
         fields.addAll(EnumSet.allOf(SpecialField.class));
         fields.addAll(EnumSet.allOf(StandardField.class));
+        fields.removeIf(field -> field instanceof UserSpecificCommentField);
         return fields;
     }
 

src/main/java/org/jabref/model/entry/field/FieldProperty.java

@@ -23,5 +23,6 @@ public enum FieldProperty {
     SINGLE_ENTRY_LINK,
     TYPE,
     VERBATIM,
-    YES_NO
+    YES_NO,
+    COMMENT
 }

src/main/java/org/jabref/model/entry/field/StandardField.java

@@ -31,7 +31,7 @@ public enum StandardField implements Field {
     BOOKTITLEADDON("booktitleaddon"),
     CHAPTER("chapter"),
     COMMENTATOR("commentator", FieldProperty.PERSON_NAMES),
-    COMMENT("comment"),
+    COMMENT("comment", FieldProperty.COMMENT),
     CROSSREF("crossref", FieldProperty.SINGLE_ENTRY_LINK),
     DATE("date", FieldProperty.DATE),
     DAY("day"),

src/main/java/org/jabref/model/entry/field/UserSpecificCommentField.java

@@ -0,0 +1,55 @@
+package org.jabref.model.entry.field;
+
+import java.util.EnumSet;
+import java.util.Locale;
+import java.util.Objects;
+import java.util.Set;
+
+public class UserSpecificCommentField implements Field {
+    private final String name;
+    private final Set<FieldProperty> properties;
+
+    public UserSpecificCommentField(String username) {
+        this.name = "comment-" + username;
+        this.properties = EnumSet.of(FieldProperty.COMMENT);
+    }
+
+    @Override
+    public Set<FieldProperty> getProperties() {
+        return properties;
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public boolean isStandardField() {
+        return false;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (!(o instanceof Field)) {
+            return false;
+        }
+        Field other = (Field) o;
+        return name.equalsIgnoreCase(other.getName());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(name.toLowerCase(Locale.ENGLISH));
+    }
+
+    @Override
+    public String toString() {
+        return "UnknownCommentField{" +
+                "name='" + name + '\'' +
+                '}';
+    }
+}