From b643e85711cae1d48bdead9ee83c50a9a6883093 Mon Sep 17 00:00:00 2001 From: Alix von Schirp Date: Tue, 24 Jan 2023 21:45:43 +0100 Subject: [PATCH 1/7] Added documentation + LastFMToSpotify.java + ArgumentHandler.java Also added a check for image content type --- .../LastFMToSpotify.java | 28 ++++- .../arguments/ArgumentHandler.java | 104 +++++++++++++++++- 2 files changed, 122 insertions(+), 10 deletions(-) diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java index c32d43e..c96ca36 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java @@ -38,9 +38,13 @@ public class LastFMToSpotify { configuration.put("requests.useragent", "LastFMToSpotify/1.0-Snapshot (" + System.getProperty("os.name") + "; " + System.getProperty("os.arch") + ") Java/" + System.getProperty("java.version")); configuration.put("playlist.name", "LastFMToSpotify@" + LocalDateTime.now(Clock.systemDefaultZone()).format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)); configuration.put("logging.level", "1"); + + //check whether all required arguments are set if (!ArgumentHandler.checkArguments(args)) { return; } + + //check whether multiple arguments from an exclusive set are used if(!ArgumentHandler.checkExclusivity(args)){ return; } @@ -77,21 +81,29 @@ public class LastFMToSpotify { SpotifyApi api = build.build(); AtomicBoolean waiting = new AtomicBoolean(true); if (configuration.containsKey("cache.crypto") && TokenHelper.existsTokens()) { + logLn("Cached credentials have been found.", 2); + logLn("Fetching old credentials, refreshing them and saving to cache", 2); AuthorizationCodeCredentials oldcred = TokenHelper.fetchTokens(); - AuthorizationCodeCredentials newcred = api.authorizationCodeRefresh(api.getClientId(), api.getClientSecret(), oldcred.getRefreshToken()).build().execute(); + AuthorizationCodeCredentials newcred = api.authorizationCodeRefresh(api.getClientId(), api.getClientSecret(), oldcred.getRefreshToken()).setHeader("User-Agent", configuration.get("requests.useragent")).build().execute(); TokenHelper.saveTokens(newcred); configuration.put("spotify.access", newcred.getAccessToken()); } else { try (Javalin webserver = Javalin.create().start(9876)) { + if (configuration.containsKey("cache.crypto")) logLn("No cached credentials have been found.", 2); + logLn("Starting webserver to initiate web based authentication.", 2); Runtime.getRuntime().addShutdownHook(new Thread(webserver::stop)); // webserver.exception(Exception.class, (exception, ctx) -> { // ctx.result(exception.getMessage()); // }); webserver.get("/callback/spotify", ctx -> { if(ctx.queryParamMap().containsKey("code")) { - AuthorizationCodeCredentials cred = api.authorizationCode(ctx.queryParam("code")).build().execute(); + logLn("Received spotify authentication code. Requesting credentials.", 2); + AuthorizationCodeCredentials cred = api.authorizationCode(ctx.queryParam("code")).setHeader("User-Agent", configuration.get("requests.useragent")).build().execute(); configuration.put("spotify.access", cred.getAccessToken()); - if(configuration.containsKey("cache.crypto")) TokenHelper.saveTokens(cred); + if(configuration.containsKey("cache.crypto")) { + logLn("Saving credentials to cache.", 2); + TokenHelper.saveTokens(cred); + } ctx.result("success. ").contentType(ContentType.TEXT_HTML).status(HttpStatus.OK); waiting.set(false); } else { @@ -111,12 +123,14 @@ public class LastFMToSpotify { logLn("Reading from LastFM...", 1); Collection tracks = User.getTopTracks(configuration.get("lastfm.user"), PeriodHelper.getPeriodByString(configuration.get("lastfm.period")), configuration.get("lastfm.apikey")); logLn("Creating Playlist...", 1); + logLn("... with custom playlistname (if set) and access modifiers (if set).", 2); api.setAccessToken(configuration.get("spotify.access")); Playlist list = api.createPlaylist(api.getCurrentUsersProfile().build().execute().getId(), configuration.get("playlist.name")).public_(configuration.containsKey("playlist.public")).collaborative(configuration.containsKey("playlist.collab")).setHeader("User-Agent", configuration.get("requests.useragent")).build().execute(); List adders = new LinkedList<>(); - String charsToReplace = "[\"']"; //regex for " and ' + String charsToReplace = "[\"']"; //regex removing " and ' because of issues with spotify search + logLn("Searching tracks from LastFM data on Spotify.", 2); for (Track track : tracks) { - logLn("Adding " + track.getName() + " by " + track.getArtist(), 3); + logLn("Searching " + track.getName() + " by " + track.getArtist(), 3); StringBuilder searchQuery = new StringBuilder(); searchQuery.append("track:").append(track.getName().replaceAll(charsToReplace, "")); searchQuery.append(" artist:").append(track.getArtist()); @@ -132,8 +146,10 @@ public class LastFMToSpotify { } } } - api.addItemsToPlaylist(list.getId(), adders.toArray(String[]::new)).build().execute(); + logLn("Adding tracks to playlist.", 2); + api.addItemsToPlaylist(list.getId(), adders.toArray(String[]::new)).setHeader("User-Agent", configuration.get("requests.useragent")).build().execute(); if(configuration.containsKey("playlist.cover")){ + logLn("Setting playlist cover", 2); logLn("Check for \"null\" if setting cover was successful: " + api.uploadCustomPlaylistCoverImage(list.getId()).image_data(configuration.get("playlist.cover")).setHeader("User-Agent", configuration.get("requests.useragent")).build().execute(),3); } logLn("Done.", 1); diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/ArgumentHandler.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/ArgumentHandler.java index 58c690e..c58d08a 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/ArgumentHandler.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/ArgumentHandler.java @@ -7,6 +7,7 @@ import de.umass.lastfm.Period; import org.jetbrains.annotations.Nullable; import java.io.File; +import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; import java.time.Clock; @@ -24,6 +25,11 @@ import static de.b00tload.tools.lastfmtospotifyplaylist.util.Logger.logLn; import java.util.List; public class ArgumentHandler { + /** + * Selects which argument is handled by which method. + * @param argument the argument to handle + * @param value the value supplied with the argument + */ public static void handle(Arguments argument, @Nullable String value) { switch (argument) { case HELP -> help(value); @@ -45,11 +51,19 @@ public class ArgumentHandler { } } + /** + * Handles an argument without a value. Will pass null as value. + * @param argument the argument to handle without value + */ public static void handle(Arguments argument) { handle(argument, null); } - + /** + * Checks whether every required argument is used. + * @param args the string[] args passed to psvm. + * @return whether every required argument is used + */ public static boolean checkArguments(String[] args) { // check if all required arguments are given Arguments[] required = {Arguments.SECRET, Arguments.CLIENT, Arguments.TOKEN, Arguments.USER}; @@ -72,6 +86,11 @@ public class ArgumentHandler { return true; } + /** + * Checks whether multiple arguments of an exclusivity group are used. + * @param args the string[] args passed to psvm. + * @return Whether only one argument out of every exclusivity group is given + */ public static boolean checkExclusivity(String[] args){ Arguments[][] exclusive = {{Arguments.PUBLIC, Arguments.COLLABORATIVE}, {Arguments.WEEKLY, Arguments.MONTHLY, Arguments.QUARTERLY, Arguments.BIANNUALLY, Arguments.YEARLY}}; for(Arguments[] arguments : exclusive){ @@ -91,7 +110,12 @@ public class ArgumentHandler { return true; } + /** + * Displays help into the console. + * @param value The argument or alias to display help for. + */ private static void help(String value) { + //evaluates whether an argument or alias is given. If not list of all arguments is displayed. if (value == null || value.isEmpty()) { logLn("This is a list of all available commands. For more specific help on the argument run --help .", 1); for (Arguments arg : Arguments.values()) { @@ -103,11 +127,13 @@ public class ArgumentHandler { } System.exit(200); } + //resolves argument or alias. If no match is found tool will exit Arguments arg = Arguments.resolveByNameOrAlias(value); if (arg == null) { logLn("This argument is unknown. Use --help to get a list of all arguments", 1); System.exit(200); } + //Displays information about the selected argument String name = arg.getName(); String description = arg.getDescription(); String[] aliases = arg.getAliases(); @@ -121,10 +147,21 @@ public class ArgumentHandler { } logLn(" ALIASES:" + aliasString.substring(1), 1); logLn("____________________", 1); + //tool exits System.exit(200); } + /** + * Sets the log level. + * - 0: Quiet Will run completely quietly + * - 1: Default Will only show progress + * - 2: Verbose Will echo current step being worked on + * - 3: Debug Will give specific information on what excactly the tool is doing + * @param value an int 0 - 3 + */ private static void verbose(String value) { + + //evaluates whether value is set if (value == null || value.isEmpty()) { logLn("--loglevel must be provided with a numeric log level. Check usage: " + Arguments.VERBOSE.getUsage(), 1); System.exit(500); @@ -139,7 +176,12 @@ public class ArgumentHandler { } + /** + * Sets the LastFM api token into the configuration + * @param value The LastFM api token + */ private static void token(String value) { + //evaluates whether value is set if (value == null || value.isEmpty()) { logLn("--lastfmtoken must be provided with an api token from LastFM. Check usage: " + Arguments.TOKEN.getUsage(), 1); System.exit(500); @@ -147,7 +189,12 @@ public class ArgumentHandler { configuration.put("lastfm.apikey", value); } + /** + * Sets the LastFM username into the configuration + * @param value The LastFM username + */ private static void user(String value) { + //evaluates whether value is set if (value == null || value.isEmpty()) { logLn("--lastfmuser must be provided with a LastFM username. Check usage: " + Arguments.USER.getUsage(), 1); System.exit(500); @@ -155,7 +202,12 @@ public class ArgumentHandler { configuration.put("lastfm.user", value); } + /** + * Sets the spotify client id into the configuration + * @param value The Spotify Client ID + */ private static void client(String value) { + //evaluates whether value is set if (value == null || value.isEmpty()) { logLn("--spotifyclient must be provided with a client id from Spotify. Check usage: " + Arguments.CLIENT.getUsage(), 1); System.exit(500); @@ -163,7 +215,12 @@ public class ArgumentHandler { configuration.put("spotify.clientid", value); } + /** + * Sets the spotify client secret into the configuration + * @param value The Spotify Client Secret + */ private static void secret(String value) { + //evaluates whether value is set if (value == null || value.isEmpty()) { logLn("--spotifysecret must be provided with a client secret from Spotify. Check usage: " + Arguments.SECRET.getUsage(), 1); System.exit(500); @@ -171,20 +228,44 @@ public class ArgumentHandler { configuration.put("spotify.secret", value); } + /** + * Sets the Period to be loaded from LastFM. Possibilities: WEEKLY, MONTHLY, QUARTERLY, BIANNUALLY, YEARLY + * @param value the LastFM Period to be loaded + */ private static void period(Period value) { configuration.put("lastfm.period", value.getString()); } + /** + * Takes a path to a jpeg image and turns it into base64 encoded image data which is subsequently saved into playlist.cover in the configuration. + * @param value The filepath to the cover image. Must be jpeg. + */ private static void cover(String value) { - if (value == null || value.isEmpty() || !Files.exists(Path.of(value.replace("\\", "//")))) { - logLn("--coverart must be provided with a path to a png file. Check usage: " + Arguments.COVER.getUsage(), 1); - System.exit(500); + //evaluating if value is provided and of content-type image/jpeg + try { + if(value == null){ + logLn("--coverart must be provided with a path to a jpeg file. Check usage: " + Arguments.COVER.getUsage(), 1); + System.exit(500); + } + Path path = Path.of(value.replace("\\", "//")); + if (value.isEmpty() || !Files.exists(path) || !Files.probeContentType(path).equalsIgnoreCase("image/jpeg")) { + logLn("--coverart must be provided with a path to a jpeg file. Check usage: " + Arguments.COVER.getUsage(), 1); + System.exit(500); + } + } catch (IOException e) { + throw new RuntimeException(e); } + //encodes image data into base64 String base64 = FileHelper.encodeFileToBase64(new File(value.replace("\\", "//"))); + //saves to configuration configuration.put("playlist.cover", base64); } + /** + * Sets the access modifier. Can either be "collaborative" or "public". + * @param value "collaborative" or "public" + */ private static void access(String value) { switch (value) { case "collaborative" -> configuration.put("playlist.collab", "collab"); @@ -192,17 +273,27 @@ public class ArgumentHandler { } } + /** + * Sets the playlist.name value in the configuration. Supports templating and date offsetting. See wiki for further documentation on templating. + * @param value The playlist name string, including templating + */ private static void name(String value) { + //evaluating if value is provided if (value == null || value.isEmpty()) { logLn("--playlistname must be provided with a playlist name. Check usage: " + Arguments.NAME.getUsage(), 1); System.exit(500); } + //creating current datetime and users locale LocalDateTime now = LocalDateTime.now(Clock.systemDefaultZone()); Locale loc = Locale.forLanguageTag(System.getProperty("user.country")); + + //checking for the date offset flag and applying it if necessary if(value.matches("(%\\$-?\\d*\\$).*")){ int offsetDays = Integer.parseInt(value.substring(2).split("\\$")[0]); now = offsetDays < 0 ? now.minusDays(Math.abs(offsetDays)) : now.plusDays(Math.abs(offsetDays)); } + + //replacing datetime template String name = value.replace("%YYYY", String.valueOf(now.getYear())).replace("%YY", String.valueOf(now.getYear()).substring(2)) .replace("%MMMM", now.getMonth().name().charAt(0) + now.getMonth().name().toLowerCase().substring(1)) .replace("%MMM", now.getMonth().getDisplayName(TextStyle.FULL, loc)) @@ -231,7 +322,12 @@ public class ArgumentHandler { configuration.put("playlist.name", name); } + /** + * Sets the cache.crypto value in the configuration + * @param value a password encrypting the credential cache + */ public static void cache(String value){ + //evaluating if value is provided if (value == null || value.isEmpty()) { logLn("--spotifycache must be provided with a password. Check usage: " + Arguments.SPOTIFY_CACHING.getUsage(), 1); System.exit(500); -- 2.49.1 From 5f6732b8ea88e33b9e8accdc22608495fac92915 Mon Sep 17 00:00:00 2001 From: Alix von Schirp Date: Wed, 25 Jan 2023 23:19:14 +0100 Subject: [PATCH 2/7] Documented arguments --- .../arguments/Arguments.java | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/Arguments.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/Arguments.java index 396e71d..9a92ada 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/Arguments.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/arguments/Arguments.java @@ -6,6 +6,7 @@ import static de.b00tload.tools.lastfmtospotifyplaylist.LastFMToSpotify.LINE_SEP public enum Arguments { + //Defining arguments HELP("help", "[Optional, will not execute tool] " + LINE_SEPERATOR + "Shows a list of all commands or, if provided, help for a given command.", "--help [argument]", "h", "?"), VERBOSE("loglevel", "[Optional] " + LINE_SEPERATOR @@ -73,6 +74,11 @@ public enum Arguments { return aliases; } + /** + * Resolves an alias-String into an Argument-object + * @param alias The alias to resolve + * @return The resolved Argument, null if alias does not exist. + */ public static Arguments getByAlias(String alias){ for(Arguments arg : values()){ if(List.of(arg.getAliases()).contains(alias)) return arg; @@ -80,6 +86,11 @@ public enum Arguments { return null; } + /** + * Resolves an argument-String into an Argument-object + * @param name The argument to resolve + * @return The resolved Argument, null if alias does not exist. + */ public static Arguments getByName(String name){ for(Arguments arg : values()){ if(arg.getName().equalsIgnoreCase(name)) return arg; @@ -87,6 +98,11 @@ public enum Arguments { return null; } + /** + * Resolves an argument- or alias-String into an Argument-object + * @param v The alias or argument to resolve + * @return The resolved Argument, null if alias does not exist. + */ public static Arguments resolveByNameOrAlias(String v){ Arguments ret = getByName(v); if(ret != null) return ret; @@ -94,6 +110,10 @@ public enum Arguments { return ret; } + /** + * Builds a String consisting of the argument name and all aliases listed + * @return "--$argument ($aliases)" + */ @Override public String toString() { StringBuilder args = new StringBuilder("--").append(this.name).append(" ("); -- 2.49.1 From 6eabc0a22f5676c7620f6ac2ef0f966dd5594b27 Mon Sep 17 00:00:00 2001 From: Alix von Schirp Date: Fri, 27 Jan 2023 20:13:01 +0100 Subject: [PATCH 3/7] Documented helper classes in util package Also did minor code cleanup --- .../util/CryptoHelper.java | 22 ++++++++++++++++--- .../util/FileHelper.java | 5 +++++ .../lastfmtospotifyplaylist/util/Logger.java | 5 +++++ .../util/PeriodHelper.java | 5 +++++ .../util/TimeHelper.java | 18 +++++++++++++-- .../util/TokenHelper.java | 13 +++++++++++ 6 files changed, 63 insertions(+), 5 deletions(-) diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/CryptoHelper.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/CryptoHelper.java index 4339930..70183fd 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/CryptoHelper.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/CryptoHelper.java @@ -15,18 +15,28 @@ import java.security.spec.KeySpec; public class CryptoHelper { + /** + * Creates a javax.crypto.SecretKey from a provided password + * @param pass The password + * @return the generated secret key + */ public static SecretKey createKeyFromPassword(String pass){ try { KeySpec spec = new PBEKeySpec(pass.toCharArray(), "abcdefghijklmnop".getBytes(), 65536, 256); // AES-256 SecretKeyFactory f = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1"); - byte[] key = new byte[0]; - key = f.generateSecret(spec).getEncoded(); + byte[] key = f.generateSecret(spec).getEncoded(); return new SecretKeySpec(key, "AES"); } catch (InvalidKeySpecException | NoSuchAlgorithmException e) { throw new RuntimeException(e); } } + /** + * Saves a java.io.Serializable Object into an encrypted file + * @param obj The object to save + * @param file The Path where to save the file + * @param key The SecretKey (AES) to encrypt the file with + */ public static void serializeEncrypted(Serializable obj, Path file, SecretKey key){ try { if(file.toFile().exists()) file.toFile().delete(); @@ -45,8 +55,14 @@ public class CryptoHelper { } } + /** + * Reads an encrypted file into a java.io.Serializable object. + * @param file The java.nio.Path where the encrypted file is stored. + * @param key The SecretKey (AES) to decrypt the file with + * @return The java.io.Serializable object read from the file. + */ public static Serializable deserializeEncrypted(Path file, SecretKey key) { - Serializable ret = null; + Serializable ret; try { Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding"); IvParameterSpec iv = new IvParameterSpec("abcdefghijklmnop".getBytes()); diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/FileHelper.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/FileHelper.java index e1ad05b..52e2890 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/FileHelper.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/FileHelper.java @@ -7,6 +7,11 @@ import java.util.Base64; public class FileHelper { + /** + * Reads a file and encodes it into Base64 + * @param file The file to read + * @return A Base64 encoded String containing the data of the file + */ public static String encodeFileToBase64(File file){ String encodedfile = null; try (FileInputStream fileInputStreamReader = new FileInputStream(file)){ diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/Logger.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/Logger.java index cad03cc..15c8ee4 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/Logger.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/Logger.java @@ -4,6 +4,11 @@ import static de.b00tload.tools.lastfmtospotifyplaylist.LastFMToSpotify.configur public class Logger { + /** + * Logs the provided String to console if the option logging.level in the configuration is higher or equal to the provided priority + * @param string The String to log + * @param priority The minimum logging level with which the provided string should be logged + */ public static void logLn(String string, int priority){ if(Integer.parseInt(configuration.get("logging.level"))>=priority){ System.out.println(string); diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/PeriodHelper.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/PeriodHelper.java index 2c68faf..6ded178 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/PeriodHelper.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/PeriodHelper.java @@ -4,6 +4,11 @@ import de.umass.lastfm.Period; public class PeriodHelper { + /** + * Converts a provided String (de.umass.lastfm.Period.getString()) into the corresponding de.umass.lastfm.Period + * @param string The value to be converted into a de.umass.lastfm.Period + * @return The converted de.umass.lastfm.Period, defaults to de.umass.lastfm.Period.ONE_MONTH + */ public static Period getPeriodByString(String string){ for(Period p : Period.values()){ if(p.getString().equalsIgnoreCase(string)) return p; diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TimeHelper.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TimeHelper.java index 8e6ba74..3cf12c6 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TimeHelper.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TimeHelper.java @@ -5,19 +5,33 @@ import java.time.ZoneId; public class TimeHelper { + /** + * Gets the hours of the UTC offset from a LocalDateTime, which is asserted to be at the system default Timezone (ZoneId.systemDefault()) + * @param now The java.time.LocalDateTime for which the offset should be calculated + * @return The hours of offset from UTC + */ public static int getUTCOffsetHours(LocalDateTime now){ - return (int) Math.floor((double) now.atZone(ZoneId.systemDefault()).getOffset().getTotalSeconds()/3600); } + /** + * Gets the minutes of the UTC offset from a LocalDateTime, which is asserted to be at the system default Timezone (ZoneId.systemDefault()) + * @param now The java.time.LocalDateTime for which the offset should be calculated + * @return The minutes of offset from UTC + */ public static int getUTCOffsetMinutes(LocalDateTime now){ return (now.atZone(ZoneId.systemDefault()).getOffset().getTotalSeconds()/60); } + /** + * Generates an ISO 8601 complying String containing the UTC offset from a LocalDateTime, which is asserted to be at the system default Timezone (ZoneId.systemDefault()) + * @param now The java.time.LocalDateTime for which the offset should be calculated + * @return an ISO 8601 complying String containing the UTC offset (e.g. "+01:00") + */ public static String getUTCOffset(LocalDateTime now){ int hour = getUTCOffsetHours(now); String h = (hour == Math.abs(hour) ? "+" : "-") + (String.valueOf(Math.abs(hour)).length() == 1 ? "0" + Math.abs(hour) : String.valueOf(Math.abs(hour))); - int min = Math.abs(getUTCOffsetMinutes(now))-(Math.abs(hour)*60); + int min = Math.abs(getUTCOffsetMinutes(now))%(Math.abs(hour)); String m = (String.valueOf(Math.abs(min)).length() == 1 ? "0" + Math.abs(min) : String.valueOf(Math.abs(min))); return h + ":" + m; } diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TokenHelper.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TokenHelper.java index 8197b21..b9e434a 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TokenHelper.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/TokenHelper.java @@ -8,14 +8,27 @@ import static de.b00tload.tools.lastfmtospotifyplaylist.LastFMToSpotify.USER_HOM import static de.b00tload.tools.lastfmtospotifyplaylist.LastFMToSpotify.configuration; public class TokenHelper { + + /** + * Manages saving a se.michaelthelin.spotify.model_objects.credentials.AuthorizationCodeCredentials into "~/.lfm2s/spotify.lfm2scred" using de.b00tload.tools.lastfmtospotifyplaylist.util.CryptoHelper.serializeEncrypted(...) + * @param cred The se.michaelthelin.spotify.model_objects.credentials.AuthorizationCodeCredentials to be saved + */ public static void saveTokens(AuthorizationCodeCredentials cred) { CryptoHelper.serializeEncrypted(cred, Path.of(USER_HOME, "/.lfm2s/spotify.lfm2scred"), CryptoHelper.createKeyFromPassword(configuration.get("cache.crypto"))); } + /** + * Manages retrieving a se.michaelthelin.spotify.model_objects.credentials.AuthorizationCodeCredentials from "~/.lfm2s/spotify.lfm2scred" using de.b00tload.tools.lastfmtospotifyplaylist.util.CryptoHelper.deserializeEncrypted(...) + * @return The retrieved se.michaelthelin.spotify.model_objects.credentials.AuthorizationCodeCredentials + */ public static AuthorizationCodeCredentials fetchTokens() { return (AuthorizationCodeCredentials) CryptoHelper.deserializeEncrypted(Path.of(USER_HOME, "/.lfm2s/spotify.lfm2scred"), CryptoHelper.createKeyFromPassword(configuration.get("cache.crypto"))); } + /** + * Checks whether the saved spotify AuthorizationCodeCredentials at "~/.lfm2s/spotify.lfm2scred" exist + * @return true if file exists, false if not + */ public static boolean existsTokens(){ return Path.of(USER_HOME, "/.lfm2s/spotify.lfm2scred").toFile().exists(); } -- 2.49.1 From 79885db3ddc010ca54d83ed59e983e212f5d52bc Mon Sep 17 00:00:00 2001 From: Alix von Schirp Date: Fri, 27 Jan 2023 21:19:00 +0100 Subject: [PATCH 4/7] Added README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f9c1dfa --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# LastFM To Spotify-Playlist +This command-line-tool creates a playlist on Spotify which contains the 50 songs you listened to the most. This data is pulled from your LastFM profile. + +The period for which this data is pulled is limited to: + - One week + - One month + - Three months + - Six months + - One year + - All time + +This limitation is set by LastFM, as those are the period selectors in their API. + +The tool supports setting a custom name for the playlist, setting a cover art as well as making the created playlist public (Added to profile) or collaborative. public and collaborative are mutually exclusive. + +--- + +## Prerequisites + - A Spotify application + - A LastFM api token + - Java 18 (as this tool is not shipped with a JRE you'll need to install the JDK) + +## Setup +### Spotify +1. Visit [the Spotify Developer Dashboard](https://developer.spotify.com/dashboard/) +2. Create an app +3. In the "Users and Access" menu, add your Email-Address and Name +4. In the "Edit Settings" add "http://localhost:9876/callback/spotify/" as a Redirect URI +5. Note your Client ID and Client Secret + +### LastFM +1. [Create a LastFM API account](https://www.last.fm/api/account/create) +2. Note the API key + +## Usage +In your command line run ```java -jar lfm2s-%version%.jar [arguments]```. + +For argument usages check [the wiki](https://github.com/B00tLoad/LastFMtoSpotifyPlaylist/wiki/Arguments) \ No newline at end of file -- 2.49.1 From b83b5370ca582005089a1c779b5a1fb015f118cd Mon Sep 17 00:00:00 2001 From: Alix von Schirp <15247003+B00tLoad@users.noreply.github.com> Date: Fri, 27 Jan 2023 21:22:41 +0100 Subject: [PATCH 5/7] Create LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. -- 2.49.1 From 084f75fb8341845dee44a0b551515a05aa921b49 Mon Sep 17 00:00:00 2001 From: Alix von Schirp <15247003+B00tLoad@users.noreply.github.com> Date: Sat, 28 Jan 2023 07:38:56 +0100 Subject: [PATCH 6/7] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e2fee88 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG] " +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS [e.g. Windows]: + - Version/Build [e.g. 22H2/19045.2546]: + - Java Version/Build [e.g. Temurin-18.0.1+10]: + +**Console Output** +``` +Add any relevant console outputs (like stack traces after an Exception) here. +``` + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..36a7fe5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FR] " +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. -- 2.49.1 From 174c9912aac4d2aa5faa6437cdb07a625017fd8d Mon Sep 17 00:00:00 2001 From: Morril Date: Sat, 28 Jan 2023 20:52:42 +0100 Subject: [PATCH 7/7] added BrowserHelper implemented open Spotify auth page --- .../LastFMToSpotify.java | 8 +++- .../util/BrowserHelper.java | 42 +++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/BrowserHelper.java diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java index c32d43e..9149a5d 100644 --- a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/LastFMToSpotify.java @@ -4,6 +4,7 @@ package de.b00tload.tools.lastfmtospotifyplaylist; import com.neovisionaries.i18n.CountryCode; import de.b00tload.tools.lastfmtospotifyplaylist.arguments.ArgumentHandler; import de.b00tload.tools.lastfmtospotifyplaylist.arguments.Arguments; +import de.b00tload.tools.lastfmtospotifyplaylist.util.BrowserHelper; import de.b00tload.tools.lastfmtospotifyplaylist.util.PeriodHelper; import de.b00tload.tools.lastfmtospotifyplaylist.util.TokenHelper; @@ -100,7 +101,12 @@ public class LastFMToSpotify { } }); logLn("Waiting for Spotify authorization.", 1); - //TODO: Open auth page in Browser + + String authPage = "https://accounts.spotify.com/authorize?client_id=" + + configuration.get("spotify.clientid") + + "&response_type=code&state=73775e18-b0bc-4031-a379-bce99a0e3e6c&redirect_uri=http%3A%2F%2Flocalhost%3A9876%2Fcallback%2Fspotify%2F&scope=user-read-private%20playlist-modify-private%20playlist-modify-public%20ugc-image-upload%20playlist-read-private%20playlist-read-collaborative"; + BrowserHelper.openInBrowser(authPage); + while (waiting.get()); } } diff --git a/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/BrowserHelper.java b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/BrowserHelper.java new file mode 100644 index 0000000..1eedfd5 --- /dev/null +++ b/src/main/java/de/b00tload/tools/lastfmtospotifyplaylist/util/BrowserHelper.java @@ -0,0 +1,42 @@ +package de.b00tload.tools.lastfmtospotifyplaylist.util; + +public class BrowserHelper { + + /** + * Opens a url in the systems default browser + * @param url + */ + public static void openInBrowser(String url) { + + String os = System.getProperty("os.name").toLowerCase(); + ProcessBuilder builder; + + if (os.indexOf("win") >= 0) { + // Windows + builder = new ProcessBuilder("rundll32.exe","url.dll,FileProtocolHandler", url); + } else if (os.indexOf("mac") >= 0) { + // Mac + builder = new ProcessBuilder("open", url); + } else if (os.indexOf("nix") >= 0 || os.indexOf("nux") >= 0) { + // Linux + os = "linux"; + builder = new ProcessBuilder("xdg-open", url); + } else { + Logger.logLn("Please open the following link:\n"+url, 1); + builder = null; + } + + try { + if (builder != null) { + Process exec = builder.start(); + if (os.equals("linux") && exec.exitValue() == 3) { + // on Linux in case of missing browser + Logger.logLn("Please open the following link:\n"+url, 1); + } + } + } catch (Exception e) { + Logger.logLn(e.getMessage(), 3); + } + + } +} -- 2.49.1