kitty/spotube
1
0
Fork 0
mirror of https://github.com/KRTirtho/spotube.git synced 2025-12-10 17:07:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: add login with lastfm support

Browse Source
This commit is contained in:
Kingkor Roy Tirtho 2023-09-29 14:04:28 +06:00
parent e54762be6a
commit 20bb28beb3
14 changed files with 538 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.env.example
View File

@ -8,4 +8,7 @@ SPOTIFY_SECRETS=
# 0 or 1
# 0 = disable
# 1 = enable
ENABLE_UPDATE_CHECK=
ENABLE_UPDATE_CHECK=
LASTFM_API_KEY=
LASTFM_API_SECRET=

1
.vscode/settings.json vendored
View File

@ -6,6 +6,7 @@
"instrumentalness",
"Mpris",
"riverpod",
"Scrobblenaut",
"speechiness",
"Spotube",
"winget"

12
lib/collections/assets.gen.dart
View File

@ -36,6 +36,8 @@ class Assets {
static const AssetGenImage emptyBox = AssetGenImage('assets/empty_box.png');
static const AssetGenImage placeholder =
AssetGenImage('assets/placeholder.png');
static const AssetGenImage spotubeHeroBanner =
AssetGenImage('assets/spotube-hero-banner.png');
static const AssetGenImage spotubeLogoForeground =
AssetGenImage('assets/spotube-logo-foreground.jpg');
static const String spotubeLogoIco = 'assets/spotube-logo.ico';
@ -53,6 +55,12 @@ class Assets {
AssetGenImage('assets/spotube-nightly-logo_android12.png');
static const AssetGenImage spotubeScreenshot =
AssetGenImage('assets/spotube-screenshot.png');
static const AssetGenImage spotubeTallCapsule =
AssetGenImage('assets/spotube-tall-capsule.png');
static const AssetGenImage spotubeWideCapsuleLarge =
AssetGenImage('assets/spotube-wide-capsule-large.png');
static const AssetGenImage spotubeWideCapsuleSmall =
AssetGenImage('assets/spotube-wide-capsule-small.png');
static const AssetGenImage spotubeBanner =
AssetGenImage('assets/spotube_banner.png');
static const AssetGenImage success = AssetGenImage('assets/success.png');
@ -67,6 +75,7 @@ class Assets {
branding,
emptyBox,
placeholder,
spotubeHeroBanner,
spotubeLogoForeground,
spotubeLogoIco,
spotubeLogoPng,
@ -77,6 +86,9 @@ class Assets {
spotubeNightlyLogoSvg,
spotubeNightlyLogoAndroid12,
spotubeScreenshot,
spotubeTallCapsule,
spotubeWideCapsuleLarge,
spotubeWideCapsuleSmall,
spotubeBanner,
success,
userPlaceholder

6
lib/collections/env.dart
View File

@ -13,6 +13,12 @@ abstract class Env {
@EnviedField(varName: 'SPOTIFY_SECRETS')
static final String rawSpotifySecrets = _Env.rawSpotifySecrets;
@EnviedField(varName: 'LASTFM_API_KEY')
static final String lastFmApiKey = _Env.lastFmApiKey;
@EnviedField(varName: 'LASTFM_API_SECRET')
static final String lastFmApiSecret = _Env.lastFmApiSecret;
static final spotifySecrets = rawSpotifySecrets.split(',').map((e) {
final secrets = e.trim().split(":").map((e) => e.trim());
return {

7
lib/collections/routes.dart
View File

@ -4,6 +4,7 @@ import 'package:flutter/widgets.dart';
import 'package:go_router/go_router.dart';
import 'package:spotify/spotify.dart' hide Search;
import 'package:spotube/pages/home/home.dart';
import 'package:spotube/pages/lastfm_login/lastfm_login.dart';
import 'package:spotube/pages/library/playlist_generate/playlist_generate.dart';
import 'package:spotube/pages/lyrics/mini_lyrics.dart';
import 'package:spotube/pages/search/search.dart';
@ -146,6 +147,12 @@ final router = GoRouter(
child: LoginTutorial(),
),
),
GoRoute(
path: "/lastfm-login",
parentNavigatorKey: rootNavigatorKey,
pageBuilder: (context, state) =>
const SpotubePage(child: LastFMLoginPage()),
),
GoRoute(
path: "/player",
parentNavigatorKey: rootNavigatorKey,

5
lib/collections/spotube_icons.dart
View File

@ -1,6 +1,7 @@
import 'package:fluentui_system_icons/fluentui_system_icons.dart';
import 'package:flutter/material.dart';
import 'package:flutter_feather_icons/flutter_feather_icons.dart';
import 'package:simple_icons/simple_icons.dart';
abstract class SpotubeIcons {
static const home = FluentIcons.home_12_regular;
@ -100,4 +101,8 @@ abstract class SpotubeIcons {
static const amoled = FeatherIcons.sunset;
static const file = FeatherIcons.file;
static const stream = Icons.stream_rounded;
static const lastFm = SimpleIcons.lastdotfm;
static const spotify = SimpleIcons.spotify;
static const eye = FeatherIcons.eye;
static const noEye = FeatherIcons.eyeOff;
}

11
lib/l10n/app_en.arb
View File

@ -270,5 +270,14 @@
"add_cover": "Add cover",
"restore_defaults": "Restore defaults",
"download_music_codec": "Download music codec",
"streaming_music_codec": "Streaming music codec"
"streaming_music_codec": "Streaming music codec",
"login_with_lastfm": "Login with Last.fm",
"connect": "Connect",
"disconnect_lastfm": "Disconnect Last.fm",
"disconnect": "Disconnect",
"username": "Username",
"password": "Password",
"login": "Login",
"login_with_your_lastfm": "Login with your Last.fm account",
"scrobble_to_lastfm": "Scrobble to Last.fm"
}

127
lib/pages/lastfm_login/lastfm_login.dart Normal file
View File

@ -0,0 +1,127 @@
import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:form_validator/form_validator.dart';
import 'package:go_router/go_router.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:spotube/collections/spotube_icons.dart';
import 'package:spotube/components/shared/dialogs/prompt_dialog.dart';
import 'package:spotube/components/shared/page_window_title_bar.dart';
import 'package:spotube/extensions/context.dart';
import 'package:spotube/provider/scrobbler_provider.dart';
class LastFMLoginPage extends HookConsumerWidget {
const LastFMLoginPage({Key? key}) : super(key: key);
@override
Widget build(BuildContext context, ref) {
final theme = Theme.of(context);
final router = GoRouter.of(context);
final scrobblerNotifier = ref.read(scrobblerProvider.notifier);
final formKey = useMemoized(() => GlobalKey<FormState>(), []);
final username = useTextEditingController();
final password = useTextEditingController();
final passwordVisible = useState(false);
final isLoading = useState(false);
return Scaffold(
appBar: const PageWindowTitleBar(leading: BackButton()),
body: Center(
child: ConstrainedBox(
constraints: const BoxConstraints(maxWidth: 400),
child: Card(
margin: const EdgeInsets.all(8.0),
child: Padding(
padding: const EdgeInsets.all(16.0).copyWith(top: 8),
child: Form(
key: formKey,
autovalidateMode: AutovalidateMode.onUserInteraction,
child: Column(
mainAxisSize: MainAxisSize.min,
children: [
Container(
decoration: BoxDecoration(
borderRadius: BorderRadius.circular(30),
color: const Color.fromARGB(255, 186, 0, 0),
),
padding: const EdgeInsets.all(12),
child: const Icon(
SpotubeIcons.lastFm,
color: Colors.white,
size: 60,
),
),
Text(
"last.fm",
style: theme.textTheme.titleLarge,
),
const SizedBox(height: 10),
Text(context.l10n.login_with_your_lastfm),
const SizedBox(height: 10),
TextFormField(
controller: username,
validator: ValidationBuilder().required().build(),
decoration: InputDecoration(
labelText: context.l10n.username,
),
),
const SizedBox(height: 10),
TextFormField(
controller: password,
validator: ValidationBuilder().required().build(),
obscureText: !passwordVisible.value,
decoration: InputDecoration(
labelText: context.l10n.password,
suffixIcon: IconButton(
icon: Icon(
passwordVisible.value
? SpotubeIcons.eye
: SpotubeIcons.noEye,
),
onPressed: () =>
passwordVisible.value = !passwordVisible.value,
),
),
),
const SizedBox(height: 10),
FilledButton(
onPressed: isLoading.value
? null
: () async {
try {
isLoading.value = true;
if (formKey.currentState?.validate() != true) {
return;
}
await scrobblerNotifier.login(
username.text,
password.text,
);
router.pop();
} catch (e) {
if (context.mounted) {
showPromptDialog(
context: context,
title: context.l10n
.error("Authentication failed"),
message: e.toString(),
cancelText: null,
);
}
} finally {
isLoading.value = false;
}
},
child: Text(context.l10n.login),
),
],
),
),
),
),
),
),
);
}
}

128
lib/pages/settings/sections/accounts.dart Normal file
View File

@ -0,0 +1,128 @@
import 'package:auto_size_text/auto_size_text.dart';
import 'package:flutter/material.dart';
import 'package:go_router/go_router.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:spotube/collections/spotube_icons.dart';
import 'package:spotube/components/settings/section_card_with_heading.dart';
import 'package:spotube/extensions/constrains.dart';
import 'package:spotube/extensions/context.dart';
import 'package:spotube/provider/authentication_provider.dart';
import 'package:spotube/provider/scrobbler_provider.dart';
class SettingsAccountSection extends HookConsumerWidget {
const SettingsAccountSection({Key? key}) : super(key: key);
@override
Widget build(context, ref) {
final theme = Theme.of(context);
final auth = ref.watch(AuthenticationNotifier.provider);
final scrobbler = ref.watch(scrobblerProvider);
final router = GoRouter.of(context);
final logoutBtnStyle = FilledButton.styleFrom(
backgroundColor: Colors.red,
foregroundColor: Colors.white,
);
return SectionCardWithHeading(
heading: context.l10n.account,
children: [
if (auth == null)
LayoutBuilder(builder: (context, constrains) {
return ListTile(
leading: Icon(
SpotubeIcons.spotify,
color: theme.colorScheme.primary,
),
title: Align(
alignment: Alignment.centerLeft,
child: AutoSizeText(
context.l10n.login_with_spotify,
maxLines: 1,
style: TextStyle(
color: theme.colorScheme.primary,
),
),
),
onTap: constrains.mdAndUp
? null
: () {
router.push("/login");
},
trailing: constrains.smAndDown
? null
: FilledButton(
onPressed: () {
router.push("/login");
},
style: ButtonStyle(
shape: MaterialStateProperty.all(
RoundedRectangleBorder(
borderRadius: BorderRadius.circular(25.0),
),
),
),
child: Text(
context.l10n.connect_with_spotify.toUpperCase(),
),
),
);
})
else
Builder(builder: (context) {
return ListTile(
leading: const Icon(SpotubeIcons.spotify),
title: SizedBox(
height: 50,
width: 180,
child: Align(
alignment: Alignment.centerLeft,
child: AutoSizeText(
context.l10n.logout_of_this_account,
maxLines: 1,
),
),
),
trailing: FilledButton(
style: logoutBtnStyle,
onPressed: () async {
ref.read(AuthenticationNotifier.provider.notifier).logout();
GoRouter.of(context).pop();
},
child: Text(context.l10n.logout),
),
);
}),
if (scrobbler == null)
ListTile(
leading: const Icon(SpotubeIcons.lastFm),
title: Text(context.l10n.login_with_lastfm),
subtitle: Text(context.l10n.scrobble_to_lastfm),
trailing: FilledButton.icon(
icon: const Icon(SpotubeIcons.lastFm),
label: Text(context.l10n.connect),
onPressed: () {
router.push("/lastfm-login");
},
style: FilledButton.styleFrom(
backgroundColor: const Color.fromARGB(255, 186, 0, 0),
foregroundColor: Colors.white,
),
),
)
else
ListTile(
leading: const Icon(SpotubeIcons.lastFm),
title: Text(context.l10n.disconnect_lastfm),
trailing: FilledButton(
onPressed: () {
ref.read(scrobblerProvider.notifier).logout();
},
style: logoutBtnStyle,
child: Text(context.l10n.disconnect),
),
),
],
);
}
}

85
lib/pages/settings/settings.dart
View File

@ -23,7 +23,7 @@ import 'package:spotube/extensions/constrains.dart';
import 'package:spotube/extensions/context.dart';
import 'package:spotube/l10n/l10n.dart';
import 'package:spotube/models/matched_track.dart';
import 'package:spotube/provider/authentication_provider.dart';
import 'package:spotube/pages/settings/sections/accounts.dart';
import 'package:spotube/provider/user_preferences_provider.dart';
import 'package:spotube/provider/piped_instances_provider.dart';
import 'package:url_launcher/url_launcher_string.dart';
@ -34,7 +34,6 @@ class SettingsPage extends HookConsumerWidget {
@override
Widget build(BuildContext context, ref) {
final preferences = ref.watch(userPreferencesProvider);
final auth = ref.watch(AuthenticationNotifier.provider);
final theme = Theme.of(context);
final mediaQuery = MediaQuery.of(context);
@ -73,87 +72,7 @@ class SettingsPage extends HookConsumerWidget {
constraints: const BoxConstraints(maxWidth: 1366),
child: ListView(
children: [
SectionCardWithHeading(
heading: context.l10n.account,
children: [
if (auth == null)
LayoutBuilder(builder: (context, constrains) {
return ListTile(
leading: Icon(
SpotubeIcons.login,
color: theme.colorScheme.primary,
),
title: Align(
alignment: Alignment.centerLeft,
child: AutoSizeText(
context.l10n.login_with_spotify,
maxLines: 1,
style: TextStyle(
color: theme.colorScheme.primary,
),
),
),
onTap: constrains.mdAndUp
? null
: () {
GoRouter.of(context).push("/login");
},
trailing: constrains.smAndDown
? null
: FilledButton(
onPressed: () {
GoRouter.of(context).push("/login");
},
style: ButtonStyle(
shape: MaterialStateProperty.all(
RoundedRectangleBorder(
borderRadius:
BorderRadius.circular(25.0),
),
),
),
child: Text(
context.l10n.connect_with_spotify
.toUpperCase(),
),
),
);
})
else
Builder(builder: (context) {
return ListTile(
leading: const Icon(SpotubeIcons.logout),
title: SizedBox(
height: 50,
width: 180,
child: Align(
alignment: Alignment.centerLeft,
child: AutoSizeText(
context.l10n.logout_of_this_account,
maxLines: 1,
),
),
),
trailing: FilledButton(
style: ButtonStyle(
backgroundColor:
MaterialStateProperty.all(Colors.red),
foregroundColor:
MaterialStateProperty.all(Colors.white),
),
onPressed: () async {
ref
.read(AuthenticationNotifier
.provider.notifier)
.logout();
GoRouter.of(context).pop();
},
child: Text(context.l10n.logout),
),
);
}),
],
),
const SettingsAccountSection(),
SectionCardWithHeading(
heading: context.l10n.language_region,
children: [

86
lib/provider/scrobbler_provider.dart Normal file
View File

@ -0,0 +1,86 @@
import 'dart:async';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:scrobblenaut/scrobblenaut.dart';
import 'package:spotube/collections/env.dart';
import 'package:spotube/utils/persisted_state_notifier.dart';
class ScrobblerState {
final String username;
final String passwordHash;
final Scrobblenaut scrobblenaut;
ScrobblerState({
required this.username,
required this.passwordHash,
required this.scrobblenaut,
});
Map<String, dynamic> toJson() {
return {
'username': username,
'passwordHash': passwordHash,
};
}
}
class ScrobblerNotifier extends PersistedStateNotifier<ScrobblerState?> {
final Scrobblenaut? scrobblenaut;
ScrobblerNotifier()
: scrobblenaut = null,
super(null, "scrobbler", encrypted: true);
Future<void> login(
String username,
String password,
) async {
final lastFm = await LastFM.authenticate(
apiKey: Env.lastFmApiKey,
apiSecret: Env.lastFmApiSecret,
username: username,
password: password,
);
if (!lastFm.isAuth) throw Exception("Invalid credentials");
state = ScrobblerState(
username: username,
passwordHash: lastFm.passwordHash!,
scrobblenaut: Scrobblenaut(lastFM: lastFm),
);
}
Future<void> logout() async {
state = null;
}
@override
FutureOr<ScrobblerState?> fromJson(Map<String, dynamic> json) async {
if (json.isEmpty) {
return null;
}
return ScrobblerState(
username: json['username'],
passwordHash: json['passwordHash'],
scrobblenaut: Scrobblenaut(
lastFM: await LastFM.authenticateWithPasswordHash(
apiKey: Env.lastFmApiKey,
apiSecret: Env.lastFmApiSecret,
username: json["username"],
passwordHash: json["passwordHash"],
),
),
);
}
@override
Map<String, dynamic> toJson() {
return state?.toJson() ?? {};
}
}
final scrobblerProvider =
StateNotifierProvider<ScrobblerNotifier, ScrobblerState?>(
(ref) => ScrobblerNotifier(),
);

19
pubspec.lock
View File

@ -438,10 +438,10 @@ packages:
dependency: "direct main"
description:
name: dio
sha256: ce75a1b40947fea0a0e16ce73337122a86762e38b982e1ccb909daa3b9bc4197
sha256: "417e2a6f9d83ab396ec38ff4ea5da6c254da71e4db765ad737a42af6930140b7"
url: "https://pub.dev"
source: hosted
version: "5.3.2"
version: "5.3.3"
disable_battery_optimization:
dependency: "direct main"
description:
@ -1702,6 +1702,13 @@ packages:
url: "https://pub.dev"
source: hosted
version: "0.1.9"
scrobblenaut:
dependency: "direct main"
description:
path: "../Scrobblenaut"
relative: true
source: path
version: "3.0.0"
scroll_to_index:
dependency: "direct main"
description:
@ -1806,6 +1813,14 @@ packages:
url: "https://pub.dev"
source: hosted
version: "0.15.0"
simple_icons:
dependency: "direct main"
description:
name: simple_icons
sha256: "8aa6832dc7a263a3213e40ecbf1328a392308c809d534a3b860693625890483b"
url: "https://pub.dev"
source: hosted
version: "7.10.0"
skeleton_text:
dependency: "direct main"
description:

3
pubspec.yaml
View File

@ -81,6 +81,8 @@ dependencies:
permission_handler: ^10.2.0
piped_client: ^0.1.0
popover: ^0.2.6+3
scrobblenaut:
path: ../Scrobblenaut
scroll_to_index: ^3.0.1
shared_preferences: ^2.0.11
sidebarx: ^0.15.0
@ -102,6 +104,7 @@ dependencies:
ref: a738913c8ce2c9f47515382d40827e794a334274
path: plugins/window_size
youtube_explode_dart: ^2.0.1
simple_icons: ^7.10.0
dev_dependencies:
build_runner: ^2.3.2

143
untranslated_messages.json
View File

@ -6,7 +6,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"bn": [
@ -16,7 +25,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"ca": [
@ -26,7 +44,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"de": [
@ -36,7 +63,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"es": [
@ -46,7 +82,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"fr": [
@ -56,7 +101,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"hi": [
@ -66,7 +120,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"ja": [
@ -76,7 +139,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"pl": [
@ -86,7 +158,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"pt": [
@ -96,7 +177,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"ru": [
@ -106,7 +196,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"uk": [
@ -116,7 +215,16 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
],
"zh": [
@ -126,6 +234,15 @@
"add_cover",
"restore_defaults",
"download_music_codec",
"streaming_music_codec"
"streaming_music_codec",
"login_with_lastfm",
"connect",
"disconnect_lastfm",
"disconnect",
"username",
"password",
"login",
"login_with_your_lastfm",
"scrobble_to_lastfm"
]
}