Merge pull request #1151 from Profpatsch/localization-return-optional

LocaleCompat.forLanguageTag: return Optional if parsing fails

Author: Stypox

extractor/src/main/java/org/schabi/newpipe/extractor/localization/Localization.java

@@ -11,10 +11,12 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
+
 public class Localization implements Serializable {
     public static final Localization DEFAULT = new Localization("en", "GB");
 
@@ -26,20 +28,28 @@ public class Localization implements Serializable {
     /**
      * @param localizationCodeList a list of localization code, formatted like {@link
      *                             #getLocalizationCode()}
+     * @throws IllegalArgumentException If any of the localizationCodeList is formatted incorrectly
+     * @return list of Localization objects
      */
+    @Nonnull
     public static List<Localization> listFrom(final String... localizationCodeList) {
         final List<Localization> toReturn = new ArrayList<>();
         for (final String localizationCode : localizationCodeList) {
-            toReturn.add(fromLocalizationCode(localizationCode));
+            toReturn.add(fromLocalizationCode(localizationCode)
+                    .orElseThrow(() -> new IllegalArgumentException(
+                            "Not a localization code: " + localizationCode
+                    )));
         }
         return Collections.unmodifiableList(toReturn);
     }
 
     /**
      * @param localizationCode a localization code, formatted like {@link #getLocalizationCode()}
+     * @return A Localization, if the code was valid.
      */
-    public static Localization fromLocalizationCode(final String localizationCode) {
-        return fromLocale(LocaleCompat.forLanguageTag(localizationCode));
+    @Nonnull
+    public static Optional<Localization> fromLocalizationCode(final String localizationCode) {
+        return LocaleCompat.forLanguageTag(localizationCode).map(Localization::fromLocale);
     }
 
     public Localization(@Nonnull final String languageCode, @Nullable final String countryCode) {
@@ -61,17 +71,15 @@ public String getCountryCode() {
         return countryCode == null ? "" : countryCode;
     }
 
-    public Locale asLocale() {
-        return new Locale(getLanguageCode(), getCountryCode());
-    }
-
     public static Localization fromLocale(@Nonnull final Locale locale) {
         return new Localization(locale.getLanguage(), locale.getCountry());
     }
 
     /**
      * Return a formatted string in the form of: {@code language-Country}, or
      * just {@code language} if country is {@code null}.
+     *
+     * @return A correctly formatted localizationCode for this localization.
      */
     public String getLocalizationCode() {
         return languageCode + (countryCode == null ? "" : "-" + countryCode);

extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCStreamExtractor.java

@@ -130,7 +130,10 @@ public List<AudioStream> getAudioStreams() throws ExtractionException {
                 // track with multiple languages, so there is no specific language for this stream
                 // Don't set the audio language in this case
                 if (language != null && !language.contains("-")) {
-                    builder.setAudioLocale(LocaleCompat.forLanguageTag(language));
+                    builder.setAudioLocale(LocaleCompat.forLanguageTag(language).orElseThrow(() ->
+                        new ParsingException(
+                                "Cannot convert this language to a locale: " + language)
+                    ));
                 }
 
                 // Not checking containsSimilarStream here, since MediaCCC does not provide enough

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java

@@ -190,7 +190,7 @@ public String getTextualUploadDate() throws ParsingException {
 
                 try { // Premiered 20 hours ago
                     final TimeAgoParser timeAgoParser = TimeAgoPatternsManager.getTimeAgoParserFor(
-                            Localization.fromLocalizationCode("en"));
+                            new Localization("en"));
                     final OffsetDateTime parsedTime = timeAgoParser.parse(time).offsetDateTime();
                     return DateTimeFormatter.ISO_LOCAL_DATE.format(parsedTime);
                 } catch (final Exception ignored) {
@@ -1378,8 +1378,9 @@ private ItagInfo buildAndAddItagInfoToList(
                 final int audioTrackIdLastLocaleCharacter = audioTrackId.indexOf(".");
                 if (audioTrackIdLastLocaleCharacter != -1) {
                     // Audio tracks IDs are in the form LANGUAGE_CODE.TRACK_NUMBER
-                    itagItem.setAudioLocale(LocaleCompat.forLanguageTag(
-                            audioTrackId.substring(0, audioTrackIdLastLocaleCharacter)));
+                    LocaleCompat.forLanguageTag(
+                            audioTrackId.substring(0, audioTrackIdLastLocaleCharacter)
+                    ).ifPresent(itagItem::setAudioLocale);
                 }
                 itagItem.setAudioTrackType(YoutubeParsingHelper.extractAudioTrackType(streamUrl));
             }

extractor/src/main/java/org/schabi/newpipe/extractor/stream/SubtitlesStream.java

@@ -1,6 +1,7 @@
 package org.schabi.newpipe.extractor.stream;
 
 import org.schabi.newpipe.extractor.MediaFormat;
+import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.services.youtube.ItagItem;
 import org.schabi.newpipe.extractor.utils.LocaleCompat;
 
@@ -170,7 +171,7 @@ public Builder setAutoGenerated(final boolean autoGenerated) {
          * not set, or have been set as {@code null}
          */
         @Nonnull
-        public SubtitlesStream build() {
+        public SubtitlesStream build() throws ParsingException {
             if (content == null) {
                 throw new IllegalStateException("No valid content was specified. Please specify a "
                         + "valid one with setContent.");
@@ -229,9 +230,11 @@ private SubtitlesStream(@Nonnull final String id,
                             @Nonnull final DeliveryMethod deliveryMethod,
                             @Nonnull final String languageCode,
                             final boolean autoGenerated,
-                            @Nullable final String manifestUrl) {
+                            @Nullable final String manifestUrl) throws ParsingException {
         super(id, content, isUrl, mediaFormat, deliveryMethod, manifestUrl);
-        this.locale = LocaleCompat.forLanguageTag(languageCode);
+        this.locale = LocaleCompat.forLanguageTag(languageCode).orElseThrow(
+                () -> new ParsingException(
+                        "not a valid locale language code: " + languageCode));
         this.code = languageCode;
         this.format = mediaFormat;
         this.autoGenerated = autoGenerated;

extractor/src/main/java/org/schabi/newpipe/extractor/utils/LocaleCompat.java

@@ -1,6 +1,7 @@
 package org.schabi.newpipe.extractor.utils;
 
 import java.util.Locale;
+import java.util.Optional;
 
 /**
  * This class contains a simple implementation of {@link Locale#forLanguageTag(String)} for Android
@@ -15,29 +16,29 @@ private LocaleCompat() {
 
     // Source: The AndroidX LocaleListCompat class's private forLanguageTagCompat() method.
     // Use Locale.forLanguageTag() on Android API level >= 21 / Java instead.
-    public static Locale forLanguageTag(final String str) {
+    public static Optional<Locale> forLanguageTag(final String str) {
         if (str.contains("-")) {
             final String[] args = str.split("-", -1);
             if (args.length > 2) {
-                return new Locale(args[0], args[1], args[2]);
+                return Optional.of(new Locale(args[0], args[1], args[2]));
             } else if (args.length > 1) {
-                return new Locale(args[0], args[1]);
+                return Optional.of(new Locale(args[0], args[1]));
             } else if (args.length == 1) {
-                return new Locale(args[0]);
+                return Optional.of(new Locale(args[0]));
             }
         } else if (str.contains("_")) {
             final String[] args = str.split("_", -1);
             if (args.length > 2) {
-                return new Locale(args[0], args[1], args[2]);
+                return Optional.of(new Locale(args[0], args[1], args[2]));
             } else if (args.length > 1) {
-                return new Locale(args[0], args[1]);
+                return Optional.of(new Locale(args[0], args[1]));
             } else if (args.length == 1) {
-                return new Locale(args[0]);
+                return Optional.of(new Locale(args[0]));
             }
         } else {
-            return new Locale(str);
+            return Optional.of(new Locale(str));
         }
 
-        throw new IllegalArgumentException("Can not parse language tag: [" + str + "]");
+        return Optional.empty();
     }
 }