3 | *
4 | * This program is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * This program is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with this program. If not, see .
16 | */
17 | package com.kanedias.vanilla.lyrics;
18 |
19 | import android.content.BroadcastReceiver;
20 | import android.content.Context;
21 | import android.content.Intent;
22 | import android.util.Log;
23 |
24 | import com.kanedias.vanilla.plugins.PluginConstants;
25 |
26 | import static com.kanedias.vanilla.plugins.PluginConstants.*;
27 |
28 | /**
29 | * Broadcast receiver used for retrieving query intents
30 | *
31 | * @see PluginConstants
32 | *
33 | * @author Kanedias
34 | */
35 | public class PluginQueryBroadcastReceiver extends BroadcastReceiver {
36 |
37 | /**
38 | * Just answer with plugin parameters. We need a broadcast receiver for this, as ordinary intents
39 | * are targeted-only. Only query intents will come here, as "plugin launch" intents are targeted
40 | * and thus don't need a broadcast receiver to reach activity.
41 | *
42 | * @param context context this receiver operates in
43 | * @param intent incoming query intent
44 | */
45 | @Override
46 | public void onReceive(Context context, Intent intent) {
47 | Log.i(PluginConstants.LOG_TAG, "Received query intent!");
48 | if (intent.getAction() == null)
49 | return;
50 |
51 | switch (intent.getAction()) {
52 | case PluginConstants.ACTION_REQUEST_PLUGIN_PARAMS:
53 | handleRequestPluginParams(context, intent);
54 | return;
55 | default:
56 | Log.e(PluginConstants.LOG_TAG, "Unknown intent received by receiver! Action" + intent.getAction());
57 | }
58 | }
59 |
60 | /**
61 | * Sends plugin info back to Vanilla Music service.
62 | *
63 | * @param intent intent from player
64 | */
65 | private void handleRequestPluginParams(Context ctx, Intent intent) {
66 | Intent answer = new Intent(ACTION_HANDLE_PLUGIN_PARAMS);
67 | answer.setPackage(intent.getPackage());
68 | answer.putExtra(EXTRA_PARAM_PLUGIN_NAME, ctx.getString(R.string.lyrics_search));
69 | answer.putExtra(EXTRA_PARAM_PLUGIN_APP, ctx.getApplicationInfo());
70 | answer.putExtra(EXTRA_PARAM_PLUGIN_DESC, ctx.getString(R.string.plugin_desc));
71 | ctx.sendBroadcast(answer);
72 | }
73 | }
74 |
--------------------------------------------------------------------------------
/app/src/main/java/com/kanedias/vanilla/lyrics/GeniusApiEngine.java:
--------------------------------------------------------------------------------
1 | package com.kanedias.vanilla.lyrics;
2 |
3 | import android.net.Uri;
4 | import android.util.Log;
5 |
6 | import com.kanedias.vanilla.plugins.PluginUtils;
7 |
8 | import org.json.JSONArray;
9 | import org.json.JSONException;
10 | import org.json.JSONObject;
11 | import org.jsoup.Jsoup;
12 | import org.jsoup.nodes.Document;
13 | import org.jsoup.nodes.Element;
14 | import org.jsoup.nodes.Node;
15 | import org.jsoup.nodes.TextNode;
16 |
17 | import java.io.IOException;
18 | import java.io.InputStream;
19 | import java.net.URL;
20 |
21 | import javax.net.ssl.HttpsURLConnection;
22 |
23 | /**
24 | * @author Kanedias
25 | *
26 | * Created on 29.11.20
27 | */
28 | public class GeniusApiEngine implements LyricsEngine {
29 |
30 | private static final String GENIUS_API_HOST = "api.genius.com";
31 | private static final String GENIUS_MAIN_URL = "https://genius.com";
32 |
33 | private static final String GENIUS_API_TOKEN = BuildConfig.GENIUS_API_TOKEN;
34 | private static final String TAG = GeniusApiEngine.class.getSimpleName();
35 |
36 | @Override
37 | public String getLyrics(String artistName, String songTitle) {
38 | try {
39 |
40 | JSONObject searchReply = makeApiCall(artistName, songTitle);
41 | if (searchReply == null) { // no URL in API answer or no correct answer at all
42 | return null;
43 | }
44 |
45 | // get first match from list
46 | JSONArray hits = searchReply.getJSONObject("response").getJSONArray("hits");
47 | if (hits == null || hits.length() == 0) {
48 | // no hits
49 | return null;
50 | }
51 |
52 | for (int i = 0; i < hits.length(); ++i) {
53 | JSONObject song = hits.getJSONObject(i);
54 | if (!song.getString("type").equals("song")) {
55 | // not a song, skip
56 | continue;
57 | }
58 |
59 | String lyricsUrl = song.getJSONObject("result").getString("path");
60 | return parseFullLyricsPage(lyricsUrl);
61 | }
62 |
63 | return null;
64 |
65 | } catch (IOException e) {
66 | Log.w(TAG, "Couldn't connect to lyrics wiki REST endpoints", e);
67 | return null;
68 | } catch (JSONException e) {
69 | Log.w(TAG, "Couldn't transform API answer to JSON entity", e);
70 | return null;
71 | }
72 | }
73 |
74 | private String parseFullLyricsPage(String lyricsUrl) throws IOException {
75 | if (lyricsUrl == null)
76 | return null;
77 |
78 | HttpsURLConnection pageGet = null;
79 | try {
80 | pageGet = (HttpsURLConnection) new URL(GENIUS_MAIN_URL + lyricsUrl).openConnection();
81 | pageGet.setReadTimeout(10_000);
82 | pageGet.setConnectTimeout(15_000);
83 |
84 | pageGet.connect();
85 | int response = pageGet.getResponseCode();
86 | if (response != HttpsURLConnection.HTTP_OK) {
87 | // redirects are handled internally, this is clearly an error
88 | return null;
89 | }
90 |
91 | InputStream is = pageGet.getInputStream();
92 | Document page = Jsoup.parse(is, "UTF-8", GENIUS_MAIN_URL);
93 | Element lyrics = page.select("div.lyrics p").first();
94 |
95 | if (lyrics == null) {
96 | // page format changed
97 | return null;
98 | }
99 |
100 | StringBuilder builder = new StringBuilder();
101 | for (Node curr : lyrics.childNodes()) {
102 | if (curr instanceof Element && ((Element) curr).tagName().equals("br")) {
103 | builder.append("\n");
104 | } else if (curr instanceof Element) {
105 | builder.append(((Element) curr).text());
106 | } else if (curr instanceof TextNode) {
107 | builder.append(((TextNode) curr).text());
108 | }
109 | }
110 |
111 | return builder.toString();
112 | } finally {
113 | if (pageGet != null) {
114 | pageGet.disconnect();
115 | }
116 | }
117 | }
118 |
119 | /**
120 | * First call
121 | */
122 | private JSONObject makeApiCall(String artistName, String songTitle) throws IOException, JSONException {
123 | HttpsURLConnection apiCall = null;
124 | try {
125 | // build query
126 | Uri link = new Uri.Builder()
127 | .scheme("https")
128 | .authority(GENIUS_API_HOST)
129 | .path("search")
130 | .appendQueryParameter("q", artistName + " " + songTitle)
131 | .build();
132 |
133 | // construct an http request
134 | apiCall = (HttpsURLConnection) new URL(link.toString()).openConnection();
135 | apiCall.setReadTimeout(10_000);
136 | apiCall.setConnectTimeout(15_000);
137 |
138 | apiCall.setRequestProperty("Authorization", "Bearer " + GENIUS_API_TOKEN);
139 |
140 | // execute
141 | apiCall.connect();
142 | int response = apiCall.getResponseCode();
143 | if (response != HttpsURLConnection.HTTP_OK) {
144 | // redirects are handled internally, this is clearly an error
145 | return null;
146 | }
147 |
148 | InputStream is = apiCall.getInputStream();
149 | String reply = new String(PluginUtils.readFully(is), "UTF-8");
150 | return new JSONObject(reply);
151 | } finally {
152 | if (apiCall != null) {
153 | apiCall.disconnect();
154 | }
155 | }
156 | }
157 | }
158 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/app/src/main/java/com/kanedias/vanilla/lyrics/LyricWikiEngine.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (C) 2016-2019 Oleg `Kanedias` Chernovskiy
3 | *
4 | * This program is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * This program is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with this program. If not, see .
16 | */
17 | package com.kanedias.vanilla.lyrics;
18 |
19 | import android.net.Uri;
20 | import android.text.TextUtils;
21 | import android.util.Log;
22 |
23 | import com.kanedias.vanilla.plugins.PluginUtils;
24 | import org.json.JSONException;
25 | import org.json.JSONObject;
26 | import org.jsoup.Jsoup;
27 | import org.jsoup.nodes.Document;
28 | import org.jsoup.nodes.Element;
29 | import org.jsoup.nodes.Node;
30 | import org.jsoup.nodes.TextNode;
31 |
32 | import java.io.IOException;
33 | import java.io.InputStream;
34 | import java.net.URL;
35 | import java.util.zip.GZIPInputStream;
36 |
37 | import javax.net.ssl.HttpsURLConnection;
38 |
39 | /**
40 | * Implementation of lyrics engine based on LyricsWiki API.
41 | * This api, although hard to find, provides getSong API call
42 | * to find the corresponding song by artist and title.
43 | *
44 | * The licensing issues don't allow it to return full song lyrics on API call.
45 | * Hence the retrieval is done in 2 steps - first, call to getSong to
46 | * find the requested song and, if found, get the page containing full song lyrics
47 | *
48 | * @deprecated LyricWiki is dead: postmortem
49 | *
50 | * @author Kanedias
51 | *
52 | */
53 | public class LyricWikiEngine implements LyricsEngine {
54 |
55 | private static final String TAG = LyricWikiEngine.class.getSimpleName();
56 |
57 | @Override
58 | public String getLyrics(String artistName, String songTitle) {
59 | try {
60 |
61 | String lyricsUrl = makeApiCall(artistName, songTitle);
62 | if (lyricsUrl == null) { // no URL in API answer or no correct answer at all
63 | return null;
64 | }
65 |
66 | return parseFullLyricsPage(lyricsUrl);
67 |
68 | } catch (IOException e) {
69 | Log.w(TAG, "Couldn't connect to lyrics wiki REST endpoints", e);
70 | return null;
71 | } catch (JSONException e) {
72 | Log.w(TAG, "Couldn't transform API answer to JSON entity", e);
73 | return null;
74 | }
75 | }
76 |
77 | /**
78 | * First call
79 | */
80 | private String makeApiCall(String artistName, String songTitle) throws IOException, JSONException {
81 | HttpsURLConnection apiCall = null;
82 | try {
83 | // build query
84 | // e.g. https://lyrics.wikia.com/api.php?func=getSong&artist=The%20Beatle&song=Girl&fmt=realjson
85 | Uri link = new Uri.Builder()
86 | .scheme("https")
87 | .authority("lyrics.wikia.com")
88 | .path("api.php")
89 | .appendQueryParameter("func", "getSong")
90 | .appendQueryParameter("fmt", "realjson")
91 | .appendQueryParameter("artist", artistName)
92 | .appendQueryParameter("song", songTitle)
93 | .build();
94 |
95 | // construct an http request
96 | apiCall = (HttpsURLConnection) new URL(link.toString()).openConnection();
97 | apiCall.setRequestProperty("Accept-Encoding", "gzip");
98 | apiCall.setReadTimeout(10_000);
99 | apiCall.setConnectTimeout(15_000);
100 |
101 | // execute
102 | apiCall.connect();
103 | int response = apiCall.getResponseCode();
104 | if (response != HttpsURLConnection.HTTP_OK) {
105 | // redirects are handled internally, this is clearly an error
106 | return null;
107 | }
108 |
109 | InputStream is;
110 | if ("gzip".equals(apiCall.getContentEncoding())) {
111 | is = new GZIPInputStream(apiCall.getInputStream());
112 | } else {
113 | is = apiCall.getInputStream();
114 | }
115 | String reply = new String(PluginUtils.readFully(is), "UTF-8");
116 | JSONObject getSongAnswer = new JSONObject(reply);
117 |
118 | return getLyricsUrl(getSongAnswer);
119 | } finally {
120 | if (apiCall != null) {
121 | apiCall.disconnect();
122 | }
123 | }
124 | }
125 |
126 | /**
127 | * Second call
128 | */
129 | private String parseFullLyricsPage(String lyricsUrl) throws IOException {
130 | Document page = Jsoup.parse(new URL(lyricsUrl), 10_000);
131 | Element lyricsBox = page.select("div.lyricbox").first();
132 | if (lyricsBox == null) { // no lyrics frame on page
133 | return null;
134 | }
135 |
136 | // remove unneeded elements
137 | lyricsBox.select("div.rtMatcher").remove();
138 | lyricsBox.select("div.lyricsbreak").remove();
139 | lyricsBox.select("script").remove();
140 |
141 | StringBuilder builder = new StringBuilder();
142 | for (Node curr : lyricsBox.childNodes()) {
143 | if (curr instanceof TextNode) {
144 | builder.append(((TextNode) curr).text());
145 | } else {
146 | builder.append("\n");
147 | }
148 | }
149 |
150 | return builder.toString();
151 | }
152 |
153 | private static String getLyricsUrl(JSONObject getSongAnswer) {
154 | try {
155 | String pageId = getSongAnswer.getString("page_id");
156 | if (TextUtils.isEmpty(pageId)) {
157 | return null; // empty page_id means page wasn't created
158 | }
159 | return getSongAnswer.getString("url");
160 | } catch (JSONException e) {
161 | Log.w(TAG, "Unknown format of getSong API call answer", e);
162 | return null;
163 | }
164 | }
165 | }
166 |
--------------------------------------------------------------------------------
/app/src/main/java/com/kanedias/vanilla/lyrics/LyricsShowActivity.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (C) 2016-2019 Oleg `Kanedias` Chernovskiy
3 | *
4 | * This program is free software: you can redistribute it and/or modify
5 | * it under the terms of the GNU General Public License as published by
6 | * the Free Software Foundation, either version 3 of the License, or
7 | * (at your option) any later version.
8 | *
9 | * This program is distributed in the hope that it will be useful,
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | * GNU General Public License for more details.
13 | *
14 | * You should have received a copy of the GNU General Public License
15 | * along with this program. If not, see .
16 | */
17 | package com.kanedias.vanilla.lyrics;
18 |
19 | import android.app.AlertDialog;
20 | import android.content.Context;
21 | import android.content.Intent;
22 | import android.content.SharedPreferences;
23 | import android.content.pm.PackageManager;
24 | import android.content.pm.ResolveInfo;
25 | import android.net.Uri;
26 | import android.os.AsyncTask;
27 | import android.os.Bundle;
28 | import android.os.ParcelFileDescriptor;
29 | import android.preference.PreferenceManager;
30 | import android.text.TextUtils;
31 | import android.util.Log;
32 | import android.view.Menu;
33 | import android.view.MenuInflater;
34 | import android.view.MenuItem;
35 | import android.view.View;
36 | import android.widget.Button;
37 | import android.widget.TextView;
38 | import android.widget.Toast;
39 | import android.widget.ViewSwitcher;
40 |
41 | import androidx.annotation.NonNull;
42 | import androidx.documentfile.provider.DocumentFile;
43 |
44 | import com.kanedias.vanilla.plugins.DialogActivity;
45 | import com.kanedias.vanilla.plugins.PluginUtils;
46 | import com.kanedias.vanilla.plugins.saf.SafPermissionHandler;
47 |
48 | import java.io.File;
49 | import java.io.FileInputStream;
50 | import java.io.FileOutputStream;
51 | import java.io.IOException;
52 | import java.nio.charset.Charset;
53 | import java.util.ArrayList;
54 | import java.util.Arrays;
55 | import java.util.List;
56 |
57 | import static android.Manifest.permission.WRITE_EXTERNAL_STORAGE;
58 | import static com.kanedias.vanilla.plugins.PluginConstants.*;
59 | import static com.kanedias.vanilla.plugins.PluginUtils.checkAndRequestPermissions;
60 | import static com.kanedias.vanilla.plugins.PluginUtils.havePermissions;
61 | import static com.kanedias.vanilla.plugins.saf.SafUtils.findInDocumentTree;
62 | import static com.kanedias.vanilla.plugins.saf.SafUtils.isSafNeeded;
63 |
64 | /**
65 | * Main activity of Lyrics Search plugin. This will be presented as a dialog to the user
66 | * if one chooses it as the requested plugin.
67 | *
68 | *
69 | * This activity must be able to handle ACTION_WAKE_PLUGIN and ACTION_LAUNCH_PLUGIN
70 | * intents coming from Vanilla Music.
71 | *
72 | *
73 | * Casual conversation looks like this:
74 | *
75 | * VanillaMusic Plugin
76 | * | |
77 | * | ACTION_WAKE_PLUGIN broadcast |
78 | * |---------------------------------------->| (plugin init if just installed)
79 | * | |
80 | * | ACTION_REQUEST_PLUGIN_PARAMS broadcast |
81 | * |---------------------------------------->| (this is handled by BroadcastReceiver)
82 | * | |
83 | * | ACTION_HANDLE_PLUGIN_PARAMS |
84 | * |<----------------------------------------| (plugin answer with name and desc)
85 | * | |
86 | * | ACTION_LAUNCH_PLUGIN |
87 | * |---------------------------------------->| (plugin is allowed to show window)
88 | *
89 | *
90 | *
91 | * @author Kanedias
92 | */
93 | public class LyricsShowActivity extends DialogActivity {
94 |
95 | private static final String PLUGIN_TAG_EDIT_PKG = "com.kanedias.vanilla.audiotag";
96 |
97 | private SharedPreferences mPrefs;
98 |
99 | private TextView mLyricsText;
100 | private ViewSwitcher mSwitcher;
101 | private Button mOkButton, mWriteButton;
102 |
103 | private SafPermissionHandler mSafHandler;
104 | private LyricsEngine mEngine = new GeniusApiEngine();
105 |
106 | @Override
107 | protected void onCreate(Bundle savedInstanceState) {
108 | super.onCreate(savedInstanceState);
109 |
110 | if (handleLaunchPlugin()) {
111 | // no UI was required for handling the intent
112 | return;
113 | }
114 |
115 | setContentView(R.layout.activity_lyrics_show);
116 |
117 | mSafHandler = new SafPermissionHandler(this);
118 | mPrefs = PreferenceManager.getDefaultSharedPreferences(this);
119 |
120 | mSwitcher = findViewById(R.id.loading_switcher);
121 | mLyricsText = findViewById(R.id.lyrics_text);
122 | mWriteButton = findViewById(R.id.write_button);
123 | mOkButton = findViewById(R.id.ok_button);
124 |
125 | setupUI();
126 | }
127 |
128 | @Override
129 | public boolean onCreateOptionsMenu(Menu menu) {
130 | MenuInflater inflater = new MenuInflater(this);
131 | inflater.inflate(R.menu.lyrics_options, menu);
132 | return super.onCreateOptionsMenu(menu);
133 | }
134 |
135 | @Override
136 | public boolean onPrepareOptionsMenu(Menu menu) {
137 | for (int i = 0; i < menu.size(); i++) {
138 | MenuItem item = menu.getItem(i);
139 | switch (item.getItemId()) {
140 | case R.id.reload_option:
141 | // show only when loading is complete
142 | item.setVisible(mSwitcher.getDisplayedChild() == 1);
143 | continue;
144 | default:
145 | break;
146 | }
147 | }
148 | return super.onPrepareOptionsMenu(menu);
149 | }
150 |
151 | @Override
152 | public boolean onOptionsItemSelected(MenuItem item) {
153 | switch (item.getItemId()) {
154 | case R.id.reload_option:
155 | // show loading circle
156 | mSwitcher.setDisplayedChild(0);
157 | handleUiIntent(false);
158 | return true;
159 | }
160 | return super.onOptionsItemSelected(item);
161 | }
162 |
163 | /**
164 | * Handle incoming intent that may possible be ping, other plugin request or user-interactive plugin request
165 | * @return true if intent was handled internally, false if activity startup is required
166 | */
167 | private boolean handleLaunchPlugin() {
168 | if (TextUtils.equals(getIntent().getAction(), ACTION_WAKE_PLUGIN)) {
169 | // just show that we're okay
170 | Log.i(LOG_TAG, "Plugin enabled!");
171 | finish();
172 | return true;
173 | }
174 |
175 | if (pluginInstalled(this, PLUGIN_TAG_EDIT_PKG) && !getIntent().hasExtra(EXTRA_PARAM_P2P)) {
176 | // it's user-requested, try to retrieve lyrics from the tag first
177 | Intent readLyrics = new Intent(ACTION_LAUNCH_PLUGIN);
178 | readLyrics.setPackage(PLUGIN_TAG_EDIT_PKG);
179 | readLyrics.putExtra(EXTRA_PARAM_URI, (Uri) getIntent().getParcelableExtra(EXTRA_PARAM_URI));
180 | readLyrics.putExtra(EXTRA_PARAM_PLUGIN_APP, getApplicationInfo());
181 | readLyrics.putExtra(EXTRA_PARAM_P2P, P2P_READ_TAG);
182 | readLyrics.putExtra(EXTRA_PARAM_P2P_KEY, new String[]{"LYRICS"}); // tag name
183 | readLyrics.putExtras(getIntent());
184 | startActivity(readLyrics);
185 | finish(); // end this activity instance, it will be re-created by incoming intent from Tag Editor
186 | return true;
187 | }
188 |
189 | return false;
190 | }
191 |
192 | @Override
193 | protected void onResume() {
194 | super.onResume();
195 |
196 | // UI is initialized now
197 | handleUiIntent(true);
198 | }
199 |
200 | @Override
201 | public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
202 | super.onRequestPermissionsResult(requestCode, permissions, grantResults);
203 |
204 | // we only request one permission
205 | if (!havePermissions(this, WRITE_EXTERNAL_STORAGE)) {
206 | // user denied our request, leave activity as-is
207 | return;
208 | }
209 |
210 | for (int i = 0; i < permissions.length; ++i) {
211 | if (TextUtils.equals(permissions[i], WRITE_EXTERNAL_STORAGE)
212 | && grantResults[i] == PackageManager.PERMISSION_GRANTED) {
213 | // continue persist process started in Write... -> *.lrc file
214 | persistAsLrcFile();
215 | }
216 | }
217 | }
218 |
219 | @Override
220 | protected void onActivityResult(int requestCode, int resultCode, Intent data) {
221 | super.onActivityResult(requestCode, resultCode, data);
222 | if (mSafHandler.onActivityResult(requestCode, resultCode, data)) {
223 | persistAsLrcFile();
224 | }
225 | }
226 |
227 | /**
228 | * Handle user-interactive intent after activity was initialized. Loads lyrics from various sources if necessary.
229 | * @param useLocal true if tag info or *.lrc file can be used to retrieve lyrics, false if only network is allowed
230 | */
231 | private void handleUiIntent(boolean useLocal) {
232 | if (useLocal && !TextUtils.isEmpty(mLyricsText.getText())) {
233 | // we already have lyrics loaded, skip trying to get it from elsewhere
234 | return;
235 | }
236 |
237 | // check if this is an answer from tag plugin
238 | if (useLocal && TextUtils.equals(getIntent().getStringExtra(EXTRA_PARAM_P2P), P2P_READ_TAG)) {
239 | String[] fields = getIntent().getStringArrayExtra(EXTRA_PARAM_P2P_VAL);
240 | if (fields != null && fields.length > 0 && !TextUtils.isEmpty(fields[0])) {
241 | // start activity with retrieved lyrics
242 | String lyrics = getIntent().getStringArrayExtra(EXTRA_PARAM_P2P_VAL)[0];
243 | showFetchedLyrics(lyrics);
244 | return;
245 | }
246 | }
247 |
248 | // try to load from *.lrc file nearby
249 | if (useLocal && loadFromFile()) {
250 | return;
251 | }
252 |
253 | // we didn't receive lyrics from tag plugin, try to retrieve it via lyrics engine
254 | new LyricsFetcher().execute(getIntent());
255 | }
256 |
257 | /**
258 | * This plugin also has P2P functionality with others.
259 | *
260 | * Tag plugin - Uses provided field retrieval interface for LYRICS tag:
261 | *
262 | *
263 | * Lyrics Plugin Tag Editor Plugin
264 | * | |
265 | * | P2P intent with lyrics request |
266 | * |---------------------------------------->|
267 | * | |
268 | * | P2P intent with lyrics response |
269 | * |<----------------------------------------| (can be empty if no embedded lyrics found)
270 | * | |
271 | *
272 | * At this point lyrics plugin starts activity with either
273 | * extras from lyrics response (if found) or with original intent
274 | *
275 | *
276 | * @param ctx context to resolve activities from
277 | * @param pkgName package name of the plugin to be queried
278 | */
279 | private static boolean pluginInstalled(Context ctx, String pkgName) {
280 | List resolved = ctx.getPackageManager().queryIntentActivities(new Intent(ACTION_LAUNCH_PLUGIN), 0);
281 | for (ResolveInfo pkg : resolved) {
282 | if (TextUtils.equals(pkg.activityInfo.packageName, pkgName)) {
283 | return true;
284 | }
285 | }
286 | return false;
287 | }
288 |
289 | /**
290 | * Retrieves companion name for lyrics file from media passed
291 | *
292 | * @param mediaFile - original media file that the lyrics was requested for
293 | * @return string representing name with extension for lyrics companion file
294 | */
295 | @NonNull
296 | private static String lyricsForFile(File mediaFile) {
297 | String mfName = mediaFile.getName();
298 | return mfName.indexOf(".") > 0
299 | ? mfName.substring(0, mfName.lastIndexOf(".")) + ".lrc"
300 | : mfName + ".lrc";
301 | }
302 |
303 | /**
304 | * Try to load lyrics tag from companion *.lrc file nearby
305 | *
306 | * @return true if lyrics was loaded from file, false otherwise
307 | */
308 | private boolean loadFromFile() {
309 | // used didn't write any *.lrc file, skip loading
310 | // better, should we ask user for it in a dialog?
311 | if (!PluginUtils.havePermissions(this, WRITE_EXTERNAL_STORAGE)) {
312 | return false;
313 | }
314 |
315 | Uri fileUri = getIntent().getParcelableExtra(EXTRA_PARAM_URI);
316 | if (fileUri == null || fileUri.getPath() == null) {
317 | // wrong intent passed?
318 | return false;
319 | }
320 |
321 | File media = new File(fileUri.getPath());
322 | String lyricsFileName = lyricsForFile(media);
323 | File lyricsFile = new File(media.getParentFile(), lyricsFileName);
324 | if (!lyricsFile.exists()) {
325 | return false;
326 | }
327 |
328 | try {
329 | String lyricsText = new String(PluginUtils.readFully(new FileInputStream(lyricsFile)), "UTF-8");
330 | showFetchedLyrics(lyricsText);
331 | } catch (IOException e) {
332 | Log.e(LOG_TAG, "Failed to read lyrics text from file!", e);
333 | return false;
334 | }
335 | return true;
336 | }
337 |
338 | /**
339 | * Initialize UI elements with handlers and action listeners
340 | */
341 | private void setupUI() {
342 | mWriteButton.setOnClickListener(new SelectWriteAction());
343 | mOkButton.setOnClickListener(v -> finish());
344 | }
345 |
346 | /**
347 | * External lyrics fetcher (using network). Operates asynchronously, notifies dialog when finishes.
348 | * On no result (no such lyrics, couldn't fetch etc.) shows toast about this, on success updates dialog text.
349 | */
350 | private class LyricsFetcher extends AsyncTask {
351 |
352 | @Override
353 | protected String doInBackground(Intent... params) {
354 | String title = getIntent().getStringExtra(EXTRA_PARAM_SONG_TITLE);
355 | String artist = getIntent().getStringExtra(EXTRA_PARAM_SONG_ARTIST);
356 | return mEngine.getLyrics(artist, title);
357 | }
358 |
359 | @Override
360 | protected void onPostExecute(String lyrics) {
361 | if (TextUtils.isEmpty(lyrics)) {
362 | // no lyrics - show excuse
363 | Toast.makeText(LyricsShowActivity.this, R.string.lyrics_not_found, Toast.LENGTH_SHORT).show();
364 | }
365 |
366 | showFetchedLyrics(lyrics);
367 | }
368 | }
369 |
370 | /**
371 | * Stop spinning animation and show lyrics for the song.
372 | * Write button wil lbe active after that as lyrics will be available for persisting.
373 | *
374 | * @param lyrics retrieved song lyrics
375 | */
376 | private void showFetchedLyrics(String lyrics) {
377 | if (TextUtils.isEmpty(lyrics)) {
378 | // nothing found
379 | mWriteButton.setEnabled(false);
380 | } else {
381 | // some lyrics was extracted
382 | mWriteButton.setEnabled(true);
383 | }
384 | mLyricsText.setText(lyrics);
385 | mSwitcher.setDisplayedChild(1);
386 | invalidateOptionsMenu();
387 | }
388 |
389 | /**
390 | * Write lyrics as a *.lrc file - selects SAF/File routine based on target access.
391 | * Resulting file should be placed in the same directory as media file but with *.lrc extension instead.
392 | */
393 | private void persistAsLrcFile() {
394 | Uri fileUri = getIntent().getParcelableExtra(EXTRA_PARAM_URI);
395 | if (fileUri == null || fileUri.getPath() == null) {
396 | // wrong intent passed?
397 | return;
398 | }
399 |
400 | File mediaFile = new File(fileUri.getPath());
401 | if (!mediaFile.exists()) {
402 | // file deleted while launching intent or player db is not refreshed
403 | return;
404 | }
405 |
406 | String lrcFilename = lyricsForFile(mediaFile);
407 | File lrcTarget = new File(mediaFile.getParent(), lrcFilename);
408 | byte[] data = mLyricsText.getText().toString().getBytes(Charset.forName("UTF-8"));
409 | if (isSafNeeded(mediaFile, this)) {
410 | if (mPrefs.contains(PREF_SDCARD_URI)) {
411 | // we already got the permission!
412 | writeThroughSaf(data, mediaFile, lrcTarget.getName());
413 | return;
414 | }
415 |
416 | // request SAF permissions in handler
417 | mSafHandler.handleFile(mediaFile);
418 | } else {
419 | writeThroughFile(data, lrcTarget);
420 | }
421 | }
422 |
423 | /**
424 | * Write to *.lrc file through file-based API
425 | *
426 | * @param data - data to write
427 | * @param target - target file for writing metadata into
428 | */
429 | private void writeThroughFile(byte[] data, File target) {
430 | try {
431 | FileOutputStream fos = new FileOutputStream(target);
432 | fos.write(data);
433 | fos.close();
434 |
435 | Toast.makeText(this, R.string.file_written_successfully, Toast.LENGTH_SHORT).show();
436 | } catch (Exception e) {
437 | Toast.makeText(this, getString(R.string.error_writing_file) + e.getLocalizedMessage(), Toast.LENGTH_LONG).show();
438 | Log.e(LOG_TAG, "Failed to write to file descriptor provided by SAF!", e);
439 | }
440 | }
441 |
442 | /**
443 | * Write lyrics to *.lrc file through SAF framework - the only way to do it in Android > 4.4 when working with SD card
444 | */
445 | private void writeThroughSaf(byte[] data, File original, String name) {
446 | DocumentFile originalRef;
447 | if (mPrefs.contains(PREF_SDCARD_URI)) {
448 | // no sorcery can allow you to gain URI to the document representing file you've been provided with
449 | // you have to find it again now using Document API
450 |
451 | // /storage/volume/Music/some.mp3 will become [storage, volume, music, some.mp3]
452 | List pathSegments = new ArrayList<>(Arrays.asList(original.getAbsolutePath().split("/")));
453 | Uri allowedSdRoot = Uri.parse(mPrefs.getString(PREF_SDCARD_URI, ""));
454 | originalRef = findInDocumentTree(DocumentFile.fromTreeUri(this, allowedSdRoot), pathSegments);
455 | } else {
456 | // user will click the button again
457 | return;
458 | }
459 |
460 | if (originalRef == null || originalRef.getParentFile() == null) {
461 | // nothing selected or invalid file?
462 | Toast.makeText(this, R.string.saf_nothing_selected, Toast.LENGTH_LONG).show();
463 | return;
464 | }
465 |
466 | DocumentFile lrcFileRef = originalRef.getParentFile().createFile("image/*", name);
467 | if (lrcFileRef == null) {
468 | // couldn't create file?
469 | Toast.makeText(this, R.string.saf_write_error, Toast.LENGTH_LONG).show();
470 | return;
471 | }
472 |
473 | try {
474 | ParcelFileDescriptor pfd = getContentResolver().openFileDescriptor(lrcFileRef.getUri(), "rw");
475 | if (pfd == null) {
476 | // should not happen
477 | Log.e(LOG_TAG, "SAF provided incorrect URI!" + lrcFileRef.getUri());
478 | return;
479 | }
480 |
481 | FileOutputStream fos = new FileOutputStream(pfd.getFileDescriptor());
482 | fos.write(data);
483 | fos.close();
484 |
485 | // rescan original file
486 | Toast.makeText(this, R.string.file_written_successfully, Toast.LENGTH_SHORT).show();
487 | } catch (Exception e) {
488 | Toast.makeText(this, getString(R.string.saf_write_error) + e.getLocalizedMessage(), Toast.LENGTH_LONG).show();
489 | Log.e(LOG_TAG, "Failed to write to file descriptor provided by SAF!", e);
490 | }
491 | }
492 |
493 | /**
494 | * Write to the song tag using Tag Editor Plugin
495 | */
496 | private void writeToFileTag() {
497 | String lyrics = mLyricsText.getText().toString();
498 | Intent request = new Intent(ACTION_LAUNCH_PLUGIN);
499 | request.setPackage(PLUGIN_TAG_EDIT_PKG);
500 | request.putExtra(EXTRA_PARAM_URI, (Uri) getIntent().getParcelableExtra(EXTRA_PARAM_URI));
501 | request.putExtra(EXTRA_PARAM_PLUGIN_APP, getApplicationInfo());
502 | request.putExtra(EXTRA_PARAM_P2P, P2P_WRITE_TAG);
503 | request.putExtra(EXTRA_PARAM_P2P_KEY, new String[]{"LYRICS"}); // tag name
504 | request.putExtra(EXTRA_PARAM_P2P_VAL, new String[]{lyrics}); // tag value
505 | startActivity(request);
506 | }
507 |
508 | /**
509 | * CLick listener for P2P integration, sends intent to write retrieved lyrics to local file tag or to
510 | * lyrics file
511 | */
512 | private class SelectWriteAction implements View.OnClickListener {
513 |
514 | @Override
515 | public void onClick(View v) {
516 | List actions = new ArrayList<>();
517 | actions.add(getString(R.string.write_to_lrc));
518 |
519 | // if tag editor is installed, show `write to tag` button
520 | if (pluginInstalled(LyricsShowActivity.this, PLUGIN_TAG_EDIT_PKG)) {
521 | actions.add(getString(R.string.write_to_tag));
522 | }
523 |
524 | new AlertDialog.Builder(LyricsShowActivity.this)
525 | .setItems(actions.toArray(new CharSequence[0]), (dialog, which) -> {
526 | switch (which) {
527 | case 0: // to lyrics file
528 | if (!checkAndRequestPermissions(LyricsShowActivity.this, WRITE_EXTERNAL_STORAGE)) {
529 | return;
530 | }
531 |
532 | persistAsLrcFile();
533 | break;
534 | case 1: // to media file tag
535 | writeToFileTag();
536 | break;
537 | }
538 | }).create().show();
539 | }
540 | }
541 | }
542 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
19 |
20 |
21 | 
23 |
24 |
25 | Features
26 | --------
27 |
28 | * Requests lyrics by artist and title from lyrics.wikia.com
29 | * Can interact with [Tag Editor plugin](https://github.com/vanilla-music/vanilla-music-tag-editor):
30 | * Can read lyrics from file tags and show them
31 | without internet connection.
32 | * Can write lyrics retrieved from wiki to file tags
33 |
34 | Donate
35 | ------
36 |
37 | [
](https://www.patreon.com/kanedias)
38 |
39 | License
40 | -------
41 |
42 | Copyright (C) 2016-2020 Oleg `Kanedias` Chernovskiy
43 |
44 | This program is free software: you can redistribute it and/or modify
45 | it under the terms of the GNU General Public License as published by
46 | the Free Software Foundation, either version 3 of the License, or
47 | (at your option) any later version.
48 |
49 | This program is distributed in the hope that it will be useful,
50 | but WITHOUT ANY WARRANTY; without even the implied warranty of
51 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
52 | GNU General Public License for more details.
53 |
54 | You should have received a copy of the GNU General Public License
55 | along with this program. If not, see