Switch from Calendar to OffsetDateTime in DateWrapper.

TeamNewPipe · Oct 20, 2020 · d1632ab · d1632ab
1 parent bf41733
commit d1632ab
Show file tree

Hide file tree

Showing 18 changed files with 194 additions and 221 deletions.
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/localization/DateWrapper.java b/extractor/src/main/java/org/schabi/newpipe/extractor/localization/DateWrapper.java
@@ -3,30 +3,61 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 import java.io.Serializable;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
 import java.util.Calendar;
+import java.util.GregorianCalendar;
 
 /**
- * A wrapper class that provides a field to describe if the date is precise or just an approximation.
+ * A wrapper class that provides a field to describe if the date/time is precise or just an approximation.
  */
 public class DateWrapper implements Serializable {
-    @NonNull private final Calendar date;
+    @NonNull private final OffsetDateTime offsetDateTime;
     private final boolean isApproximation;
 
-    public DateWrapper(@NonNull Calendar date) {
-        this(date, false);
+    /**
+     * @deprecated Use {@link #DateWrapper(OffsetDateTime)} instead.
+     */
+    @Deprecated
+    public DateWrapper(@NonNull Calendar calendar) {
+        this(calendar, false);
+    }
+
+    /**
+     * @deprecated Use {@link #DateWrapper(OffsetDateTime, boolean)} instead.
+     */
+    @Deprecated
+    public DateWrapper(@NonNull Calendar calendar, boolean isApproximation) {
+        offsetDateTime = OffsetDateTime.ofInstant(calendar.toInstant(), ZoneOffset.UTC);
+        this.isApproximation = isApproximation;
     }
 
-    public DateWrapper(@NonNull Calendar date, boolean isApproximation) {
-        this.date = date;
+    public DateWrapper(@NonNull OffsetDateTime offsetDateTime) {
+        this(offsetDateTime, false);
+    }
+
+    public DateWrapper(@NonNull OffsetDateTime offsetDateTime, boolean isApproximation) {
+        this.offsetDateTime = offsetDateTime.withOffsetSameInstant(ZoneOffset.UTC);
         this.isApproximation = isApproximation;
     }
 
     /**
-     * @return the wrapped date.
+     * @return the wrapped date/time as a {@link Calendar}.
+     *
+     * @deprecated use {@link #offsetDateTime()} instead.
      */
+    @Deprecated
     @NonNull
     public Calendar date() {
-        return date;
+        return GregorianCalendar.from(offsetDateTime.toZonedDateTime());
+    }
+
+    /**
+     * @return the wrapped date/time.
+     */
+    @NonNull
+    public OffsetDateTime offsetDateTime() {
+        return offsetDateTime;
     }
 
     /**

diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/localization/TimeAgoParser.java b/extractor/src/main/java/org/schabi/newpipe/extractor/localization/TimeAgoParser.java
@@ -4,8 +4,9 @@
 import org.schabi.newpipe.extractor.timeago.PatternsHolder;
 import org.schabi.newpipe.extractor.utils.Parser;
 
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
 import java.time.temporal.ChronoUnit;
-import java.util.Calendar;
 import java.util.Collection;
 import java.util.Map;
 import java.util.regex.Pattern;
@@ -16,7 +17,7 @@
  */
 public class TimeAgoParser {
     private final PatternsHolder patternsHolder;
-    private final Calendar consistentNow;
+    private final OffsetDateTime now;
 
     /**
      * Creates a helper to parse upload dates in the format '2 days ago'.
@@ -28,7 +29,7 @@ public class TimeAgoParser {
      */
     public TimeAgoParser(PatternsHolder patternsHolder) {
         this.patternsHolder = patternsHolder;
-        consistentNow = Calendar.getInstance();
+        now = OffsetDateTime.now(ZoneOffset.UTC);
     }
 
     /**
@@ -113,64 +114,34 @@ private boolean textualDateMatches(String textualDate, String agoPhrase) {
     }
 
     private DateWrapper getResultFor(int timeAgoAmount, ChronoUnit chronoUnit) {
-        final Calendar calendarTime = getNow();
+        OffsetDateTime offsetDateTime = now;
         boolean isApproximation = false;
 
         switch (chronoUnit) {
             case SECONDS:
-                calendarTime.add(Calendar.SECOND, -timeAgoAmount);
-                break;
-
             case MINUTES:
-                calendarTime.add(Calendar.MINUTE, -timeAgoAmount);
-                break;
-
             case HOURS:
-                calendarTime.add(Calendar.HOUR_OF_DAY, -timeAgoAmount);
+                offsetDateTime = offsetDateTime.minus(timeAgoAmount, chronoUnit);
                 break;
 
             case DAYS:
-                calendarTime.add(Calendar.DAY_OF_MONTH, -timeAgoAmount);
-                isApproximation = true;
-                break;
-
             case WEEKS:
-                calendarTime.add(Calendar.WEEK_OF_YEAR, -timeAgoAmount);
-                isApproximation = true;
-                break;
-
             case MONTHS:
-                calendarTime.add(Calendar.MONTH, -timeAgoAmount);
+                offsetDateTime = offsetDateTime.minus(timeAgoAmount, chronoUnit);
                 isApproximation = true;
                 break;
 
             case YEARS:
-                calendarTime.add(Calendar.YEAR, -timeAgoAmount);
-                // Prevent `PrettyTime` from showing '12 months ago'.
-                calendarTime.add(Calendar.DAY_OF_MONTH, -1);
+                // minusDays is needed to prevent `PrettyTime` from showing '12 months ago'.
+                offsetDateTime = offsetDateTime.minusYears(timeAgoAmount).minusDays(1);
                 isApproximation = true;
                 break;
         }
 
         if (isApproximation) {
-            markApproximatedTime(calendarTime);
+            offsetDateTime = offsetDateTime.truncatedTo(ChronoUnit.HOURS);
         }
 
-        return new DateWrapper(calendarTime, isApproximation);
-    }
-
-    private Calendar getNow() {
-        return (Calendar) consistentNow.clone();
-    }
-
-    /**
-     * Marks the time as approximated by setting minutes, seconds and milliseconds to 0.
-     *
-     * @param calendarTime Time to be marked as approximated
-     */
-    private void markApproximatedTime(Calendar calendarTime) {
-        calendarTime.set(Calendar.MINUTE, 0);
-        calendarTime.set(Calendar.SECOND, 0);
-        calendarTime.set(Calendar.MILLISECOND, 0);
+        return new DateWrapper(offsetDateTime, isApproximation);
     }
 }
diff --git a/...ava/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCParsingHelper.java b/...ava/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCParsingHelper.java
@@ -2,25 +2,18 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.Calendar;
-import java.util.Date;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeParseException;
 
 public final class MediaCCCParsingHelper {
     private MediaCCCParsingHelper() { }
 
-    public static Calendar parseDateFrom(final String textualUploadDate) throws ParsingException {
-        Date date;
+    public static OffsetDateTime parseDateFrom(final String textualUploadDate) throws ParsingException {
         try {
-            date = new SimpleDateFormat("yyyy-MM-dd").parse(textualUploadDate);
-        } catch (ParseException e) {
+            return OffsetDateTime.parse(textualUploadDate, DateTimeFormatter.ISO_OFFSET_DATE_TIME);
+        } catch (DateTimeParseException e) {
             throw new ParsingException("Could not parse date: \"" + textualUploadDate + "\"", e);
         }
-
-        final Calendar uploadDate = Calendar.getInstance();
-        uploadDate.setTime(date);
-        return uploadDate;
     }
-
 }
diff --git a/...r/src/main/java/org/schabi/newpipe/extractor/services/peertube/PeertubeParsingHelper.java b/...r/src/main/java/org/schabi/newpipe/extractor/services/peertube/PeertubeParsingHelper.java
@@ -2,7 +2,6 @@
 
 import com.grack.nanojson.JsonArray;
 import com.grack.nanojson.JsonObject;
-
 import org.schabi.newpipe.extractor.InfoItemsCollector;
 import org.schabi.newpipe.extractor.Page;
 import org.schabi.newpipe.extractor.exceptions.ContentNotAvailableException;
@@ -12,11 +11,10 @@
 import org.schabi.newpipe.extractor.utils.Parser;
 import org.schabi.newpipe.extractor.utils.Utils;
 
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.Calendar;
-import java.util.Date;
-import java.util.TimeZone;
+import java.time.Instant;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.time.format.DateTimeParseException;
 
 public class PeertubeParsingHelper {
     public static final String START_KEY = "start";
@@ -34,19 +32,12 @@ public static void validate(final JsonObject json) throws ContentNotAvailableExc
         }
     }
 
-    public static Calendar parseDateFrom(final String textualUploadDate) throws ParsingException {
-        final Date date;
+    public static OffsetDateTime parseDateFrom(final String textualUploadDate) throws ParsingException {
         try {
-            final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.S'Z'");
-            sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
-            date = sdf.parse(textualUploadDate);
-        } catch (ParseException e) {
+            return OffsetDateTime.ofInstant(Instant.parse(textualUploadDate), ZoneOffset.UTC);
+        } catch (DateTimeParseException e) {
             throw new ParsingException("Could not parse date: \"" + textualUploadDate + "\"", e);
         }
-
-        final Calendar uploadDate = Calendar.getInstance();
-        uploadDate.setTime(date);
-        return uploadDate;
     }
 
     public static Page getNextPage(final String prevPageUrl, final long total) {

diff --git a/...c/main/java/org/schabi/newpipe/extractor/services/soundcloud/SoundcloudParsingHelper.java b/...c/main/java/org/schabi/newpipe/extractor/services/soundcloud/SoundcloudParsingHelper.java
@@ -21,14 +21,16 @@
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 import org.schabi.newpipe.extractor.utils.Parser;
 import org.schabi.newpipe.extractor.utils.Parser.RegexException;
-import org.schabi.newpipe.extractor.utils.Utils;
 
 import javax.annotation.Nonnull;
 import java.io.IOException;
 import java.net.URLEncoder;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.*;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeParseException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
 
 import static java.util.Collections.singletonList;
 import static org.schabi.newpipe.extractor.ServiceList.SoundCloud;
@@ -93,23 +95,16 @@ static boolean checkIfHardcodedClientIdIsValid() {
         }
     }
 
-    public static Calendar parseDateFrom(String textualUploadDate) throws ParsingException {
-        Date date;
+    public static OffsetDateTime parseDateFrom(String textualUploadDate) throws ParsingException {
         try {
-            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
-            sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
-            date = sdf.parse(textualUploadDate);
-        } catch (ParseException e1) {
+            return OffsetDateTime.parse(textualUploadDate, DateTimeFormatter.ISO_OFFSET_DATE_TIME);
+        } catch (DateTimeParseException e1) {
             try {
-                date = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss +0000").parse(textualUploadDate);
-            } catch (ParseException e2) {
+                return OffsetDateTime.parse(textualUploadDate, DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss +0000"));
+            } catch (DateTimeParseException e2) {
                 throw new ParsingException("Could not parse date: \"" + textualUploadDate + "\"" + ", " + e1.getMessage(), e2);
             }
         }
-
-        final Calendar uploadDate = Calendar.getInstance();
-        uploadDate.setTime(date);
-        return uploadDate;
     }
 
     /**

diff --git a/...tor/src/main/java/org/schabi/newpipe/extractor/services/youtube/YoutubeParsingHelper.java b/...tor/src/main/java/org/schabi/newpipe/extractor/services/youtube/YoutubeParsingHelper.java
@@ -5,7 +5,6 @@
 import com.grack.nanojson.JsonParser;
 import com.grack.nanojson.JsonParserException;
 import com.grack.nanojson.JsonWriter;
-
 import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
 import org.schabi.newpipe.extractor.downloader.Response;
@@ -22,13 +21,20 @@
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLDecoder;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.*;
+import java.time.LocalDate;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.time.format.DateTimeParseException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 import static org.schabi.newpipe.extractor.NewPipe.getDownloader;
 import static org.schabi.newpipe.extractor.utils.JsonUtils.EMPTY_STRING;
-import static org.schabi.newpipe.extractor.utils.Utils.*;
+import static org.schabi.newpipe.extractor.utils.Utils.HTTP;
+import static org.schabi.newpipe.extractor.utils.Utils.HTTPS;
+import static org.schabi.newpipe.extractor.utils.Utils.isNullOrEmpty;
 
 /*
  * Created by Christian Schabesberger on 02.03.16.
@@ -182,17 +188,12 @@ public static String getFeedUrlFrom(final String channelIdOrUser) {
         }
     }
 
-    public static Calendar parseDateFrom(String textualUploadDate) throws ParsingException {
-        Date date;
+    public static OffsetDateTime parseDateFrom(String textualUploadDate) throws ParsingException {
         try {
-            date = new SimpleDateFormat("yyyy-MM-dd").parse(textualUploadDate);
-        } catch (ParseException e) {
+            return LocalDate.parse(textualUploadDate).atStartOfDay().atOffset(ZoneOffset.UTC);
+        } catch (DateTimeParseException e) {
             throw new ParsingException("Could not parse date: \"" + textualUploadDate + "\"", e);
         }
-
-        final Calendar uploadDate = Calendar.getInstance();
-        uploadDate.setTime(date);
-        return uploadDate;
     }
 
     public static JsonObject getInitialData(String html) throws ParsingException {

diff --git a/...rg/schabi/newpipe/extractor/services/youtube/extractors/YoutubeFeedInfoItemExtractor.java b/...rg/schabi/newpipe/extractor/services/youtube/extractors/YoutubeFeedInfoItemExtractor.java
@@ -7,11 +7,9 @@
 import org.schabi.newpipe.extractor.stream.StreamType;
 
 import javax.annotation.Nullable;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.Calendar;
-import java.util.Date;
-import java.util.TimeZone;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeParseException;
 
 public class YoutubeFeedInfoItemExtractor implements StreamInfoItemExtractor {
     private final Element entryElement;
@@ -62,19 +60,11 @@ public String getTextualUploadDate() {
     @Nullable
     @Override
     public DateWrapper getUploadDate() throws ParsingException {
-        final Date date;
         try {
-            final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss+00:00");
-            dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
-            date = dateFormat.parse(getTextualUploadDate());
-        } catch (ParseException e) {
+            return new DateWrapper(OffsetDateTime.parse(getTextualUploadDate(), DateTimeFormatter.ISO_OFFSET_DATE_TIME));
+        } catch (DateTimeParseException e) {
             throw new ParsingException("Could not parse date (\"" + getTextualUploadDate() + "\")", e);
         }
-
-        final Calendar calendar = Calendar.getInstance();
-        calendar.setTime(date);
-
-        return new DateWrapper(calendar);
     }
 
     @Override