Add cleanup operation in reference to the Urldate field

CHANGELOG.md

@@ -31,7 +31,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We added drag and drop events for field 'Groups' in entry editor panel. [#569](https://github.com/koppor/jabref/issues/569)
 - We added support for parsing MathML in the Medline importer. [#4273](https://github.com/JabRef/jabref/issues/4273)
 - We added the ability to search for a DOI directly from 'Web Search'. [#9674](https://github.com/JabRef/jabref/issues/9674)
-- We added a cleanup activity that identifies a URL in the `note` field and moves it to the `url` field. [koppor#216](https://github.com/koppor/jabref/issues/216)
+- We added a cleanup activity that identifies a URL or a last-visited-date in the `note` field and moves it to the `url` and `urldate` field respectively. [koppor#216](https://github.com/koppor/jabref/issues/216)
 - We enabled the user to change the name of a field in a custom entry type by double-clicking on it. [#9840](https://github.com/JabRef/jabref/issues/9840)
 
 

src/main/java/org/jabref/logic/cleanup/URLCleanup.java

@@ -5,6 +5,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.jabref.logic.formatter.bibtexfields.NormalizeDateFormatter;
 import org.jabref.model.FieldChange;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.field.Field;
@@ -17,6 +18,9 @@ public class URLCleanup implements CleanupJob {
 
     private static final Field NOTE_FIELD = StandardField.NOTE;
     private static final Field URL_FIELD = StandardField.URL;
+    private static final Field URLDATE_FIELD = StandardField.URLDATE;
+
+    private NormalizeDateFormatter formatter = new NormalizeDateFormatter();
 
     @Override
     public List<FieldChange> cleanup(BibEntry entry) {
@@ -35,11 +39,46 @@ public List<FieldChange> cleanup(BibEntry entry) {
                 + "<>\\\\]+\\)))*\\))+(?:\\(([^\\s()<>\\\\]+|(\\([^\\s()<>\\\\]+\\"
                 + ")))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»“”‘’]))";
 
-        final Pattern pattern = Pattern.compile(urlRegex, Pattern.CASE_INSENSITIVE);
-        final Matcher matcher = pattern.matcher(noteFieldValue);
+        String dateTermsRegex = "accessed on|visited on|retrieved on|viewed on";
+
+        /*
+         * Several date patterns are available at:
+         * jabref/src/main/java/org/jabref/model/entry/Date.java class
+         *
+         * However, these cannot be used for the needs of the operation
+         * as Date.parse static method requires the newNoteFieldValue String to
+         * hold only a date to match correctly. Besides that, it is not possible to
+         * extract a certain regex introduced in the parse method and call it in
+         * the current class. Reasoning:
+         * Defining a public static final attribute (containing desired regex)
+         * within the parse static method, it is not allowed, as public static
+         * constants must be declared at class-level and not inside the method.
+         *
+         * dateRegex matches several date formats. Explanation:
+         * <ul>
+         *     <li>"\d{4}": Matches exactly four digits (YYYY)</li>
+         *     <li>"\d{1,2}": Matches one or two digits (M or MM)</li>
+         *     <li>"\d{1,2}": Matches one or two digits (D or DD)</li>
+         * </ul>
+         * Indicative formats identified:
+         * YYYY-MM-DD, YYYY-M-DD, YYYY-MM-D, YYYY-M-D
+         * YYYY.MM.DD, YYYY.M.DD, YYYY.MM.D, YYYY.M.D
+         * Month DD, YYYY & Month D, YYYY
+         */
+        String dateRegex = "\\d{4}-\\d{1,2}-\\d{1,2}|\\d{4}\\.\\d{1,2}\\.\\d{1,2}|" +
+                "(January|February|March|April|May|June|July|August|September|" +
+                "October|November|December) \\d{1,2}, \\d{4}";
+
+        final Pattern urlPattern = Pattern.compile(urlRegex, Pattern.CASE_INSENSITIVE);
+        final Pattern dateTermsPattern = Pattern.compile(dateTermsRegex, Pattern.CASE_INSENSITIVE);
+        final Pattern datePattern = Pattern.compile(dateRegex, Pattern.CASE_INSENSITIVE);
 
-        if (matcher.find()) {
-            String url = matcher.group();
+        final Matcher urlMatcher = urlPattern.matcher(noteFieldValue);
+        final Matcher dateTermsMatcher = dateTermsPattern.matcher(noteFieldValue);
+        final Matcher dateMatcher = datePattern.matcher(noteFieldValue);
+
+        if (urlMatcher.find()) {
+            String url = urlMatcher.group();
 
             // Remove the URL from the NoteFieldValue
             String newNoteFieldValue = noteFieldValue
@@ -70,6 +109,30 @@ public List<FieldChange> cleanup(BibEntry entry) {
                 entry.setField(NOTE_FIELD, newNoteFieldValue).ifPresent(changes::add);
                 entry.setField(URL_FIELD, url).ifPresent(changes::add);
             }
+
+            if (dateTermsMatcher.find()) {
+                String term = dateTermsMatcher.group();
+                newNoteFieldValue = newNoteFieldValue
+                        .replace(term, "");
+                if (dateMatcher.find()) {
+                    String date = dateMatcher.group();
+                    String formattedDate = formatter.format(date);
+                    newNoteFieldValue = newNoteFieldValue
+                            .replace(date, "").trim()
+                            .replaceAll("^,|,$", "").trim(); // either starts or ends with a comma
+
+                    // Same approach with the URL cleanup.
+                    if (entry.hasField(URLDATE_FIELD)) {
+                        String urlDateFieldValue = entry.getField(URLDATE_FIELD).orElse(null);
+                        if (urlDateFieldValue.equals(formattedDate)) {
+                            entry.setField(NOTE_FIELD, newNoteFieldValue).ifPresent(changes::add);
+                        }
+                    } else {
+                        entry.setField(NOTE_FIELD, newNoteFieldValue).ifPresent(changes::add);
+                        entry.setField(URLDATE_FIELD, formattedDate).ifPresent(changes::add);
+                    }
+                }
+            }
         }
         return changes;
     }

src/test/java/org/jabref/logic/cleanup/URLCleanupTest.java

@@ -53,6 +53,15 @@ private static Stream<Arguments> provideURL() {
                                     "\\url{https://hdl.handle.net/10442/hedi/6089}, "
                                         + "\\url{http://142.42.1.1:8080}")),
 
+            // Input entry holds the same URL both in Note and Url field.
+            Arguments.of(
+                new BibEntry().withField(StandardField.URL,
+                                     "https://hdl.handle.net/10442/hedi/6089"),
+                new BibEntry().withField(StandardField.NOTE,
+                                     "\\url{https://hdl.handle.net/10442/hedi/6089}")
+                              .withField(StandardField.URL,
+                                     "https://hdl.handle.net/10442/hedi/6089")),
+
             // Input Note field has several values stored.
             Arguments.of(
                 new BibEntry().withField(StandardField.URL,
@@ -112,7 +121,56 @@ private static Stream<Arguments> provideURL() {
                 new BibEntry().withField(StandardField.URL,
                                     "https://www.example.com/foo/?bar=baz&inga=42&quux"),
                 new BibEntry().withField(StandardField.NOTE,
-                                    "https://www.example.com/foo/?bar=baz&inga=42&quux"))
+                                    "https://www.example.com/foo/?bar=baz&inga=42&quux")),
+
+            // Expected entry returns formatted the url-date in the Urldate field.
+            Arguments.of(
+                new BibEntry().withField(StandardField.URL,
+                                    "http://142.42.1.1:8080")
+                              .withField(StandardField.URLDATE,
+                                    "2021-01-15"),
+                new BibEntry().withField(StandardField.NOTE,
+                                    "\\url{http://142.42.1.1:8080}, Accessed on January 15, 2021")),
+
+            // Input entry doesn't hold any URL in the Note field.
+            Arguments.of(
+                new BibEntry().withField(StandardField.NOTE,
+                                    "Accessed on 2015-01-15"),
+                new BibEntry().withField(StandardField.NOTE,
+                                    "Accessed on 2015-01-15")),
+
+            // Input entry has multiple url-dates stored in the Note field.
+            Arguments.of(
+                new BibEntry().withField(StandardField.URL,
+                                    "http://142.42.1.1:8080")
+                              .withField(StandardField.URLDATE,
+                                    "2021-01-15")
+                              .withField(StandardField.NOTE,
+                                    "Visited on February 12, 2017"),
+                new BibEntry().withField(StandardField.NOTE,
+                                    "\\url{http://142.42.1.1:8080}, Accessed on January 15, 2021, Visited on February 12, 2017")),
+
+            // Input entry holds the same url-date in both Note and Urldate field.
+            Arguments.of(
+                new BibEntry().withField(StandardField.URL,
+                                    "http://142.42.1.1:8080")
+                              .withField(StandardField.URLDATE,
+                                    "2015-01-15"),
+                new BibEntry().withField(StandardField.NOTE,
+                                    "\\url{http://142.42.1.1:8080}, Visited on 2015.01.15")
+                              .withField(StandardField.URLDATE,
+                                    "2015-01-15")),
+
+            // Input Note field has several values stored.
+            Arguments.of(
+                new BibEntry().withField(StandardField.URL,
+                                    "https://example.org")
+                              .withField(StandardField.URLDATE,
+                                    "2023-04-11")
+                              .withField(StandardField.NOTE,
+                                    "cited by Kramer"),
+                new BibEntry().withField(StandardField.NOTE,
+                                    "\\url{https://example.org}, cited by Kramer, Accessed on 2023-04-11"))
         );
     }
 }